Interface IMesh<TE, TG, TM>

interface IMesh<
    TE extends IObject3DEventMap = IObject3DEventMap,
    TG extends IGeometry = IGeometry,
    TM extends IMaterial | IMaterial[] = IMaterial | IMaterial[],
> {
    __exportState?: {
        fomMap: Map<
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
            undefined | Material<MaterialEventMap> | Material<MaterialEventMap>[],
        >;
        geomMap: Map<
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
            undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        >;
        matCloneMap: Map<
            IMaterial<IMaterialEventMap>,
            IMaterial<IMaterialEventMap>,
        >;
        meshLines: Map<
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
            IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        >;
        objectList: Set<
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
        >;
        savedTextures: Map<
            | IMaterial<IMaterialEventMap>
            | IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
            Record<string, ITexture<TextureEventMap>>,
        >;
    };
    __meshSetup?: boolean;
    __objectSetup?: boolean;
    __objExtUiConfigs?: Record<
        string,
        | undefined
        | (
            | UiObjectConfig<any, string, any>
            | Fof<ValOrArrOp<UiObjectConfig<any, string, any>>>
        )[],
    >;
    _currentGeometry?:
        | null
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>;
    _currentMaterial?:
        | null
        | IMaterial<IMaterialEventMap>
        | IMaterial<IMaterialEventMap>[];
    _customDepthMaterial?: Material<MaterialEventMap>;
    _customGBufferMaterial?: Material<MaterialEventMap>;
    _customNormalMaterial?: Material<MaterialEventMap>;
    _loadingPromise?: Promise<any>;
    _onGeometryUpdate?: EventListener2<
        "geometryUpdate",
        BufferGeometryEventMap,
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    >;
    _rootPathRefreshed?: boolean;
    _rootPathRefreshing?: boolean;
    _sChildren?: Object3D<Object3DEventMap>[];
    acceptChildEvents?: boolean;
    assetType?: "model" | "light" | "camera" | "widget";
    autoUpgradeChildren?: boolean;
    boundingBox?: null | Box3;
    boundingSphere?: null | Sphere;
    children: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >[];
    currentMaterial?:
        | null
        | IMaterial<IMaterialEventMap>
        | IMaterial<IMaterialEventMap>[];
    customDepthMaterial?: Material<MaterialEventMap>;
    customDistanceMaterial?: Material<MaterialEventMap>;
    customGBufferMaterial?: Material<MaterialEventMap>;
    customNormalMaterial?: Material<MaterialEventMap>;
    forcedOverrideGeometry?: IGeometry<
        NormalBufferAttributes,
        BufferGeometryEventMap,
    >;
    forcedOverrideMaterial?: | Material<MaterialEventMap>
    | Material<MaterialEventMap>[];
    geometry: TG;
    isAmbientLight?: boolean;
    isCamera?: boolean;
    isDirectionalLight?: boolean;
    isHemisphereLight?: boolean;
    isInstancedMesh?: boolean;
    isLight?: boolean;
    isLine?: boolean;
    isLine2?: boolean;
    isLineSegments?: boolean;
    isLineSegments2?: boolean;
    isMesh?: boolean;
    isMeshLine?: boolean;
    isObject3D: true;
    isPointLight?: boolean;
    isPoints?: boolean;
    isRectAreaLight?: boolean;
    isScene?: boolean;
    isSkinnedMesh?: boolean;
    isSpotLight?: boolean;
    isWidget?: boolean;
    isWireframe?: boolean;
    material: TM;
    materials?: IMaterial<IMaterialEventMap>[];
    morphTargetDictionary?: Record<string, number>;
    morphTargetInfluences?: number[];
    objectExtensions?: IObjectExtension[];
    objectProcessor?: IObjectProcessor;
    parent:
        | null
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >;
    parentRoot?:
        | null
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >;
    uiConfig?: UiObjectConfig<any, string, any>;
    userData: IObject3DUserData;
    autoCenter(setDirty?: boolean, undo?: boolean): void;
    autoScale(
        autoScaleRadius?: number,
        isCentered?: boolean,
        setDirty?: boolean,
        undo?: boolean,
    ): void;
    computeBoundingBox(): void;
    computeBoundingSphere(): void;
    computeLineDistances(): void;
    dispose(removeFromParent?: boolean): any;
    getObjectById(
        id: number,
    ):
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >;
    getObjectByName(
        name: string,
    ):
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >;
    getObjectByProperty(
        name: string,
        value: string,
    ):
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >;
    pivotToBoundsCenter(setDirty?: boolean): () => void;
    pivotToPoint(point: Vector3, setDirty?: boolean): this;
    refreshUi(): void;
    setDirty(e?: IObjectSetDirtyOptions): void;
    traverse(callback: (object: IObject3D) => void): void;
    traverseAncestors(callback: (object: IObject3D) => void): void;
    traverseModels(
        callback: (object: IObject3D) => boolean | void,
        options: { visible: boolean; widgets: boolean; [key: string]: any },
    ): void;
    traverseVisible(callback: (object: IObject3D) => void): void;
    updateMorphTargets(): void;
}

