OrbitController
An orbit camera's state, from makeOrbitController. Dragging right decreases yaw() (the scene turns with the pointer); dragging down raises pitch().
Defined in: engine/src/input/orbit.ts:64
Methods
dispose()
dispose(): void;Defined in: engine/src/input/orbit.ts:79
Stop listening to the input.
Returns
void
distance()
distance(): number;Defined in: engine/src/input/orbit.ts:69
Returns
number
interacting()
interacting(): boolean;Defined in: engine/src/input/orbit.ts:75
A drag or pinch is under way (e.g. to stop an idle turntable).
Returns
boolean
pitch()
pitch(): number;Defined in: engine/src/input/orbit.ts:68
Degrees above the horizon.
Returns
number
set()
set(state: Partial<{
distance: number;
pitch: number;
target: Vec3;
yaw: number;
}>): void;Defined in: engine/src/input/orbit.ts:73
Move the camera from code; values are clamped to the limits and onChange fires.
Parameters
| Parameter | Type |
|---|---|
state | Partial<{ distance: number; pitch: number; target: Vec3; yaw: number; }> |
Returns
void
setEnabled()
setEnabled(on: boolean): void;Defined in: engine/src/input/orbit.ts:77
Ignore input while disabled; set still works.
Parameters
| Parameter | Type |
|---|---|
on | boolean |
Returns
void
target()
target(): Vec3;Defined in: engine/src/input/orbit.ts:71
The point orbited. Replaced, not mutated, when it changes.
Returns
Vec3
yaw()
yaw(): number;Defined in: engine/src/input/orbit.ts:66
Degrees.
Returns
number