Class Scene

Container of model geometry and materials.

A Scene contains SceneModels, SceneObjects, SceneMeshes, SceneGeometries, SceneTextureSets and SceneTextures.

See @xeokit/sdk/scene for usage.

Hierarchy (View Summary)

Component
- Scene

Index

Constructors

constructor

new Scene(params?: SceneParams): Scene
Creates a new Scene.
Parameters
- Optionalparams: SceneParams
Returns Scene
Overrides Component.constructor
- Defined in packages/sdk/src/scene/Scene.ts:81

Properties

`Readonly`coordinateSystem

coordinateSystem: CoordinateSystem

Configures the Scene's coordinate system.

destroyed

destroyed: boolean

True once this Component has been destroyed.

Don't use this Component if this is true.

`Protected`dirty

dirty: boolean

id

id: string

Unique ID of this Component.

`Readonly`models

models: { [key: string]: SceneModel }

The SceneModels belonging to this Scene, each keyed to its SceneModel.id.

`Readonly`objects

objects: { [key: string]: SceneObject }

The SceneObjects in this Scene, mapped to SceneObject.id.

`Readonly`tiles

tiles: { [key: string]: SceneTile }

The SceneTiles in this Scene.

Accessors

aabb

get aabb(): FloatArrayParam
Gets the collective World-space 3D axis-aligned boundary of all the SceneModels in this Scene.

The boundary will be of the form [xMin, yMin, zMin, xMax, yMax, zMax].

Returns FloatArrayParam
- Defined in packages/sdk/src/scene/Scene.ts:125

center

get center(): FloatArrayParam
Gets the collective World-space 3D center of all the SceneModels in this Scene.

Returns FloatArrayParam
- Defined in packages/sdk/src/scene/Scene.ts:110

Methods

`Protected`clean

clean(): void
Forces this component to action any deferred state updates.

Returns void
Inherited from Component.clean
- Defined in packages/sdk/src/core/Component.ts:119

`Protected`cleanIfDirty

cleanIfDirty(): void
Gives this component an opportunity to action any defered state updates.

Returns void
Inherited from Component.cleanIfDirty
- Defined in packages/sdk/src/core/Component.ts:109

clear

clear(): void | SDKError
Destroys all contained SceneModels.
- Fires Scene.onModelDestroyed and SceneModel.onDestroyed for each existing SceneModel in this Scene.
See @xeokit/sdk/scene for usage.
Returns void | SDKError
void
- On success.
- Defined in packages/sdk/src/scene/Scene.ts:244

createModel

createModel(sceneModelParams: SceneModelParams): SDKError | SceneModel
Creates a new SceneModel in this Scene.

Remember to call SceneModel.build when you've finished building or loading the SceneModel. That will fire events via Scene.onModelCreated and SceneModel.onBuilt, to indicate to any subscribers that the SceneModel is built and ready for use.

See @xeokit/sdk/scene for more details on usage.
Parameters
- sceneModelParams: SceneModelParams
  Creation parameters for the new SceneModel.
Returns SDKError | SceneModel
SceneModel
- On success.
- Defined in packages/sdk/src/scene/Scene.ts:200

destroy

destroy(): void
Destroys this Scene and all contained SceneModels.
- Fires Scene.onModelDestroyed and SceneModel.onDestroyed for each existing SceneModels in this Data.
- Unsubscribes all subscribers to Scene.onModelCreated, Scene.onModelDestroyed, SceneModel.onDestroyed
See @xeokit/sdk/scene for usage.
Returns void
void
- On success.
Overrides Component.destroy
- Defined in packages/sdk/src/scene/Scene.ts:267

`Protected`error

error(message: string): void
Protected
Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>
Parameters
- message: string
  The error message to log
Returns void
Inherited from Component.error
- Defined in packages/sdk/src/core/Component.ts:95

getTile

getTile(origin: FloatArrayParam): SceneTile
Parameters
- origin: FloatArrayParam
Returns SceneTile
- Defined in packages/sdk/src/scene/Scene.ts:294

`Protected`log

log(message: string): void
Protected
Logs a message for this component.

The message will have this format: [LOG] [<component type> <component id>: <message>
Parameters
- message: string
  The message to log
Returns void
Inherited from Component.log
- Defined in packages/sdk/src/core/Component.ts:71

putTile

putTile(tile: SceneTile): void
Parameters
- tile: SceneTile
Returns void
- Defined in packages/sdk/src/scene/Scene.ts:308

`Protected`setDirty

setDirty(): void
Flags this component as having a defered state updates it needs to perform.

Returns void
Inherited from Component.setDirty
- Defined in packages/sdk/src/core/Component.ts:102

`Protected`warn

warn(message: string): void
Protected
Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>
Parameters
- message: string
  The warning message to log
Returns void
Inherited from Component.warn
- Defined in packages/sdk/src/core/Component.ts:83

Events

onDestroyed

onDestroyed: EventEmitter<Component, null>

Emits an event when the Component has been destroyed.

`Readonly`onModelCreated

onModelCreated: EventEmitter<Scene, SceneModel>

Emits an event each time a SceneModel is created in this Scene.

`Readonly`onModelDestroyed

onModelDestroyed: EventEmitter<Scene, SceneModel>

Emits an event each time a SceneModel is destroyed in this Scene.

`Readonly`onTileCreated

onTileCreated: EventEmitter<Scene, SceneTile>

Emits an event each time a SceneTile is created in this Scene.

`Readonly`onTileDestroyed

onTileDestroyed: EventEmitter<Scene, SceneTile>

Emits an event each time a SceneTile is destroyed in this Scene.

Class Scene

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Parameters

Returns Scene

Properties

ReadonlycoordinateSystem

destroyed

Protecteddirty

id

Readonlymodels

Readonlyobjects

Readonlytiles

Accessors

aabb

Returns FloatArrayParam

center

Returns FloatArrayParam

Methods

Protectedclean

Returns void

ProtectedcleanIfDirty

Returns void

clear

Returns void | SDKError

createModel

Parameters

Returns SDKError | SceneModel

destroy

Returns void

Protectederror

Parameters

Returns void

getTile

Parameters

Returns SceneTile

Protectedlog

Parameters

Returns void

putTile

Parameters

Returns void

ProtectedsetDirty

Returns void

Protectedwarn

Parameters

Returns void

Events

onDestroyed

ReadonlyonModelCreated

ReadonlyonModelDestroyed

ReadonlyonTileCreated

ReadonlyonTileDestroyed

Settings

On This Page

`Readonly`coordinateSystem

`Protected`dirty

`Readonly`models

`Readonly`objects

`Readonly`tiles

`Protected`clean

`Protected`cleanIfDirty

`Protected`error

`Protected`log

`Protected`setDirty

`Protected`warn

`Readonly`onModelCreated

`Readonly`onModelDestroyed

`Readonly`onTileCreated

`Readonly`onTileDestroyed