Type Parameters

TE extends IObject3DEventMap = IObject3DEventMap
TG extends IGeometry = IGeometry
TM extends IMaterial | IMaterial[] = IMaterial | IMaterial[]

Hierarchy (View Summary)

IObject3D<TE, TG, TM>
IUiConfigContainer
- IMesh

Index

Properties

__exportState? __meshSetup? __objectSetup? __objExtUiConfigs? _currentGeometry? _currentMaterial? _customDepthMaterial? _customGBufferMaterial? _customNormalMaterial? _loadingPromise? _onGeometryUpdate? _rootPathRefreshed? _rootPathRefreshing? _sChildren? acceptChildEvents? assetType? autoUpgradeChildren? boundingBox? boundingSphere? children currentMaterial? customDepthMaterial? customDistanceMaterial? customGBufferMaterial? customNormalMaterial? forcedOverrideGeometry? forcedOverrideMaterial? geometry isAmbientLight? isCamera? isDirectionalLight? isHemisphereLight? isInstancedMesh? isLight? isLine? isLine2? isLineSegments? isLineSegments2? isMesh? isMeshLine? isObject3D isPointLight? isPoints? isRectAreaLight? isScene? isSkinnedMesh? isSpotLight? isWidget? isWireframe? material materials? morphTargetDictionary? morphTargetInfluences? objectExtensions? objectProcessor? parent parentRoot? uiConfig? userData

Methods

autoCenter? autoScale? computeBoundingBox? computeBoundingSphere? computeLineDistances? dispose? getObjectById getObjectByName getObjectByProperty pivotToBoundsCenter? pivotToPoint? refreshUi? setDirty? traverse traverseAncestors traverseModels? traverseVisible updateMorphTargets?

Properties

`Optional`__exportState

__exportState?: {
    fomMap: Map<
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
        undefined | Material<MaterialEventMap> | Material<MaterialEventMap>[],
    >;
    geomMap: Map<
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
        undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    >;
    matCloneMap: Map<
        IMaterial<IMaterialEventMap>,
        IMaterial<IMaterialEventMap>,
    >;
    meshLines: Map<
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    >;
    objectList: Set<
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
    >;
    savedTextures: Map<
        | IMaterial<IMaterialEventMap>
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
        Record<string, ITexture<TextureEventMap>>,
    >;
}

`Optional` `Internal`__meshSetup

__meshSetup?: boolean

If a mesh has been converted to IObject3D using upgradeObject3D, this flag is set to true.

`Optional` `Internal`__objectSetup

__objectSetup?: boolean

If an object has been converted to IObject3D using upgradeObject3D, this flag is set to true.

`Optional`__objExtUiConfigs

__objExtUiConfigs?: Record<
    string,
    | undefined
    | (
        | UiObjectConfig<any, string, any>
        | Fof<ValOrArrOp<UiObjectConfig<any, string, any>>>
    )[],
>

`Optional`_currentGeometry

_currentGeometry?:
| null
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>

`Optional` `Internal`_currentMaterial

_currentMaterial?:
    | null
    | IMaterial<IMaterialEventMap>
    | IMaterial<IMaterialEventMap>[]

store for the actual material. see also currentMaterial

`Optional` `Internal`_customDepthMaterial

_customDepthMaterial?: Material<MaterialEventMap>

store for the actual customDepthMaterial

`Optional` `Internal`_customGBufferMaterial

_customGBufferMaterial?: Material<MaterialEventMap>

store for the actual customGBufferMaterial

`Optional` `Internal`_customNormalMaterial

_customNormalMaterial?: Material<MaterialEventMap>

store for the actual customNormalMaterial

`Optional`_loadingPromise

