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

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 refreshUi remove setDirty traverse traverseAncestors traverseVisible updateMorphTargets?

Properties

Optional _currentGeometry

_currentGeometry?: null | IGeometry<NormalBufferAttributes>

Optional _currentMaterial

_currentMaterial?: null | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

Optional _onGeometryUpdate

_onGeometryUpdate?: ((e) => void)

Type declaration

assetType

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

children

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

Optional geometry

geometry?: IGeometry<NormalBufferAttributes>

Optional isCamera

isCamera?: boolean

Optional isLight

isLight?: boolean

Optional isLine

isLine?: boolean

Optional isLineSegments

isLineSegments?: boolean

Optional isMesh

isMesh?: boolean

Readonly isObject3D

isObject3D: true

Optional isScene

isScene?: boolean

Optional isWidget

isWidget?: boolean

Optional material

material?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

Optional Readonly materials

materials?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

Same as material but always returns an array.

modelObject

modelObject: IObject3D<E, ET>

Deprecated

use object directly

Optional morphTargetDictionary

morphTargetDictionary?: Record<string, number>

Optional morphTargetInfluences

morphTargetInfluences?: number[]

Optional objectProcessor

objectProcessor?: IObjectProcessor

parent

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

Optional parentRoot

parentRoot?: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

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

Optional uiConfig

uiConfig?: UiObjectConfig<any, string, any>

userData

userData: IObject3DUserData

Methods

add

Optional autoCenter

  • autoCenter(setDirty?): this

  • Parameters

    • Optional setDirty: boolean

      calls setDirty

    Returns this

    Default

    true

Optional autoScale

  • autoScale(autoScaleRadius?, isCentered?, setDirty?): 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

clone

  • clone(recursive?): this

  • Parameters

    • Optional recursive: boolean

    Returns this

copy

  • copy(source, recursive?, ...args): this

  • Parameters

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

    Returns this

dispose

  • dispose(removeFromParent?): void

  • Parameters

    • Optional removeFromParent: boolean

      remove from parent. Default true

    Returns void

getObjectById

getObjectByName

getObjectByProperty

refreshUi

remove

setDirty

traverse

traverseAncestors

traverseVisible

Optional updateMorphTargets

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc