Class TranslationControls

3D translation controls.

This class emits events of type EVENT_UPDATE when the position is changed.

Hierarchy

EventDispatcher<ControlsEventMap>
- TranslationControls

Implements

Disposable
EventListenerObject
Updatable

Index

Constructors

Properties

Accessors

enabled position quaternion target

Methods

dispose handleEvent update

Events

Constructors

constructor

new TranslationControls(position?, quaternion?, target?, settings?): TranslationControls
Constructs new controls.
Parameters
- position: Vector3 = ...
  
  A position.
- quaternion: Quaternion = ...
  
  A quaternion.
- target: Vector3 = ...
  
  A target.
- settings: Settings = ...
  
  The settings.
Returns TranslationControls
Overrides EventDispatcher<ControlsEventMap>.constructor
- Defined in core/TranslationControls.ts:68

Properties

`Readonly` settings

settings: Settings

The settings.

Accessors

enabled

get enabled(): boolean
Indicates whether the controls are enabled.

Event listeners will be registered or unregistered depending on this flag.

Returns boolean
- Defined in core/TranslationControls.ts:133
set enabled(value): void
Parameters
- value: boolean
Returns void
- Defined in core/TranslationControls.ts:139

position

set position(value): void
The position.
Parameters
- value: Vector3
Returns void
- Defined in core/TranslationControls.ts:101

quaternion

set quaternion(value): void
The quaternion.
Parameters
- value: Quaternion
Returns void
- Defined in core/TranslationControls.ts:111

target

set target(value): void
The target.
Parameters
- value: Vector3
Returns void
- Defined in core/TranslationControls.ts:121

Methods

dispose

dispose(): void
Frees internal resources.

Returns void
Implementation of Disposable.dispose
- Defined in core/TranslationControls.ts:250

handleEvent

handleEvent(event): void
Parameters
- event: Event
Returns void
Implementation of EventListenerObject.handleEvent
- Defined in core/TranslationControls.ts:220

update

update(timestamp): void
Updates this object.
Parameters
- timestamp: number
  
  The current time in milliseconds.
Returns void
Implementation of Updatable.update
- Defined in core/TranslationControls.ts:244

Events

`Static` `Readonly` EVENT_UPDATE

EVENT_UPDATE: "update" = "update"

Triggers when the position or quaternion is changed.

Generated using TypeDoc