DragControls.html 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. [page:EventDispatcher] &rarr;
  12. <h1>[name]</h1>
  13. <p class="desc">
  14. This class can be used to provide a drag'n'drop interaction.
  15. </p>
  16. <h2>Example</h2>
  17. <p>[example:misc_controls_drag misc / controls / drag ]</p>
  18. <code>
  19. var controls = new THREE.DragControls( objects, camera, renderer.domElement );
  20. // add event listener to highlight dragged objects
  21. controls.addEventListener( 'dragstart', function ( event ) {
  22. event.object.material.emissive.set( 0xaaaaaa );
  23. } );
  24. controls.addEventListener( 'dragend', function ( event ) {
  25. event.object.material.emissive.set( 0x000000 );
  26. } );
  27. </code>
  28. <h2>Constructor</h2>
  29. <h3>[name]( [param:Array objects], [param:Camera camera], [param:HTMLDOMElement domElement] )</h3>
  30. <p>
  31. <p>
  32. [page:Array objects]: An array of draggable 3D objects.
  33. </p>
  34. <p>
  35. [page:Camera camera]: The camera of the rendered scene.
  36. </p>
  37. <p>
  38. [page:HTMLDOMElement domElement]: The HTML element used for event listeners.
  39. </p>
  40. <p>
  41. Creates a new instance of [name].
  42. </p>
  43. </p>
  44. <h2>Events</h2>
  45. <h3>dragstart</h3>
  46. <p>
  47. Fires when the user starts to drag a 3D object.
  48. </p>
  49. <h3>drag</h3>
  50. <p>
  51. Fires when the user drags a 3D object.
  52. </p>
  53. <h3>dragend</h3>
  54. <p>
  55. Fires when the user has finished dragging a 3D object.
  56. </p>
  57. <h3>hoveron</h3>
  58. <p>
  59. Fires when the pointer is moved onto a 3D object, or onto one of its children.
  60. </p>
  61. <h3>hoveroff</h3>
  62. <p>
  63. Fires when the pointer is moved out of a 3D object.
  64. </p>
  65. <h2>Properties</h2>
  66. <h3>[property:Boolean enabled]</h3>
  67. <p>
  68. Whether or not the controls are enabled.
  69. </p>
  70. <h2>Methods</h2>
  71. <p>See the base [page:EventDispatcher] class for common methods.</p>
  72. <h3>[method:null activate] ()</h3>
  73. <p>
  74. Adds the event listeners of the controls.
  75. </p>
  76. <h3>[method:null deactivate] ()</h3>
  77. <p>
  78. Removes the event listeners of the controls.
  79. </p>
  80. <h3>[method:null dispose] ()</h3>
  81. <p>
  82. Should be called if the controls is no longer required.
  83. </p>
  84. <h2>Source</h2>
  85. <p>
  86. [link:https://github.com/mrdoob/three.js/blob/master/examples/js/controls/DragControls.js examples/js/controls/DragControls.js]
  87. </p>
  88. </body>
  89. </html>