OrbitControls Class

Extends Group
Module: Controls

Orbit controls object can be controlled using the mouse.

It can be rotated using the mouse left button, moved with the mouse right button or mouse wheel.

Methods

updateControls

()

Update controls position and rotation.

Should be called if some of its properties are changed manually.

Properties

center

Vector3

Central point of the orbit.

distance

Number

Initial distance of the object relative to the center.

Default: 3

friction

Number

Obit movement speed.

Only used when smooth is set true.

friction

Number

Orbit speed friction, higher value allow the orbit to retain more speed.

Only used when smooth is set true.

invertNavigation

Boolean

If set true the Y orientation movement is inverted.

limitDown

Number

Bottom limit angle.

Default: -1.57

limitUp

Number

Top limit angle.

Default: 1.57

maxDistance

Number

Maximum Distance allowed.

minDistance

Number

Minimum distance allowed.

movementEnabled

Boolean

Indicates if its possible to move the object around.

Default: true

needsButtonPressed

Boolean

Indicates if the button left button needs to be pressed to rotate the object.

Default: true

sensitivity

Number

Mouse sensitivity.

smooth

Boolean

Enables smooth orbit movement.

vector

Vector2

Orientation of the camera.

X is the horizontal orientation and Y the vertical orientation.

zoomEnabled

Boolean

Indicates if its possible to zoom in and out to the center point.

Default: true

zoomSensitivity

Number

Mouse scroll sensitivity.