Class: CameraController

Defined in: livelink.js/sources/rendering/camera/CameraController.ts:33

A camera controller based on the camera-controls library.

Extends

• CameraControls

Constructors

Constructor

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

Defined in: livelink.js/sources/rendering/camera/CameraController.ts:133

Parameters

Parameter	Type
__namedParameters	{ camera_entity: Entity; viewport: Viewport; activate?: boolean; preset?: CameraControllerPreset; }
__namedParameters.camera_entity	Entity
__namedParameters.viewport	Viewport
__namedParameters.activate?	boolean
__namedParameters.preset?	CameraControllerPreset

Returns

CameraController

Overrides

CameraControls.constructor;

Properties

Property	Type	Default value	Description
invert_middle_button_dolly	boolean	false	Invert the movement direction of the dolly action on middle button only
orbit_on_cursor	{ enabled: boolean; cancel_target_offset: boolean; }	undefined	Orbit on cursor options Default - { enabled: false, cancel_target_offset: false }
orbit_on_cursor.enabled	boolean	undefined	Enable for the rotate action to pick the orbit target on the pointer down
orbit_on_cursor.cancel_target_offset	boolean	undefined	Enable 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; }	undefined	Lock pointer options Default - { aim: "off", on_drag_threshold_in_pixels: 0 }
lock_pointer.aim	LockMousePointerAim	undefined	Aim of the pointer lock
lock_pointer.on_drag_threshold_in_pixels	number	undefined	Threshold in pixels of the pointer movement before to lock it when lock_pointer.aim = "on-drag"
init_options	Readonly<CameraControllerInitOptions>	{}	Set of options used by CameraController.initController
keyboard_fly_controls	null | KeyboardFlyControls	null	-

Methods

onViewportResize()

onViewportResize(): void;

Defined in: livelink.js/sources/rendering/camera/CameraController.ts:166

Returns

void

---

release()

release(): void;

Defined in: livelink.js/sources/rendering/camera/CameraController.ts:173

Returns

void

---

activate()

activate(): void;

Defined in: livelink.js/sources/rendering/camera/CameraController.ts:184

Returns

void

---

deactivate()

deactivate(): void;

Defined in: livelink.js/sources/rendering/camera/CameraController.ts:203

Returns

void