Interface IScene<E, ET>

interface IScene<E, ET> {
    _currentGeometry?: null | IGeometry<NormalBufferAttributes>;
    _currentMaterial?: null | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[];
    _onGeometryUpdate?: ((e) => void);
    activeCamera: ICamera<ICameraEvent, ICameraEventTypes>;
    assetType: "model" | "light" | "camera" | "widget";
    background: null | "environment" | Color | ITexture;
    backgroundColor: null | Color;
    backgroundIntensity: number;
    children: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[];
    defaultCamera: ICamera<ICameraEvent, ICameraEventTypes>;
    envMapIntensity: number;
    environment: null | ITexture;
    fixedEnvMapDirection: boolean;
    geometry?: IGeometry<NormalBufferAttributes>;
    isCamera?: boolean;
    isLight?: boolean;
    isLine?: boolean;
    isLineSegments?: boolean;
    isMesh?: boolean;
    isScene: true;
    isWidget?: boolean;
    mainCamera: ICamera<ICameraEvent, ICameraEventTypes>;
    material?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[];
    materials?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[];
    modelObject: IScene<E, ET>;
    modelRoot: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
    morphTargetDictionary?: Record<string, number>;
    morphTargetInfluences?: number[];
    objectProcessor?: IObjectProcessor;
    parent: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
    parentRoot?: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
    renderCamera: ICamera<ICameraEvent, ICameraEventTypes>;
    type: "Scene";
    uiConfig?: UiObjectConfig<any, string, any>;
    userData: IObject3DUserData;
    visible: boolean;
    add(...object): this;
    addObject<T>(imported, options?): T & IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
    autoCenter?(setDirty?): this;
    autoScale?(autoScaleRadius?, isCentered?, setDirty?): this;
    clone(recursive?): this;
    copy(source, recursive?): this;
    dispose(removeFromParent?): void;
    findObjectsByName(name, parent?): any[];
    getBounds(precise?, ignoreInvisible?): Box3B;
    getObjectById<T>(id): undefined | T;
    getObjectByName<T>(name): undefined | T;
    getObjectByProperty<T>(name, value): undefined | T;
    refreshUi(): void;
    remove(...object): this;
    setDirty(e?): void;
    toJSON(): any;
    traverse(callback): void;
    traverseAncestors(callback): void;
    traverseVisible(callback): void;
    updateMorphTargets?(): void;
    updateShaderProperties(material): this;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

_currentGeometry? _currentMaterial? _onGeometryUpdate? activeCamera assetType background backgroundColor backgroundIntensity children defaultCamera envMapIntensity environment fixedEnvMapDirection geometry? isCamera? isLight? isLine? isLineSegments? isMesh? isScene isWidget? mainCamera material? materials? modelObject modelRoot morphTargetDictionary? morphTargetInfluences? objectProcessor? parent parentRoot? renderCamera type uiConfig? userData visible

Methods

add addObject autoCenter? autoScale? clone copy dispose findObjectsByName getBounds getObjectById getObjectByName getObjectByProperty refreshUi remove setDirty toJSON traverse traverseAncestors traverseVisible updateMorphTargets? updateShaderProperties

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

activeCamera

activeCamera: ICamera<ICameraEvent, ICameraEventTypes>

Deprecated

renamed to mainCamera

assetType

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

background

background: null | "environment" | Color | ITexture

backgroundColor

backgroundColor: null | Color

backgroundIntensity

backgroundIntensity: number

children

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

defaultCamera

defaultCamera: ICamera<ICameraEvent, ICameraEventTypes>

envMapIntensity

envMapIntensity: number

environment

environment: null | ITexture

fixedEnvMapDirection

fixedEnvMapDirection: boolean

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 isScene

isScene: true

Optional isWidget

isWidget?: boolean

mainCamera

mainCamera: ICamera<ICameraEvent, ICameraEventTypes>

Main camera that the user controls

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: IScene<E, ET>

Deprecated

use object directly

modelRoot

modelRoot: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

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.

renderCamera

renderCamera: ICamera<ICameraEvent, ICameraEventTypes>

Camera that in currently being rendered.

type

type: "Scene"

Optional uiConfig

uiConfig?: UiObjectConfig<any, string, any>

userData

userData: IObject3DUserData

Readonly visible

visible: boolean

Methods

add

addObject

Optional autoCenter

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

copy

dispose

findObjectsByName

getBounds

getObjectById

getObjectByName

getObjectByProperty

refreshUi

remove

setDirty

toJSON

traverse

traverseAncestors

traverseVisible

Optional updateMorphTargets

updateShaderProperties

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc