three.js OrbitControls

Orbit controls（轨道控制器）可以使得相机围绕目标进行轨道运动。要使用这一功能，就像在/examples（示例）目录中的所有文件一样， 您必须在HTML中包含这个文件。

代码示例

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

const scene = new THREE.Scene();

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

const controls = new OrbitControls( camera, renderer.domElement );

//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 );

}

例子

misc / controls / orbit

构造函数

OrbitControls( object : Camera, domElement : HTMLDOMElement )

object: （必须）将要被控制的相机。该相机不允许是其他任何对象的子级，除非该对象是场景自身。
domElement: 用于事件监听的HTML元素。

事件

change

当相机已被控件转换时触发。

start

当交互开始时触发。

end

当交互完成时触发。

属性

.autoRotate : Boolean

将其设为true，以自动围绕目标旋转。
请注意，如果它被启用，你必须在你的动画循环里调用.update()。

.autoRotateSpeed : Float

当.autoRotate为true时，围绕目标旋转的速度将有多快，默认值为2.0，相当于在60fps时每旋转一周需要30秒。
请注意，如果.autoRotate被启用，你必须在你的动画循环里调用.update()。

.dampingFactor : Float

当.enableDamping设置为true的时候，阻尼惯性有多大。 默认值为 0.05。

请注意，要使得这一值生效，你必须在你的动画循环里调用.update()。

.domElement : HTMLDOMElement

该 HTMLDOMElement 用于监听鼠标/触摸事件，该属性必须在构造函数中传入。在此处改变它将不会设置新的事件监听。

.enabled : Boolean

当设置为false时，控制器将不会响应用户的操作。默认值为true。

.enableDamping : Boolean

将其设置为true以启用阻尼（惯性），这将给控制器带来重量感。默认值为false。
请注意，如果该值被启用，你将必须在你的动画循环里调用.update()。

.enablePan : Boolean

启用或禁用摄像机平移，默认为true。

.enableRotate : Boolean

启用或禁用摄像机水平或垂直旋转。默认值为true。

请注意，可以通过将polar angle或者azimuth angle 的min和max设置为相同的值来禁用单个轴， 这将使得水平旋转或垂直旋转固定为所设置的值。

.enableZoom : Boolean

启用或禁用摄像机的缩放。

.keyPanSpeed : Float

当使用键盘按键的时候，相机平移的速度有多快。默认值为每次按下按键时平移7像素。

.keys : Object

这一对象包含了用于控制相机平移的按键代码的引用。默认值为4个箭头（方向）键。

controls.keys = {
	LEFT: 'ArrowLeft', //left arrow
	UP: 'ArrowUp', // up arrow
	RIGHT: 'ArrowRight', // right arrow
	BOTTOM: 'ArrowDown' // down arrow
}

.maxAzimuthAngle : Float

你能够水平旋转的角度上限。如果设置，其有效值范围为[-2 * Math.PI，2 * Math.PI]，且旋转角度的上限和下限差值小于2 * Math.PI。默认值为无穷大。

.maxDistance : Float

你能够将相机向外移动多少（仅适用于PerspectiveCamera），其默认值为Infinity。

.maxPolarAngle : Float

你能够垂直旋转的角度的上限，范围是0到Math.PI，其默认值为Math.PI。

.maxZoom : Float

你能够将相机缩小多少（仅适用于OrthographicCamera），其默认值为Infinity。

.minAzimuthAngle : Float

你能够水平旋转的角度下限。如果设置，其有效值范围为[-2 * Math.PI，2 * Math.PI]，且旋转角度的上限和下限差值小于2 * Math.PI。默认值为无穷大。

.minDistance : Float

你能够将相机向内移动多少（仅适用于PerspectiveCamera），其默认值为0。

.minPolarAngle : Float

你能够垂直旋转的角度的下限，范围是0到Math.PI，其默认值为0。

.minZoom : Float

你能够将相机放大多少（仅适用于OrthographicCamera），其默认值为0。

.mouseButtons : Object

该对象包含由控件所使用的鼠标操作的引用。

controls.mouseButtons = {
	LEFT: THREE.MOUSE.ROTATE,
	MIDDLE: THREE.MOUSE.DOLLY,
	RIGHT: THREE.MOUSE.PAN
}

.object : Camera

正被控制的摄像机。

.panSpeed : Float

位移的速度，其默认值为1。

.position0 : Vector3

由.saveState和.reset方法在内部使用。

.rotateSpeed : Float

旋转的速度，其默认值为1。

.screenSpacePanning : Boolean

定义当平移的时候摄像机的位置将如何移动。如果为true，摄像机将在屏幕空间内平移。 否则，摄像机将在与摄像机向上方向垂直的平面中平移。当使用 OrbitControls 时， 默认值为true；当使用 MapControls 时，默认值为false。

.target0 : Vector3

由.saveState和.reset方法在内部使用。

.target : Vector3

控制器的焦点，.object的轨道围绕它运行。 它可以在任何时候被手动更新，以更改控制器的焦点。

.touches : Object

该对象包含由控件所使用的触摸操作的引用。

controls.touches = {
	ONE: THREE.TOUCH.ROTATE,
	TWO: THREE.TOUCH.DOLLY_PAN
}

.zoom0 : Float

由.saveState和.reset方法在内部使用。

.zoomSpeed : Float

摄像机缩放的速度，其默认值为1。

方法

.dispose () : undefined

移除所有的事件监听。

.getAzimuthalAngle () : radians

获得当前的水平旋转，单位为弧度。

.getPolarAngle () : radians

获得当前的垂直旋转，单位为弧度。

.getDistance () : Float

返回从相机到目标的距离。

.listenToKeyEvents ( domElement : HTMLDOMElement ) : undefined

为指定的DOM元素添加按键监听。推荐将window作为指定的DOM元素。

.reset () : undefined

将控制器重置为上次调用.saveState时的状态，或者初始状态。

.saveState () : undefined

保存当前控制器的状态。这一状态可在之后由.reset所恢复。

.update () : Boolean

更新控制器。必须在摄像机的变换发生任何手动改变后调用， 或如果.autoRotate或.enableDamping被设置时，在update循环里调用。

源代码

examples/jsm/controls/OrbitControls.js