Class OrbitController

A controller that orbits a camera around a fixed target.

Hierarchy (View Summary)

Behavior
- OrbitController

Index

Constructors

Properties

enabled isActive target uuid inspector?

Methods

clone onAttach onDetach update

Constructors

constructor

new OrbitController(options: OrbitControllerOptions): OrbitController
Creates a new OrbitController.
Parameters
- options: OrbitControllerOptions
  Configuration options.
Returns OrbitController
Overrides Behavior.constructor
- Defined in core/controllers/OrbitController.ts:37

Properties

enabled

enabled: boolean = true

isActive

isActive: boolean = true

target

target: CameraInterfaceData | Object3D | undefined = undefined

The object this behavior is attached to. Set automatically.

`Readonly`uuid

uuid: string = ...

`Static` `Optional` `Readonly`inspector

inspector?: Record<string, InspectorField>

Methods

clone

clone(): Behavior
Returns an independent copy of this behavior (own uuid, target cleared -- the caller is expected to attachBehavior() it onto the new host, which sets target correctly via onAttach()). Used by Object3D.clone() (Maker's Duplicate command).

Returns Behavior
Inherited from Behavior.clone
- Defined in core/behaviors/Behavior.ts:43

onAttach

onAttach(target: CameraInterfaceData | Object3D): void
Called when the behavior is attached to an object.
Parameters
- target: CameraInterfaceData | Object3D
Returns void
Inherited from Behavior.onAttach
- Defined in core/behaviors/Behavior.ts:27

onDetach

onDetach(): void
Called when the behavior is detached from an object.

Returns void
Inherited from Behavior.onDetach
- Defined in core/behaviors/Behavior.ts:34

update

update(_deltaTime: number): void
Called every frame to update the behavior logic.
Parameters
- _deltaTime: number
Returns void
Overrides Behavior.update
- Defined in core/controllers/OrbitController.ts:51