OrbitControls

Orbit controls allow the camera to orbit around a target object.

Example


var renderer = new v3d.WebGLRenderer();
renderer.setSize(window.innerWidth, window.innerHeight);
document.body.appendChild(renderer.domElement);

var scene = new v3d.Scene();

var  camera = new v3d.PerspectiveCamera(45, window.innerWidth / window.innerHeight, 1, 10000);

var controls = new v3d.OrbitControls(camera);

//controls.update() must be called after any manual changes to the camera's transform
camera.position.set(0, 20, 100);
controls.update();

function animate() {

  requestAnimationFrame(animate);

  // required if controls.enableDamping or controls.autoRotate are set to true
  controls.update();

  renderer.render(scene, camera);

}

Constructor

OrbitControls(object, domElement)

object: (required) The camera to be controlled.

domElement: (optional) The HTML element used for event listeners. By default this is the whole document, however if you only want to the controls to work over a specific element (e.g. the canvas) you can specify that here.

Properties

# .autoRotate : Boolean

Set to true to automatically rotate around the target object.
Note that if this is enabled, you must call .update () in your animation loop.

# .autoRotateSpeed : Float

How fast to rotate around the target object if # .autoRotate : Booleanis true. Default is 2.0, which equates to 30 seconds per rotation at 60fps.
Note that if # .autoRotate : Booleanis enabled, you must call .update () in your animation loop.

# .dampingFactor : Float

The damping inertia used if # .enableDamping : Booleanis set to true.
Note that for this to work, you must call .update () in your animation loop.

# .domElement : HTMLDOMElement

The HTMLDOMElement used to listen for mouse / touch events. This must be passed in the constructor; changing it here will not set up new event listeners. Default is the whole document.

# .enabled : Boolean

Whether or not the controls are enabled.

# .enableDamping : Boolean

Whether to enable damping (inertia), which is used to give a sense of weight to the controls. Default is true.
Note that if this is enabled, you must call .update () in your animation loop.

# .enableKeys : Boolean

Enable or disable the use of keyboard controls.

# .enablePan : Boolean

Enable or disable camera panning. Default is true.

# .enableRotate : Boolean

Enable or disable horizontal and vertical rotation of the camera. Default is true.
Note that it is possible to disable a single axis by setting the min and max of the polar angle or azimuth angle to the same value, which will cause the vertical or horizontal rotation to be fixed at that value.

# .enableZoom : Boolean

Enable or disable zooming (dollying) of the camera.

# .keyPanSpeed : Float

How fast to pan the camera when the keyboard is used. Default is 7.0 pixels per keypress.

# .keys : Object

This object contains references to the keycodes for controlling camera panning. Default is the 4 arrow keys.


controls.keys = {
  LEFT: 37, //left arrow
  UP: 38, // up arrow
  RIGHT: 39, // right arrow
  BOTTOM: 40 // down arrow
}

See this page for a full list of keycodes.

# .maxAzimuthAngle : Float

How far you can orbit horizontally, upper limit. Range is - Math.PI to Math.PI (or Infinity for no limit) and default is Infinity;

# .maxDistance : Float

How far you can dolly out (PerspectiveCamera only). Default is Infinity.

# .maxPolarAngle : Float

How far you can orbit vertically, upper limit. Range is 0 to Math.PI radians, and default is Math.PI.

# .maxZoom : Float

How far you can zoom out (OrthographicCamera only). Default is Infinity.

# .minAzimuthAngle : Float

How far you can orbit horizontally, lower limit. Range is - Math.PI to Math.PI (or - Infinity for no limit) and default is - Infinity;

# .minDistance : Float

How far you can dolly in (PerspectiveCamera only). Default is 0.

# .minPolarAngle : Float

How far you can orbit vertically, lower limit. Range is 0 to Math.PI radians, and default is 0.

# .minZoom : Float

How far you can zoom in (OrthographicCamera only). Default is 0.

# .mouseButtons : Object

This object contains references to the mouse buttons used for the controls.


controls.mouseButtons = {
  ROTATE: v3d.MOUSE.LEFT,
  ZOOM: v3d.MOUSE.MIDDLE,
  PAN: v3d.MOUSE.RIGHT
}

# .object : Camera

The camera (or other object) that is being controlled.

# .position0 : Vector3

Used internally by the .saveState and .reset methods.

# .rotateSpeed : Float

Speed of rotation. Default is 1.

# .screenSpacePanning : Boolean

Defines how the camera's position is translated when panning. If true, the camera pans in screen space. Otherwise, the camera pans in the plane orthogonal to the camera's up direction. Default is true.

# .target0 : Vector3

Used internally by the .saveState and .reset methods.

# .targetObj : Object3D

An Object3D which position in the world space acts as the focus point of the controls, the .object orbits around this. It can be updated manually at any point to change the focus of the controls.

# .zoom0 : Float

Used internally by the .saveState and .reset methods.

# .zoomSpeed : Float

Speed of zooming / dollying. Default is 1.

Methods

# .dispose () : null

Remove all the event listeners.

# .getAzimuthalAngle () : radians

Get the current horizontal rotation, in radians.

# .getPolarAngle () : radians

Get the current vertical rotation, in radians.

# .reset () : null

Reset the controls to their state from either the last time the .saveState was called, or the initial state.

# .saveState () : null

Save the current state of the controls. This can later be recovered with .reset.

# .tween (toPosition : Vector3, toTarget : Vector3, time : Number, finishCb : Function, movementType : Number) : null

toPosition -- The new position of the camera.
toTarget -- The new target point.
time -- The length of the tween animation.
finishCb -- A callback to be called after the tween animation ends.
movementType -- The movement interpolation. Can be v3d.TweenLinear (default) or v3d.TweenSpherical.

Change the camera's current position and target point to the specified new position and target smoothly over the specified time.

# .update () : false

Update the controls. Must be called after any manual changes to the camera's transform, or in the update loop if .autoRotate or .enableDamping are set.

Source

For more info on how to obtain the source code of this module see this page.