Class: TranslationControlComponents

Defined in: src/util/transformUtil/TranslationControlComponents.ts:21

Translation gizmo controller. Builds the axis arrows and the planar (XY/XZ/YZ) drag handles and moves the target in local or global space.

Extends

TransformControllerBaseComponent

Constructors

Constructor

new TranslationControlComponents(): TranslationControlComponents

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:35

Returns

TranslationControlComponents

Inherited from

TransformControllerBaseComponent.constructor

Properties

object3D

object3D: Object3D = null

Defined in: src/components/ComponentBase.ts:29

owner object3D

Inherited from

TransformControllerBaseComponent.object3D

isDestroyed

isDestroyed: boolean = false

Defined in: src/components/ComponentBase.ts:77

Inherited from

TransformControllerBaseComponent.isDestroyed

Accessors

visibleLayer

Get Signature

get visibleLayer(): number

Defined in: src/components/ComponentBase.ts:46

Composition-layer membership bitmask. The pass / camera / collector filters via

(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0

Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.

Returns

number

Set Signature

set visibleLayer(value): void

Defined in: src/components/ComponentBase.ts:50

Parameters

value

number

Returns

void

Inherited from

TransformControllerBaseComponent.visibleLayer

eventDispatcher

Get Signature

get eventDispatcher(): CEventDispatcher

Defined in: src/components/ComponentBase.ts:63

Returns

CEventDispatcher

Set Signature

set eventDispatcher(value): void

Defined in: src/components/ComponentBase.ts:68

Parameters

value

CEventDispatcher

Returns

void

Inherited from

TransformControllerBaseComponent.eventDispatcher

isStart

Get Signature

get isStart(): boolean

Defined in: src/components/ComponentBase.ts:79

Returns

boolean

Inherited from

TransformControllerBaseComponent.isStart

transform

Get Signature

get transform(): Transform

Defined in: src/components/ComponentBase.ts:89

Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..

Returns

Transform

Inherited from

TransformControllerBaseComponent.transform

enable

Get Signature

get enable(): boolean

Defined in: src/components/ComponentBase.ts:113

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns

boolean

Set Signature

set enable(value): void

Defined in: src/components/ComponentBase.ts:96

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters

value

boolean

Returns

void

Inherited from

TransformControllerBaseComponent.enable

target

Get Signature

get target(): Object3D

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:47

The object currently controlled by the owning gizmo.

Returns

Object3D

Inherited from

TransformControllerBaseComponent.target

mX

Get Signature

get mX(): Object3D

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:52

The gizmo's X-axis root object.

Returns

Object3D

Inherited from

TransformControllerBaseComponent.mX

mY

Get Signature

get mY(): Object3D

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:57

The gizmo's Y-axis object.

Returns

Object3D

Inherited from

TransformControllerBaseComponent.mY

mZ

Get Signature

get mZ(): Object3D

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:62

The gizmo's Z-axis object.

Returns

Object3D

Inherited from

TransformControllerBaseComponent.mZ

transformSpaceMode

Get Signature

get transformSpaceMode(): TransformSpaceMode

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:67

The active transform space (local or global) from the owning gizmo.

Returns

TransformSpaceMode

Inherited from

TransformControllerBaseComponent.transformSpaceMode

Methods

stop()

stop(): void

Defined in: src/components/ComponentBase.ts:163

Returns

void

Inherited from

TransformControllerBaseComponent.stop

onLateUpdate()?

optional onLateUpdate(view?): any

Defined in: src/components/ComponentBase.ts:167

Parameters

view?

View3D

Returns

any

Inherited from

TransformControllerBaseComponent.onLateUpdate

onBeforeUpdate()?

optional onBeforeUpdate(view?): any

Defined in: src/components/ComponentBase.ts:168

Parameters

view?

View3D

Returns

any

Inherited from

TransformControllerBaseComponent.onBeforeUpdate

onCompute()?

optional onCompute(view?, command?): any

Defined in: src/components/ComponentBase.ts:169

Parameters

view?

View3D

command?

GPUCommandEncoder

Returns

any

Inherited from

TransformControllerBaseComponent.onCompute

onGraphic()?

optional onGraphic(view?): any

Defined in: src/components/ComponentBase.ts:170

Parameters

view?

View3D

Returns

any

Inherited from

TransformControllerBaseComponent.onGraphic

onParentChange()?

optional onParentChange(lastParent?, currentParent?): any

Defined in: src/components/ComponentBase.ts:171

Parameters

lastParent?

Object3D

currentParent?

Object3D

Returns

any

Inherited from

TransformControllerBaseComponent.onParentChange

onAddChild()?

optional onAddChild(child): any

Defined in: src/components/ComponentBase.ts:172

Parameters

child

Object3D

Returns

any

Inherited from

TransformControllerBaseComponent.onAddChild

onRemoveChild()?

optional onRemoveChild(child): any

Defined in: src/components/ComponentBase.ts:173

Parameters

child

Object3D

Returns

any

Inherited from

TransformControllerBaseComponent.onRemoveChild

cloneTo()

cloneTo(obj): void

Defined in: src/components/ComponentBase.ts:180

clone component data to target object3D

Parameters

obj

Object3D

target object3D

Returns

void

Inherited from

TransformControllerBaseComponent.cloneTo

copyComponent()

copyComponent(from): this

Defined in: src/components/ComponentBase.ts:182

Parameters

from

this

Returns

this

Inherited from

TransformControllerBaseComponent.copyComponent

beforeDestroy()

beforeDestroy(force?): void

Defined in: src/components/ComponentBase.ts:249

before release this component, object refrences are not be set null now.

Parameters

force?

boolean

Returns

void

Inherited from

TransformControllerBaseComponent.beforeDestroy

destroy()

destroy(force?): void

Defined in: src/components/ComponentBase.ts:256

release this component

Parameters

force?

boolean

Returns

void

Inherited from

TransformControllerBaseComponent.destroy

start()

start(): void

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:107

Component lifecycle start hook.

Returns

void

Inherited from

TransformControllerBaseComponent.start

onEnable()

onEnable(view?): void

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:112

Attach the handle container and align the gizmo when enabled.

Parameters

view?

View3D

Returns

void

Inherited from

TransformControllerBaseComponent.onEnable

onDisable()

onDisable(view?): void

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:118

Detach the handle container when disabled.

Parameters

view?

View3D

Returns

void

Inherited from

TransformControllerBaseComponent.onDisable

reset()

reset(): void

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:123

Re-align the gizmo to the target according to the current transform space.

Returns

void

Inherited from

TransformControllerBaseComponent.reset

onMouseDown()

onMouseDown(e): void

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:215

Begin a drag: pick an axis and record the start point.

Parameters

e

PointerEvent3D

Returns

void

Inherited from

TransformControllerBaseComponent.onMouseDown

onMouseMove()

onMouseMove(e): void

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:239

Highlight handles on hover, or apply the transform while dragging.

Parameters

e

PointerEvent3D

Returns

void

Inherited from

TransformControllerBaseComponent.onMouseMove

onMouseUp()

onMouseUp(e): void

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:295

End a drag and clear the active axis.

Parameters

e

PointerEvent3D

Returns

void

Inherited from

TransformControllerBaseComponent.onMouseUp

onUpdate()

onUpdate(view?): void

Defined in: src/util/transformUtil/TransformControllerBaseComponent.ts:304

Keep the gizmo at a constant screen size and pinned to the target each frame.

Parameters

view?

View3D

Returns

void

Inherited from

TransformControllerBaseComponent.onUpdate

init()

init(param?): void

Defined in: src/util/transformUtil/TranslationControlComponents.ts:24

Build the translation handles, including the three drag planes.

Parameters

param?

any

Returns

void

Overrides

TransformControllerBaseComponent.init

Class: TranslationControlComponents ​

Extends ​

Constructors ​

Constructor ​

Returns ​

Inherited from ​

Properties ​

object3D ​

Inherited from ​

isDestroyed ​

Inherited from ​

Accessors ​

visibleLayer ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

value ​

Returns ​

Inherited from ​

eventDispatcher ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

value ​

Returns ​

Inherited from ​

isStart ​

Get Signature ​

Returns ​

Inherited from ​

transform ​

Get Signature ​

Returns ​

Inherited from ​

enable ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

value ​

Returns ​

Inherited from ​

target ​

Get Signature ​

Returns ​

Inherited from ​

mX ​

Get Signature ​

Returns ​

Inherited from ​

mY ​

Get Signature ​

Returns ​

Inherited from ​

mZ ​

Get Signature ​

Returns ​

Inherited from ​

transformSpaceMode ​

Get Signature ​

Returns ​

Inherited from ​

Methods ​

stop() ​

Returns ​

Inherited from ​

onLateUpdate()? ​

Parameters ​

view? ​

Returns ​

Inherited from ​

onBeforeUpdate()? ​

Parameters ​

view? ​

Returns ​

Inherited from ​

onCompute()? ​

Parameters ​

Class: TranslationControlComponents

Extends

Constructors

Constructor

Returns

Inherited from

Properties

object3D

Inherited from

isDestroyed

Inherited from

Accessors

visibleLayer

Get Signature

Returns

Set Signature

Parameters

value

Returns

Inherited from

eventDispatcher

Get Signature

Returns

Set Signature

Parameters

value

Returns

Inherited from

isStart

Get Signature

Returns

Inherited from

transform

Get Signature

Returns

Inherited from

enable

Get Signature

Returns

Set Signature

Parameters

value

Returns

Inherited from

target

Get Signature

Returns

Inherited from

mX

Get Signature

Returns

Inherited from

mY

Get Signature

Returns

Inherited from

mZ

Get Signature

Returns

Inherited from

transformSpaceMode

Get Signature

Returns

Inherited from

Methods

stop()

Returns

Inherited from

onLateUpdate()?

Parameters

view?

Returns

Inherited from

onBeforeUpdate()?

Parameters

view?

Returns

Inherited from

onCompute()?

Parameters