Interface IScene<TE>

interface IScene<TE extends ISceneEventMap = ISceneEventMap> {
    __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<void>;
    _onGeometryUpdate?: EventListener2<
        "geometryUpdate",
        BufferGeometryEventMap,
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    >;
    _rootPathRefreshed?: boolean;
    _rootPathRefreshing?: boolean;
    _sChildren?: Object3D<Object3DEventMap>[];
    acceptChildEvents?: boolean;
    activeCamera: ICamera;
    assetType: "model" | "light" | "camera" | "widget";
    autoUpgradeChildren?: boolean;
    background: null | Color | ITexture<TextureEventMap> | "environment";
    backgroundColor: null | Color;
    backgroundIntensity: number;
    boundingBox?: null | Box3;
    boundingSphere?: null | Sphere;
    children: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >[];
    currentMaterial?:
        | null
        | IMaterial<IMaterialEventMap>
        | IMaterial<IMaterialEventMap>[];
    customGBufferMaterial?: Material<MaterialEventMap>;
    customNormalMaterial?: Material<MaterialEventMap>;
    defaultCamera: ICamera;
    environment: null | ITexture<TextureEventMap>;
    envMapIntensity: number;
    fixedEnvMapDirection: boolean;
    forcedOverrideMaterial?: Material<MaterialEventMap>;
    geometry?: IGeometry<NormalBufferAttributes, BufferGeometryEventMap>;
    isAmbientLight?: boolean;
    isCamera?: boolean;
    isDirectionalLight?: boolean;
    isHemisphereLight?: boolean;
    isInstancedMesh?: boolean;
    isLight?: boolean;
    isLine?: boolean;
    isLine2?: boolean;
    isLineSegments?: boolean;
    isLineSegments2?: boolean;
    isMesh?: boolean;
    isMeshLine?: boolean;
    isPointLight?: boolean;
    isPoints?: boolean;
    isRectAreaLight?: boolean;
    isScene: true;
    isSkinnedMesh?: boolean;
    isSpotLight?: boolean;
    isWidget?: boolean;
    mainCamera: ICamera;
    material?: IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[];
    materials?: IMaterial<IMaterialEventMap>[];
    modelObject: IScene<TE>;
    modelRoot: IObject3D;
    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>[],
        >;
    renderCamera: ICamera;
    type: "Scene";
    uiConfig?: UiObjectConfig<any, string, any>;
    userData: IObject3DUserData;
    visible: boolean;
    add(
        ...object: IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >[],
    ): this;
    addObject<
        T extends
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
    >(
        imported: T,
        options?: AddObjectOptions,
    ): T & IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >;
    autoCenter(setDirty?: boolean, undo?: boolean): this;
    autoScale(
        autoScaleRadius?: number,
        isCentered?: boolean,
        setDirty?: boolean,
        undo?: boolean,
    ): this;
    clone(recursive?: boolean): this;
    computeBoundingBox(): void;
    computeBoundingSphere(): void;
    computeLineDistances(): void;
    copy(source: this, recursive?: boolean): this;
    dispose(removeFromParent?: boolean): void;
    findObjectsByName(name: string, parent?: any): any[];
    getBounds(precise?: boolean, ignoreInvisible?: boolean): Box3B;
    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;
    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;
    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;
    pivotToBoundsCenter(setDirty?: boolean): () => void;
    pivotToPoint(point: Vector3, setDirty?: boolean): this;
    refreshUi(): void;
    remove(
        ...object: IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >[],
    ): this;
    setDirty(e?: ISceneSetDirtyOptions): void;
    toJSON(): any;
    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;
    updateShaderProperties(
        material: {
            defines: Record<string, string | number | undefined>;
            uniforms: { [name: string]: IUniform<any> };
        },
    ): this;
}

Type Parameters

TE extends ISceneEventMap = ISceneEventMap

Hierarchy (View Summary)

Implemented by

RootScene

Index

Properties

__objExtUiConfigs? _currentGeometry? _currentMaterial? _customDepthMaterial? _customGBufferMaterial? _customNormalMaterial? _loadingPromise? _onGeometryUpdate? _rootPathRefreshed? _rootPathRefreshing? _sChildren? acceptChildEvents? activeCamera assetType autoUpgradeChildren? background backgroundColor backgroundIntensity boundingBox? boundingSphere? children currentMaterial? customGBufferMaterial? customNormalMaterial? defaultCamera environment envMapIntensity fixedEnvMapDirection forcedOverrideMaterial? geometry? isAmbientLight? isCamera? isDirectionalLight? isHemisphereLight? isInstancedMesh? isLight? isLine? isLine2? isLineSegments? isLineSegments2? isMesh? isMeshLine? isPointLight? isPoints? isRectAreaLight? isScene isSkinnedMesh? isSpotLight? isWidget? mainCamera material? materials? modelObject modelRoot morphTargetDictionary? morphTargetInfluences? objectExtensions? objectProcessor? parent parentRoot? renderCamera type uiConfig? userData visible

