Class RootScene

Hierarchy

Scene<ISceneEvent, ISceneEventTypes>
- RootScene

Implements

IScene<ISceneEvent, ISceneEventTypes>

Index

Constructors

constructor

Accessors

activeCamera environmentIntensity mainCamera minNearDistance modelObject renderCamera

Constructors

constructor

new RootScene(camera, objectProcessor?): RootScene
Create a scene instance. This is done automatically in the ThreeViewer and must not be created separately.
Parameters
- camera: TCamera
- Optional objectProcessor: IObjectProcessor
Returns RootScene
Overrides Scene<ISceneEvent, ISceneEventTypes>.constructor
- Defined in src/core/object/RootScene.ts:122

Properties

`Private` _dummyCam

_dummyCam: TCamera = ...

`Private` _mainCamera

_mainCamera: null | TCamera = null

`Private` _renderCamera

_renderCamera: undefined | TCamera

`Private` _sceneBoundingRadius

_sceneBoundingRadius: number = 0

`Private` _sceneBounds

_sceneBounds: Box3B = ...

`Private` _v1

_v1: Vector3 = ...

`Private` _v2

_v2: Vector3 = ...

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 | "environment" | Color | ITexture = null

backgroundColor

backgroundColor: null | Color = null

backgroundIntensity

backgroundIntensity: number = 1

The intensity for the environment light.

children

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

clone

clone: ((recursive?) => this)

Type declaration

- (recursive?): this
- Parameters
  - Optional recursive: boolean
  Returns this

copy

copy: ((source, recursive?, ...args) => this)

Type declaration

- (source, recursive?, ...args): this
- Parameters
  - source: this
  - Optional recursive: boolean
  - Rest ...args: any[]
  Returns this

`Readonly` defaultCamera

defaultCamera: TCamera

The default camera in the scene

dispatchEvent

dispatchEvent: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: ISceneEvent<ISceneEventTypes>
  Returns void

envMapIntensity

envMapIntensity: number = 1

The intensity for the environment light.

environment

environment: null | ITexture = null

fixedEnvMapDirection

fixedEnvMapDirection: boolean = false

Fixed direction environment reflections irrespective of camera position.

getObjectById

getObjectById: (<T>(id) => undefined | T)

Type declaration

- <T>(id): undefined | T
- Type Parameters
  - T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Parameters
  - id: number
  Returns undefined | T

getObjectByName

getObjectByName: (<T>(name) => undefined | T)

Type declaration

- <T>(name): undefined | T
- Type Parameters
  - T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Parameters
  - name: string
  Returns undefined | T

getObjectByProperty

getObjectByProperty: (<T>(name, value) => undefined | T)

Type declaration

- <T>(name, value): undefined | T
- Type Parameters
  - T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Parameters
  - name: string
  - value: string
  Returns undefined | T

`Readonly` isRootScene

isRootScene: true = true

`Readonly` modelRoot

modelRoot: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

The root object where all imported objects are added.

parent

parent: null

refreshUi

refreshUi: any = ...

remove

remove: ((...object) => this)

Type declaration

- (...object): this
- Parameters
  - Rest ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]
  Returns this

traverse

traverse: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((object) => void)
    - (object): void
      Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
  Returns void

traverseAncestors

traverseAncestors: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((object) => void)
    - (object): void
      Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
  Returns void

traverseVisible

traverseVisible: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((object) => void)
    - (object): void
      Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
  Returns void

uiConfig

uiConfig: UiObjectConfig<any, string, any>

Accessors

activeCamera

get activeCamera(): TCamera
Returns TCamera
Deprecated
Implementation of IScene.activeCamera
- Defined in src/core/object/RootScene.ts:629
set activeCamera(camera): void
Parameters
- camera: undefined | TCamera
Returns void
Deprecated
Implementation of IScene.activeCamera
- Defined in src/core/object/RootScene.ts:637

environmentIntensity

get environmentIntensity(): number
Returns number
Deprecated
use envMapIntensity instead
- Defined in src/core/object/RootScene.ts:653
set environmentIntensity(value): void
Parameters
- value: number
Returns void
Deprecated
use envMapIntensity instead
- Defined in src/core/object/RootScene.ts:660

mainCamera

get mainCamera(): TCamera
Main camera that the user controls

Returns TCamera
Implementation of IScene.mainCamera
- Defined in src/core/object/RootScene.ts:84
set mainCamera(camera): void
Main camera that the user controls
Parameters
- camera: undefined | TCamera
Returns void
Implementation of IScene.mainCamera
- Defined in src/core/object/RootScene.ts:87

