Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.ogc.kml

Class KmlGroundOverlay

java.lang.Object
com.esri.arcgisruntime.ogc.kml.KmlNode
com.esri.arcgisruntime.ogc.kml.KmlGroundOverlay
public final class KmlGroundOverlay extends KmlNode
A KML ground overlay is an image overlay draped on to the terrain.
Since:
100.4.0

  • Property Details

    • color

      public ObjectProperty<Color> colorProperty
      The color mask to be applied to the KML ground overlay's image.

      Pixels in the overlay image are multiplied by this color channel-by-channel.

      The default value is Color.WHITE.

      At version 100.4, only the alpha (opacity) channel is multiplied; all others are left as-is.

      Since:
      200.0.0
      See Also:

  • Constructor Details

    • KmlGroundOverlay

      public KmlGroundOverlay(Geometry geometry, KmlIcon kmlIcon)
      Creates a KML ground overlay with the specified geometry and icon.

      The specified geometry must be either an Envelope or a Polygon with exactly 4 points. Other geometry types are not supported.

      Parameters:
      geometry - a Geometry
      kmlIcon - a KmlIcon
      Throws:
      IllegalArgumentException - if geometry is null
      IllegalArgumentException - if kmlIcon is null
      ArcGISRuntimeException - if geometry is not an Envelope or Polygon with four points
      Since:
      100.6.0

  • Method Details

    • getAltitude

      public double getAltitude()
      Gets the KML ground overlay's altitude in meters. Interpreted in terms of getAltitudeMode().
      Returns:
      the KML ground overlay's altitude in meters
      Since:
      100.4.0

    • getAltitudeMode

      public KmlAltitudeMode getAltitudeMode()
      Gets the altitude mode of the ground overlay.

      Ground overlays support KmlAltitudeMode.ABSOLUTE and KmlAltitudeMode.CLAMP_TO_GROUND.

      Returns:
      the altitude mode of the ground overlay
      Since:
      100.4.0

    • setAltitudeMode

      public void setAltitudeMode(KmlAltitudeMode kmlAltitudeMode)
      Sets the altitude mode of the ground overlay.

      Ground overlays support KmlAltitudeMode.ABSOLUTE and KmlAltitudeMode.CLAMP_TO_GROUND.

      Parameters:
      kmlAltitudeMode - a KmlAltitudeMode
      Throws:
      IllegalArgumentException - if kmlAltitudeMode is null
      ArcGISRuntimeException - if an unsupported altitude mode is used
      Since:
      100.7.0

    • getDrawOrder

      public int getDrawOrder()
      Gets the KML ground overlay's draw order. Overlays with higher draw order values are drawn on top of those with lower values.
      Returns:
      the KML ground overlay's draw order
      Since:
      100.4.0

    • getGeometry

      public Geometry getGeometry()
      Gets the geometry for the KML ground overlay.
      Returns:
      an Envelope geometry for the KML ground overlay
      Since:
      100.4.0
      See Also:

    • colorProperty

      public ObjectProperty<Color> colorProperty()
      The color mask to be applied to the KML ground overlay's image.

      Pixels in the overlay image are multiplied by this color channel-by-channel.

      The default value is Color.WHITE.

      At version 100.4, only the alpha (opacity) channel is multiplied; all others are left as-is.

      Returns:
      the color property
      Since:
      200.0.0
      See Also:

    • getColor

      public Color getColor()
      Gets the value of the color property.
      Property description:
      The color mask to be applied to the KML ground overlay's image.

      Pixels in the overlay image are multiplied by this color channel-by-channel.

      The default value is Color.WHITE.

      At version 100.4, only the alpha (opacity) channel is multiplied; all others are left as-is.

      Returns:
      the value of the color property
      Since:
      200.0.0
      See Also:

    • setColor

      public void setColor(Color color)
      Sets the value of the color property.
      Property description:
      The color mask to be applied to the KML ground overlay's image.

      Pixels in the overlay image are multiplied by this color channel-by-channel.

      The default value is Color.WHITE.

      At version 100.4, only the alpha (opacity) channel is multiplied; all others are left as-is.

      Parameters:
      color - the value for the color property
      Since:
      200.0.0
      See Also:

    • getRotation

      public double getRotation()
      Gets the KML ground overlay's rotation.

      The rotation of the overlay about its center is in degrees. Values can be in the range of +/-180. The default is 0 (north). Rotations are specified in a counterclockwise direction.

      Returns:
      the KML ground overlay's rotation
      Since:
      100.4.0

    • getIcon

      public KmlIcon getIcon()
      Gets the KML ground overlay icon.
      Returns:
      a KmlIcon
      Since:
      100.6.0
      See Also:

    • setIcon

      public void setIcon(KmlIcon kmlIcon)
      Sets the KML ground overlay icon.
      Parameters:
      kmlIcon - a KmlIcon
      Since:
      100.6.0
      See Also:

    • setAltitude

      public void setAltitude(double altitude)
      Sets the KML ground overlay's altitude.

      Specifies the altitude of the overlay in meters. It shall be interpreted according to KmlAltitudeMode.

      Parameters:
      altitude - the altitude in meters
      Since:
      100.6.0

    • setColor

      @Deprecated(since="200.0.0", forRemoval=true) public void setColor(int color)
      Deprecated, for removal: This API element is subject to removal in a future version.
      as of 200.0.0, replaced by setColor(Color)
      Sets the color mask to be applied to the KML ground overlay's image.

      The color mask is used to blend the image associated with KML ground overlay. Pixels in the overlay image are multiplied by this color channel-by-channel.

      Parameters:
      color - the color (an integer as 0xAARRGGBB) to blend with overlay image
      Since:
      100.6.0

    • setDrawOrder

      public void setDrawOrder(int drawOrder)
      Sets the KML ground overlay's draw order.

      The draw order defines the stacking order for the images in overlapping overlays. Overlays with higher draw order values are drawn on top of overlays with lower draw order values.

      Parameters:
      drawOrder - draw order of the overlay
      Throws:
      IllegalArgumentException - if drawOrder is negative
      Since:
      100.6.0

    • setGeometry

      public void setGeometry(Geometry geometry)
      Sets the geometry of the KML ground overlay.

      The specified geometry must be either an Envelope or a Polygon with exactly 4 points. Other geometry types are not supported.

      Parameters:
      geometry - a Geometry
      Throws:
      ArcGISRuntimeException - if geometry is not an Envelope or Polygon with four points
      IllegalArgumentException - if geometry is null
      Since:
      100.6.0
      See Also:

    • setRotation

      public void setRotation(double rotation)
      Sets the rotation of the KML ground overlay.

      Specifies the rotation of the overlay about its center in degrees. The default is 0 (north). Rotations are specified in a counterclockwise direction.

      Parameters:
      rotation - the rotation of the overlay
      Since:
      100.6.0