123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136 |
- <!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">
- This class can be used to provide a drag'n'drop interaction.
- </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 { DragControls } from 'three/addons/controls/DragControls.js';
- </code>
- <h2>Code Example</h2>
- <code>
- const controls = new DragControls( objects, camera, renderer.domElement );
- // add event listener to highlight dragged objects
- controls.addEventListener( 'dragstart', function ( event ) {
- event.object.material.emissive.set( 0xaaaaaa );
- } );
- controls.addEventListener( 'dragend', function ( event ) {
- event.object.material.emissive.set( 0x000000 );
- } );
- </code>
- <h2>Examples</h2>
- <p>[example:misc_controls_drag misc / controls / drag ]</p>
- <h2>Constructor</h2>
- <h3>[name]( [param:Array objects], [param:Camera camera], [param:HTMLDOMElement domElement] )</h3>
- <p>
- [page:Array objects]: An array of draggable 3D objects.
- </p>
- <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>dragstart</h3>
- <p>
- Fires when the user starts to drag a 3D object.
- </p>
- <h3>drag</h3>
- <p>
- Fires when the user drags a 3D object.
- </p>
- <h3>dragend</h3>
- <p>
- Fires when the user has finished dragging a 3D object.
- </p>
- <h3>hoveron</h3>
- <p>
- Fires when the pointer is moved onto a 3D object, or onto one of its children.
- </p>
- <h3>hoveroff</h3>
- <p>
- Fires when the pointer is moved out of a 3D object.
- </p>
- <h2>Properties</h2>
- <p>See the base [page:Controls] class for common properties.</p>
- <h3>[property:Array objects]</h3>
- <p>
- An array of draggable 3D objects.
- </p>
- <h3>[property:Raycaster raycaster]</h3>
- <p>
- The internal raycaster used for detecting 3D objects.
- </p>
- <h3>[property:Boolean recursive]</h3>
- <p>
- Whether children of draggable objects can be dragged independently from their parent. Default is `true`.
- </p>
- <h3>[property:Float rotateSpeed]</h3>
- <p>
- The speed at which the object will rotate when dragged in `rotate` mode. The higher the number the faster the rotation. Default is `1`.
- </p>
- <h3>[property:Boolean transformGroup]</h3>
- <p>
- This option only works if the [page:DragControls.objects] array contains a single draggable group object.
- If set to `true`, [name] does not transform individual objects but the entire group. Default is `false`.
- </p>
- <h2>Methods</h2>
- <p>See the base [page:Controls] class for common methods.</p>
- <h2>Source</h2>
- <p>
- [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/controls/DragControls.js examples/jsm/controls/DragControls.js]
- </p>
- </body>
- </html>
|