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.

Hierarchy

  • EnvironmentHelper

Index

Constructors

constructor

Find examples in Playground

Properties

ground

Find examples in Playground
ground: Nullable<Mesh>

Gets the ground mesh created by the helper.

groundMaterial

Find examples in Playground
groundMaterial: Nullable<BackgroundMaterial>

Gets the ground material created by the helper.

groundMirror

Find examples in Playground
groundMirror: Nullable<MirrorTexture>

Gets the ground mirror created by the helper.

groundMirrorRenderList

Find examples in Playground
groundMirrorRenderList: Nullable<AbstractMesh[]>

Gets the ground mirror render list to helps pushing the meshes you wish in the ground reflection.

groundTexture

Find examples in Playground
groundTexture: Nullable<BaseTexture>

Gets the ground texture created by the helper.

onErrorObservable

Find examples in Playground
onErrorObservable: Observable<object>

This observable will be notified with any error during the creation of the environment, mainly texture creation errors.

rootMesh

Find examples in Playground
rootMesh: Mesh

Gets the root mesh created by the helper.

skybox

Find examples in Playground
skybox: Nullable<Mesh>

Gets the skybox created by the helper.

skyboxMaterial

Find examples in Playground
skyboxMaterial: Nullable<BackgroundMaterial>

Gets the skybox material created by the helper.

skyboxTexture

Find examples in Playground
skyboxTexture: Nullable<BaseTexture>

Gets the skybox texture created by the helper.

Methods

dispose

Find examples in Playground
  • dispose(): void
  • Dispose all the elements created by the Helper.

    Returns void

setMainColor

Find examples in Playground
  • setMainColor(color: Color3): void
  • Sets the primary color of all the available elements.

    Parameters

    • color: Color3

      the main color to affect to the ground and the background

    Returns void

updateOptions

Find examples in Playground

Generated using TypeDoc