Skip to main content

Class: OrbitControls

Defined in: interaction/OrbitControls.ts:42

Wrapper for Three.js OrbitControls providing camera orbit interaction. Allows users to rotate, zoom, and pan the camera around a target point.

Constructors​

Constructor​

new OrbitControls(camera, canvas, options?): OrbitControls

Defined in: interaction/OrbitControls.ts:53

Create new OrbitControls.

Parameters​

camera​

Camera

The Three.js camera to control

canvas​

HTMLCanvasElement

The HTML canvas element for mouse events

options?​

OrbitControlsOptions

Controls configuration options

Returns​

OrbitControls

Methods​

addEventListener()​

addEventListener(event, callback): void

Defined in: interaction/OrbitControls.ts:229

Add an event listener for control changes.

Parameters​

event​

Event type ('change', 'start', 'end')

"start" | "end" | "change"

callback​

() => void

Callback function

Returns​

void

disable()​

disable(): void

Defined in: interaction/OrbitControls.ts:118

Disable the controls.

Returns​

void

dispose()​

dispose(): void

Defined in: interaction/OrbitControls.ts:245

Dispose of the controls and clean up event listeners.

Returns​

void

enable()​

enable(): void

Defined in: interaction/OrbitControls.ts:110

Enable the controls.

Returns​

void

getControls()​

getControls(): OrbitControls

Defined in: interaction/OrbitControls.ts:220

Get the underlying Three.js OrbitControls.

Returns​

OrbitControls

The ThreeOrbitControls instance

getTarget()​

getTarget(): Vector3

Defined in: interaction/OrbitControls.ts:143

Get the current target point.

Returns​

Vector3

The target position as a Vector3

isEnabled()​

isEnabled(): boolean

Defined in: interaction/OrbitControls.ts:127

Check if controls are enabled.

Returns​

boolean

true if controls are enabled

removeEventListener()​

removeEventListener(event, callback): void

Defined in: interaction/OrbitControls.ts:238

Remove an event listener.

Parameters​

event​

Event type ('change', 'start', 'end')

"start" | "end" | "change"

callback​

() => void

Callback function to remove

Returns​

void

reset()​

reset(): void

Defined in: interaction/OrbitControls.ts:212

Reset the camera to its default position and target.

Returns​

void

setAutoRotate()​

setAutoRotate(enabled): void

Defined in: interaction/OrbitControls.ts:167

Enable or disable auto-rotation.

Parameters​

enabled​

boolean

Whether auto-rotation should be enabled

Returns​

void

setAutoRotateSpeed()​

setAutoRotateSpeed(speed): void

Defined in: interaction/OrbitControls.ts:175

Set the auto-rotation speed.

Parameters​

speed​

number

Rotation speed in degrees per second

Returns​

void

setAzimuthLimits()​

setAzimuthLimits(min, max): void

Defined in: interaction/OrbitControls.ts:204

Set azimuth angle limits (horizontal rotation).

Parameters​

min​

number

Minimum angle in radians

max​

number

Maximum angle in radians

Returns​

void

setDamping()​

setDamping(enabled): void

Defined in: interaction/OrbitControls.ts:151

Enable or disable damping (smooth motion).

Parameters​

enabled​

boolean

Whether damping should be enabled

Returns​

void

setDampingFactor()​

setDampingFactor(factor): void

Defined in: interaction/OrbitControls.ts:159

Set the damping factor.

Parameters​

factor​

number

Damping factor (0 = no damping, 1 = full damping)

Returns​

void

setPolarLimits()​

setPolarLimits(min, max): void

Defined in: interaction/OrbitControls.ts:194

Set polar angle limits (vertical rotation).

Parameters​

min​

number

Minimum angle in radians (0 = looking down)

max​

number

Maximum angle in radians (PI = looking up)

Returns​

void

setTarget()​

setTarget(target): void

Defined in: interaction/OrbitControls.ts:135

Set the target point for the camera to orbit around.

Parameters​

target​

[number, number, number]

Target position [x, y, z]

Returns​

void

setZoomLimits()​

setZoomLimits(min, max): void

Defined in: interaction/OrbitControls.ts:184

Set zoom distance limits.

Parameters​

min​

number

Minimum zoom distance

max​

number

Maximum zoom distance

Returns​

void

update()​

update(): void

Defined in: interaction/OrbitControls.ts:101

Update the controls. Must be called in the animation loop when damping is enabled.

Returns​

void