Class LanewayDesignTool

巷道设计工具

Export

Date

2023.10.19

Author

lyx

Hierarchy

Tool
- LanewayDesignTool

Index

Constructors

Properties

Accessors

activedDesigner engine

Methods

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

Constructors

constructor

new LanewayDesignTool(engine): LanewayDesignTool
Parameters
- engine: Engine
Returns LanewayDesignTool

Overrides Tool.constructor

Properties

`Protected` _engine

_engine: Engine

Accessors

activedDesigner

get activedDesigner(): LanewayDesigner
获取当前激活的设计器

Returns LanewayDesigner

Memberof
LanewayDesignTool

engine

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

Returns Engine

Memberof
EngineObject

Inherited from Tool.engine

Methods

active

active(parameters?): void
激活工具
Parameters
- parameters: LanewayDesignToolParameters = {}
Returns void

Memberof
LanewayDesignTool

Overrides Tool.active

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 Tool.addEventListener

deactivate

deactivate(): void
冻结停用工具

Returns void

Memberof
LanewayDesignTool

Overrides Tool.deactivate

dispatchEvent

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

Memberof
EventDispatcher

Inherited from Tool.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
LanewayDesignTool

Overrides Tool.dispose

onClick

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

Memberof
LanewayDesignTool

Overrides Tool.onClick

onDblClick

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

Memberof
LanewayDesignTool

Overrides Tool.onDblClick

onKeyDown

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

Memberof
LanewayDesignTool

Overrides Tool.onKeyDown

onKeyUp

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

Memberof
LanewayDesignTool

Overrides Tool.onKeyUp

onPointerCancel

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

Memberof
Tool

Inherited from Tool.onPointerCancel

onPointerDown

onPointerDown(event): boolean | void
'pointerdown'事件响应接口
Parameters
- event: PointerEvent
Returns boolean | void

Memberof
LanewayDesignTool

Overrides Tool.onPointerDown

onPointerMove

onPointerMove(event): boolean | void
'pointermove'事件响应接口
Parameters
- event: PointerEvent
Returns boolean | void

Memberof
LanewayDesignTool

Overrides Tool.onPointerMove

onPointerUp

onPointerUp(event): boolean | void
'pointerup'事件响应接口
Parameters
- event: PointerEvent
Returns boolean | void

Memberof
LanewayDesignTool

Overrides Tool.onPointerUp

onWheel

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

Memberof
Tool

Inherited from Tool.onWheel

removeAllEventListeners

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

Returns void

Memberof
EventDispatcher

Inherited from Tool.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 Tool.removeEventListener

removeEventListenerByEventId

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

Memberof
EventDispatcher

Inherited from Tool.removeEventListenerByEventId

switchMode

switchMode(mode?, parameters?): void
切换设计模式
Parameters
- mode: DesignMode = DesignMode.DESIGN_UNKNOWN
- Optional parameters: LanewayDesignerParameters
Returns void

Memberof
LanewayDesignTool