Skip to main content

Type Alias: 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;
    };
    init_options?: CameraControllerInitOptions;
};

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:44

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.

Properties​

mouseButtons?​

optional mouseButtons: Partial<MouseButtons>;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:47

Mouse buttons bindings

touches?​

optional touches: Partial<Touches>;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:49

Touch bindings

truckSpeed?​

optional truckSpeed: number;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:51

Speed of drag for truck and pedestal *

dollySpeed?​

optional dollySpeed: number;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:53

Speed of dollying

azimuthRotateSpeed?​

optional azimuthRotateSpeed: number;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:55

Speed of azimuth rotation

polarRotateSpeed?​

optional polarRotateSpeed: number;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:57

Speed of polar rotation.

dollyToCursor?​

optional dollyToCursor: boolean;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:59

Dolly-in to the cursor coords (mouse pointer or pinch center)

infinityDolly?​

optional infinityDolly: boolean;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:61

Infinity Dolly for wheel and pinch. Use this with minDistance and maxDistance

minDistance?​

optional minDistance: number;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:63

Minimum distance for dolly. The value must be higher than 0

maxDistance?​

optional maxDistance: number;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:65

Maximum distance for dolly

invert_middle_button_dolly?​

optional invert_middle_button_dolly: boolean;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:70

[custom] Invert the movement direction of the dolly action on middle button only

orbit_on_cursor?​

optional orbit_on_cursor: {
  enabled: boolean;
  cancel_target_offset?: boolean;
};

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:72

[custom] Orbit on cursor options

NameTypeDescription
enabledbooleanEnable for the rotate action to pick the orbit target on the pointer down
cancel_target_offset?booleanEnable to use the previous target when none is picked to prevent target shift on truck and dolly actions.

lock_pointer?​

optional lock_pointer: {
  aim: LockMousePointerAim;
  on_drag_threshold_in_pixels?: number;
};

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:79

[custom] Lock pointer options

NameTypeDescription
aimLockMousePointerAimAim of the pointer lock
on_drag_threshold_in_pixels?numberThreshold in pixels of the pointer movement before to lock it when lock_pointer.aim = "on-drag"

init_options?​

optional init_options: CameraControllerInitOptions;

Defined in: livelink.js/sources/rendering/camera/CameraControllerPreset.ts:86

[custom] Set of options to be used only at controller creation