Options
All
  • Public
  • Public/Protected
  • All
Menu

The graphics effects that can be applied to a map.
You cannot create a GraphicsEffects. Instead, you can retrieve it from Map.effects and assign properties.
For example:

  map.effects.light = null;
  map.effects.atmosphere = false;

The order in which effects are applied, if enabled, is:

  • Star field
  • Atmosphere
  • Lighting + shadows
  • Ambient occlusion
  • Eye-dome lighting
  • Anti-aliasing
  • Depth-of-field

Hierarchy

  • GraphicsEffects

Overview

Constructors

Private constructor

  • This class should not be instantiated by users of LuciadRIA.

    Returns GraphicsEffects

Accessors

ambientOcclusion

  • The ambient occlusion effect that is used.

    Note that ambient occlusion is only applied in 3D views.

    default

    off

    Returns AmbientOcclusionEffect | null

  • The ambient occlusion effect that is used.

    Note that ambient occlusion is only applied in 3D views.

    default

    off

    Parameters

    Returns any

antiAliasing

  • get antiAliasing(): boolean
  • set antiAliasing(fxaa: boolean): void
  • Enable anti-aliasing on the entire map.

    The anti-aliasing algorithm is FXAA.

    Note that anti-aliasing is only applied in 3D views. In 2D views, most content is already anti-aliased anyway: imagery, lines and icons.
    default

    off

    since

    2020.0

    Returns boolean

  • Enable anti-aliasing on the entire map.

    The anti-aliasing algorithm is FXAA.

    Note that anti-aliasing is only applied in 3D views. In 2D views, most content is already anti-aliased anyway: imagery, lines and icons.
    default

    off

    since

    2020.0

    Parameters

    • fxaa: boolean

    Returns any

atmosphere

  • Configures the atmosphere to be painted on a 3D view.

    By default, a basic atmosphere effect is on.
    This look is unaffected by lighting. You can also use a LightScatteringAtmosphere that approximates the behavior of light in the atmosphere. This provides more accurate time of day effects.
    Set to null or false to disable the atmosphere.

    default

    on in 3D

    Returns LightScatteringAtmosphere | null | boolean

  • Configures the atmosphere to be painted on a 3D view.

    By default, a basic atmosphere effect is on.
    This look is unaffected by lighting. You can also use a LightScatteringAtmosphere that approximates the behavior of light in the atmosphere. This provides more accurate time of day effects.
    Set to null or false to disable the atmosphere.

    default

    on in 3D

    Parameters

    Returns any

depthOfField

  • The depth of field effect that is used.

    Note that depth of field is only applied in 3D views.

    default

    off

    Returns DepthOfFieldEffect | null

  • The depth of field effect that is used.

    Note that depth of field is only applied in 3D views.

    default

    off

    Parameters

    Returns any

eyeDomeLighting

  • The eye-dome lighting effect that is used.

    Eye-dome lighting (EDL) is a non-photorealistic lighting model, which helps accentuate the shapes of different objects to improve depth perception, by shading their outlines.

    Note that eye-dome lighting is only applied in 3D views.

    default

    off

    since

    2020.0

    Returns EyeDomeLightingEffect | null

  • The eye-dome lighting effect that is used.

    Eye-dome lighting (EDL) is a non-photorealistic lighting model, which helps accentuate the shapes of different objects to improve depth perception, by shading their outlines.

    Note that eye-dome lighting is only applied in 3D views.

    default

    off

    since

    2020.0

    Parameters

    Returns any

light

  • The light effect that is used.

    You can use the factory methods in the LightEffect module to create new instances.
    See the LightEffect module for more information on what lights are supported on what views.

    By default a head light is used.
    Set to null to disable lighting.

    default

    headlight in 3D

    Returns LightEffect | null

  • The light effect that is used.

    You can use the factory methods in the LightEffect module to create new instances.
    See the LightEffect module for more information on what lights are supported on what views.

    By default a head light is used.
    Set to null to disable lighting.

    default

    headlight in 3D

    Parameters

    Returns any

starfield

  • get starfield(): boolean
  • set starfield(starfield: boolean): void
  • Indicates if a starfield should be painted when zoomed in on a 3D view.

    By default, the starfield property is set to true.
    Set to false to disable the starfield.

    default

    on in 3D

    Returns boolean

  • Indicates if a starfield should be painted when zoomed in on a 3D view.

    By default, the starfield property is set to true.
    Set to false to disable the starfield.

    default

    on in 3D

    Parameters

    • starfield: boolean

    Returns any

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