voxolithOrbitOptions
Options for makeOrbitController. Angles are in degrees; distance and target are in world units (voxels), as the renderer's makeCamera takes them.
Defined in: engine/src/input/orbit.ts:24
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
distance? | number | Initial distance from the target. Default 100. | engine/src/input/orbit.ts:30 |
distanceLimits? | [number, number] | Clamp distance. Default [1, Infinity]. | engine/src/input/orbit.ts:38 |
fovDeg? | number | Vertical field of view, so a pan tracks the cursor. Default 45. | engine/src/input/orbit.ts:53 |
gestures? | GestureOptions | Gesture tuning and priority among recognisers on the same input. | engine/src/input/orbit.ts:57 |
onChange? | () => void | Called on any change (hook a render-on-demand loop here, or pass loop to the input). | engine/src/input/orbit.ts:55 |
pan? | "none" | "secondary" | "primary" | How to pan: "secondary" (right/middle/shift-drag, two-finger drag), "primary" (any one-pointer drag, for maps; pairs with rotate "none"), or "none". Default "none". | engine/src/input/orbit.ts:49 |
panBounds? | object | Clamp the target on XZ. | engine/src/input/orbit.ts:51 |
panBounds.maxX | number | - | engine/src/input/orbit.ts:51 |
panBounds.maxZ | number | - | engine/src/input/orbit.ts:51 |
panBounds.minX | number | - | engine/src/input/orbit.ts:51 |
panBounds.minZ | number | - | engine/src/input/orbit.ts:51 |
pitch? | number | Initial pitch above the horizon, degrees. Default 25. | engine/src/input/orbit.ts:28 |
pitchLimits? | [number, number] | Clamp pitch (degrees). Default [3, 87]. | engine/src/input/orbit.ts:36 |
rotate? | "both" | "yaw" | "none" | Which drags rotate: "both" axes, "yaw" only, or "none" (a pan-only map). Default "both". | engine/src/input/orbit.ts:40 |
sensitivity? | number | Degrees per pixel of drag. Default 0.35. | engine/src/input/orbit.ts:42 |
target? | Vec3 | Initial point orbited. Default the origin. | engine/src/input/orbit.ts:32 |
yaw? | number | Initial yaw, degrees. Default 35. | engine/src/input/orbit.ts:26 |
yawLimits? | [number, number] | Clamp yaw (degrees). Default unbounded. | engine/src/input/orbit.ts:34 |
zoom? | boolean | Wheel and pinch zoom. Default true. | engine/src/input/orbit.ts:44 |