Class TransformControls

Hierarchy (view full)

Object3D
- TransformControls
  - TransformControls2

Index

Constructors

constructor

new TransformControls(object, domElement?): TransformControls
Parameters
- object: Camera<Event, string>
- Optional domElement: HTMLElement
Returns TransformControls
Overrides Object3D.constructor
- Defined in src/three/controls/TransformControls.d.ts:15

Properties

axis

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

camera

camera: Camera<Event, string>

domElement

domElement: HTMLElement

dragging

dragging: boolean

enabled

enabled: boolean

`Readonly` isTransformControls

isTransformControls: true

mode

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

mouseButtons

mouseButtons: {
    LEFT: MOUSE;
    MIDDLE: MOUSE;
    RIGHT: MOUSE;
}

Type declaration

LEFT: MOUSE
MIDDLE: MOUSE
RIGHT: MOUSE

object

object: undefined | Object3D<Event, string>

rotationSnap

rotationSnap: null | number

showX

showX: boolean

showY

showY: boolean

showZ

showZ: boolean

size

size: number

space

space: "local" | "world"

translationSnap

translationSnap: null | number

`Static` ObjectConstructors

ObjectConstructors: {
LineBasicMaterial: typeof LineBasicMaterial;
MeshBasicMaterial: typeof MeshBasicMaterial;
}

Type declaration

LineBasicMaterial: typeof LineBasicMaterial
MeshBasicMaterial: typeof MeshBasicMaterial

Methods

attach

attach(object): this
Parameters
- object: Object3D<Event, string>
Returns this
Overrides Object3D.attach
- Defined in src/three/controls/TransformControls.d.ts:37

detach

detach(): this
Returns this
- Defined in src/three/controls/TransformControls.d.ts:38

dispose

dispose(): void
Returns void
- Defined in src/three/controls/TransformControls.d.ts:48

getMode

getMode(): "rotate" | "scale" | "translate"
Returns "rotate" | "scale" | "translate"
- Defined in src/three/controls/TransformControls.d.ts:39

getRaycaster

getRaycaster(): Raycaster
Returns Raycaster
- Defined in src/three/controls/TransformControls.d.ts:40

reset

reset(): void
Returns void
- Defined in src/three/controls/TransformControls.d.ts:47

setMode

setMode(mode): void
Parameters
- mode: "rotate" | "scale" | "translate"
Returns void
- Defined in src/three/controls/TransformControls.d.ts:41

setRotationSnap

setRotationSnap(rotationSnap): void
Parameters
- rotationSnap: null | number
Returns void
- Defined in src/three/controls/TransformControls.d.ts:43

setScaleSnap

setScaleSnap(scaleSnap): void
Parameters
- scaleSnap: null | number
Returns void
- Defined in src/three/controls/TransformControls.d.ts:44

setSize

setSize(size): void
Parameters
- size: number
Returns void
- Defined in src/three/controls/TransformControls.d.ts:45

setSpace

setSpace(space): void
Parameters
- space: "local" | "world"
Returns void
- Defined in src/three/controls/TransformControls.d.ts:46

setTranslationSnap

setTranslationSnap(translationSnap): void
Parameters
- translationSnap: null | number
Returns void
- Defined in src/three/controls/TransformControls.d.ts:42

Class TransformControls

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

object: Camera<Event, string>

Optional domElement: HTMLElement

Returns TransformControls

Properties

axis

camera

domElement

dragging

enabled

Readonly isTransformControls

mode

mouseButtons

Type declaration

LEFT: MOUSE

MIDDLE: MOUSE

RIGHT: MOUSE

object

rotationSnap

showX

showY

showZ

size

space

translationSnap

Static ObjectConstructors

Type declaration

LineBasicMaterial: typeof LineBasicMaterial

MeshBasicMaterial: typeof MeshBasicMaterial

Methods

attach

Parameters

object: Object3D<Event, string>

Returns this

detach

Returns this

dispose

Returns void

getMode

Returns "rotate" | "scale" | "translate"

getRaycaster

Returns Raycaster

reset

Returns void

setMode

Parameters

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

Returns void

setRotationSnap

Parameters

rotationSnap: null | number

Returns void

setScaleSnap

Parameters

scaleSnap: null | number

Returns void

setSize

Parameters

size: number

Returns void

setSpace

Parameters

space: "local" | "world"

Returns void

setTranslationSnap

Parameters

translationSnap: null | number

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` domElement: HTMLElement

`Readonly` isTransformControls

`Static` ObjectConstructors