Package com.luciad.maps.effects

Class EyeDomeLightingEffect

java.lang.Object
com.luciad.maps.effects.EyeDomeLightingEffect
All Implemented Interfaces:
AutoCloseable
public final class EyeDomeLightingEffect extends Object implements AutoCloseable
This class implements the Eye-dome lighting (EDL) effect, a non-photorealistic lighting model which helps accentuate the shapes of different objects to improve depth perception, by shading their outlines.

Left: eye-dome lighting disabled, Right: eye-dome lighting enabled
Left: eye-dome lighting disabled, Right: eye-dome lighting enabled

The lighting model applies a shade to each pixel, based on the depth difference between that pixel and its surrounding pixels. Its parameters are held by an immutable EyeDomeLightingModel. Read them with getModel and change them by building a new model and passing it to setModel.

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

You cannot create an EyeDomeLightingEffect. Instead, you can retrieve it from GraphicsEffects#getEyeDomeLighting.

  • Method Details

    • finalize

      protected void finalize()
      Overrides:
      finalize in class Object

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable

    • isEnabled

      public boolean isEnabled()
      Returns whether the Eye-dome lighting effect is enabled.
      Returns:
      whether the Eye-dome lighting effect is enabled.

    • setEnabled

      public void setEnabled(boolean enabled)
      Sets whether the Eye-dome lighting effect is enabled.

      The default is false.

      Parameters:
      enabled - true to enable the Eye-dome lighting effect or false to disable it.

    • getModel

      @NotNull public EyeDomeLightingModel getModel()
      Returns the eye-dome lighting model.
      Returns:
      the eye-dome lighting model.

    • setModel

      public void setModel(@NotNull EyeDomeLightingModel model) throws NullPointerException
      Sets the eye-dome lighting model.
      Parameters:
      model - the eye-dome lighting model.
      Throws:
      NullPointerException - when the model is a null value.