Class LayerSceneProperties


  • public final class LayerSceneProperties
    extends java.lang.Object
    A set of properties for displaying a layer or a graphics overlay in 3D space.

    If layer or graphics overlay is set to a MapView, then all settings will be ignored.

    Example of setting a graphics overlay's LayerSceneProperties.SurfacePlacement mode. This property handles the altitude of graphics in 3D space. Absolute mode will set a graphics altitude using its z value only.

     // only applies to a graphics overlay that is set to a scene view
     graphicsOverlay.getSceneProperties().setSurfacePlacement(SurfacePlacement.ABSOLUTE);
     
    Since:
    100.0.0
    See Also:
    GraphicsOverlay.getSceneProperties()
    • Method Detail

      • getSurfacePlacement

        public LayerSceneProperties.SurfacePlacement getSurfacePlacement()
        Gets the surface placement mode from a layer or graphics overlay. This mode will control the altitude at which objects are positioned.
        Returns:
        the surface placement mode
        Since:
        100.0.0
      • setSurfacePlacement

        public void setSurfacePlacement​(LayerSceneProperties.SurfacePlacement surfacePlacement)
        Sets the surface placement mode to a layer or graphics overlay. This mode will control the altitude at which objects are positioned.
        Parameters:
        surfacePlacement - the surface placement mode to be set
        Throws:
        java.lang.IllegalArgumentException - if surfacePlacement is null
        Since:
        100.0.0
      • getAltitudeOffset

        public double getAltitudeOffset()
        Gets the altitude offset.
        Returns:
        the altitude offset associated with the scene properties
        Since:
        100.6.0
      • setAltitudeOffset

        public void setAltitudeOffset​(double altitudeOffset)
        Sets the altitude offset.
        Parameters:
        altitudeOffset - the altitude offset to apply
        Since:
        100.6.0