TransformControls.html 5.3 KB

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