_loadingPromise?: Promise<any>

A promise can be set by the object to indicate that the object is loading. This can be used by the scene, viewer, plugins to defer actions until the object is loaded.

`Optional` `Internal`_onGeometryUpdate

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

for embedded objects

`Optional` `Internal`_rootPathRefreshed

_rootPathRefreshed?: boolean

for embedded objects

`Optional` `Internal`_rootPathRefreshing

_rootPathRefreshing?: boolean

when embedded objects are loading

`Optional` `Internal`_sChildren

_sChildren?: Object3D<Object3DEventMap>[]

If this is present, only the objects in this array will be saved in the glb/gltf files, and the object.children array will be ignored. The other properties are expected to be loaded/filled at runtime by default values or from an external asset loaded from IImportResultUserData.rootPath.

for embedded objects.

`Optional`acceptChildEvents

acceptChildEvents?: boolean

Set to false to disable propagation of any events from its children.

`Optional`assetType

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

`Optional`autoUpgradeChildren

autoUpgradeChildren?: boolean

Set to false to disable automatic call of upgradeObject3D when a child is added.

`Optional`boundingBox

boundingBox?: null | Box3

For InstancedMesh, SkinnedMesh etc

`Optional`boundingSphere

boundingSphere?: null | Sphere

For InstancedMesh, SkinnedMesh etc

children

children: IObject3D<
    IObject3DEventMap,
    undefined
    | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>[]

Array with object's children.

See

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

Default Value

[]

`Optional`currentMaterial

currentMaterial?:
    | null
    | IMaterial<IMaterialEventMap>
    | IMaterial<IMaterialEventMap>[]

`Optional`customDepthMaterial

customDepthMaterial?: Material<MaterialEventMap>

Required for Light shadows and plugins like DepthBufferPlugin

`Optional`customDistanceMaterial

customDistanceMaterial?: Material<MaterialEventMap>

Required for PointLight shadows

`Optional`customGBufferMaterial

customGBufferMaterial?: Material<MaterialEventMap>

Required for plugins like GBufferPlugin

`Optional`customNormalMaterial

customNormalMaterial?: Material<MaterialEventMap>

Required for plugins like NormalBufferPlugin

`Optional`forcedOverrideGeometry

forcedOverrideGeometry?: IGeometry<
NormalBufferAttributes,
BufferGeometryEventMap,
>

If this is set, it will be returned when accessing geometry property.

`Optional`forcedOverrideMaterial

forcedOverrideMaterial?:
| Material<MaterialEventMap>
| Material<MaterialEventMap>[]

If this is set, it will be returned when accessing material property. see GBufferRenderPass for sample usage

geometry

geometry: TG

`Optional`isAmbientLight

isAmbientLight?: boolean

`Optional`isCamera

isCamera?: boolean

`Optional`isDirectionalLight

isDirectionalLight?: boolean

`Optional`isHemisphereLight

isHemisphereLight?: boolean

`Optional`isInstancedMesh

isInstancedMesh?: boolean

`Optional`isLight

isLight?: boolean

`Optional`isLine

isLine?: boolean

`Optional`isLine2

isLine2?: boolean

`Optional`isLineSegments

isLineSegments?: boolean

`Optional`isLineSegments2

isLineSegments2?: boolean

`Optional`isMesh

isMesh?: boolean

`Optional`isMeshLine

isMeshLine?: boolean

`Readonly`isObject3D

isObject3D: true

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

Remarks

This is a constant value

Default Value

true

`Optional`isPointLight

isPointLight?: boolean

`Optional`isPoints

isPoints?: boolean

`Optional`isRectAreaLight

isRectAreaLight?: boolean

`Optional`isScene

isScene?: boolean

`Optional`isSkinnedMesh

isSkinnedMesh?: boolean

`Optional`isSpotLight

isSpotLight?: boolean

`Optional`isWidget

isWidget?: boolean

`Optional`isWireframe

isWireframe?: boolean

material

material: TM

`Optional` `Readonly`materials

materials?: IMaterial<IMaterialEventMap>[]

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

`Optional`morphTargetDictionary

morphTargetDictionary?: Record<string, number>

`Optional`morphTargetInfluences

morphTargetInfluences?: number[]

`Optional`objectExtensions

objectExtensions?: IObjectExtension[]

`Optional`objectProcessor

objectProcessor?: IObjectProcessor

parent

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

`Optional`parentRoot

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

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

