You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
191 lines
4.8 KiB
HTML
191 lines
4.8 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<base href="../../../" />
|
|
<script src="page.js"></script>
|
|
<link type="text/css" rel="stylesheet" href="page.css" />
|
|
</head>
|
|
<body>
|
|
[page:Controls] →
|
|
|
|
<h1>[name]</h1>
|
|
|
|
<p class="desc">
|
|
|
|
[name] is similar to [page:OrbitControls]. However, it does not maintain a constant camera [page:Object3D.up up] vector.
|
|
That means if the camera orbits over the “north” and “south” poles, it does not flip to stay "right side up".
|
|
|
|
</p>
|
|
|
|
<h2>Import</h2>
|
|
|
|
<p>
|
|
[name] is an add-on, and must be imported explicitly.
|
|
See [link:#manual/introduction/Installation Installation / Addons].
|
|
</p>
|
|
|
|
<code>
|
|
import { TrackballControls } from 'three/addons/controls/TrackballControls.js';
|
|
</code>
|
|
|
|
<h2>Examples</h2>
|
|
|
|
<p>[example:misc_controls_trackball misc / controls / trackball ]</p>
|
|
|
|
<h2>Constructor</h2>
|
|
|
|
<h3>[name]( [param:Camera camera], [param:HTMLDOMElement domElement] )</h3>
|
|
|
|
<p>
|
|
[page:Camera camera]: The camera of the rendered scene.
|
|
</p>
|
|
<p>
|
|
[page:HTMLDOMElement domElement]: The HTML element used for event listeners. (optional)
|
|
</p>
|
|
<p>
|
|
Creates a new instance of [name].
|
|
</p>
|
|
|
|
|
|
<h2>Events</h2>
|
|
|
|
<h3>change</h3>
|
|
<p>
|
|
Fires when the camera has been transformed by the controls.
|
|
</p>
|
|
|
|
<h3>start</h3>
|
|
<p>
|
|
Fires when an interaction (e.g. touch) was initiated.
|
|
</p>
|
|
|
|
<h3>end</h3>
|
|
<p>
|
|
Fires when an interaction has finished.
|
|
</p>
|
|
|
|
<h2>Properties</h2>
|
|
|
|
<p>See the base [page:Controls] class for common properties.</p>
|
|
|
|
<h3>[property:Number dynamicDampingFactor]</h3>
|
|
<p>
|
|
Defines the intensity of damping. Only considered if [page:.staticMoving staticMoving] is set to `false`. Default is `0.2`.
|
|
</p>
|
|
|
|
<h3>[property:Array keys]</h3>
|
|
|
|
This array holds keycodes for controlling interactions.
|
|
<ul>
|
|
<li>When the first defined key is pressed, all mouse interactions (left, middle, right) performs orbiting.</li>
|
|
<li>When the second defined key is pressed, all mouse interactions (left, middle, right) performs zooming.</li>
|
|
<li>When the third defined key is pressed, all mouse interactions (left, middle, right) performs panning.</li>
|
|
</ul>
|
|
Default is *KeyA, KeyS, KeyD* which represents A, S, D.
|
|
|
|
|
|
<h3>[property:Number maxDistance]</h3>
|
|
<p>
|
|
How far you can dolly out ( [page:PerspectiveCamera] only ). Default is `Infinity`.
|
|
</p>
|
|
|
|
<h3>[property:Number minDistance]</h3>
|
|
<p>
|
|
How far you can dolly in ( [page:PerspectiveCamera] only ). Default is *0*.
|
|
</p>
|
|
|
|
<h3>[property:Float maxZoom]</h3>
|
|
<p>
|
|
How far you can zoom out ( [page:OrthographicCamera] only ). Default is `Infinity`.
|
|
</p>
|
|
|
|
<h3>[property:Float minZoom]</h3>
|
|
<p>
|
|
How far you can zoom in ( [page:OrthographicCamera] only ). Default is *0*.
|
|
</p>
|
|
|
|
<h3>
|
|
[property:Object mouseButtons]</h3>
|
|
|
|
This object contains references to the mouse actions used by the controls.
|
|
<ul>
|
|
<li>.LEFT is assigned with `THREE.MOUSE.ROTATE`</li>
|
|
<li>.MIDDLE is assigned with `THREE.MOUSE.ZOOM`</li>
|
|
<li>.RIGHT is assigned with `THREE.MOUSE.PAN`</li>
|
|
</ul>
|
|
|
|
|
|
<h3>[property:Boolean noPan]</h3>
|
|
<p>
|
|
Whether or not panning is disabled. Default is `false`.
|
|
</p>
|
|
|
|
<h3>[property:Boolean noRotate]</h3>
|
|
<p>
|
|
Whether or not rotation is disabled. Default is `false`.
|
|
</p>
|
|
|
|
<h3>[property:Boolean noZoom]</h3>
|
|
<p>
|
|
Whether or not zooming is disabled. Default is `false`.
|
|
</p>
|
|
|
|
<h3>[property:Number panSpeed]</h3>
|
|
<p>
|
|
The pan speed. Default is `0.3`.
|
|
</p>
|
|
|
|
<h3>[property:Number rotateSpeed]</h3>
|
|
<p>
|
|
The rotation speed. Default is `1.0`.
|
|
</p>
|
|
|
|
<h3>[property:Object screen]</h3>
|
|
|
|
Represents the properties of the screen. Automatically set when [page:.handleResize handleResize]() is called.
|
|
<ul>
|
|
<li>left: Represents the offset in pixels to the screen's left boundary.</li>
|
|
<li>top: Represents the offset in pixels to the screen's top boundary.</li>
|
|
<li>width: Represents the screen width in pixels.</li>
|
|
<li>height: Represents the screen height in pixels.</li>
|
|
</ul>
|
|
|
|
|
|
<h3>[property:Boolean staticMoving]</h3>
|
|
<p>
|
|
Whether or not damping is disabled. Default is `false`.
|
|
</p>
|
|
|
|
<h3>[property:Vector3 target]</h3>
|
|
<p>
|
|
The focus point of the controls.
|
|
</p>
|
|
|
|
<h3>[property:Number zoomSpeed]</h3>
|
|
<p>
|
|
The zoom speed. Default is `1.2`.
|
|
</p>
|
|
|
|
<h2>Methods</h2>
|
|
|
|
<p>See the base [page:Controls] class for common methods.</p>
|
|
|
|
<h3>[method:undefined handleResize] ()</h3>
|
|
<p>
|
|
Should be called if the application window is resized.
|
|
</p>
|
|
|
|
<h3>[method:undefined reset] ()</h3>
|
|
<p>
|
|
Resets the controls to its initial state.
|
|
</p>
|
|
|
|
<h2>Source</h2>
|
|
|
|
<p>
|
|
[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/controls/TrackballControls.js examples/jsm/controls/TrackballControls.js]
|
|
</p>
|
|
</body>
|
|
</html>
|