Class CadEventEmitter

CAD事件发射器

提供事件订阅、发布和管理功能的核心类

Example

const emitter = new CadEventEmitter();

// 监听事件
emitter.on(CadEvents.EntityAdded, (args) => {
  console.log('Entity added:', args.entity.type);
});

// 触发事件
emitter.emit(CadEvents.EntityAdded, { entity: lineEnt, timestamp: Date.now() });

Index

Constructors

constructor

Methods

on once off offAll emit hasListeners listenerCount suspendEvents resumeEvents isSuspended getRegisteredEvents

Constructors

constructor

new CadEventEmitter(): CadEventEmitter
Returns CadEventEmitter
- Defined in events/EventEmitter.ts:51

Methods

on

on<K extends keyof EventArgsMap>(
event: K,
handler: EventHandler<EventArgsMap[K]>,
): this
注册事件监听器
Type Parameters
- K extends keyof EventArgsMap
Parameters
- event: K
  事件类型
- handler: EventHandler<EventArgsMap[K]>
  事件处理函数
Returns this
当前实例，支持链式调用
Example
```
events.on(CadEvents.EntityAdded, (args) => {
  console.log('Entity added:', args.entity.id);
});
```
- Defined in events/EventEmitter.ts:73
on(event: string, handler: EventHandler): this
注册事件监听器
Parameters
- event: string
  事件类型
- handler: EventHandler
  事件处理函数
Returns this
当前实例，支持链式调用
Example
```
events.on(CadEvents.EntityAdded, (args) => {
  console.log('Entity added:', args.entity.id);
});
```
- Defined in events/EventEmitter.ts:77

once

once<K extends keyof EventArgsMap>(
event: K,
handler: EventHandler<EventArgsMap[K]>,
): this
注册一次性事件监听器监听器在触发一次后自动移除
Type Parameters
- K extends keyof EventArgsMap
Parameters
- event: K
  事件类型
- handler: EventHandler<EventArgsMap[K]>
  事件处理函数
Returns this
当前实例，支持链式调用
- Defined in events/EventEmitter.ts:97
once(event: string, handler: EventHandler): this
注册一次性事件监听器监听器在触发一次后自动移除
Parameters
- event: string
  事件类型
- handler: EventHandler
  事件处理函数
Returns this
当前实例，支持链式调用
- Defined in events/EventEmitter.ts:101

off

off<K extends keyof EventArgsMap>(
event: K,
handler: EventHandler<EventArgsMap[K]>,
): this
移除事件监听器
Type Parameters
- K extends keyof EventArgsMap
Parameters
- event: K
  事件类型
- handler: EventHandler<EventArgsMap[K]>
  要移除的处理函数
Returns this
当前实例，支持链式调用
- Defined in events/EventEmitter.ts:120
off(event: string, handler: EventHandler): this
移除事件监听器
Parameters
- event: string
  事件类型
- handler: EventHandler
  要移除的处理函数
Returns this
当前实例，支持链式调用
- Defined in events/EventEmitter.ts:124

offAll

offAll(event?: string): this
移除指定事件的所有监听器
Parameters
- Optionalevent: string
  事件类型，如果不提供则移除所有事件的监听器
Returns this
当前实例，支持链式调用
- Defined in events/EventEmitter.ts:145

emit

emit<K extends keyof EventArgsMap>(event: K, args: EventArgsMap[K]): boolean
触发事件
Type Parameters
- K extends keyof EventArgsMap
Parameters
- event: K
  事件类型
- args: EventArgsMap[K]
  事件参数
Returns boolean
如果事件被取消则返回 true，否则返回 false
- Defined in events/EventEmitter.ts:163
emit(event: string, args: CadEventArgs): boolean
触发事件
Parameters
- event: string
  事件类型
- args: CadEventArgs
  事件参数
Returns boolean
如果事件被取消则返回 true，否则返回 false
- Defined in events/EventEmitter.ts:167

hasListeners

hasListeners(event: string): boolean
检查指定事件是否有监听器
Parameters
- event: string
  事件类型
Returns boolean
是否有监听器
- Defined in events/EventEmitter.ts:235

listenerCount

listenerCount(event: string): number
获取指定事件的监听器数量
Parameters
- event: string
  事件类型
Returns number
监听器数量
- Defined in events/EventEmitter.ts:248

suspendEvents

suspendEvents(queueEvents?: boolean): void
暂停事件触发在暂停期间，所有事件都不会触发
Parameters
- queueEvents: boolean = false
  是否在暂停期间队列化事件，以便恢复时触发
Returns void
- Defined in events/EventEmitter.ts:261

resumeEvents

resumeEvents(): void
恢复事件触发如果之前设置了队列化事件，将依次触发队列中的事件

Returns void
- Defined in events/EventEmitter.ts:272

isSuspended

isSuspended(): boolean
检查事件是否被暂停

Returns boolean
是否暂停
- Defined in events/EventEmitter.ts:295

getRegisteredEvents

getRegisteredEvents(): string[]
获取所有已注册事件类型

Returns string[]
事件类型数组
- Defined in events/EventEmitter.ts:306

Class CadEventEmitter

Example

Index

Constructors

Methods

Constructors

constructor

Returns CadEventEmitter

Methods

on

Type Parameters

Parameters

Returns this

Example

Parameters

Returns this

Example

once

Type Parameters

Parameters

Returns this

Parameters

Returns this

off

Type Parameters

Parameters

Returns this

Parameters

Returns this

offAll

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

Parameters

Returns boolean

hasListeners

Parameters

Returns boolean

listenerCount

Parameters

Returns number

suspendEvents

Parameters

Returns void

resumeEvents

Returns void

isSuspended

Returns boolean

getRegisteredEvents

Returns string[]

Settings

On This Page