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?: Vector3,
    quaternion?: Quaternion,
    target?: Vector3,
    settings?: 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:67

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:132
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in core/TranslationControls.ts:138

position

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

quaternion

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

target

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

Methods

dispose

dispose(): void
Frees internal resources.

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

handleEvent

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

update

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

Events

`Static` `Readonly`EVENT_UPDATE

EVENT_UPDATE: "update"

Triggers when the position or quaternion is changed.