Class Environment

Manages ground plane and lights that are part of the THREE.Scene to render but not part of the Vims.

Hierarchy

Environment

Index

Constructors

Properties

skyLight sunLights

Accessors

Methods

adaptToContent applySettings dispose getObjects loadGroundTexture

Constructors

constructor

new Environment(settings: Settings): Environment
Parameters
- settings: Settings
Returns Environment
- Defined in src/viewer/environment.ts:117

Properties

skyLight

skyLight: HemisphereLight

sunLights

sunLights: DirectionalLight[]

Accessors

groundPlane

get groundPlane(): THREE.Mesh<BufferGeometry, THREE.Material | THREE.Material[]>
Returns THREE.Mesh<BufferGeometry, THREE.Material | THREE.Material[]>
- Defined in src/viewer/environment.ts:113

Methods

adaptToContent

adaptToContent(box: Box3): void
Adjust scale so that it matches box dimensions.
Parameters
- box: Box3
Returns void
- Defined in src/viewer/environment.ts:168

applySettings

applySettings(settings: Settings): void
Parameters
- settings: Settings
Returns void
- Defined in src/viewer/environment.ts:135

dispose

dispose(): void
Returns void
- Defined in src/viewer/environment.ts:173

getObjects

getObjects(): Object3D<Event>[]
Returns all three objects composing the environment

Returns Object3D<Event>[]
- Defined in src/viewer/environment.ts:131

loadGroundTexture

loadGroundTexture(encoding: TextureEncoding, url: string): void
Parameters
- encoding: TextureEncoding
- url: string
Returns void
- Defined in src/viewer/environment.ts:124

Generated using TypeDoc