API Reference › Globals › BackgroundEnvironment
# Class: BackgroundEnvironment
# Hierarchy
↳ BackgroundEnvironment
# Index
# Constructors
# Methods
- addToScene
- cleanUp
- needsBounds
- needsCamera
- needsRotation
- reload
- removeFromScene
- setLoadedCallback
- setPixotron
- showGUI
- update
- updateBounds
- updateCamera
# Constructors
# constructor
+ new BackgroundEnvironment(scene: Scene, oldEnvironment?: Environment, color?: Color, canvas?: HTMLCanvasElement, url?: string): BackgroundEnvironment
Overrides BakedShadowEnvironment.constructor
Defined in packages/common-core/src/environment/background-environment.ts:10
Parameters:
| Name | Type |
|---|---|
scene | Scene |
oldEnvironment? | Environment |
color? | Color |
canvas? | HTMLCanvasElement |
url? | string |
Returns: BackgroundEnvironment
# Methods
# addToScene
▸ addToScene(): void
Overrides BakedShadowEnvironment.addToScene
Defined in packages/common-core/src/environment/background-environment.ts:37
Returns: 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/common-core/src/environment/background-environment.ts:25
Returns: boolean
# needsCamera
▸ needsCamera(): boolean
Overrides BakedShadowEnvironment.needsCamera
Defined in packages/common-core/src/environment/background-environment.ts:29
Returns: boolean
# needsRotation
▸ needsRotation(): boolean
Overrides BakedShadowEnvironment.needsRotation
Defined in packages/common-core/src/environment/background-environment.ts:33
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/common-core/src/environment/background-environment.ts:52
Returns: 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
Inherited from BakedShadowEnvironment.showGUI
Overrides Environment.showGUI
Defined in packages/common-core/src/environment/baked-shadow-environment.ts:159
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, force?: boolean): boolean
Inherited from BakedShadowEnvironment.updateBounds
Overrides Environment.updateBounds
Defined in packages/common-core/src/environment/baked-shadow-environment.ts:110
Parameters:
| Name | Type |
|---|---|
bounds | Vector3 |
force? | boolean |
Returns: boolean
# updateCamera
▸ updateCamera(_camera: PerspectiveCamera): void
Inherited from Environment.updateCamera
Defined in packages/common-core/src/environment/environment.ts:18
Parameters:
| Name | Type |
|---|---|
_camera | PerspectiveCamera |
Returns: void