Skip to main content

CameraControllerPreset

type CameraControllerPreset = {
mouseButtons: Partial<MouseButtons>;
touches: Partial<Touches>;
truckSpeed: number;
dollySpeed: number;
azimuthRotateSpeed: number;
polarRotateSpeed: number;
dollyToCursor: boolean;
infinityDolly: boolean;
minDistance: number;
maxDistance: number;
invert_middle_button_dolly: boolean;
orbit_on_cursor: {
enabled: boolean;
cancel_target_offset: boolean;
};
lock_pointer: {
aim: LockMousePointerAim;
on_drag_threshold_in_pixels: number;
};
};

Defined in: livelink.js/sources/rendering/CameraControllerPreset.ts:21

A preset of the properties of the CameraController class. You can refer to https://www.npmjs.com/package/@3dverse/livelink-camera-controls for more information. Properties documented with [custom] prefix are not part of the livelink-camera-controls package.

Type declaration

NameTypeDescription
mouseButtons?Partial<MouseButtons>Mouse buttons bindings
touches?Partial<Touches>Touch bindings
truckSpeed?numberSpeed of drag for truck and pedestal *
dollySpeed?numberSpeed of dollying
azimuthRotateSpeed?numberSpeed of azimuth rotation
polarRotateSpeed?numberSpeed of polar rotation.
dollyToCursor?booleanDolly-in to the cursor coords (mouse pointer or pinch center)
infinityDolly?booleanInfinity Dolly for wheel and pinch. Use this with minDistance and maxDistance
minDistance?numberMinimum distance for dolly. The value must be higher than 0
maxDistance?numberMaximum distance for dolly
invert_middle_button_dolly?boolean[custom] Invert the movement direction of the dolly action on middle button only
orbit_on_cursor?{ enabled: boolean; cancel_target_offset: boolean; }[custom] Orbit on cursor options
orbit_on_cursor.enabledbooleanEnable for the rotate action to pick the orbit target on the pointer down
orbit_on_cursor.cancel_target_offset?booleanEnable to use the previous target when none is picked to prevent target shift on truck and dolly actions.
lock_pointer?{ aim: LockMousePointerAim; on_drag_threshold_in_pixels: number; }[custom] Lock pointer options
lock_pointer.aimLockMousePointerAimAim of the pointer lock
lock_pointer.on_drag_threshold_in_pixels?numberThreshold in pixels of the pointer movement before to lock it when lock_pointer.aim = "on-drag"