Class Scene

A Scene regroups many Meshes It tracks the global bounding box as Meshes are added It keeps a map from instance indices to Meshes and vice versa

Hierarchy

Scene

Index

Constructors

Properties

Accessors

materialOverride onUpdate updated

Methods

addMesh addOutline applyMatrix4 clearUpdateFlag dispose getBoundingBox getMeshFromInstance hasOutline merge removeOutline

Constructors

constructor

new Scene(): Scene
Returns Scene

Properties

meshes

meshes: Mesh[] = []

Accessors

materialOverride

get materialOverride(): THREE.Material
Gets the current material override or undefined if none.

Returns THREE.Material
- Defined in src/scene/scene.ts:134
set materialOverride(value: THREE.Material): void
Sets and apply a material override to the scene, undefined will remove override.
Parameters
- value: THREE.Material
Returns void
- Defined in src/scene/scene.ts:141

onUpdate

get onUpdate(): ISignal
Returns ISignal
- Defined in src/scene/scene.ts:22

updated

get updated(): boolean
Returns boolean
- Defined in src/scene/scene.ts:26
set updated(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/scene/scene.ts:30

Methods

addMesh

addMesh(mesh: Mesh): Scene
Add an instanced mesh to the Scene and recomputes fields as needed. param mesh Is expected to have: userData.instances = number[] (indices of the g3d instances that went into creating the mesh) userData.boxes = THREE.Box3[] (bounding box of each instance)
Parameters
- mesh: Mesh
Returns Scene
- Defined in src/scene/scene.ts:87

addOutline

addOutline(): void
Returns void
- Defined in src/scene/scene.ts:38

applyMatrix4

applyMatrix4(matrix: Matrix4): void
Applies given transform matrix to all Meshes and bounding box.
Parameters
- matrix: Matrix4
Returns void
- Defined in src/scene/scene.ts:69

clearUpdateFlag

clearUpdateFlag(): void
Returns void
- Defined in src/scene/scene.ts:48

dispose

dispose(): void
Disposes of all resources.

Returns void
- Defined in src/scene/scene.ts:151

getBoundingBox

getBoundingBox(target?: Box3): Box3
Returns the scene bounding box. Returns undefined if scene is empty.
Parameters
- target: Box3 = ...
Returns Box3
- Defined in src/scene/scene.ts:55

getMeshFromInstance

getMeshFromInstance(instance: number): SubMesh[]
Returns the THREE.Mesh in which this instance is represented along with index For merged mesh, index refers to submesh index For instanced mesh, index refers to instance index.
Parameters
- instance: number
Returns SubMesh[]
- Defined in src/scene/scene.ts:64

hasOutline

hasOutline(): boolean
Returns boolean
- Defined in src/scene/scene.ts:34

merge

merge(other: Scene): Scene
Adds the content of other Scene to this Scene and recomputes fields as needed.
Parameters
- other: Scene
Returns Scene
- Defined in src/scene/scene.ts:112

removeOutline

removeOutline(): void
Returns void
- Defined in src/scene/scene.ts:43

Generated using TypeDoc