minNearDistance

get minNearDistance(): number
Minimum Camera near plane

Returns number
Deprecated
- use camera.minNearPlane instead
- Defined in src/core/object/RootScene.ts:612
set minNearDistance(value): void
Parameters
- value: number
Returns void
Deprecated
- use camera.minNearPlane instead
- Defined in src/core/object/RootScene.ts:619

modelObject

get modelObject(): this
Get the threejs scene object

Returns this
Deprecated
Implementation of IScene.modelObject
- Defined in src/core/object/RootScene.ts:646

renderCamera

get renderCamera(): TCamera
Camera that in currently being rendered.

Returns TCamera
Implementation of IScene.renderCamera
- Defined in src/core/object/RootScene.ts:108
set renderCamera(camera): void
Camera that in currently being rendered.
Parameters
- camera: TCamera
Returns void
Implementation of IScene.renderCamera
- Defined in src/core/object/RootScene.ts:111

Methods

`Private` _addObject3D

_addObject3D(model, __namedParameters?): void
Parameters
- model: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
- __namedParameters: AddObjectOptions = {}
Returns void
- Defined in src/core/object/RootScene.ts:233

`Private` _mainCameraUpdate

_mainCameraUpdate(): void
Returns void
- Defined in src/core/object/RootScene.ts:344

`Private` _onEnvironmentChange

_onEnvironmentChange(): void
Returns void
- Defined in src/core/object/RootScene.ts:289

add

add(...object): this
Parameters
- Rest ...object: Object3D<Event, string>[]
Returns this
Deprecated
Use addObject
Implementation of IScene.add
Overrides Scene.add
- Defined in src/core/object/RootScene.ts:309

addEventListener

addEventListener<T>(type, listener): void
Type Parameters
- T extends ISceneEventTypes
Parameters
- type: T
- listener: EventListener<ISceneEvent<ISceneEventTypes>, T, RootScene>
Returns void
Implementation of IScene.addEventListener
Overrides Scene.addEventListener
- Defined in src/core/object/RootScene.ts:496

addObject

addObject<T>(imported, options?): T & IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Add any object to the scene.
Type Parameters
- T extends Object3D<Event, string> | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Parameters
- imported: T
- Optional options: AddObjectOptions
Returns T & IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Implementation of IScene.addObject
- Defined in src/core/object/RootScene.ts:176

addSceneObject

addSceneObject<T>(imported, options?): T
Add any processed scene object to the scene.
Type Parameters
- T extends Object3D<Event, string> | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Parameters
- imported: T
- Optional options: AddObjectOptions
Returns T
Deprecated
renamed to addObject
- Defined in src/core/object/RootScene.ts:670

centerAllGeometries

centerAllGeometries(keepPosition?, obj?): void
Parameters
- keepPosition: boolean = true
- Optional obj: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Returns void
- Defined in src/core/object/RootScene.ts:266

clearSceneModels

clearSceneModels(dispose?, setDirty?): void
Parameters
- dispose: boolean = false
- setDirty: boolean = true
Returns void
- Defined in src/core/object/RootScene.ts:272

dispose

dispose(clear?): void
Dispose the scene and clear all resources.
Parameters
- clear: boolean = true
Returns void
Warn
Not fully implemented yet, just clears the scene.
Implementation of IScene.dispose
- Defined in src/core/object/RootScene.ts:379

disposeSceneModels

disposeSceneModels(setDirty?, clear?): void
Parameters
- setDirty: boolean = true
- clear: boolean = true
Returns void
- Defined in src/core/object/RootScene.ts:279

findObjectsByName

findObjectsByName(name, parent?): IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]
Find objects by name exact match in the complete hierarchy.
Parameters
- name: string
  name
- Optional parent: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  optional root node to start search from
Returns IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]
Array of found objects

Deprecated
Use getObjectByName instead.
Implementation of IScene.findObjectsByName
- Defined in src/core/object/RootScene.ts:569

fromJSON

fromJSON(json, meta?): this
Deserialize the scene properties
Parameters
- json: any
  object from toJSON
- Optional meta: any
Returns this
- Defined in src/core/object/RootScene.ts:485

getBounds

getBounds(precise?, ignoreInvisible?, ignoreWidgets?, ignoreObject?): Box3B
Returns the bounding box of the scene model root.
Parameters
- precise: boolean = false
- ignoreInvisible: boolean = true
- ignoreWidgets: boolean = true
- Optional ignoreObject: ((obj) => boolean)
  - - (obj): boolean
    - Parameters
      obj: Object3D<Event, string>
      Returns boolean