Properties

`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<void>

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>[]

for embedded objects

`Optional`acceptChildEvents

acceptChildEvents?: boolean

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

activeCamera

activeCamera: ICamera

Deprecated

renamed to mainCamera

assetType

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

`Optional`autoUpgradeChildren

autoUpgradeChildren?: boolean

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

background

background: null | Color | ITexture<TextureEventMap> | "environment"

Defines the background of the scene.

Remarks

Valid inputs are:

A Color for defining a uniform colored background.
A Texture for defining a (flat) textured background.
Texture cubes (CubeTexture) or equirectangular textures for defining a skybox.
A value 'environment' will force the background to be same as environment.

Default Value

null

backgroundColor

backgroundColor: null | Color

Custom property for background tint, or just background color rendered in the shader

backgroundIntensity

backgroundIntensity: number

Attenuates the color of the background. Only applies to background textures.

Default Value

1

Remarks

Expects a Float

`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`customGBufferMaterial

customGBufferMaterial?: Material<MaterialEventMap>

Required for plugins like GBufferPlugin

`Optional`customNormalMaterial

customNormalMaterial?: Material<MaterialEventMap>

Required for plugins like NormalBufferPlugin

defaultCamera

defaultCamera: ICamera

environment

environment: null | ITexture<TextureEventMap>

Sets the environment map for all physical materials in the scene. However, it's not possible to overwrite an existing texture assigned to MeshStandardMaterial.envMap.

Default Value

null

envMapIntensity

envMapIntensity: number

fixedEnvMapDirection

fixedEnvMapDirection: boolean

`Optional`forcedOverrideMaterial

forcedOverrideMaterial?: Material<MaterialEventMap>

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

`Optional`geometry

geometry?: IGeometry<NormalBufferAttributes, BufferGeometryEventMap>

`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

`Optional`isPointLight

isPointLight?: boolean

`Optional`isPoints

isPoints?: boolean

`Optional`isRectAreaLight

isRectAreaLight?: boolean

`Readonly`isScene

isScene: true

Read-only flag to check if a given object is of type Scene.

Remarks

This is a constant value

Default Value

true

`Optional`isSkinnedMesh

isSkinnedMesh?: boolean

`Optional`isSpotLight

isSpotLight?: boolean

`Optional`isWidget

isWidget?: boolean

mainCamera

mainCamera: ICamera

Main camera that the user controls

`Optional`material

material?: IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[]

`Optional` `Readonly`materials

materials?: IMaterial<IMaterialEventMap>[]

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

modelObject

modelObject: IScene<TE>

Deprecated

use object directly

modelRoot

modelRoot: IObject3D

`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.

renderCamera

renderCamera: ICamera

Camera that in currently being rendered.

type

type: "Scene"

Default Value

Scene

`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

{}

`Readonly`visible

visible: boolean

Object gets rendered if true.

Default Value

true

Methods

add

add(
    ...object: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >[],
): this
Adds another Object3D as child of this Object3D.
Parameters
- ...object: IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >[]
Returns this
Remarks
An arbitrary number of objects may be added
See
- attach
- Group for info on manually grouping objects.
Overrides IObject3D.add
- Defined in src/core/IScene.ts:240

addObject

addObject<
    T extends
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
>(
    imported: T,
    options?: AddObjectOptions,
): T & IObject3D<
    IObject3DEventMap,
    undefined
    | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>
Type Parameters
- T extends IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >
Parameters
- imported: T
- Optionaloptions: AddObjectOptions
Returns T & IObject3D<
    IObject3DEventMap,
    undefined
    | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>
- Defined in src/core/IScene.ts:193

`Optional`autoCenter

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

`Optional`autoScale

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

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
Overrides IObject3D.clone
- Defined in src/core/IScene.ts:239

`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:463

`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:470

`Optional`computeLineDistances

computeLineDistances(): void
For LineSegments, Line2 etc

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

copy

copy(source: this, recursive?: boolean): this
Copy the given object into this object
Parameters
- source: this
- Optionalrecursive: boolean
  If true, descendants of the object are also copied. Default true
Returns this
Remarks
Note: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Overrides IObject3D.copy
- Defined in src/core/IScene.ts:238

dispose

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

findObjectsByName

findObjectsByName(name: string, parent?: any): any[]
Parameters
- name: string
- Optionalparent: any
Returns any[]
Deprecated
use getObjectByName instead
- Defined in src/core/IScene.ts:221

getBounds

getBounds(precise?: boolean, ignoreInvisible?: boolean): Box3B
Parameters
- Optionalprecise: boolean
- OptionalignoreInvisible: boolean
Returns Box3B
- Defined in src/core/IScene.ts:198

getObjectById

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 Parameters
- T extends IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  > = IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >
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
Overrides IObject3D.getObjectById
- Defined in src/core/IScene.ts:235

