Skip to main content

CameraController

Defined in: livelink.js/sources/rendering/CameraController.ts:32

A camera controller based on the camera-controls library.

Extends

  • CameraControls

Constructors

new CameraController()

new CameraController(__namedParameters: {
camera_entity: Entity;
viewport: Viewport;
activate: boolean;
preset: CameraControllerPreset;
}): CameraController

Defined in: livelink.js/sources/rendering/CameraController.ts:122

Parameters

ParameterType
__namedParameters{ camera_entity: Entity; viewport: Viewport; activate: boolean; preset: CameraControllerPreset; }
__namedParameters.camera_entityEntity
__namedParameters.viewportViewport
__namedParameters.activate?boolean
__namedParameters.preset?CameraControllerPreset

Returns

CameraController

Overrides

CameraControls.constructor;

Properties

PropertyTypeDefault valueDescription
invert_middle_button_dollybooleanfalseInvert the movement direction of the dolly action on middle button only
orbit_on_cursor{ enabled: boolean; cancel_target_offset: boolean; }undefinedOrbit on cursor options Default - { enabled: false, cancel_target_offset: false }
orbit_on_cursor.enabledbooleanundefinedEnable for the rotate action to pick the orbit target on the pointer down
orbit_on_cursor.cancel_target_offsetbooleanundefinedEnable 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; }undefinedLock pointer options Default - { aim: "off", on_drag_threshold_in_pixels: 0 }
lock_pointer.aimLockMousePointerAimundefinedAim of the pointer lock
lock_pointer.on_drag_threshold_in_pixelsnumberundefinedThreshold in pixels of the pointer movement before to lock it when lock_pointer.aim = "on-drag"

Methods

onViewportResize()

onViewportResize(): void

Defined in: livelink.js/sources/rendering/CameraController.ts:160

Returns

void


release()

release(): void

Defined in: livelink.js/sources/rendering/CameraController.ts:167

Returns

void


activate()

activate(): void

Defined in: livelink.js/sources/rendering/CameraController.ts:177

Returns

void


deactivate()

deactivate(): void

Defined in: livelink.js/sources/rendering/CameraController.ts:194

Returns

void