Class AtmosphereEffect

java.lang.Object
com.luciad.maps.effects.AtmosphereEffect
All Implemented Interfaces:
AutoCloseable

public final class AtmosphereEffect extends Object implements AutoCloseable
Graphics effect which adds a sky/atmosphere background to a 3D view.

This effect is only applied in 3D views.

If the view has a geocentric reference, an atmospheric glow effect is drawn around the globe. The colors of this glow can be configured using setHorizonColor() and setSkyColor().

You cannot create an AtmosphereEffect. Instead, you can retrieve it from GraphicsEffects#getAtmosphere.

Since:
2023.1
  • Method Details Link icon

    • finalize Link icon

      protected void finalize()
      Overrides:
      finalize in class Object
    • close Link icon

      public void close()
      Specified by:
      close in interface AutoCloseable
    • isEnabled Link icon

      public boolean isEnabled()
      Returns whether the atmosphere effect is enabled.
      Returns:
      whether the atmosphere effect is enabled.
    • setEnabled Link icon

      public void setEnabled(boolean enabled)
      Sets whether the atmosphere effect is enabled.

      The default is true.

      Parameters:
      enabled - true to enable the atmosphere effect or false to disable it.
    • getSkyColor Link icon

      @NotNull public android.graphics.Color getSkyColor()
      Returns the sky color.

      Only used in geocentric views, where a gradient going from getHorizonColor() to getSkyColor() will be visible on the horizon.

      Returns:
      the color of the sky.
    • setSkyColor Link icon

      public void setSkyColor(@NotNull android.graphics.Color color)
      Sets the sky color.
      Parameters:
      color - the sky color.
    • getHorizonColor Link icon

      @NotNull public android.graphics.Color getHorizonColor()
      Returns the horizon color.

      Only used in geocentric views, where a gradient going from getHorizonColor() to getSkyColor() will be visible on the horizon.

      Returns:
      the color of the horizon.
    • setHorizonColor Link icon

      public void setHorizonColor(@NotNull android.graphics.Color color)
      Sets the horizon color.
      Parameters:
      color - the horizon color.