Skip to content

OrbitController

Defined in: packages/threeplay/src/plugins/camera/types.ts:101

The running orbit behavior.

stop(): void

Defined in: packages/threeplay/src/plugins/camera/types.ts:10

Stops it; the camera stays where it is.

void

CameraController.stop

distance: number

Defined in: packages/threeplay/src/plugins/camera/types.ts:107

Current distance to the target.


readonly mode: "follow" | "firstPerson" | "thirdPerson" | "orbit" | "topDown"

Defined in: packages/threeplay/src/plugins/camera/types.ts:8

Which behavior this is.

CameraController.mode


pitch: number

Defined in: packages/threeplay/src/plugins/camera/types.ts:105

Camera elevation over the horizon, degrees.


target: Vector3

Defined in: packages/threeplay/src/plugins/camera/types.ts:109

Point being orbited (refreshed every frame when the option was an object).


yaw: number

Defined in: packages/threeplay/src/plugins/camera/types.ts:103

Degrees around the target; 0 puts the camera on its +Z side.