Class TransformEditor

方位编辑器

Export

Date

2023.3.27

Author

Hierarchy

EngineObject
- TransformEditor

Index

Constructors

constructor

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

Overrides EngineObject.constructor

Properties

`Protected` _engine

_engine: Engine

Accessors

editorAxis

get editorAxis(): TransformGizmo
获取编辑轴

Returns TransformGizmo

Memberof
TransformEditor

editorAxisEntity

get editorAxisEntity(): Readonly<Entity>
获取编辑轴实体

Returns Readonly<Entity>

Memberof
TransformEditor

engine

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

Returns Engine

Memberof
EngineObject

Inherited from EngineObject.engine

mode

get mode(): string
获取模式mode

Returns string

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

Memberof
TransformEditor

selectObject

get selectObject(): (Transform | Renderable)[]
获取编辑对象列表

Returns (Transform | Renderable)[]

Memberof
TransformEditor

space

get space(): string
编辑空间

Returns string

Memberof
TransformEditor
set space(value): void
设置编辑空间
Parameters
- value: string
Returns void

Memberof
TransformEditor

Methods

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

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
TransformEditor

Overrides EngineObject.dispose

onPointerDown

onPointerDown(pointerX, pointerY): boolean
响应‘pointdown’事件
Parameters
- pointerX: number
- pointerY: number
Returns boolean

Memberof
TransformEditor

onPointerMove

onPointerMove(event, isLeftButtonDown?): boolean
响应‘pointermove’事件
Parameters
- event: PointerEvent
- Optional isLeftButtonDown: boolean = false
Returns boolean
{boolean}

Memberof
TransformEditor

onPointerUp

onPointerUp(event?): {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
响应‘pointup’事件
Parameters
- Optional event: PointerEvent
Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
- commandGroup: CommandGroup
- datas: TransformEditorDataParameters[]
Memberof
TransformEditor

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

rotate

rotate(rotateAxis, angle): {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
指定旋转轴和旋转角度旋转
Parameters
- rotateAxis: Vector3
- angle: number
Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
{CommandGroup}
- commandGroup: CommandGroup
- datas: TransformEditorDataParameters[]
Memberof
TransformEditor

rotateTo

rotateTo(value): {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
旋转到指定的欧拉角或四元数
Parameters
- value: number[] | Euler | Quaternion
Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
{CommandGroup}
- commandGroup: CommandGroup
- datas: TransformEditorDataParameters[]
Memberof
TransformEditor

scale

scale(variation): {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
缩放指定倍数
Parameters
- variation: number[] | Vector3
Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
{any}
- commandGroup: CommandGroup
- datas: TransformEditorDataParameters[]
Memberof
TransformEditor

scaleTo

scaleTo(scale): {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
缩放到指定倍数大小
Parameters
- scale: number[] | Vector3
Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
{any}
- commandGroup: CommandGroup
- datas: TransformEditorDataParameters[]
Memberof
TransformEditor

setAxisVisible

setAxisVisible(showX?, showY?, showZ?): void
设置轴可见性
Parameters
- Optional showX: boolean = true
- Optional showY: boolean = true
- Optional showZ: boolean = true
Returns void

Memberof
TransformEditor

setTranslateLimitData

setTranslateLimitData(start?, end?, distance?): void
设置平移限定条件
Parameters
- Optional start: number[] | Vector3 = null
- Optional end: number[] | Vector3 = null
- Optional distance: number = 0.5
Returns void

Memberof
TransformEditor

translate

translate(offset): {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
在指定方向上移动
Parameters
- offset: number[] | Vector3
Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
{CommandGroup}
- commandGroup: CommandGroup
- datas: TransformEditorDataParameters[]
Memberof
TransformEditor

translateTo

translateTo(position): {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
移动到指定位置
Parameters
- position: number[] | Vector3
  
  指定位置
Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
{CommandGroup} 返回编辑命令组
- commandGroup: CommandGroup
- datas: TransformEditorDataParameters[]
Memberof
TransformEditor

trimUpdate

trimUpdate(axisName, value): {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
微调更新
Parameters
- axisName: string
  
  轴名称
- value: number
  
  微调量
Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}
- commandGroup: CommandGroup
- datas: TransformEditorDataParameters[]
Memberof
TransformEditor

update

update(): void
更新编辑轴位置

Returns void

Memberof
TransformEditor

Class TransformEditor

Export

Date

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

engine: Engine

parameters: TransformEditorParameters = {}

Returns TransformEditor

Properties

Protected _engine

Accessors

editorAxis

Returns TransformGizmo

Memberof

editorAxisEntity

Returns Readonly<Entity>

Memberof

engine

Returns Engine

Memberof

mode

Returns string

Memberof

Parameters

value: string

Returns void

Memberof

selectObject

Returns (Transform | Renderable)[]

Memberof

space

Returns string

Memberof

Parameters

value: string

Returns void

Memberof

Methods

addEventListener

Parameters

type: string

callback: ((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

dispatchEvent

Parameters

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

[key: string]: any

type: string

Returns void

Memberof

dispose

Returns void

Memberof

onPointerDown

Parameters

pointerX: number

pointerY: number

Returns boolean

Memberof

onPointerMove

Parameters

event: PointerEvent

Optional isLeftButtonDown: boolean = false

`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;
}

`Optional` isLeftButtonDown: boolean = false

`Optional` event: PointerEvent

Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}

`Optional` callback: ((event) => void)

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

Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}

Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}

Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}

Returns {
commandGroup: CommandGroup;
datas: TransformEditorDataParameters[];
}

`Optional` showX: boolean = true

`Optional` showY: boolean = true

`Optional` showZ: boolean = true

`Optional` start: number[] | Vector3 = null

`Optional` end: number[] | Vector3 = null

`Optional` distance: number = 0.5