Class TransformControls2

Hierarchy (view full)

TransformControls
- TransformControls2

Implements

Constructors

constructor

new TransformControls2(camera, canvas): TransformControls2
Parameters
- camera: ICamera<ICameraEvent, ICameraEventTypes>
- canvas: HTMLCanvasElement
Returns TransformControls2
Overrides TransformControls.constructor
- Defined in src/three/controls/TransformControls2.ts:104

Properties

assetType

assetType: "widget" = ...

axis

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

camera

camera: Camera<Event, string>

children

children: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

clone

clone: ((recursive?) => this)

Type declaration

- (recursive?): this
- Parameters
  - Optional recursive: boolean
  Returns this

copy

copy: ((source, recursive?, ...args) => this)

Type declaration

- (source, recursive?, ...args): this
- Parameters
  - source: this
  - Optional recursive: boolean
  - Rest ...args: any[]
  Returns this

dispatchEvent

dispatchEvent: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: ISceneEvent<ISceneEventTypes>
  Returns void

domElement

domElement: HTMLElement

dragging

dragging: boolean

enabled

enabled: boolean

getObjectById

getObjectById: (<T>(id) => undefined | T)

Type declaration

- <T>(id): undefined | T
- Type Parameters
  - T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Parameters
  - id: number
  Returns undefined | T

getObjectByName

getObjectByName: (<T>(name) => undefined | T)

Type declaration

- <T>(name): undefined | T
- Type Parameters
  - T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Parameters
  - name: string
  Returns undefined | T

getObjectByProperty

getObjectByProperty: (<T>(name, value) => undefined | T)

Type declaration

- <T>(name, value): undefined | T
- Type Parameters
  - T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Parameters
  - name: string
  - value: string
  Returns undefined | T

`Readonly` isTransformControls

isTransformControls: true

isWidget

isWidget: 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 | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

parent

parent: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

refreshUi

refreshUi: any = ...

remove

remove: ((...object) => this)

Type declaration

- (...object): this
- Parameters
  - Rest ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]
  Returns this

rotationSnap

rotationSnap: null | number

scaleSnap

scaleSnap: null | number

setDirty

setDirty: any = ...

showX

showX: boolean

showY

showY: boolean

showZ

showZ: boolean

size

size: number

space

space: "local" | "world"

translationSnap

translationSnap: null | number

traverse

traverse: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((object) => void)
    - (object): void
      Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
  Returns void

traverseAncestors

traverseAncestors: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((object) => void)
    - (object): void
      Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
  Returns void

traverseVisible

traverseVisible: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((object) => void)
    - (object): void
      Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
  Returns void

`Static` ObjectConstructors

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

Type declaration

LineBasicMaterial: typeof LineBasicMaterial
MeshBasicMaterial: typeof MeshBasicMaterial

Accessors

modelObject

get modelObject(): this
Get the threejs object

Returns this
Deprecated
Implementation of IObject3D.modelObject
- Defined in src/three/controls/TransformControls2.ts:168

Methods

`Private` _keyDownListener

_keyDownListener(event): void
Parameters
- event: KeyboardEvent
Returns void
- Defined in src/three/controls/TransformControls2.ts:15

`Private` _keyUpListener

_keyUpListener(event): void
Parameters
- event: KeyboardEvent
Returns void
- Defined in src/three/controls/TransformControls2.ts:79

attach

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

detach

detach(): this
Returns this
Implementation of IWidget.detach
Inherited from TransformControls.detach
- Defined in src/three/controls/TransformControls.d.ts:38

dispose

dispose(): void
Returns void
Implementation of IObject3D.dispose
Overrides TransformControls.dispose
- Defined in src/three/controls/TransformControls2.ts:126

getMode

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

getRaycaster

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

reset

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

setMode

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

setRotationSnap

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

setScaleSnap

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

setSize

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

setSpace

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

setTranslationSnap

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

Class TransformControls2

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

camera: ICamera<ICameraEvent, ICameraEventTypes>

canvas: HTMLCanvasElement

Returns TransformControls2

Properties

assetType

axis

camera

children

clone

Type declaration

Parameters

Optional recursive: boolean

Returns this

copy

Type declaration

Parameters

source: this

Optional recursive: boolean

Rest ...args: any[]

Returns this

dispatchEvent

Type declaration

Parameters

event: ISceneEvent<ISceneEventTypes>

Returns void

domElement

dragging

enabled

getObjectById

Type declaration

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

id: number

Returns undefined | T

getObjectByName

Type declaration

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

name: string

Returns undefined | T

getObjectByProperty

Type declaration

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

name: string

value: string

Returns undefined | T

Readonly isTransformControls

isWidget

mode

mouseButtons

Type declaration

LEFT: MOUSE

MIDDLE: MOUSE

RIGHT: MOUSE

object

parent

refreshUi

remove

Type declaration

Parameters

Rest ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

Returns this

rotationSnap

scaleSnap

setDirty

`Optional` recursive: boolean

`Optional` recursive: boolean

`Rest` ...args: any[]

`Readonly` isTransformControls

`Rest` ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

`Static` ObjectConstructors

`Private` _keyDownListener

`Private` _keyUpListener