Interface IObject3D<TE>

interface IObject3D<TE extends IObject3DEventMap = IObject3DEventMap> {
    _currentGeometry?: null | IGeometry;
    _currentMaterial?: null | IMaterial | IMaterial[];
    _onGeometryUpdate?: EventListener2<
        "geometryUpdate",
        BufferGeometryEventMap,
        IGeometry,
    >;
    assetType: "model"
    | "light"
    | "camera"
    | "widget";
    children: IObject3D[];
    geometry?: IGeometry;
    isCamera?: boolean;
    isLight?: boolean;
    isLine?: boolean;
    isLineSegments?: boolean;
    isMesh?: boolean;
    isObject3D: true;
    isScene?: boolean;
    isWidget?: boolean;
    material?: IMaterial | IMaterial[];
    materials?: IMaterial[];
    modelObject: IObject3D<TE>;
    morphTargetDictionary?: Record<string, number>;
    morphTargetInfluences?: number[];
    objectProcessor?: IObjectProcessor;
    parent: null | IObject3D;
    parentRoot?: null | IObject3D;
    uiConfig?: UiObjectConfig;
    userData: IObject3DUserData;
    add(...object: Object3D[]): this;
    autoCenter(setDirty?: boolean, undo?: boolean): this;
    autoScale(
        autoScaleRadius?: number,
        isCentered?: boolean,
        setDirty?: boolean,
        undo?: boolean,
    ): this;
    clone(recursive?: boolean): this;
    copy(source: this, recursive?: boolean, ...args: any[]): this;
    dispose(removeFromParent?: boolean): void;
    getObjectById<T extends IObject3D = IObject3D>(id: number): undefined | T;
    getObjectByName<T extends IObject3D = IObject3D>(
        name: string,
    ): undefined | T;
    getObjectByProperty<T extends IObject3D = IObject3D>(
        name: string,
        value: string,
    ): undefined | T;
    pivotToBoundsCenter(setDirty?: boolean): () => void;
    pivotToPoint(point: Vector3, setDirty?: boolean): this;
    refreshUi(): void;
    remove(...object: IObject3D[]): this;
    setDirty(e?: IObjectSetDirtyOptions): void;
    traverse(callback: (object: IObject3D) => void): void;
    traverseAncestors(callback: (object: IObject3D) => void): void;
    traverseVisible(callback: (object: IObject3D) => void): void;
    updateMorphTargets(): void;
}

Type Parameters

Hierarchy (View Summary)

Implemented by

Properties

_currentGeometry? _currentMaterial? _onGeometryUpdate? assetType children geometry? isCamera? isLight? isLine? isLineSegments? isMesh? isObject3D isScene? isWidget? material? materials? modelObject morphTargetDictionary? morphTargetInfluences? objectProcessor? parent parentRoot? uiConfig? userData

Methods

add autoCenter? autoScale? clone copy dispose getObjectById getObjectByName getObjectByProperty pivotToBoundsCenter? pivotToPoint? refreshUi remove setDirty traverse traverseAncestors traverseVisible updateMorphTargets?

Properties

Optional_currentGeometry

_currentGeometry?: null | IGeometry

Optional_currentMaterial

_currentMaterial?: null | IMaterial | IMaterial[]

Optional_onGeometryUpdate

_onGeometryUpdate?: EventListener2<
    "geometryUpdate",
    BufferGeometryEventMap,
    IGeometry,
>

assetType

assetType: "model" | "light" | "camera" | "widget"

children

children: IObject3D[]

Array with object's children.

See

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

Default Value

[]

Optionalgeometry

geometry?: IGeometry

OptionalisCamera

isCamera?: boolean

OptionalisLight

isLight?: boolean

OptionalisLine

isLine?: boolean

OptionalisLineSegments

isLineSegments?: boolean

OptionalisMesh

isMesh?: boolean

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

Remarks

This is a constant value

Default Value

true

OptionalisScene

isScene?: boolean

OptionalisWidget

isWidget?: boolean

Optionalmaterial

material?: IMaterial | IMaterial[]

Optional Readonlymaterials

materials?: IMaterial[]

Same as material but always returns an array. To set, just set material property

modelObject

modelObject: IObject3D<TE>

Deprecated

use object directly

OptionalmorphTargetDictionary

morphTargetDictionary?: Record<string, number>

OptionalmorphTargetInfluences

morphTargetInfluences?: number[]

OptionalobjectProcessor

objectProcessor?: IObjectProcessor

parent

parent: null | IObject3D

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

OptionalparentRoot

parentRoot?: null | IObject3D

Parent/Ancestor of this object to bubble events to. This is set internally by setupObject3D.

OptionaluiConfig

uiConfig?: UiObjectConfig

userData

userData: IObject3DUserData

An object that can be used to store custom data about the Object3D.

Remarks

It should not hold references to functions as these will not be cloned.

Default

{}

Methods

add

OptionalautoCenter

  • autoCenter(setDirty?: boolean, undo?: boolean): this

  • Moves the bounding box center of the object to the center of the world

    Parameters

    • OptionalsetDirty: boolean

      calls setDirty

    • Optionalundo: boolean

      undo any previous autoCenter operation

    Returns this

    Default

    true

OptionalautoScale

  • autoScale(
        autoScaleRadius?: number,
        isCentered?: boolean,
        setDirty?: boolean,
        undo?: boolean,
    ): this

  • Scales the object to fit the given radius.

    Parameters

    • OptionalautoScaleRadius: number

      optional (taken from userData.autoScaleRadius by default)

    • OptionalisCentered: boolean

      optional (taken from userData.isCentered by default)

    • OptionalsetDirty: boolean

      true by default

    • Optionalundo: boolean

      undo any previous autoScale operation

    Returns this

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    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

    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.

dispose

  • dispose(removeFromParent?: boolean): void

  • Parameters

    • OptionalremoveFromParent: boolean

      remove from parent. Default true

    Returns void

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 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 Parameters

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

    Returns undefined | T

    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 Parameters

    Parameters

    • name: string

      the property name to search for.

    • value: string

      value of the given property.

    Returns undefined | T

OptionalpivotToBoundsCenter

  • pivotToBoundsCenter(setDirty?: boolean): () => void

  • Moves the object pivot to the center of the bounding box.

    The object will rotate around the new pivot.

    Parameters

    • OptionalsetDirty: boolean

      calls setDirty

    Returns () => void

    undo function

    Default

    true

OptionalpivotToPoint

  • pivotToPoint(point: Vector3, setDirty?: boolean): this

  • Moves the object pivot to the given point

    The object will rotate around the new pivot.

    Parameters

    • point: Vector3

      point to move the pivot to

    • OptionalsetDirty: boolean

      calls setDirty

    Returns this

    undo function

    Default

    true

refreshUi

remove

setDirty

traverse

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

  • Executes the callback on this object and all descendants.

    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.

    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

    Parameters

    • callback: (object: IObject3D) => void

      A function with as first argument an Object3D object.

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.

OptionalupdateMorphTargets

Settings

Member Visibility

On This Page

Properties
Methods