变换控制器(TransformControls)

优质
小牛编辑
147浏览
2023-12-01

该类可提供一种类似于在数字内容创建工具(例如Blender)中对模型进行交互的方式,来在3D空间中变换物体。 和其他控制器不同的是,变换控制器不倾向于对场景摄像机的变换进行改变。

TransformControls 期望其所附加的3D对象是场景图的一部分。

例子

misc / controls / transform

构造函数

TransformControls( camera : Camera, domElement : HTMLDOMElement )

camera: 被控制的摄像机。

domElement: 用于事件监听的HTML元素。

创建一个新的 TransformControls 实例。

事件

change

如果发生了任何类型的改变(对象或属性的改变)则触发该事件。 属性改变是单独的事件,你也可以为此添加单独的事件监听;该事件类型为"propertyname-changed"(“属性名称-changed”)。

mouseDown

如果指针(鼠标/触摸)为活动状态则触发该事件。

mouseUp

如果指针(鼠标/触摸)不再为活动状态则触发该事件。

objectChange

如果被控制的3D对象发生改变则触发该事件。

属性

共有属性请参见其基类Object3D

.axis : String

当前变换轴。

.camera : Camera

渲染场景的摄像机。

.domElement : HTMLDOMElement

该 HTMLDOMElement 用于监听鼠标/触摸事件,该属性必须在构造函数中传入。在此处改变它将不会设置新的事件监听。

.dragging : Boolean

当前是否正在拖动。只读属性。

.enabled : Boolean

是否启用控制器。默认为true

.mode : String

当前的变换模式。可能的值包括"translate"、"rotate" 和 "scale"。默认为translate

.object : Object3D

正在被控制的3D对象。

.rotationSnap : Number

默认情况下,3D对象是可以被连续旋转的。如果你将该值设为一个数值(弧度),则你将可以定义每次旋转3D对象时的步幅。 默认为null

.showX : Boolean

x轴手柄是否显示。默认为true

.showY : Boolean

y轴手柄是否显示。默认为true

.showZ : Boolean

z轴手柄是否显示。默认为true

.size : Number

手柄UI(轴/平面)的大小。默认为1

.space : String

定义了在哪种坐标空间中进行变换。可能的值有"world" 和 "local"。默认为world

.translationSnap : Number

默认情况下,3D对象是可以被连续平移的。如果你将该值设为一个数值(世界单位),则你将可以定义每次平移3D对象时的步幅。 默认为null

方法

共有方法请参见其基类Object3D

.attach ( object : Object3D ) : TransformControls

object: 应当变换的3D对象。

设置应当变换的3D对象,并确保控制器UI是可见的。

.detach () : TransformControls

从控制器中移除当前3D对象,并确保控制器UI是不可见的。

.dispose () : null

若不再需要该控制器,则应当调用此函数。

.getRaycaster () : Raycaster

返回用于用户交互的 Raycaster 对象。 此对象在所有实例之间共享 变换控件。 如果您设置 TransformControls 的 .layers 属性,您还需要 使用匹配值设置 Raycaster 上的 .layers 属性,否则设置 TransformControls 不会按预期工作。

.getMode () : String

返回变换模式。

.setMode ( mode : String ) : null

mode: 变换模式。

设置变换模式。

.setRotationSnap ( rotationSnap : Number ) : null

rotationSnap: 旋转捕捉步幅。

设置旋转捕捉。

.setSize ( size : Number ) : null

size: 手柄UI的大小。

设置手柄UI的大小。

.setSpace ( space : String ) : null

space: 应用变换的坐标空间。

设置应用变换的坐标空间。

.setTranslationSnap ( translationSnap : Number ) : null

translationSnap: 平移捕捉步幅。

设置平移捕捉。

源代码

examples/jsm/controls/TransformControls.js