Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents an environment around the camera. The environment consists of two parts: the skybox and the reflection map.

The skybox is the background imagery the camera sees around it. Having detailed background imagery that is appropriate to the scene can allow for a more immersive visual experience.

The reflection map is the imagery that is seen in the reflections on certain objects in the scene. 3D icons and OGC 3D Tiles can use the reflection map to show reflections if they are styled with imageBasedLighting. Seeing the environment reflected can make the objects seem more realistic and grounded in the scene.

since

2021.1

Hierarchy

  • EnvironmentMapEffect

Overview

Properties

Properties

Optional reflectionMap

reflectionMap: EnvironmentMap | null

The environment map to use for reflections. This can be a different from the skybox.

You can also only set a reflection map and use for example the atmosphere for the environment.

The reflection map can be of lower resolution than the skybox because it's only used for the reflections. HDR imagery is preferred but not required. To this end, .hdr files (radiance rgbE format) are supported.

Optional skybox

skybox: EnvironmentMap | null

The skybox (or environment map as it is sometimes called).

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method