Class RootScene

Hierarchy

Implements

Constructors

constructor

Properties

assetType autoNearFarEnabled background backgroundColor backgroundIntensity children clone copy defaultCamera dispatchEvent environment envMapIntensity envMapRotation fixedEnvMapDirection getObjectById getObjectByName getObjectByProperty isRootScene modelRoot parent refreshUi remove textureSlots traverse traverseAncestors traverseVisible uiConfig

Accessors

activeCamera environmentIntensity mainCamera minNearDistance modelObject renderCamera

Methods

add addEventListener addObject addSceneObject autoGPUInstanceMeshes centerAllGeometries clearSceneModels dispose disposeSceneModels dollyActiveCameraFov findObjectsByName fromJSON getBounds getModelBounds loadModelRoot onBackgroundChange refreshActiveCameraNearFar refreshScene removeSceneModels resetCamera setBackgroundColor setDirty toJSON updateScene updateShaderProperties

Constructors

constructor

Properties

assetType

assetType: "model" = ...

autoNearFarEnabled

autoNearFarEnabled: boolean = true

For Programmatically toggling autoNearFar. This property is not supposed to be in the UI or serialized. Use camera.userData.autoNearFar for UI and serialization This is used in PickingPlugin autoNearFar will still be disabled if this is true and camera.userData.autoNearFar is false

background

background: null | ITexture | Color | "environment" = null

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 = null

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

backgroundIntensity

backgroundIntensity: number = 1

The intensity for the environment light.

children

children: IObject3D[]

Array with object's children.

See

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

Default Value

[]

clone

clone: (recursive?: boolean) => this

Returns a clone of this object and optionally all descendants.

Type declaration

    • (recursive?: boolean): this

    • Parameters

      • Optionalrecursive: boolean

        If true, descendants of the object are also cloned. Default true

      Returns this

copy

copy: (source: this, recursive?: boolean, ...args: any[]) => this

Copy the given object into this object

Type declaration

    • (source: this, recursive?: boolean, ...args: any[]): this

    • Parameters

      • source: this
      • Optionalrecursive: boolean

        If true, descendants of the object are also copied. Default true

      • ...args: any[]

      Returns this

Remarks

Note: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

ReadonlydefaultCamera

defaultCamera: TCamera

The default camera in the scene

dispatchEvent

dispatchEvent: (event: ISceneEvent) => void

Fire an event type.

Type declaration

environment

environment: null | ITexture = null

The default environment map used when rendering materials in the scene

envMapIntensity

envMapIntensity: number = 1

The intensity for the environment light.

envMapRotation

envMapRotation: number = 0

Rotation in radians of the default environment map. Same as environment.rotation.

Note - this is not serialized here, but inside the texture.

fixedEnvMapDirection

fixedEnvMapDirection: boolean = false

Fixed direction environment reflections irrespective of camera position.

getObjectById

