TransformControls.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  1. <!DOCTYPE html>
  2. <html lang="zh">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. [page:Object3D] &rarr;
  11. <h1>变换控制器([name])</h1>
  12. <p class="desc">
  13. 该类可提供一种类似于在数字内容创建工具(例如Blender)中对模型进行交互的方式,来在3D空间中变换物体。
  14. 和其他控制器不同的是,变换控制器不倾向于对场景摄像机的变换进行改变。<br /><br />
  15. [name] 期望其所附加的3D对象是场景图的一部分。
  16. </p>
  17. <h2>例子</h2>
  18. <p>[example:misc_controls_transform misc / controls / transform ]</p>
  19. <h2>构造函数</h2>
  20. <h3>[name]( [param:Camera camera], [param:HTMLDOMElement domElement] )</h3>
  21. <p>
  22. <p>
  23. [page:Camera camera]: 被控制的摄像机。
  24. </p>
  25. <p>
  26. [page:HTMLDOMElement domElement]: 用于事件监听的HTML元素。
  27. </p>
  28. <p>
  29. 创建一个新的 [name] 实例。
  30. </p>
  31. </p>
  32. <h2>事件</h2>
  33. <h3>change</h3>
  34. <p>
  35. 如果发生了任何类型的改变(对象或属性的改变)则触发该事件。
  36. 属性改变是单独的事件,你也可以为此添加单独的事件监听;该事件类型为"propertyname-changed"(“属性名称-changed”)。
  37. </p>
  38. <h3>mouseDown</h3>
  39. <p>
  40. 如果指针(鼠标/触摸)为活动状态则触发该事件。
  41. </p>
  42. <h3>mouseUp</h3>
  43. <p>
  44. 如果指针(鼠标/触摸)不再为活动状态则触发该事件。
  45. </p>
  46. <h3>objectChange</h3>
  47. <p>
  48. 如果被控制的3D对象发生改变则触发该事件。
  49. </p>
  50. <h2>属性</h2>
  51. <p>共有属性请参见其基类[page:Object3D]。</p>
  52. <h3>[property:String axis]</h3>
  53. <p>
  54. 当前变换轴。
  55. </p>
  56. <h3>[property:Camera camera]</h3>
  57. <p>
  58. 渲染场景的摄像机。
  59. </p>
  60. <h3>[property:HTMLDOMElement domElement]</h3>
  61. <p>
  62. 该 HTMLDOMElement 用于监听鼠标/触摸事件,该属性必须在构造函数中传入。在此处改变它将不会设置新的事件监听。
  63. </p>
  64. <h3>[property:Boolean dragging]</h3>
  65. <p>
  66. 当前是否正在拖动。只读属性。
  67. </p>
  68. <h3>[property:Boolean enabled]</h3>
  69. <p>
  70. 是否启用控制器。默认为*true*。
  71. </p>
  72. <h3>[property:String mode]</h3>
  73. <p>
  74. 当前的变换模式。可能的值包括"translate"、"rotate" 和 "scale"。默认为*translate*。
  75. </p>
  76. <h3>[property:Object3D object]</h3>
  77. <p>
  78. 正在被控制的3D对象。
  79. </p>
  80. <h3>[property:Number rotationSnap]</h3>
  81. <p>
  82. 默认情况下,3D对象是可以被连续旋转的。如果你将该值设为一个数值(弧度),则你将可以定义每次旋转3D对象时的步幅。
  83. 默认为*null*。
  84. </p>
  85. <h3>[property:Boolean showX]</h3>
  86. <p>
  87. x轴手柄是否显示。默认为*true*。
  88. </p>
  89. <h3>[property:Boolean showY]</h3>
  90. <p>
  91. y轴手柄是否显示。默认为*true*。
  92. </p>
  93. <h3>[property:Boolean showZ]</h3>
  94. <p>
  95. z轴手柄是否显示。默认为*true*。
  96. </p>
  97. <h3>[property:Number size]</h3>
  98. <p>
  99. 手柄UI(轴/平面)的大小。默认为*1*。
  100. </p>
  101. <h3>[property:String space]</h3>
  102. <p>
  103. 定义了在哪种坐标空间中进行变换。可能的值有"world" 和 "local"。默认为*world*。
  104. </p>
  105. <h3>[property:Number translationSnap]</h3>
  106. <p>
  107. 默认情况下,3D对象是可以被连续平移的。如果你将该值设为一个数值(世界单位),则你将可以定义每次平移3D对象时的步幅。
  108. 默认为*null*。
  109. </p>
  110. <h2>方法</h2>
  111. <p>共有方法请参见其基类[page:Object3D]。</p>
  112. <h3>[method:TransformControls attach] ( [param:Object3D object] )</h3>
  113. <p>
  114. <p>
  115. [page:Object3D object]: 应当变换的3D对象。
  116. </p>
  117. <p>
  118. 设置应当变换的3D对象,并确保控制器UI是可见的。
  119. </p>
  120. </p>
  121. <h3>[method:TransformControls detach] ()</h3>
  122. <p>
  123. 从控制器中移除当前3D对象,并确保控制器UI是不可见的。
  124. </p>
  125. <h3>[method:null dispose] ()</h3>
  126. <p>
  127. 若不再需要该控制器,则应当调用此函数。
  128. </p>
  129. <h3>[method:String getMode] ()</h3>
  130. <p>
  131. 返回变换模式。
  132. </p>
  133. <h3>[method:null setMode] ( [param:String mode] )</h3>
  134. <p>
  135. <p>
  136. [page:String mode]: 变换模式。
  137. </p>
  138. <p>
  139. 设置变换模式。
  140. </p>
  141. </p>
  142. <h3>[method:null setRotationSnap] ( [param:Number rotationSnap] )</h3>
  143. <p>
  144. <p>
  145. [page:Number rotationSnap]: 旋转捕捉步幅。
  146. </p>
  147. <p>
  148. 设置旋转捕捉。
  149. </p>
  150. </p>
  151. <h3>[method:null setSize] ( [param:Number size] )</h3>
  152. <p>
  153. <p>
  154. [page:Number size]: 手柄UI的大小。
  155. </p>
  156. <p>
  157. 设置手柄UI的大小。
  158. </p>
  159. </p>
  160. <h3>[method:null setSpace] ( [param:String space] )</h3>
  161. <p>
  162. <p>
  163. [page:String space]: 应用变换的坐标空间。
  164. </p>
  165. <p>
  166. 设置应用变换的坐标空间。
  167. </p>
  168. </p>
  169. <h3>[method:null setTranslationSnap] ( [param:Number translationSnap] )</h3>
  170. <p>
  171. <p>
  172. [page:Number translationSnap]: 平移捕捉步幅。
  173. </p>
  174. <p>
  175. 设置平移捕捉。
  176. </p>
  177. </p>
  178. <h2>源代码</h2>
  179. <p>
  180. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/controls/TransformControls.js examples/jsm/controls/TransformControls.js]
  181. </p>
  182. </body>
  183. </html>