Class TransformControls2

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

assetType axis camera children clone copy dispatchEvent domElement dragging enabled getObjectById getObjectByName getObjectByProperty isTransformControls isWidget mode mouseButtons object parent refreshUi remove rotationSnap scaleSnap setDirty showX showY showZ size space translationSnap traverse traverseAncestors traverseVisible ObjectConstructors

Accessors

modelObject

Methods

attach detach dispose getMode getRaycaster reset setMode setRotationSnap setScaleSnap setSize setSpace setTranslationSnap

Constructors

constructor

Properties

assetType

assetType: "widget" = ...

axis

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

camera

camera: Camera

children

children: IObject3D[]

Array with object's children.

See

THREE.Object3DGroup | Group for info on manually grouping objects.

Default Value

[]

clone

clone: (recursive?: boolean) => this

Returns a clone of this object and optionally all descendants.

Type declaration

    • (recursive?: boolean): this

    • Parameters

      • Optionalrecursive: boolean

        If true, descendants of the object are also cloned. Default true

      Returns this

copy

copy: (source: this, recursive?: boolean, ...args: any[]) => this

Copy the given object into this object

Type declaration

    • (source: this, recursive?: boolean, ...args: any[]): this

    • Parameters

      • source: this
      • Optionalrecursive: boolean

        If true, descendants of the object are also copied. Default true

      • ...args: any[]

      Returns this

Remarks

Note: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

dispatchEvent

dispatchEvent: (event: ISceneEvent) => void

Fire an event type.

Type declaration

domElement

domElement: HTMLElement

dragging

dragging: boolean

enabled

enabled: boolean

getObjectById

getObjectById: <T extends IObject3D = IObject3D>(id: number) => undefined | T

Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

Type declaration

    • <T extends IObject3D = IObject3D>(id: number): undefined | T

    • Type Parameters

      Parameters

      • id: number

        Unique number of the object instance. Expects a Integer

      Returns undefined | T

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

See

id

getObjectByName

getObjectByName: <T extends IObject3D = IObject3D>(
    name: string,
) => undefined | T

Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

Type declaration

Remarks

Note that for most objects the name is an empty string by default

getObjectByProperty

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

Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

Type declaration

    • <T extends IObject3D = IObject3D>(name: string, value: string): undefined | T

    • Type Parameters

      Parameters

      • name: string

        the property name to search for.

      • value: string

        value of the given property.

      Returns undefined | T

ReadonlyisTransformControls

isTransformControls: true

isWidget

isWidget: true = ...

mode

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

mouseButtons

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

object

object: undefined | IObject3D

parent

parent: null | IObject3D

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

refreshUi

refreshUi: any = ...

remove

remove: (...object: IObject3D[]) => this

Removes a Object3D as child of this Object3D.

Remarks

An arbitrary number of objects may be removed.

See

Group for info on manually grouping objects.

rotationSnap

rotationSnap: null | number

scaleSnap

scaleSnap: null | number

setDirty

setDirty: any = ...

Dispatches 'objectUpdate' event on object.

Param: e

showX

showX: boolean

showY

showY: boolean

showZ

showZ: boolean

size

size: number

space

space: "world" | "local"

translationSnap

translationSnap: null | number

traverse

traverse: (callback: (object: IObject3D) => void) => void

Executes the callback on this object and all descendants.

Type declaration

    • (callback: (object: IObject3D) => void): void

    • Parameters

      • callback: (object: IObject3D) => void

        A function with as first argument an Object3D object.

      Returns void

Remarks

Note: Modifying the scene graph inside the callback is discouraged.

traverseAncestors

traverseAncestors: (callback: (object: IObject3D) => void) => void

Executes the callback on all ancestors.

Type declaration

    • (callback: (object: IObject3D) => void): void

    • Parameters

      • callback: (object: IObject3D) => void

        A function with as first argument an Object3D object.

      Returns void

Remarks

Note: Modifying the scene graph inside the callback is discouraged.

traverseVisible

traverseVisible: (callback: (object: IObject3D) => void) => void

Like traverse, but the callback will only be executed for visible objects

Type declaration

    • (callback: (object: IObject3D) => void): void

    • Parameters

      • callback: (object: IObject3D) => void

        A function with as first argument an Object3D object.

      Returns void

Remarks

Descendants of invisible objects are not traversed.

StaticObjectConstructors

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

Accessors

modelObject

Methods

attach

detach

dispose

getMode

getRaycaster

reset

setMode

setRotationSnap

setScaleSnap

setSize

setSpace

setTranslationSnap

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods