API Reference › Globals › FloorEnvironment
# Class: FloorEnvironment
# Hierarchy
↳ FloorEnvironment
# Index
# Constructors
# Methods
- addToScene
- changeFloorMaterial
- cleanUp
- needsBounds
- needsCamera
- needsRotation
- reload
- removeFromScene
- setFloorMaterial
- setLoadedCallback
- setPixotron
- showGUI
- update
- updateBounds
- updateCamera
# Constructors
# constructor
+ new FloorEnvironment(scene: Scene, oldEnvironment: Environment, fog?: boolean): FloorEnvironment
Overrides BakedShadowEnvironment.constructor
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:35
Parameters:
| Name | Type |
|---|---|
scene | Scene |
oldEnvironment | Environment |
fog? | boolean |
Returns: FloorEnvironment
# Methods
# addToScene
▸ addToScene(): void
Overrides BakedShadowEnvironment.addToScene
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:104
Returns: void
# changeFloorMaterial
▸ changeFloorMaterial(rapiMaterial: RapiMaterial, maxAnisotropy?: number): Promise‹void›
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:139
Parameters:
| Name | Type |
|---|---|
rapiMaterial | RapiMaterial |
maxAnisotropy? | number |
Returns: Promise‹void›
# cleanUp
▸ cleanUp(): void
Inherited from Environment.cleanUp
Defined in packages/common-core/src/environment/environment.ts:37
Returns: void
# needsBounds
▸ needsBounds(): boolean
Overrides BakedShadowEnvironment.needsBounds
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:46
Returns: boolean
# needsCamera
▸ needsCamera(): boolean
Overrides BakedShadowEnvironment.needsCamera
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:50
Returns: boolean
# needsRotation
▸ needsRotation(): boolean
Overrides BakedShadowEnvironment.needsRotation
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:54
Returns: boolean
# reload
▸ reload(): void
Inherited from Environment.reload
Defined in packages/common-core/src/environment/environment.ts:28
Returns: void
# removeFromScene
▸ removeFromScene(): void
Overrides BakedShadowEnvironment.removeFromScene
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:116
Returns: void
# setFloorMaterial
▸ setFloorMaterial(url: string, width: number, height: number, repeatable: boolean): Promise‹void›
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:120
Parameters:
| Name | Type |
|---|---|
url | string |
width | number |
height | number |
repeatable | boolean |
Returns: Promise‹void›
# setLoadedCallback
▸ setLoadedCallback(callback: function): void
Inherited from BakedShadowEnvironment.setLoadedCallback
Defined in packages/common-core/src/environment/baked-shadow-environment.ts:100
Parameters:
▪ callback: function
▸ (): void
Returns: void
# setPixotron
▸ setPixotron(pixotron: Pixotron, renderer: WebGLRenderer, camera: Camera, params?: BakedShadowParams): void
Inherited from BakedShadowEnvironment.setPixotron
Defined in packages/common-core/src/environment/baked-shadow-environment.ts:61
Parameters:
| Name | Type |
|---|---|
pixotron | Pixotron |
renderer | WebGLRenderer |
camera | Camera |
params? | BakedShadowParams |
Returns: void
# showGUI
▸ showGUI(): void
Overrides BakedShadowEnvironment.showGUI
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:168
Returns: void
# update
▸ update(): void
Inherited from BakedShadowEnvironment.update
Defined in packages/common-core/src/environment/baked-shadow-environment.ts:104
Returns: void
# updateBounds
▸ updateBounds(bounds: Vector3): boolean
Overrides BakedShadowEnvironment.updateBounds
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:58
Parameters:
| Name | Type |
|---|---|
bounds | Vector3 |
Returns: boolean
# updateCamera
▸ updateCamera(camera: PerspectiveCamera): void
Overrides Environment.updateCamera
Defined in packages/configurator-core/src/webgl/environment/floor-environment.ts:68
Parameters:
| Name | Type |
|---|---|
camera | PerspectiveCamera |
Returns: void