1
0

TransformControls.html 5.7 KB

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