Options
All
  • Public
  • Public/Protected
  • All
Menu

The Environment helper class can be used to add a fully featured 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

Properties

onErrorObservable: Observable<{ exception?: any; message?: string }>

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

Accessors

  • Gets the ground mesh created by the helper.

    Returns Nullable<Mesh>

  • Gets the ground mirror created by the helper.

    Returns Nullable<MirrorTexture>

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

    Returns Nullable<AbstractMesh[]>

  • Gets the ground texture created by the helper.

    Returns Nullable<BaseTexture>

  • get rootMesh(): Mesh
  • Gets the root mesh created by the helper.

    Returns Mesh

  • Gets the skybox created by the helper.

    Returns Nullable<Mesh>

  • Gets the skybox texture created by the helper.

    Returns Nullable<BaseTexture>

Methods

  • dispose(): void
  • Dispose all the elements created by the Helper.

    Returns void

  • 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

  • Updates the background according to the new options

    Parameters

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme