gov.nasa.worldwind.ogc.kml
Class KMLGroundOverlay

java.lang.Object
  gov.nasa.worldwind.util.xml.AbstractXMLEventParser
      gov.nasa.worldwind.ogc.kml.KMLAbstractObject
          gov.nasa.worldwind.ogc.kml.KMLAbstractFeature
              gov.nasa.worldwind.ogc.kml.KMLAbstractOverlay
                  gov.nasa.worldwind.ogc.kml.KMLGroundOverlay

All Implemented Interfaces:

MessageListener, KMLRenderable, XMLEventParser

public class KMLGroundOverlay
extends KMLAbstractOverlay
implements KMLRenderable

Represents the KML GroundOverlay element and provides access to its contents.

Field Summary

protected KMLRenderable

renderable

Fields inherited from class gov.nasa.worldwind.ogc.kml.KMLAbstractFeature

balloon, region, styleSelectors, visibility

Fields inherited from class gov.nasa.worldwind.ogc.kml.KMLAbstractObject

MSG_BOX_CHANGED, MSG_GEOMETRY_CHANGED, MSG_LINK_CHANGED, MSG_STYLE_CHANGED, MSG_TIME_CHANGED, MSG_VIEW_CHANGED

Fields inherited from class gov.nasa.worldwind.util.xml.AbstractXMLEventParser

CHARACTERS_CONTENT, fields, namespaceURI, parent

Constructor Summary

KMLGroundOverlay(String namespaceURI)
Construct an instance.

Method Summary

void	applyChange(KMLAbstractObject sourceValues)
protected void	doPreRender(KMLTraversalContext tc, DrawContext dc) Pre-renders the ground overlay geometry represented by this KMLGroundOverlay.
protected void	doRender(KMLTraversalContext tc, DrawContext dc) Renders the ground overlay geometry represented by this KMLGroundOverlay.
Double	getAltitude()
String	getAltitudeMode()
KMLLatLonBox	getLatLonBox()
GXLatLongQuad	getLatLonQuad()
Position.PositionList	getPositions() Convenience method to get the positions defined by either LatLonBox or gx:LatLonQuad.
KMLRenderable	getRenderable() Get the renderable that represents the screen overlay.
protected void	initializeRenderable(KMLTraversalContext tc) Create the renderable that will represent the overlay.
void	onChange(Message msg)

Methods inherited from class gov.nasa.worldwind.ogc.kml.KMLAbstractOverlay

getColor, getDrawOrder, getIcon

Methods inherited from class gov.nasa.worldwind.ogc.kml.KMLAbstractFeature

addStyleSelector, doAddEventContent, getAddress, getAddressDetails, getAuthor, getBalloon, getDescription, getExtendedData, getLink, getName, getOpen, getPhoneNumber, getRegion, getSnippet, getSnippetText, getStyleSelectors, getStyleUrl, getSubStyle, getTimePrimitive, getView, getVisibility, hasStyle, hasStyleSelectors, isFeatureActive, mergeStyleSelectors, preRender, render, renderBalloon, setBalloon, setRegion, setTimePrimitive, setView, setVisibility

Methods inherited from class gov.nasa.worldwind.ogc.kml.KMLAbstractObject

getId, getRoot, getTargetId, onMessage

Methods inherited from class gov.nasa.worldwind.util.xml.AbstractXMLEventParser

allocate, doAddCharacters, doAddEventAttribute, doParseEventAttributes, doParseEventContent, freeResources, getAConstructor, getCharacters, getField, getField, getFields, getNamespaceURI, getParent, hasField, hasField, hasFields, mergeFields, newInstance, overrideFields, parse, parseCharacterContent, removeField, setField, setField, setFields, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gov.nasa.worldwind.ogc.kml.impl.KMLRenderable

preRender, render

Methods inherited from interface gov.nasa.worldwind.event.MessageListener

onMessage

Field Detail

renderable

protected KMLRenderable renderable

Constructor Detail

KMLGroundOverlay

public KMLGroundOverlay(String namespaceURI)

Construct an instance.

Parameters:

namespaceURI - the qualifying namespace URI. May be null to indicate no namespace qualification.

Method Detail

applyChange

public void applyChange(KMLAbstractObject sourceValues)

Overrides:

applyChange in class KMLAbstractFeature

doPreRender

protected void doPreRender(KMLTraversalContext tc,
                           DrawContext dc)

Pre-renders the ground overlay geometry represented by this KMLGroundOverlay. This initializes the ground overlay geometry if necessary, prior to pre-rendering.

Overrides:

doPreRender in class KMLAbstractFeature

Parameters:

tc - the current KML traversal context.

dc - the current draw context.

doRender

protected void doRender(KMLTraversalContext tc,
                        DrawContext dc)

Renders the ground overlay geometry represented by this KMLGroundOverlay.

Overrides:

doRender in class KMLAbstractFeature

Parameters:

tc - the current KML traversal context.

dc - the current draw context.

getAltitude

public Double getAltitude()

getAltitudeMode

public String getAltitudeMode()

getLatLonBox

public KMLLatLonBox getLatLonBox()

getLatLonQuad

public GXLatLongQuad getLatLonQuad()

getPositions

public Position.PositionList getPositions()

Convenience method to get the positions defined by either LatLonBox or gx:LatLonQuad. If the overlay includes a LatLonBox element, this method returns the corners of the sector defined by the LatLonBox. Otherwise, if the overlay contains a gx:LatLonQuad, this method returns the positions defined by the quad.

Returns:

A list of the positions that define the corner points of the overlay.

getRenderable

public KMLRenderable getRenderable()

Get the renderable that represents the screen overlay. The renderable is created the first time that the overlay is rendered. Until then, the method will return null.

Returns:

The renderable, or null if the renderable has not been created yet.

initializeRenderable

protected void initializeRenderable(KMLTraversalContext tc)

Create the renderable that will represent the overlay.

Parameters:

tc - the current KML traversal context.

onChange

public void onChange(Message msg)

Overrides:

onChange in class KMLAbstractObject