`Optional`autoCenter

autoCenter(setDirty?: boolean, undo?: boolean): void
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 void
Default
```
true
```
Inherited from IObject3D.autoCenter
- Defined in src/core/IObject.ts:429

`Optional`autoScale

autoScale(
    autoScaleRadius?: number,
    isCentered?: boolean,
    setDirty?: boolean,
    undo?: boolean,
): void
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 void
Inherited from IObject3D.autoScale
- Defined in src/core/IObject.ts:421

`Optional`computeBoundingBox

computeBoundingBox(): void
For InstancedMesh, SkinnedMesh etc Computes bounding box, updating .boundingBox attribute.

Returns void
Remarks
Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.
Inherited from IObject3D.computeBoundingBox
- Defined in src/core/IObject.ts:481

`Optional`computeBoundingSphere

computeBoundingSphere(): void
For InstancedMesh, SkinnedMesh etc Computes bounding sphere, updating .boundingSphere attribute.

Returns void
Remarks
bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are null.
Inherited from IObject3D.computeBoundingSphere
- Defined in src/core/IObject.ts:488

`Optional`computeLineDistances

computeLineDistances(): void
For LineSegments, Line2 etc

Returns void
Inherited from IObject3D.computeLineDistances
- Defined in src/core/IObject.ts:493

`Optional`dispose

dispose(removeFromParent?: boolean): any
Parameters
- OptionalremoveFromParent: boolean
  remove from parent. Default true
Returns any
Inherited from IObject3D.dispose
- Defined in src/core/IObject.ts:460

getObjectById

getObjectById(
    id: number,
):
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Searches through an object and its children, starting with the object itself, and returns the first with a matching id.
Parameters
- id: number
  Unique number of the object instance. Expects a Integer
Returns
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Remarks
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

See
id
Inherited from IObject3D.getObjectById
- Defined in src/core/IObject.ts:626

getObjectByName

getObjectByName(
    name: string,
):
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Searches through an object and its children, starting with the object itself, and returns the first with a matching name.
Parameters
- name: string
  String to match to the children's Object3D.name property.
Returns
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Remarks
Note that for most objects the name is an empty string by default You will have to set it manually to make use of this method.
Inherited from IObject3D.getObjectByName
- Defined in src/core/IObject.ts:627

getObjectByProperty

getObjectByProperty(
    name: string,
    value: string,
):
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
Parameters
- name: string
  the property name to search for.
- value: string
  value of the given property.
Returns
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Inherited from IObject3D.getObjectByProperty
- Defined in src/core/IObject.ts:628

`Optional`pivotToBoundsCenter

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
```
Inherited from IObject3D.pivotToBoundsCenter
- Defined in src/core/IObject.ts:439

`Optional`pivotToPoint

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
```
Inherited from IObject3D.pivotToPoint
- Defined in src/core/IObject.ts:450

`Optional`refreshUi

refreshUi(): void
Returns void
Inherited from IObject3D.refreshUi
- Defined in src/core/IObject.ts:408

`Optional`setDirty

setDirty(e?: IObjectSetDirtyOptions): void
Dispatches 'objectUpdate' event on object.
Parameters
- Optionale: IObjectSetDirtyOptions
Returns void
Inherited from IObject3D.setDirty
- Defined in src/core/IObject.ts:400

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.
Inherited from IObject3D.traverse
- Defined in src/core/IObject.ts:623

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.
Inherited from IObject3D.traverseAncestors
- Defined in src/core/IObject.ts:625

`Optional`traverseModels

traverseModels(
callback: (object: IObject3D) => boolean | void,
options: { visible: boolean; widgets: boolean; [key: string]: any },
): void
Traverse only upgraded objects with extra options
Parameters
- callback: (object: IObject3D) => boolean | void
- options: { visible: boolean; widgets: boolean; [key: string]: any }
  visible: traverse only visible objects, widgets: traverse widgets also
Returns void
Inherited from IObject3D.traverseModels
- Defined in src/core/IObject.ts:537

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. Note: Modifying the scene graph inside the callback is discouraged.
Inherited from IObject3D.traverseVisible
- Defined in src/core/IObject.ts:624

`Optional`updateMorphTargets

updateMorphTargets(): void
Returns void
Inherited from IObject3D.updateMorphTargets
- Defined in src/core/IObject.ts:391

Interface IMesh<TE, TG, TM>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Optional__exportState

