Class: TransformControls

Extra-Helpers.TransformControls

Hierarchy

• Object3D<TransformControlsEventMap>

  ↳ TransformControls

  ↳↳ TransformControls2

Properties

ObjectConstructors

▪ Static ObjectConstructors: Object

Type declaration

Name	Type
MeshBasicMaterial	typeof MeshBasicMaterial
LineBasicMaterial	typeof LineBasicMaterial

---

domElement

• domElement: HTMLElement

---

camera

• camera: Camera<Object3DEventMap>

---

object

• object: undefined | Object3D<Object3DEventMap>

---

enabled

• enabled: boolean

---

axis

• axis: null | "XYZ" | "X" | "Y" | "Z" | "E" | "XY" | "YZ" | "XZ" | "XYZE"

---

mode

• mode: "scale" | "translate" | "rotate"

---

translationSnap

• translationSnap: null | number

---

rotationSnap

• rotationSnap: null | number

---

space

• space: "world" | "local"

---

size

• size: number

---

dragging

• dragging: boolean

---

showX

• showX: boolean

---

showY

• showY: boolean

---

showZ

• showZ: boolean

---

isTransformControls

• Readonly isTransformControls: true

---

mouseButtons

• mouseButtons: Object

Type declaration

Name	Type
LEFT	MOUSE
MIDDLE	MOUSE
RIGHT	MOUSE

---

_stablePoses

• Optional _stablePoses: { distance: number ; faceNormal: Vector3 ; area: number ; face: Face ; maxEdgeLength: number ; xform: Matrix4 ; edgePoint: Vector3 }[]

Inherited from

Object3D._stablePoses

---

_poseIndex

• Optional _poseIndex: number

Inherited from

Object3D._poseIndex

---

_originalXform

• Optional _originalXform: Matrix4

Inherited from

Object3D._originalXform

Constructors

constructor

• new TransformControls(object, domElement?)

Parameters

Name	Type
object	Camera<Object3DEventMap>
domElement?	HTMLElement

Overrides

Object3D<TransformControlsEventMap\>.constructor

Methods

attach

▸ attach(object): TransformControls

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

TransformControls

Overrides

Object3D.attach

---

detach

▸ detach(): TransformControls

Returns

TransformControls

---

getMode

▸ getMode(): "scale" | "translate" | "rotate"

Returns

"scale" | "translate" | "rotate"

---

getRaycaster

▸ getRaycaster(): Raycaster

Returns

Raycaster

---

setMode

▸ setMode(mode): void

Parameters

Name	Type
mode	"scale" | "translate" | "rotate"

Returns

void

---

setTranslationSnap

▸ setTranslationSnap(translationSnap): void

Parameters

Name	Type
translationSnap	null | number

Returns

void

---

setRotationSnap

▸ setRotationSnap(rotationSnap): void

Parameters

Name	Type
rotationSnap	null | number

Returns

void

---

setScaleSnap

▸ setScaleSnap(scaleSnap): void

Parameters

Name	Type
scaleSnap	null | number

Returns

void

---

setSize

▸ setSize(size): void

Parameters

Name	Type
size	number

Returns

void

---

setSpace

▸ setSpace(space): void

Parameters

Name	Type
space	"world" | "local"

Returns

void

---

reset

▸ reset(): void

Returns

void

---

dispose

▸ dispose(): void

Returns

void