Package com.esri.arcgisruntime.ogc.kml

Class KmlGroundOverlay

  • public final class KmlGroundOverlay
extends KmlNode
    A KML ground overlay is an image overlay draped on to the terrain.
    Since:
    100.4.0

    • Constructor Detail

      • 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 Detail

      • 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

      • 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:
        setGeometry(Geometry)

      • getColor

        public int getColor()
        Gets 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 0xFFFFFFFF (white).

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

        Returns:
        the color mask in an integer 0xAARRGGBB format
        Since:
        100.4.0

      • 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(KmlIcon)

      • setIcon

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

      • 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

        public void setColor​(int 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:
        getGeometry()

      • 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