Interface IObject3D<E, ET>

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

Type Parameters

Hierarchy (view full)

Implemented by


_currentGeometry?: null | IGeometry<NormalBufferAttributes>
_onGeometryUpdate?: ((e) => void)

Type declaration

assetType: "model" | "light" | "camera" | "widget"
isCamera?: boolean
isLight?: boolean
isLine?: boolean
isLineSegments?: boolean
isMesh?: boolean
isObject3D: true
isScene?: boolean
isWidget?: boolean

Same as material but always returns an array.

modelObject: IObject3D<E, ET>


use object directly

morphTargetDictionary?: Record<string, number>
morphTargetInfluences?: number[]
objectProcessor?: IObjectProcessor

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

uiConfig?: UiObjectConfig<any, string, any>


  • Parameters

    • Optional setDirty: boolean

      calls setDirty

    Returns this


  • Parameters

    • Optional autoScaleRadius: number

      optional (taken from userData.autoScaleRadius by default)

    • Optional isCentered: boolean

      optional (taken from userData.isCentered by default)

    • Optional setDirty: boolean

      true by default

    Returns this

  • Parameters

    • Optional recursive: boolean

    Returns this

  • Parameters

    • source: this
    • Optional recursive: boolean
    • Rest ...args: any[]

    Returns this

  • Parameters

    • Optional removeFromParent: boolean

      remove from parent. Default true

    Returns void

Generated using TypeDoc