EnvironmentHelper

Description

class EnvironmentHelper

The Environment helper class can be used to add a fully featuread none expensive background to your scene.

It includes by default a skybox and a ground relying on the BackgroundMaterial.

It also helps with the default setup of your imageProcessing configuration.

Constructor

new EnvironmentHelper(options, scene)

constructor

Parameters

	Name	Type	Description
	options	Partial<IEnvironmentHelperOptions>
	scene	undefined	The scene to add the material to

Members

rootMesh : Mesh

Gets the root mesh created by the helper.

skybox : Nullable<Mesh>

Gets the skybox created by the helper.

skyboxTexture : Nullable<BaseTexture>

Gets the skybox texture created by the helper.

skyboxMaterial : Nullable<BackgroundMaterial>

Gets the skybox material created by the helper.

ground : Nullable<Mesh>

Gets the ground mesh created by the helper.

groundTexture : Nullable<BaseTexture>

Gets the ground texture created by the helper.

groundMirror : Nullable<MirrorTexture>

Gets the ground mirror created by the helper.

groundMirrorRenderList : Nullable<AbstractMesh[]>

Gets the ground mirror render list to helps pushing the meshes

you wish in the ground reflection.

groundMaterial : Nullable<BackgroundMaterial>

Gets the ground material created by the helper.

Methods

updateOptions(options) → void

Updates the background according to the new options

Parameters

	Name	Type	Description
	options	Partial<IEnvironmentHelperOptions>

setMainColor(color) → void

Sets the primary color of all the available elements.

Parameters

	Name	Type	Description
	color	Color3

dispose() → void

Dispose all the elements created by the Helper.