Returns Box3B
Implementation of IScene.getBounds
- Defined in src/core/object/RootScene.ts:406

loadModelRoot

loadModelRoot(obj, options?): (Object3D<Event, string> & IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>)[]
Load model root scene exported to GLTF format. Used internally by ThreeViewer.addSceneObject.
Parameters
- obj: RootSceneImportResult
- Optional options: AddObjectOptions
Returns (Object3D<Event, string> & IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>)[]
- Defined in src/core/object/RootScene.ts:195

onBackgroundChange

onBackgroundChange(): void
Returns void
- Defined in src/core/object/RootScene.ts:300

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
- Defined in src/core/object/RootScene.ts:429

refreshScene

refreshScene(event?): this
For visualizing the scene bounds. API incomplete.
Parameters
- Optional event: Partial<ISceneEvent<ISceneEventTypes>> & IObjectSetDirtyOptions
Returns this
- Defined in src/core/object/RootScene.ts:360

removeSceneModels

removeSceneModels(): void
Returns void
Deprecated
renamed to clearSceneModels
- Defined in src/core/object/RootScene.ts:687

resetCamera

resetCamera(rootObject?, centerOffset?, targetOffset?): void
Parameters
- rootObject: undefined | Object3D<Event, string> = 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.
- Defined in src/core/object/RootScene.ts:585

setBackgroundColor

setBackgroundColor(color): void
Sets the backgroundColor property from a string, number or Color, and updates the scene.
Parameters
- color: null | string | number | Color
Returns void
- Defined in src/core/object/RootScene.ts:319

setDirty

setDirty(options?): this
Mark the scene dirty, and force render in the next frame.
Parameters
- Optional options: IObjectSetDirtyOptions
  set refreshScene to true to mark that any object transformations have changed. It might trigger effects like frame fade depening on plugins.
Returns this
Implementation of IScene.setDirty
- Defined in src/core/object/RootScene.ts:328

toJSON

toJSON(meta?): any
Serialize the scene properties
Parameters
- Optional meta: any
Returns any
Implementation of IScene.toJSON
Overrides Scene.toJSON
- Defined in src/core/object/RootScene.ts:473

updateScene

updateScene(options?): this
Equivalent to setDirty({refreshScene: true}), dispatches 'sceneUpdate' event with the specified options.
Parameters
- Optional options: AnyOptions
Returns this
Deprecated
use refreshScene
- Defined in src/core/object/RootScene.ts:679

updateShaderProperties

updateShaderProperties(material): this
Parameters
- material: {
      defines: Record<string, undefined | string | number>;
      uniforms: {
          [name: string]: IUniform;
      };
  }
  - defines: Record<string, undefined | string | number>
  - uniforms: {
    [name: string]: IUniform;
    }
    - [name: string]: IUniform
Returns this
Implementation of IScene.updateShaderProperties
- Defined in src/core/object/RootScene.ts:462

Class RootScene

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

camera: TCamera

Optional objectProcessor: IObjectProcessor

Returns RootScene

Properties

Private _dummyCam

Private _mainCamera

Private _renderCamera

Private _sceneBoundingRadius

Private _sceneBounds

Private _v1

Private _v2

assetType

autoNearFarEnabled

background

backgroundColor

backgroundIntensity

children

clone

Type declaration

Parameters

Optional recursive: boolean

Returns this

copy

Type declaration

Parameters

source: this

Optional recursive: boolean

Rest ...args: any[]

Returns this

Readonly defaultCamera

dispatchEvent

Type declaration

Parameters

event: ISceneEvent<ISceneEventTypes>

Returns void

envMapIntensity

environment

fixedEnvMapDirection

getObjectById

Type declaration

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

id: number

Returns undefined | T

getObjectByName

Type declaration

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

name: string

Returns undefined | T

getObjectByProperty

Type declaration

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

name: string

value: string

Returns undefined | T

Readonly isRootScene

Readonly modelRoot

parent

refreshUi

remove

Type declaration

Parameters

Rest ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

Returns this

`Optional` objectProcessor: IObjectProcessor

`Private` _dummyCam

`Private` _mainCamera

`Private` _renderCamera

`Private` _sceneBoundingRadius

`Private` _sceneBounds

`Private` _v1

`Private` _v2

`Optional` recursive: boolean

`Optional` recursive: boolean

`Rest` ...args: any[]

`Readonly` defaultCamera

`Readonly` isRootScene

`Readonly` modelRoot

`Rest` ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

`Private` _addObject3D

`Private` _mainCameraUpdate

`Private` _onEnvironmentChange