@tmrw-realityos/charm

---

@tmrw-realityos/charm / OrbitControl

Class: OrbitControl

Defined in: packages/charm/src/helpers/orbitControl.ts:19

Orbit controller. Loosely inspired by threejs OrbitControls. Rotate: Mouse 1 or touch 1 Pan: Mouse 2 or touch 1+2 Dolly: Mouse 3 or pinch touch 1+2

Constructors

new OrbitControl()

new OrbitControl(camera, ...additionalCameras): OrbitControl

Defined in: packages/charm/src/helpers/orbitControl.ts:61

Needs at least one camera. Additional cameras can be given to synchronize multiple cameras.

Parameters

camera

Camera

additionalCameras

...Camera[]

Returns

OrbitControl

Properties

cameras

cameras: Camera[]

Defined in: packages/charm/src/helpers/orbitControl.ts:38

---

canvas?

optional canvas: HTMLCanvasElement

Defined in: packages/charm/src/helpers/orbitControl.ts:39

---

freeze

freeze: boolean = false

Defined in: packages/charm/src/helpers/orbitControl.ts:34

---

panSpeed

panSpeed: number = 1.0

Defined in: packages/charm/src/helpers/orbitControl.ts:36

---

rotateSpeed

rotateSpeed: number = 1.0

Defined in: packages/charm/src/helpers/orbitControl.ts:35

---

zoomSpeed

zoomSpeed: number = 1.0

Defined in: packages/charm/src/helpers/orbitControl.ts:37

Methods

disable()

disable(): void

Defined in: packages/charm/src/helpers/orbitControl.ts:96

Returns

void

---

enable()

enable(canvas): void

Defined in: packages/charm/src/helpers/orbitControl.ts:65

Parameters

canvas

HTMLCanvasElement

Returns

void

Events

cameraMoved

cameraMoved: ROSEvent<Callback>

Defined in: packages/charm/src/helpers/orbitControl.ts:55

Starts listening to when the camera changes position or direction.