Optional Internal__meshSetup

Optional Internal__objectSetup

Optional__objExtUiConfigs

Optional_currentGeometry

Optional Internal_currentMaterial

Optional Internal_customDepthMaterial

Optional Internal_customGBufferMaterial

Optional Internal_customNormalMaterial

Optional_loadingPromise

Optional Internal_onGeometryUpdate

Optional Internal_rootPathRefreshed

Optional Internal_rootPathRefreshing

Optional Internal_sChildren

OptionalacceptChildEvents

OptionalassetType

OptionalautoUpgradeChildren

OptionalboundingBox

OptionalboundingSphere

children

See

Default Value

OptionalcurrentMaterial

OptionalcustomDepthMaterial

OptionalcustomDistanceMaterial

OptionalcustomGBufferMaterial

OptionalcustomNormalMaterial

OptionalforcedOverrideGeometry

OptionalforcedOverrideMaterial

geometry

OptionalisAmbientLight

OptionalisCamera

OptionalisDirectionalLight

OptionalisHemisphereLight

OptionalisInstancedMesh

OptionalisLight

OptionalisLine

OptionalisLine2

OptionalisLineSegments

OptionalisLineSegments2

OptionalisMesh

OptionalisMeshLine

ReadonlyisObject3D

Remarks

Default Value

OptionalisPointLight

OptionalisPoints

OptionalisRectAreaLight

OptionalisScene

OptionalisSkinnedMesh

OptionalisSpotLight

OptionalisWidget

OptionalisWireframe

material

Optional Readonlymaterials

OptionalmorphTargetDictionary

OptionalmorphTargetInfluences

OptionalobjectExtensions

OptionalobjectProcessor

parent

Remarks

Default Value

OptionalparentRoot

OptionaluiConfig

userData

Remarks

Default

Methods

OptionalautoCenter

Parameters

Returns void

Default

OptionalautoScale

`Optional`__exportState

`Optional` `Internal`__meshSetup

`Optional` `Internal`__objectSetup

`Optional`__objExtUiConfigs

`Optional`_currentGeometry

`Optional` `Internal`_currentMaterial

`Optional` `Internal`_customDepthMaterial

`Optional` `Internal`_customGBufferMaterial

`Optional` `Internal`_customNormalMaterial

`Optional`_loadingPromise

`Optional` `Internal`_onGeometryUpdate

`Optional` `Internal`_rootPathRefreshed

`Optional` `Internal`_rootPathRefreshing

`Optional` `Internal`_sChildren

`Optional`acceptChildEvents

`Optional`assetType

`Optional`autoUpgradeChildren

`Optional`boundingBox

`Optional`boundingSphere

`Optional`currentMaterial

`Optional`customDepthMaterial

`Optional`customDistanceMaterial

`Optional`customGBufferMaterial

`Optional`customNormalMaterial

`Optional`forcedOverrideGeometry

`Optional`forcedOverrideMaterial

`Optional`isAmbientLight

`Optional`isCamera

`Optional`isDirectionalLight

`Optional`isHemisphereLight

`Optional`isInstancedMesh

`Optional`isLight

`Optional`isLine

`Optional`isLine2

`Optional`isLineSegments

`Optional`isLineSegments2

`Optional`isMesh

`Optional`isMeshLine

`Readonly`isObject3D

`Optional`isPointLight

`Optional`isPoints

`Optional`isRectAreaLight

`Optional`isScene

`Optional`isSkinnedMesh

`Optional`isSpotLight

`Optional`isWidget

`Optional`isWireframe

`Optional` `Readonly`materials

`Optional`morphTargetDictionary

`Optional`morphTargetInfluences

`Optional`objectExtensions

`Optional`objectProcessor

`Optional`parentRoot

`Optional`uiConfig

`Optional`autoCenter

`Optional`autoScale

`Optional`computeBoundingBox

`Optional`computeBoundingSphere

`Optional`computeLineDistances

`Optional`dispose

Returns
| undefined
| IObject3D<
IObject3DEventMap,
undefined
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>

Returns
| undefined
| IObject3D<
IObject3DEventMap,
undefined
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>

Returns
| undefined
| IObject3D<
IObject3DEventMap,
undefined
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>

`Optional`pivotToBoundsCenter

`Optional`pivotToPoint

`Optional`refreshUi

`Optional`setDirty

`Optional`traverseModels

`Optional`updateMorphTargets