Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ria/view/LightEffect

Factory for light effects. You can set a light by doing:

  map.effects.light = createHeadLight();

The default light is a head light. You can disable lighting by assigning null.

Overview

Functions

createHeadLight

  • Creates a directional light source which automatically follows the orientation of the viewer.

    The head light direction is linked to the orientation of the camera in 3D. That is a useful feature in many applications where lighting can improve a user’s perception of shape. In this case, lighting is not used to represent the time of day. The user does not need the whole earth to have a bright side and a dark side.

    This light only has effect on a 3D WebGLMap.
    The lighting affects:

    • terrain, based on the elevation data
    • draped shapes
    • non-draped shapes such as extruded shapes and mesh icons

    Parameters

    Returns object

    the head light

createSunLight

  • Creates a sun light source based on a specific time.

    This light will simulate a sun light at the given time.

    This light has effect on a 2D or 3D WebGLMap.
    In 3D the lighting affects:

    • terrain, based on the elevation data
    • draped shapes
    • non-draped shapes such as extruded shapes and mesh icons
    • the night side of the earth: it is desaturated
    • meshes of OGC 3D Tiles layers if their mesh style has lighting turned on
    In 2D, the night side of the earth is desaturated.

    Parameters

    Returns object

    the sun light

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