getObjectById: <T extends IObject3D = IObject3D>(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 declaration

    • <T extends IObject3D = IObject3D>(id: number): undefined | T

    • Type Parameters

      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

getObjectByName

getObjectByName: <T extends IObject3D = IObject3D>(
    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 declaration

Remarks

Note that for most objects the name is an empty string by default

getObjectByProperty

getObjectByProperty: <T extends IObject3D = IObject3D>(
    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 declaration

    • <T extends IObject3D = IObject3D>(name: string, value: string): undefined | T

    • Type Parameters

      Parameters

      • name: string

        the property name to search for.

      • value: string

        value of the given property.

      Returns undefined | T

ReadonlyisRootScene

isRootScene: true

ReadonlymodelRoot

modelRoot: IObject3D

The root object where all imported objects are added.

parent

parent: null | IObject3D

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

refreshUi

refreshUi: any = ...

remove

remove: (...object: IObject3D[]) => this

Removes a Object3D as child of this Object3D.

Remarks

An arbitrary number of objects may be removed.

See

Group for info on manually grouping objects.

textureSlots

textureSlots: Record<string, ITexture> = {}

Extra textures/envmaps that can be used by objects/materials/plugins and will be serialized.

traverse

traverse: (callback: (object: IObject3D) => void) => void

Executes the callback on this object and all descendants.

Type declaration

    • (callback: (object: IObject3D) => void): void

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

traverseAncestors

traverseAncestors: (callback: (object: IObject3D) => void) => void

Executes the callback on all ancestors.

Type declaration

    • (callback: (object: IObject3D) => void): void

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

traverseVisible

traverseVisible: (callback: (object: IObject3D) => void) => void

Like traverse, but the callback will only be executed for visible objects

Type declaration

    • (callback: (object: IObject3D) => void): void

    • Parameters

      • callback: (object: IObject3D) => void

        A function with as first argument an Object3D object.

      Returns void

Remarks

Descendants of invisible objects are not traversed.

uiConfig

uiConfig: UiObjectConfig

Accessors

activeCamera

environmentIntensity

mainCamera

minNearDistance

modelObject

renderCamera

Methods

add

addEventListener

addObject

addSceneObject

autoGPUInstanceMeshes

centerAllGeometries

clearSceneModels

  • clearSceneModels(dispose?: boolean, setDirty?: boolean): void

  • Parameters

    • dispose: boolean = false
    • setDirty: boolean = true

    Returns void

dispose

  • dispose(clear?: boolean): void

  • Dispose the scene and clear all resources.

    Parameters

    • clear: boolean = true

    Returns void

    Warn

    Not fully implemented yet, just clears the scene.

disposeSceneModels

  • disposeSceneModels(setDirty?: boolean, clear?: boolean): void

  • Parameters

    • setDirty: boolean = true
    • clear: boolean = true

    Returns void

dollyActiveCameraFov

  • dollyActiveCameraFov(): void

  • Refreshes the scene active camera near far values, based on the scene bounding box. This is called automatically every time the camera fov is updated.

    Returns void

findObjectsByName

fromJSON

getBounds

  • getBounds(
        precise?: boolean,
        ignoreInvisible?: boolean,
        ignoreWidgets?: boolean,
        ignoreObject?: (obj: Object3D) => boolean,
    ): Box3B

  • Returns the bounding box of the whole scene (model root and other meta objects). To get the bounds of just the objects added by the user(not by plugins) use new Box3B().expandByObject(scene.modelRoot)

    Parameters

    • precise: boolean = false
    • ignoreInvisible: boolean = true
    • ignoreWidgets: boolean = true
    • OptionalignoreObject: (obj: Object3D) => boolean

    Returns Box3B

getModelBounds

  • getModelBounds(
        precise?: boolean,
        ignoreInvisible?: boolean,
        ignoreWidgets?: boolean,
        ignoreObject?: (obj: Object3D) => boolean,
    ): Box3B

  • Similar to getBounds, but returns the bounding box of just the modelRoot.

    Parameters

    • precise: boolean = false
    • ignoreInvisible: boolean = true
    • ignoreWidgets: boolean = true
    • OptionalignoreObject: (obj: Object3D) => boolean

    Returns Box3B

loadModelRoot

onBackgroundChange

refreshActiveCameraNearFar

  • refreshActiveCameraNearFar(): void

  • Refreshes the scene active camera near far values, based on the scene bounding box. This is called automatically every time the camera is updated.

    Returns void

refreshScene

removeSceneModels

resetCamera

  • resetCamera(
        rootObject?: undefined | Object3D,
        centerOffset?: Vector3,
        targetOffset?: Vector3,
    ): void

  • Parameters

    • rootObject: undefined | Object3D = undefined

      The object to point at.

    • centerOffset: Vector3 = ...

      The distance offset from the object to point at.

    • targetOffset: Vector3 = ...

      The distance offset for the target from the center of object to point at.

    Returns void

    Deprecated

    Sets the camera pointing towards the object at a specific distance.

setBackgroundColor

  • setBackgroundColor(color: null | string | number | Color): void

  • Sets the backgroundColor property from a string, number or Color, and updates the scene.

    Parameters

    • color: null | string | number | Color

    Returns void

setDirty

toJSON

updateScene

  • updateScene(options?: AnyOptions): this

  • Equivalent to setDirty({refreshScene: true}), dispatches 'sceneUpdate' event with the specified options.

    Parameters

    Returns this

    Deprecated

    use refreshScene

updateShaderProperties

  • updateShaderProperties(
        material: {
            defines: Record<string, undefined | string | number>;
            uniforms: { [name: string]: IUniform };
        },
    ): this

  • Parameters

    • material: {
          defines: Record<string, undefined | string | number>;
          uniforms: { [name: string]: IUniform };
      }

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods