Enum Class ILspWorldElevationStyle.ElevationMode

All Implemented Interfaces:
Serializable, Comparable<ILspWorldElevationStyle.ElevationMode>, Constable
Enclosing interface:

public static enum ILspWorldElevationStyle.ElevationMode extends Enum<ILspWorldElevationStyle.ElevationMode>
The elevationMode property is a styling property that determines how objects should be positioned relative to the terrain.
  • Enum Constant Details


      public static final ILspWorldElevationStyle.ElevationMode ABOVE_ELLIPSOID
      All objects are painted using their own absolute elevation, as specified in the domain objects. As a result, the terrain may obscure those objects.

      public static final ILspWorldElevationStyle.ElevationMode ON_TERRAIN

      All objects are draped over a terrain. Any elevation provided in the objects themselves is ignored. In 2D views, this mode has no effect.

      Draping allows you to paint directly onto a terrain. It is used in 3D to ensure that the objects follow the surface of the terrain. Anything can be painted in this mode, but it makes the most sense for objects that do not have an elevation and which are not drawn in alignment with the screen.


      public static final ILspWorldElevationStyle.ElevationMode ABOVE_TERRAIN

      All objects are painted above the terrain. This means that the elevation of the objects themselves is added to the elevation of the terrain. In 2D views, this mode has no effect. This mode is currently supported for TLspIconStyle, TLspLineStyle and TLspFillStyle.

      • For fill and line styles, only one terrain elevation is computed for a given geometry or object. This way, fluctuations in the underlying terrain are not visible in the geometry of the object.
      • Icons are normally centered around this elevated point, so even with this elevation mode, they can be partially obscured by the terrain, depending on the view angle. To prevent this, you can either set a fixed offset on the TLspIconStyle, or add a TLspViewDisplacementStyle, so that an icon can be moved above the terrain dynamically, depending on the view angle.

      public static final ILspWorldElevationStyle.ElevationMode OBJECT_DEPENDENT

      The object type and the object geometry determine which of the other three elevation modes is most suitable. This is currently the default elevation mode applied to stylers and most styles. It is only available for TLspIconStyle, TLspLineStyle and TLspFillStyle.

      Typically this elevation mode is used when styling data from an input format with potentially diverse types of objects: streets, rivers, and icons, for example. If you are using a:

      • TLspFillStyle or a TLspLineStyle: an OBJECT_DEPENDENT elevation mode results in objects draped on the terrain if the objects do not have elevation themselves. If the objects have elevation, they are painted ABOVE_ELLIPSOID.
      • TLspIconStyle: the icon objects are painted ABOVE_TERRAIN if they do not have any elevation themselves, meaning that their Z value is zero. The point is painted ABOVE_ELLIPSOID if it does have elevation.

      If you know up front what type of objects must be visualized, choose one of the other, more specific elevation modes. Base your choice on the type of input data. If you want to display street data for example, choose the ON_TERRAIN elevation mode.

  • Method Details

    • values

      public static ILspWorldElevationStyle.ElevationMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ILspWorldElevationStyle.ElevationMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null