Class Scene

Represents a scene that contains multiple meshes. It tracks the global bounding box as meshes are added and maintains a mapping between g3d instance indices and meshes.

Hierarchy

Scene

Index

Constructors

Properties

builder insertables meshes

Accessors

material renderer vim

Methods

addMesh addOutline addSubmesh clear clearUpdateFlag dispose getBoundingBox getMemory getMeshFromInstance getMeshesFromInstances hasOutline merge removeOutline setDirty updateBox

Constructors

constructor

new Scene(builder: SceneBuilder, matrix: Matrix4): Scene
Parameters
- builder: SceneBuilder
- matrix: Matrix4
Returns Scene
- Defined in src/vim-loader/scene.ts:46

Properties

`Readonly` builder

builder: SceneBuilder

insertables

insertables: InsertableMesh[] = ...

meshes

meshes: (Mesh | InsertableMesh | InstancedMesh)[] = []

Accessors

material

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

Returns Material
- Defined in src/vim-loader/scene.ts:195
set material(value: Material): void
Sets and apply a material override to the scene, set to undefined to remove override.
Parameters
- value: Material
Returns void
- Defined in src/vim-loader/scene.ts:202

renderer

get renderer(): IRenderer
Returns IRenderer
- Defined in src/vim-loader/scene.ts:117
set renderer(value: IRenderer): void
Parameters
- value: IRenderer
Returns void
- Defined in src/vim-loader/scene.ts:121

vim

get vim(): Vim
Returns Vim
- Defined in src/vim-loader/scene.ts:125
set vim(value: Vim): void
Sets vim index for this scene and all its THREE.Meshes.
Parameters
- value: Vim
Returns void
- Defined in src/vim-loader/scene.ts:132

Methods

addMesh

addMesh(mesh: Mesh | InsertableMesh | InstancedMesh): Scene
Add an instanced mesh to the Scene and recomputes fields as needed.
Parameters
- mesh: Mesh | InsertableMesh | InstancedMesh
  
  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)
Returns Scene
- Defined in src/vim-loader/scene.ts:154

addOutline

addOutline(): void
Returns void
- Defined in src/vim-loader/scene.ts:59

addSubmesh

addSubmesh(submesh: Submesh): void
Parameters
- submesh: Submesh
Returns void
- Defined in src/vim-loader/scene.ts:137

clear

clear(): void
Unloads and disposes all meshes and leaves the scene ready to add new ones.

Returns void
- Defined in src/vim-loader/scene.ts:212

clearUpdateFlag

clearUpdateFlag(): void
Returns void
- Defined in src/vim-loader/scene.ts:69

dispose

dispose(): void
Disposes of all resources.

Returns void
- Defined in src/vim-loader/scene.ts:227

getBoundingBox

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

getMemory

getMemory(): number
Returns number
- Defined in src/vim-loader/scene.ts:88

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/vim-loader/scene.ts:99

getMeshesFromInstances

getMeshesFromInstances(instances: number[]): Submesh[]
Parameters
- instances: number[]
Returns Submesh[]
- Defined in src/vim-loader/scene.ts:103

hasOutline

hasOutline(): boolean
Returns boolean
- Defined in src/vim-loader/scene.ts:55

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/vim-loader/scene.ts:173

removeOutline

removeOutline(): void
Returns void
- Defined in src/vim-loader/scene.ts:64

setDirty

setDirty(): void
Returns void
- Defined in src/vim-loader/scene.ts:51

updateBox

updateBox(box: Box3): void
Parameters
- box: Box3
Returns void
- Defined in src/vim-loader/scene.ts:80

Generated using TypeDoc