This element draws an image overlay draped onto the terrain. The child of
specifies the image to be used as the overlay. This file can be either on
a local file system or on a web server. If this element is omitted or contains no
, a rectangle is drawn using the color and LatLonBox bounds defined by the
ground overlay.
Syntax:
<GroundOverlay id="ID">
<!-- inherited from Feature element -->
<name>... </name> <!-- string -->
<visibility>1</visibility> <!-- boolean -->
<open>0</open> <!-- boolean -->
<atom:author>...<atom:author> <!-- xmlns:atom -->
<atom:link>...</atom:link> <!-- xmlns:atom -->
<address>... </address> <!-- string -->
<xal:AddressDetails>...</xal:AddressDetails> <!-- xmlns:xal --> <phoneNumber>...</phoneNumber> <!-- string --> <Snippet maxLines="2">... </Snippet> <!-- string -->
<description>... </description> <!-- string -->
<AbstractView>...</AbstractView> <!-- Camera or LookAt -->
<TimePrimitive >...</TimePrimitive >
<styleUrl>... </styleUrl> <!-- anyURI -->
<StyleSelector>...</StyleSelector>
<Region>...</Region>
<Metadata>...</Metadata> <!-- deprecated in KML 2.2 -->
<ExtendedData>...</ExtendedData> <!-- new in KML 2.2 -->
<!-- inherited from Overlay element -->
<color>ffffffff</color> <!-- kml:color -->
<drawOrder>0</drawOrder> <!-- int -->
<Icon>...</Icon>
<!-- specific to GroundOverlay -->
<altitude>0</altitude> <!-- double -->
<altitudeMode>clampToGround</altitudeMode>
<!-- kml:altitudeModeEnum: clampToGround or absolute -->
<!-- or, substitute gx:altitudeMode: clampToSeaFloor or relativeToSeaFloor -->
<LatLonBox>
<north>...</north> <! kml:angle90 -->
<south>... </south> <! kml:angle90 -->
<east>... </east> <! kml:angle180 -->
<west>... </west> <! kml:angle180 -->
<rotation>0</rotation> <! kml:angle180 -->
</LatLonBox>
</GroundOverlay>
Extends:
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Feature
abstractView , address , atomAuthor , atomLink , description , extendedData , featureObjectExtension , featureSimpleExtension , metadata , name , open , phoneNumber , region , snippet , snippetd , styleSelector , styleUrl , timePrimitive , visibility , xalAddressDetails
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Feature
createAndAddStyle , createAndAddStyleMap , createAndSetAtomAuthor , createAndSetAtomLink , createAndSetCamera , createAndSetExtendedData , createAndSetLookAt , createAndSetMetadata , createAndSetRegion , createAndSetSnippet , createAndSetTimeSpan , createAndSetTimeStamp , createAndSetXalAddressDetails , getAbstractView , getAddress , getAtomAuthor , getAtomLink , getDescription , getExtendedData , getFeatureObjectExtension , getFeatureSimpleExtension , getMetadata , getName , getPhoneNumber , getRegion , getSnippet , getSnippetd , getStyleSelector , getStyleUrl , getTimePrimitive , getXalAddressDetails , isOpen , isVisibility , setAbstractView , setAddress , setAtomAuthor , setAtomLink , setDescription , setExtendedData , setMetadata , setName , setOpen , setPhoneNumber , setRegion , setSnippet , setSnippetd , setStyleUrl , setTimePrimitive , setVisibility , setXalAddressDetails
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
altitude
protected double altitude
Distance from the earth's surface, in meters. Interpreted according to the LookAt's
altitude mode.
Distance of the camera from the earth's surface, in meters. Interpreted according
to the Camera's or .
Specifies the distance above the earth's surface, in meters, and is interpreted
according to the altitude mode.
altitudeMode
protected AltitudeMode altitudeMode
AltitudeMode
clampToGround, relativeToGround, absolute
See Also:
See and
latLonBox
protected LatLonBox latLonBox
Specifies where the top, bottom, right, and left sides of a bounding box for the
ground overlay are aligned. Specifies the latitude of the north edge of
the bounding box, in decimal degrees from 0 to ±90. Specifies the latitude
of the south edge of the bounding box, in decimal degrees from 0 to ±90.
Specifies the longitude of the east edge of the bounding box, in decimal degrees
from 0 to ±180. (For overlays that overlap the meridian of 180° longitude, values
can extend beyond that range.) Specifies the longitude of the west edge of
the bounding box, in decimal degrees from 0 to ±180. (For overlays that overlap
the meridian of 180° longitude, values can extend beyond that range.)
Specifies a rotation of the overlay about its center, in degrees. Values can be
±180. The default is 0 (north). Rotations are specified in a counterclockwise direction.
48.25475939255556 48.25207367852141 -90.86591508839973
-90.8714285289695 39.37878630116985
groundOverlaySimpleExtension
protected java.util.List<java.lang.Object> groundOverlaySimpleExtension
groundOverlayObjectExtension
protected java.util.List<AbstractObject > groundOverlayObjectExtension
This is an abstract base class and cannot be used directly in a KML file. It provides
the id attribute, which allows unique identification of a KML element, and the targetId
attribute, which is used to reference objects that have already been loaded into
Google Earth. The id attribute must be assigned if the mechanism is to
be used.
Syntax:
<!-- abstract element; do not create -->
<!-- Object id="ID" targetId="NCName" -->
<!-- /Object > -->
GroundOverlay
public GroundOverlay ()
getAltitude
public double getAltitude ()
Returns: possible object is
Double
See Also: altitude
setAltitude
public void setAltitude (double value)
Parameters: value
- allowed object is
Double
See Also: altitude
getAltitudeMode
public AltitudeMode getAltitudeMode ()
Returns: possible object is
<
Object
<
AltitudeMode
<
de.micromata.opengis.kml.v_2_2_0.gx.AltitudeMode
See Also: altitudeMode
setAltitudeMode
public void setAltitudeMode (AltitudeMode value)
Parameters: value
- allowed object is
<
Object
<
AltitudeMode
<
de.micromata.opengis.kml.v_2_2_0.gx.AltitudeMode
See Also: altitudeMode
getLatLonBox
public LatLonBox getLatLonBox ()
Returns: possible object is
LatLonBox
See Also: latLonBox
setLatLonBox
public void setLatLonBox (LatLonBox value)
Parameters: value
- allowed object is
LatLonBox
See Also: latLonBox
getGroundOverlaySimpleExtension
public java.util.List<java.lang.Object> getGroundOverlaySimpleExtension ()
See Also: groundOverlaySimpleExtension
getGroundOverlayObjectExtension
public java.util.List<AbstractObject > getGroundOverlayObjectExtension ()
See Also: groundOverlayObjectExtension
hashCode
public int hashCode ()
Overrides: hashCode
in class Overlay
equals
public boolean equals (java.lang.Object obj)
Overrides: equals
in class Overlay
createAndSetLatLonBox
public LatLonBox createAndSetLatLonBox ()
Creates a new instance of LatLonBox
and set it to latLonBox.
This method is a short version for:
LatLonBox latLonBox = new LatLonBox();
this.setLatLonBox(latLonBox);
setGroundOverlaySimpleExtension
public void setGroundOverlaySimpleExtension (java.util.List<java.lang.Object> groundOverlaySimpleExtension)
Parameters: groundOverlaySimpleExtension
- See Also: groundOverlaySimpleExtension
addToGroundOverlaySimpleExtension
public GroundOverlay addToGroundOverlaySimpleExtension (java.lang.Object groundOverlaySimpleExtension)
add a value to the groundOverlaySimpleExtension property collection
Parameters: groundOverlaySimpleExtension
- Objects of the following type are allowed in the list: Object
Returns: true (as general contract of Collection.add ).
setGroundOverlayObjectExtension
public void setGroundOverlayObjectExtension (java.util.List<AbstractObject > groundOverlayObjectExtension)
Parameters: groundOverlayObjectExtension
- See Also: groundOverlayObjectExtension
addToGroundOverlayObjectExtension
public GroundOverlay addToGroundOverlayObjectExtension (AbstractObject groundOverlayObjectExtension)
add a value to the groundOverlayObjectExtension property collection
Parameters: groundOverlayObjectExtension
- Objects of the following type are allowed in the list: <
AbstractObject
JAXBElement
<
LatLonQuad
Returns: true (as general contract of Collection.add ).
setObjectSimpleExtension
public void setObjectSimpleExtension (java.util.List<java.lang.Object> objectSimpleExtension)
Overrides: setObjectSimpleExtension
in class Overlay
See Also: objectSimpleExtension
addToObjectSimpleExtension
public GroundOverlay addToObjectSimpleExtension (java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection
Overrides: addToObjectSimpleExtension
in class Overlay
Parameters: objectSimpleExtension
- Objects of the following type are allowed in the list: Object
Returns: true (as general contract of Collection.add ).
setStyleSelector
public void setStyleSelector (java.util.List<StyleSelector > styleSelector)
Overrides: setStyleSelector
in class Overlay
See Also: styleSelector
addToStyleSelector
public GroundOverlay addToStyleSelector (StyleSelector styleSelector)
Description copied from class: Feature
add a value to the styleSelector property collection
Overrides: addToStyleSelector
in class Overlay
Parameters: styleSelector
- Objects of the following type are allowed in the list: <
StyleSelector
JAXBElement
<
StyleMap
JAXBElement
<
Style
Returns: true (as general contract of Collection.add ).
setFeatureSimpleExtension
public void setFeatureSimpleExtension (java.util.List<java.lang.Object> featureSimpleExtension)
Overrides: setFeatureSimpleExtension
in class Overlay
See Also: featureSimpleExtension
addToFeatureSimpleExtension
public GroundOverlay addToFeatureSimpleExtension (java.lang.Object featureSimpleExtension)
Description copied from class: Feature
add a value to the featureSimpleExtension property collection
Overrides: addToFeatureSimpleExtension
in class Overlay
Parameters: featureSimpleExtension
- Objects of the following type are allowed in the list: <
Object
JAXBElement
<
Boolean
Returns: true (as general contract of Collection.add ).
setFeatureObjectExtension
public void setFeatureObjectExtension (java.util.List<AbstractObject > featureObjectExtension)
Overrides: setFeatureObjectExtension
in class Overlay
See Also: featureObjectExtension
addToFeatureObjectExtension
public GroundOverlay addToFeatureObjectExtension (AbstractObject featureObjectExtension)
Description copied from class: Feature
add a value to the featureObjectExtension property collection
Overrides: addToFeatureObjectExtension
in class Overlay
Parameters: featureObjectExtension
- Objects of the following type are allowed in the list: AbstractObject
Returns: true (as general contract of Collection.add ).
setOverlaySimpleExtension
public void setOverlaySimpleExtension (java.util.List<java.lang.Object> overlaySimpleExtension)
Overrides: setOverlaySimpleExtension
in class Overlay
See Also: overlaySimpleExtension
addToOverlaySimpleExtension
public GroundOverlay addToOverlaySimpleExtension (java.lang.Object overlaySimpleExtension)
Description copied from class: Overlay
add a value to the overlaySimpleExtension property collection
Overrides: addToOverlaySimpleExtension
in class Overlay
Parameters: overlaySimpleExtension
- Objects of the following type are allowed in the list: Object
Returns: true (as general contract of Collection.add ).
setOverlayObjectExtension
public void setOverlayObjectExtension (java.util.List<AbstractObject > overlayObjectExtension)
Overrides: setOverlayObjectExtension
in class Overlay
See Also: overlayObjectExtension
addToOverlayObjectExtension
public GroundOverlay addToOverlayObjectExtension (AbstractObject overlayObjectExtension)
Description copied from class: Overlay
add a value to the overlayObjectExtension property collection
Overrides: addToOverlayObjectExtension
in class Overlay
Parameters: overlayObjectExtension
- Objects of the following type are allowed in the list: AbstractObject
Returns: true (as general contract of Collection.add ).
withAltitude
public GroundOverlay withAltitude (double altitude)
fluent setter
Parameters: altitude
- required parameterSee Also: setAltitude(double)
withAltitudeMode
public GroundOverlay withAltitudeMode (AltitudeMode altitudeMode)
fluent setter
Parameters: altitudeMode
- required parameterSee Also: #setAltitudeMode(Object)
withLatLonBox
public GroundOverlay withLatLonBox (LatLonBox latLonBox)
fluent setter
Parameters: latLonBox
- required parameterSee Also: setLatLonBox(LatLonBox)
withGroundOverlaySimpleExtension
public GroundOverlay withGroundOverlaySimpleExtension (java.util.List<java.lang.Object> groundOverlaySimpleExtension)
fluent setter
Parameters: groundOverlaySimpleExtension
- required parameterSee Also: #setGroundOverlaySimpleExtension(List)
withGroundOverlayObjectExtension
public GroundOverlay withGroundOverlayObjectExtension (java.util.List<AbstractObject > groundOverlayObjectExtension)
fluent setter
Parameters: groundOverlayObjectExtension
- required parameterSee Also: #setGroundOverlayObjectExtension(List)
withObjectSimpleExtension
public GroundOverlay withObjectSimpleExtension (java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter
Overrides: withObjectSimpleExtension
in class Overlay
Parameters: objectSimpleExtension
- required parameterSee Also: #setObjectSimpleExtension(List)
withId
public GroundOverlay withId (java.lang.String id)
Description copied from class: AbstractObject
fluent setter
Overrides: withId
in class Overlay
Parameters: id
- required parameterSee Also: AbstractObject.setId(String)
withTargetId
public GroundOverlay withTargetId (java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter
Overrides: withTargetId
in class Overlay
Parameters: targetId
- required parameterSee Also: AbstractObject.setTargetId(String)
withName
public GroundOverlay withName (java.lang.String name)
Description copied from class: Feature
fluent setter
Overrides: withName
in class Overlay
Parameters: name
- required parameterSee Also: Feature.setName(String)
withVisibility
public GroundOverlay withVisibility (java.lang.Boolean visibility)
Description copied from class: Feature
fluent setter
Overrides: withVisibility
in class Overlay
Parameters: visibility
- required parameterSee Also: Feature.setVisibility(Boolean)
withOpen
public GroundOverlay withOpen (java.lang.Boolean open)
Description copied from class: Feature
fluent setter
Overrides: withOpen
in class Overlay
Parameters: open
- required parameterSee Also: Feature.setOpen(Boolean)
withAtomAuthor
public GroundOverlay withAtomAuthor (Author atomAuthor)
Description copied from class: Feature
fluent setter
Overrides: withAtomAuthor
in class Overlay
Parameters: atomAuthor
- required parameterSee Also: Feature.setAtomAuthor(Author)
withAtomLink
public GroundOverlay withAtomLink (Link atomLink)
Description copied from class: Feature
fluent setter
Overrides: withAtomLink
in class Overlay
Parameters: atomLink
- required parameterSee Also: Feature.setAtomLink(Link)
withAddress
public GroundOverlay withAddress (java.lang.String address)
Description copied from class: Feature
fluent setter
Overrides: withAddress
in class Overlay
Parameters: address
- required parameterSee Also: Feature.setAddress(String)
withXalAddressDetails
public GroundOverlay withXalAddressDetails (AddressDetails xalAddressDetails)
Description copied from class: Feature
fluent setter
Overrides: withXalAddressDetails
in class Overlay
Parameters: xalAddressDetails
- required parameterSee Also: Feature.setXalAddressDetails(AddressDetails)
withPhoneNumber
public GroundOverlay withPhoneNumber (java.lang.String phoneNumber)
Description copied from class: Feature
fluent setter
Overrides: withPhoneNumber
in class Overlay
Parameters: phoneNumber
- required parameterSee Also: Feature.setPhoneNumber(String)
withSnippet
public GroundOverlay withSnippet (Snippet snippet)
Description copied from class: Feature
fluent setter
Overrides: withSnippet
in class Overlay
Parameters: snippet
- required parameterSee Also: Feature.setSnippet(Snippet)
withSnippetd
public GroundOverlay withSnippetd (java.lang.String snippetd)
Description copied from class: Feature
fluent setter
Overrides: withSnippetd
in class Overlay
Parameters: snippetd
- required parameterSee Also: Feature.setSnippetd(String)
withDescription
public GroundOverlay withDescription (java.lang.String description)
Description copied from class: Feature
fluent setter
Overrides: withDescription
in class Overlay
Parameters: description
- required parameterSee Also: Feature.setDescription(String)
withAbstractView
public GroundOverlay withAbstractView (AbstractView abstractView)
Description copied from class: Feature
fluent setter
Overrides: withAbstractView
in class Overlay
Parameters: abstractView
- required parameterSee Also: Feature.setAbstractView(AbstractView)
withTimePrimitive
public GroundOverlay withTimePrimitive (TimePrimitive timePrimitive)
Description copied from class: Feature
fluent setter
Overrides: withTimePrimitive
in class Overlay
Parameters: timePrimitive
- required parameterSee Also: Feature.setTimePrimitive(TimePrimitive)
withStyleUrl
public GroundOverlay withStyleUrl (java.lang.String styleUrl)
Description copied from class: Feature
fluent setter
Overrides: withStyleUrl
in class Overlay
Parameters: styleUrl
- required parameterSee Also: Feature.setStyleUrl(String)
withStyleSelector
public GroundOverlay withStyleSelector (java.util.List<StyleSelector > styleSelector)
Description copied from class: Feature
fluent setter
Overrides: withStyleSelector
in class Overlay
Parameters: styleSelector
- required parameterSee Also: #setStyleSelector(List)
withRegion
public GroundOverlay withRegion (Region region)
Description copied from class: Feature
fluent setter
Overrides: withRegion
in class Overlay
Parameters: region
- required parameterSee Also: Feature.setRegion(Region)
withMetadata
public GroundOverlay withMetadata (Metadata metadata)
Description copied from class: Feature
fluent setter
Overrides: withMetadata
in class Overlay
Parameters: metadata
- required parameterSee Also: Feature.setMetadata(Metadata)
withExtendedData
public GroundOverlay withExtendedData (ExtendedData extendedData)
Description copied from class: Feature
fluent setter
Overrides: withExtendedData
in class Overlay
Parameters: extendedData
- required parameterSee Also: Feature.setExtendedData(ExtendedData)
withFeatureSimpleExtension
public GroundOverlay withFeatureSimpleExtension (java.util.List<java.lang.Object> featureSimpleExtension)
Description copied from class: Feature
fluent setter
Overrides: withFeatureSimpleExtension
in class Overlay
Parameters: featureSimpleExtension
- required parameterSee Also: #setFeatureSimpleExtension(List)
withFeatureObjectExtension
public GroundOverlay withFeatureObjectExtension (java.util.List<AbstractObject > featureObjectExtension)
Description copied from class: Feature
fluent setter
Overrides: withFeatureObjectExtension
in class Overlay
Parameters: featureObjectExtension
- required parameterSee Also: #setFeatureObjectExtension(List)
withColor
public GroundOverlay withColor (java.lang.String color)
Description copied from class: Overlay
fluent setter
Overrides: withColor
in class Overlay
Parameters: color
- required parameterSee Also: Overlay.setColor(String)
withDrawOrder
public GroundOverlay withDrawOrder (int drawOrder)
Description copied from class: Overlay
fluent setter
Overrides: withDrawOrder
in class Overlay
Parameters: drawOrder
- required parameterSee Also: Overlay.setDrawOrder(int)
withIcon
public GroundOverlay withIcon (Icon icon)
Description copied from class: Overlay
fluent setter
Overrides: withIcon
in class Overlay
Parameters: icon
- required parameterSee Also: Overlay.setIcon(Icon)
withOverlaySimpleExtension
public GroundOverlay withOverlaySimpleExtension (java.util.List<java.lang.Object> overlaySimpleExtension)
Description copied from class: Overlay
fluent setter
Overrides: withOverlaySimpleExtension
in class Overlay
Parameters: overlaySimpleExtension
- required parameterSee Also: #setOverlaySimpleExtension(List)
withOverlayObjectExtension
public GroundOverlay withOverlayObjectExtension (java.util.List<AbstractObject > overlayObjectExtension)
Description copied from class: Overlay
fluent setter
Overrides: withOverlayObjectExtension
in class Overlay
Parameters: overlayObjectExtension
- required parameterSee Also: #setOverlayObjectExtension(List)
clone
public GroundOverlay clone ()
Overrides: clone
in class Overlay