Class: TransformControls2

Extra-Helpers.TransformControls2

Hierarchy

• TransformControls

  ↳ TransformControls2

Properties

ObjectConstructors

▪ Static ObjectConstructors: Object

Type declaration

Name	Type
MeshBasicMaterial	typeof MeshBasicMaterial
LineBasicMaterial	typeof LineBasicMaterial

Inherited from

TransformControls.ObjectConstructors

---

domElement

• domElement: HTMLElement

Inherited from

TransformControls.domElement

---

camera

• camera: Camera<Object3DEventMap>

Inherited from

TransformControls.camera

---

object

• object: undefined | Object3D<Object3DEventMap>

Inherited from

TransformControls.object

---

axis

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

Inherited from

TransformControls.axis

---

dragging

• dragging: boolean

Inherited from

TransformControls.dragging

---

isTransformControls

• Readonly isTransformControls: true

Inherited from

TransformControls.isTransformControls

---

mouseButtons

• mouseButtons: Object

Type declaration

Name	Type
LEFT	MOUSE
MIDDLE	MOUSE
RIGHT	MOUSE

Inherited from

TransformControls.mouseButtons

---

isWidget

• isWidget: true

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

---

enabled

• enabled: boolean

Overrides

TransformControls.enabled

---

mode

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

Overrides

TransformControls.mode

---

translationSnap

• translationSnap: null | number

Overrides

TransformControls.translationSnap

---

rotationSnap

• rotationSnap: null | number

Overrides

TransformControls.rotationSnap

---

scaleSnap

• scaleSnap: null | number

---

space

• space: "world" | "local"

Overrides

TransformControls.space

---

size

• size: number

Overrides

TransformControls.size

---

showX

• showX: boolean

Overrides

TransformControls.showX

---

showY

• showY: boolean

Overrides

TransformControls.showY

---

showZ

• showZ: boolean

Overrides

TransformControls.showZ

---

_stablePoses

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

Inherited from

TransformControls._stablePoses

---

_poseIndex

• Optional _poseIndex: number

Inherited from

TransformControls._poseIndex

---

_originalXform

• Optional _originalXform: Matrix4

Inherited from

TransformControls._originalXform

Methods

attach

▸ attach(object): TransformControls2

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

TransformControls2

Inherited from

TransformControls.attach

---

detach

▸ detach(): TransformControls2

Returns

TransformControls2

Inherited from

TransformControls.detach

---

getMode

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

Returns

"scale" | "translate" | "rotate"

Inherited from

TransformControls.getMode

---

getRaycaster

▸ getRaycaster(): Raycaster

Returns

Raycaster

Inherited from

TransformControls.getRaycaster

---

setMode

▸ setMode(mode): void

Parameters

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

Returns

void

Inherited from

TransformControls.setMode

---

setTranslationSnap

▸ setTranslationSnap(translationSnap): void

Parameters

Name	Type
translationSnap	null | number

Returns

void

Inherited from

TransformControls.setTranslationSnap

---

setRotationSnap

▸ setRotationSnap(rotationSnap): void

Parameters

Name	Type
rotationSnap	null | number

Returns

void

Inherited from

TransformControls.setRotationSnap

---

setScaleSnap

▸ setScaleSnap(scaleSnap): void

Parameters

Name	Type
scaleSnap	null | number

Returns

void

Inherited from

TransformControls.setScaleSnap

---

setSize

▸ setSize(size): void

Parameters

Name	Type
size	number

Returns

void

Inherited from

TransformControls.setSize

---

setSpace

▸ setSpace(space): void

Parameters

Name	Type
space	"world" | "local"

Returns

void

Inherited from

TransformControls.setSpace

---

reset

▸ reset(): void

Returns

void

Inherited from

TransformControls.reset

---

setDirty

▸ setDirty(e?): void

Parameters

Name	Type
e?	any

Returns

void

---

refreshUi

▸ refreshUi(): void

Returns

void

---

dispose

▸ dispose(): void

Returns

void

Overrides

TransformControls.dispose

Constructors

constructor

• new TransformControls2(camera, canvas)

Parameters

Name	Type
camera	Camera<Object3DEventMap>
canvas	HTMLCanvasElement

Overrides

TransformControls.constructor

Accessors

modelObject

• get modelObject(): this

Get the threejs object

deprecated

Returns

this