Class Tool`Abstract`

工具基类

Export

Date

2022.6.1

Author

lyx

Hierarchy

EngineObject
- Tool

Index

Constructors

Properties

Accessors

Methods

active addEventListener deactivate dispatchEvent dispose onClick onDblClick onKeyDown onKeyUp onPointerCancel onPointerDown onPointerMove onPointerUp onWheel removeAllEventListeners removeEventListener removeEventListenerByEventId

Constructors

constructor

new Tool(engine, parameters?): Tool
Parameters
- engine: Engine
- parameters: {} = {}
Returns Tool

Overrides EngineObject.constructor

Properties

`Protected` _engine

_engine: Engine

Accessors

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from EngineObject.engine

Methods

`Abstract` active

active(parameters): void
激活工具
Parameters
- parameters: any
Returns void

Abstract

Memberof
Tool

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  } = {}
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from EngineObject.addEventListener

`Abstract` deactivate

deactivate(): void
停用工具

Returns void

Abstract

Memberof
Tool

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from EngineObject.dispose

onClick

onClick(event): boolean | void
响应‘click’事件
Parameters
- event: MouseEvent
Returns boolean | void

Memberof
Tool

onDblClick

onDblClick(event): boolean | void
响应dblclick事件
Parameters
- event: MouseEvent
Returns boolean | void

Memberof
Tool

onKeyDown

onKeyDown(event): boolean | void
响应‘keydown’事件
Parameters
- event: KeyboardEvent
Returns boolean | void

Memberof
Tool

onKeyUp

onKeyUp(event): boolean | void
响应‘keyup’事件
Parameters
- event: KeyboardEvent
Returns boolean | void

Memberof
Tool

onPointerCancel

onPointerCancel(event): boolean | void
响应‘pointercancel’事件
Parameters
- event: PointerEvent
Returns boolean | void

Memberof
Tool

onPointerDown

onPointerDown(event): boolean | void
响应‘pointdown’事件
Parameters
- event: PointerEvent
Returns boolean | void

Memberof
Tool

onPointerMove

onPointerMove(event): boolean | void
响应‘pointermove’事件
Parameters
- event: PointerEvent
Returns boolean | void

Memberof
Tool

onPointerUp

onPointerUp(event): boolean | void
响应‘pointerup’事件
Parameters
- event: PointerEvent
Returns boolean | void

Memberof
Tool

onWheel

onWheel(event): boolean | void
响应‘wheel’事件
Parameters
- event: MouseEvent
Returns boolean | void

Memberof
Tool

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeEventListenerByEventId