[page:Object3D] →

# 变换控制器（[name]）

该类可提供一种类似于在数字内容创建工具（例如Blender）中对模型进行交互的方式，来在3D空间中变换物体。 和其他控制器不同的是，变换控制器不倾向于对场景摄像机的变换进行改变。
[name] 期望其所附加的3D对象是场景图的一部分。

## 进口

[name] 是一个附加组件，必须显式导入。 See [link:#manual/introduction/Installation Installation / Addons].

`import { TransformControls } from 'three/addons/controls/TransformControls.js';`

## 例子

[example:misc_controls_transform misc / controls / transform ]

## 构造函数

### [name]( [param:Camera camera], [param:HTMLDOMElement domElement] )

[page:Camera camera]: 被控制的摄像机。

[page:HTMLDOMElement domElement]: 用于事件监听的HTML元素。

创建一个新的 [name] 实例。

## 事件

### change

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

### mouseDown

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

### mouseUp

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

### objectChange

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

## 属性

共有属性请参见其基类[page:Object3D]。

### [property:String axis]

当前变换轴。

### [property:Camera camera]

渲染场景的摄像机。

### [property:HTMLDOMElement domElement]

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

### [property:Boolean dragging]

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

### [property:Boolean enabled]

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

### [property:String mode]

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

### [property:Object3D object]

正在被控制的3D对象。

### [property:Number rotationSnap]

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

### [property:Boolean showX]

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

### [property:Boolean showY]

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

### [property:Boolean showZ]

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

### [property:Number size]

手柄UI（轴/平面）的大小。默认为*1*。

### [property:String space]

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

### [property:Number translationSnap]

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

## 方法

共有方法请参见其基类[page:Object3D]。

### [method:TransformControls attach] ( [param:Object3D object] )

[page:Object3D object]: 应当变换的3D对象。

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

### [method:TransformControls detach] ()

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

### [method:undefined dispose] ()

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

### [method:Raycaster getRaycaster] ()

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

### [method:String getMode] ()

返回变换模式。

### [method:undefined setMode] ( [param:String mode] )

[page:String mode]: 变换模式。

设置变换模式。

### [method:undefined setRotationSnap] ( [param:Number rotationSnap] )

[page:Number rotationSnap]: 旋转捕捉步幅。

设置旋转捕捉。

### [method:undefined setSize] ( [param:Number size] )

[page:Number size]: 手柄UI的大小。

设置手柄UI的大小。

### [method:undefined setSpace] ( [param:String space] )

[page:String space]: 应用变换的坐标空间。

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

### [method:undefined setTranslationSnap] ( [param:Number translationSnap] )

[page:Number translationSnap]: 平移捕捉步幅。

设置平移捕捉。

## 源代码

[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/controls/TransformControls.js examples/jsm/controls/TransformControls.js]