[name]

Orbit controls allow the camera to orbit around a target.
To use this, as with all files in the /examples directory, you will have to include the file seperately in your HTML.

Example

[example:misc_controls_orbit misc / controls / orbit ]


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

var scene = new THREE.Scene();

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

var controls = new THREE.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

[name]( [page:Camera object], [page:HTMLDOMElement domElement] )

[page:Camera object]: (required) The camera to be controlled.

[page:HTMLDOMElement 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

[property:Boolean autoRotate]

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

[property:Float autoRotateSpeed]

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

[property:Float dampingFactor]

The damping inertia used if [property:Boolean enableDamping] is set to true.
Note that for this to work, you must call [page:.update] () in your animation loop.

[property:HTMLDOMElement domElement]

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.

[property:Boolean enabled]

Whether or not the controls are enabled.

[property:Boolean enableDamping]

Set to true to enable damping (inertia), which can be used to give a sense of weight to the controls. Default is false.
Note that if this is enabled, you must call [page:.update] () in your animation loop.

[property:Boolean enableKeys]

Enable or disable the use of keyboard controls.

[property:Boolean enablePan]

Enable or disable camera panning. Default is true.

[property:Boolean enableRotate]

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 [page:.minPolarAngle polar angle] or [page:.minAzimuthAngle azimuth angle] to the same value, which will cause the vertical or horizontal rotation to be fixed at that value.

[property:Boolean enableZoom]

Enable or disable zooming (dollying) of the camera.

[property:Float keyPanSpeed]

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

[property:Object keys]

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 [link:https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode this page] for a full list of keycodes.

[property:Float maxAzimuthAngle]

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

[property:Float maxDistance]

How far you can dolly out ( [page:PerspectiveCamera] only ). Default is Infinity.

[property:Float maxPolarAngle]

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

[property:Float maxZoom]

How far you can zoom out ( [page:OrthographicCamera] only ). Default is Infinity.

[property:Float minAzimuthAngle]

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

[property:Float minDistance]

How far you can dolly in ( [page:PerspectiveCamera] only ). Default is 0.

[property:Float minPolarAngle]

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

[property:Float minZoom]

How far you can zoom in ( [page:OrthographicCamera] only ). Default is 0.

[property:Object mouseButtons]

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


controls.mouseButtons = {
  ORBIT: THREE.MOUSE.LEFT,
  ZOOM: THREE.MOUSE.MIDDLE,
  PAN: THREE.MOUSE.RIGHT
}

[property:Camera object]

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

[property:Vector3 position0]

Used internally by the [method:saveState] and [method:reset] methods.

[property:Float rotateSpeed]

Speed of rotation. Default is 1.

[property:Vector3 target0]

Used internally by the [method:saveState] and [method:reset] methods.

[property:Vector3 target]

The focus point of the controls, the [page:.object] orbits around this. It can be updated manually at any point to change the focus of the controls.

[property:Float zoom0]

Used internally by the [method:saveState] and [method:reset] methods.

[property:Float zoomSpeed]

Speed of zooming / dollying. Default is 1.

Methods

[method:null dispose] ()

Remove all the event listeners.

[method:radians getAzimuthalAngle] ()

Get the current horizontal rotation, in radians.

[method:radians getPolarAngle] ()

Get the current vertical rotation, in radians.

[method:null reset] ()

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

[method:null saveState] ()

Save the current state of the controls. This can later be recovered with [page:.reset].

[method:false update] ()

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

Source

[link:https://github.com/mrdoob/three.js/blob/master/examples/js/[path].js examples/js/[path].js]