getObjectByName

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 Parameters
- T extends IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  > = IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >
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
Overrides IObject3D.getObjectByName
- Defined in src/core/IScene.ts:236

getObjectByProperty

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 Parameters
- T extends IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  > = IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >
Parameters
- name: string
  the property name to search for.
- value: string
  value of the given property.
Returns undefined | T
Overrides IObject3D.getObjectByProperty
- Defined in src/core/IScene.ts:237

`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:417

`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:428

refreshUi

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

remove

remove(
    ...object: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >[],
): this
Removes a Object3D as child of this Object3D.
Parameters
- ...object: IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >[]
Returns this
Remarks
An arbitrary number of objects may be removed.

See
Group for info on manually grouping objects.
Overrides IObject3D.remove
- Defined in src/core/IScene.ts:241

setDirty

setDirty(e?: ISceneSetDirtyOptions): void
Dispatches 'objectUpdate' event on object.
Parameters
- Optionale: ISceneSetDirtyOptions
Returns void
Overrides IObject3D.setDirty
- Defined in src/core/IScene.ts:195

toJSON

toJSON(): any
Convert the Scene to three.js JSON Object/Scene format.

Returns any
Overrides Scene.toJSON
- Defined in src/core/IScene.ts:186

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.
Overrides IObject3D.traverse
- Defined in src/core/IScene.ts:232

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.
Overrides IObject3D.traverseAncestors
- Defined in src/core/IScene.ts:234

`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 }
Returns void
Inherited from IObject3D.traverseModels
- Defined in src/core/IObject.ts:514

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.
Overrides IObject3D.traverseVisible
- Defined in src/core/IScene.ts:233

`Optional`updateMorphTargets

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

updateShaderProperties

updateShaderProperties(
    material: {
        defines: Record<string, string | number | undefined>;
        uniforms: { [name: string]: IUniform<any> };
    },
): this
Parameters
- material: {
  defines: Record<string, string | number | undefined>;
  uniforms: { [name: string]: IUniform<any> };
  }
Returns this
Inherited from IShaderPropertiesUpdater.updateShaderProperties
- Defined in src/materials/MaterialExtension.ts:143

Interface IScene<TE>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

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

activeCamera

Deprecated

assetType

OptionalautoUpgradeChildren

background

Remarks

Default Value

backgroundColor

backgroundIntensity

Default Value

Remarks

OptionalboundingBox

OptionalboundingSphere

children

See

Default Value

OptionalcurrentMaterial

OptionalcustomGBufferMaterial

OptionalcustomNormalMaterial

defaultCamera

environment

Default Value

envMapIntensity

fixedEnvMapDirection

OptionalforcedOverrideMaterial

Optionalgeometry

OptionalisAmbientLight

OptionalisCamera

OptionalisDirectionalLight

OptionalisHemisphereLight

OptionalisInstancedMesh

OptionalisLight

OptionalisLine

OptionalisLine2

OptionalisLineSegments

OptionalisLineSegments2

OptionalisMesh

OptionalisMeshLine

OptionalisPointLight

OptionalisPoints

OptionalisRectAreaLight

ReadonlyisScene

Remarks

Default Value

OptionalisSkinnedMesh

OptionalisSpotLight

OptionalisWidget

mainCamera

Optionalmaterial

Optional Readonlymaterials

modelObject

Deprecated

modelRoot

OptionalmorphTargetDictionary

OptionalmorphTargetInfluences

OptionalobjectExtensions

OptionalobjectProcessor

parent

Remarks

Default Value

`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`autoUpgradeChildren

`Optional`boundingBox

`Optional`boundingSphere

`Optional`currentMaterial

`Optional`customGBufferMaterial

`Optional`customNormalMaterial

`Optional`forcedOverrideMaterial

`Optional`geometry

`Optional`isAmbientLight

`Optional`isCamera

`Optional`isDirectionalLight

`Optional`isHemisphereLight

`Optional`isInstancedMesh

`Optional`isLight

`Optional`isLine

`Optional`isLine2

`Optional`isLineSegments

`Optional`isLineSegments2

`Optional`isMesh

`Optional`isMeshLine

`Optional`isPointLight

`Optional`isPoints

`Optional`isRectAreaLight

`Readonly`isScene

`Optional`isSkinnedMesh

`Optional`isSpotLight

`Optional`isWidget

`Optional`material

`Optional` `Readonly`materials

`Optional`morphTargetDictionary

`Optional`morphTargetInfluences

`Optional`objectExtensions

`Optional`objectProcessor

`Optional`parentRoot

`Optional`uiConfig

`Readonly`visible

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

`Optional`autoCenter

`Optional`autoScale

`Optional`computeBoundingBox

`Optional`computeBoundingSphere

`Optional`computeLineDistances

`Optional`pivotToBoundsCenter