ThreePipe
    Preparing search index...

    Class TransformControls2

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    _savedSettings assetType axis camera children clone copy domElement dragging enabled getObjectById getObjectByName getObjectByProperty isTransformControls isWidget lockProps 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

    Properties

    Protected_savedSettings

    _savedSettings: any = ...
    assetType: "widget" = ...
    axis: null | "X" | "Y" | "Z" | "E" | "XY" | "YZ" | "XZ" | "XYZ" | "XYZE"
    camera: Camera
    children: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >[]

    Array with object's children.

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

    []

    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: (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

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

    domElement: HTMLElement
    dragging: boolean
    enabled: boolean
    getObjectById: <
        T extends
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
                undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
            > = IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
    >(
        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

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

    id

    getObjectByName: <
        T extends
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
                undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
            > = IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
    >(
        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

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

    getObjectByProperty: <
        T extends
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
                undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
            > = IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
    >(
        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

    isTransformControls: true
    isWidget: true = ...
    lockProps: undefined | string[] = undefined
    mode: "translate" | "rotate" | "scale"
    mouseButtons: { LEFT: MOUSE; MIDDLE: MOUSE; RIGHT: MOUSE }
    object:
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >
    parent:
        | null
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >

    Object's parent in the scene graph.

    An object can have at most one parent.

    null

    refreshUi: any = ...
    remove: (
        ...object: IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >[],
    ) => this

    Removes a Object3D as child of this Object3D.

    An arbitrary number of objects may be removed.

    Group for info on manually grouping objects.

    rotationSnap: null | number
    scaleSnap: null | number
    setDirty: any = ...

    Dispatches 'objectUpdate' event on object.

    showX: boolean
    showY: boolean
    showZ: boolean
    size: number
    space: "world" | "local"
    translationSnap: null | number
    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

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

    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

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

    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

    Descendants of invisible objects are not traversed.

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

    Accessors

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods