Class TransformEditorTool

方位编辑工具

Export

Date

2023.3.27

Author

Hierarchy

Tool
- TransformEditorTool

Index

Constructors

constructor

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

Overrides Tool.constructor

Properties

`Protected` _engine

_engine: Engine

Accessors

boxSelectKey

get boxSelectKey(): string
获取框选辅助按键

Returns string

Memberof
TransformEditorTool
set boxSelectKey(value): void
设置框选辅助按键
Parameters
- value: string
Returns void

Memberof
TransformEditorTool

componentSelectKey

get componentSelectKey(): string
获取组件选择辅助按键

Returns string

Memberof
TransformEditorTool
set componentSelectKey(value): void
设置组件选择辅助按键
Parameters
- value: string
Returns void

Memberof
TransformEditorTool

enableBoxSelect

get enableBoxSelect(): boolean
获取是否启用框选

Returns boolean

Memberof
TransformEditorTool
set enableBoxSelect(value): void
设置是否启用框选
Parameters
- value: boolean
Returns void

Memberof
TransformEditorTool

engine

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

Returns Engine

Memberof
EngineObject

Inherited from Tool.engine

lock

get lock(): boolean
获取是否锁定编辑对象

Returns boolean

Memberof
TransformEditorTool
set lock(value): void
设置是否锁定编辑实体
Parameters
- value: boolean
Returns void

Memberof
TransformEditorTool

mode

get mode(): string
获取模式mode

Returns string

Memberof
TransformEditorTool
set mode(value): void
设置mode
Parameters
- value: string
Returns void

Memberof
TransformEditorTool

queryMask

get queryMask(): number
获取查询遮罩值

Returns number

Memberof
TransformEditorTool
set queryMask(value): void
设置查询遮罩值
Parameters
- value: number
Returns void

Memberof
TransformEditorTool

selectObject

set selectObject(value): void
设置当前选中编辑实体
Parameters
- value: Renderable | Transform | (Renderable | Transform)[]
Returns void

Memberof
TransformEditorTool

subSelectKey

get subSelectKey(): string
获取子实体选择辅助按键

Returns string

Memberof
TransformEditorTool
set subSelectKey(value): void
设置子实体选择辅助按键
Parameters
- value: string
Returns void

Memberof
TransformEditorTool

Methods

active

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

Memberof
TransformEditorTool

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
TransformEditorTool

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
TransformEditorTool

Overrides Tool.dispose

onClick

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

Memberof
Tool

Inherited from Tool.onClick

onDblClick

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

Memberof
Tool

Inherited from Tool.onDblClick

onKeyDown

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

Memberof
TransformEditorTool

Overrides Tool.onKeyDown

onKeyUp

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

Memberof
TransformEditorTool

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
响应‘pointdown’事件
Parameters
- event: PointerEvent
Returns boolean

Memberof
TransformEditorTool

Overrides Tool.onPointerDown

onPointerMove

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

Memberof
TransformEditorTool

Overrides Tool.onPointerMove

onPointerUp

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

Memberof
TransformEditorTool

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

trimUpdate

trimUpdate(axisName, value): void
微调接口
Parameters
- axisName: string
- value: number
Returns void

Memberof
TransformEditorTool

Class TransformEditorTool

Export

Date

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

engine: Engine

parameters: TransformEditorToolParameters = {}

Returns TransformEditorTool

Properties

Protected _engine

Accessors

boxSelectKey

Returns string

Memberof

Parameters

value: string

Returns void

Memberof

componentSelectKey

Returns string

Memberof

Parameters

value: string

Returns void

Memberof

enableBoxSelect

Returns boolean

Memberof

Parameters

value: boolean

Returns void

Memberof

engine

Returns Engine

Memberof

lock

Returns boolean

Memberof

Parameters

value: boolean

Returns void

Memberof

mode

Returns string

Memberof

Parameters

value: string

Returns void

Memberof

queryMask

Returns number

Memberof

Parameters

value: number

Returns void

Memberof

selectObject

Parameters

value: Renderable | Transform | (Renderable | Transform)[]

Returns void

Memberof

subSelectKey

Returns string

Memberof

Parameters

value: string

Returns void

Memberof

Methods

active

Parameters

parameters: TransformEditorToolParameters = {}

`Protected` _engine

event: {
type: string;
[key: string]: any;
}

`Optional` parameters: {
priority?: Priority;
target?: any;
}

`Optional` priority?: Priority

`Optional` target?: any

event: {
type: string;
[key: string]: any;
}