gov.nasa.worldwind.render

Class SurfaceQuad

java.lang.Object

gov.nasa.worldwind.avlist.AVListImpl

gov.nasa.worldwind.WWObjectImpl

gov.nasa.worldwind.render.AbstractSurfaceObject

gov.nasa.worldwind.render.AbstractSurfaceShape

gov.nasa.worldwind.render.SurfaceQuad

All Implemented Interfaces:

AVList, Draggable, MessageListener, Exportable, ExtentHolder, MeasurableArea, MeasurableLength, Movable, Movable2, Attributable, Highlightable, OrderedRenderable, PreRenderable, Renderable, SurfaceObject, SurfaceRenderable, SurfaceShape, Restorable, Combinable, WWObject, PropertyChangeListener, EventListener

Direct Known Subclasses:

SurfaceSquare

public class SurfaceQuad
extends AbstractSurfaceShape
implements Exportable

Nested Class Summary

Nested classes/interfaces inherited from class gov.nasa.worldwind.render.AbstractSurfaceShape

AbstractSurfaceShape.GeometryKey, AbstractSurfaceShape.SurfaceShapeStateKey

Nested classes/interfaces inherited from class gov.nasa.worldwind.render.AbstractSurfaceObject

AbstractSurfaceObject.CacheEntry, AbstractSurfaceObject.SurfaceObjectStateKey

Field Summary

Fields

Modifier and Type	Field and Description
protected LatLon	center
protected Angle	heading
protected double	height
protected double	width

Fields inherited from class gov.nasa.worldwind.render.AbstractSurfaceShape

activeAttrs, activeGeometry, activeOutlineGeometry, areaMeasurer, areaMeasurerLastModifiedTime, DEFAULT_HIGHLIGHT_MATERIAL, DEFAULT_INTERIOR_MATERIAL, DEFAULT_MAX_EDGE_INTERVALS, DEFAULT_MIN_EDGE_INTERVALS, DEFAULT_OUTLINE_MATERIAL, DEFAULT_PATH_TYPE, DEFAULT_TEXELS_PER_EDGE_INTERVAL, defaultAttrs, dragEnabled, draggableSupport, geometryCache, highlightAttrs, highlighted, maxEdgeIntervals, minEdgeIntervals, normalAttrs, pathType, sectorCache, stackHandler, texelsPerEdgeInterval, texture, vertexBuffer

Fields inherited from class gov.nasa.worldwind.render.AbstractSurfaceObject

delegateOwner, drawBoundingSectors, enableBatchPicking, extentCache, lastModifiedTime, nextUniqueId, pickLayer, pickSupport, pickTileBuilder, uniqueId, visible

Fields inherited from interface gov.nasa.worldwind.Exportable

FORMAT_NOT_SUPPORTED, FORMAT_PARTIALLY_SUPPORTED, FORMAT_SUPPORTED

Constructor Summary

Constructors

Constructor and Description
SurfaceQuad() Constructs a new surface quad with the default attributes, default center location, default dimensions, and default heading.
SurfaceQuad(LatLon center, double width, double height) Constructs a new surface quad with the default attributes, the specified center location and dimensions (in meters).
SurfaceQuad(LatLon center, double width, double height, Angle heading) Constructs a new surface quad with the default attributes, the specified center location, dimensions (in meters), and heading clockwise from North.
SurfaceQuad(ShapeAttributes normalAttrs) Constructs a new surface quad with the specified normal (as opposed to highlight) attributes, default center location, default dimensions, and default heading.
SurfaceQuad(ShapeAttributes normalAttrs, LatLon center, double width, double height) Constructs a new surface quad with the specified normal (as opposed to highlight) attributes, the specified center location and dimensions (in meters).
SurfaceQuad(ShapeAttributes normalAttrs, LatLon center, double width, double height, Angle heading) Constructs a new surface quad with the specified normal (as opposed to highlight) attributes, the specified center location and dimensions (in meters).
SurfaceQuad(SurfaceQuad source) Creates a shallow copy of the specified source shape.

Method Summary

Modifier and Type	Method and Description
protected List<List<LatLon>>	createGeometry(Globe globe, double edgeIntervalsPerDegree)
protected void	doGetRestorableState(RestorableSupport rs, RestorableSupport.StateObject context)
protected void	doMoveTo(Globe globe, Position oldReferencePosition, Position newReferencePosition)
protected void	doMoveTo(Position oldReferencePosition, Position newReferencePosition)
protected void	doRestoreState(RestorableSupport rs, RestorableSupport.StateObject context)
protected void	exportAsKML(Object output) Export the polygon to KML as a <Placemark> element.
LatLon	getCenter()
Angle	getHeading()
double	getHeight()
Iterable<? extends LatLon>	getLocations(Globe globe) Returns the shape's locations as they appear on the specified globe, or null if the shape has no locations.
Position	getReferencePosition() A position associated with the object that indicates its aggregate geographic position.
Object	getStateKey(DrawContext dc) Returns an object that uniquely identifies this renderable's state for the specified draw context.
double	getWidth()
protected void	legacyRestoreState(RestorableSupport rs, RestorableSupport.StateObject context) Restores state values from previous versions of the SurfaceShape state XML.
void	setCenter(LatLon center)
void	setHeading(Angle heading)
void	setHeight(double height)
void	setSize(double width, double height)
void	setWidth(double width)

Methods inherited from class gov.nasa.worldwind.render.AbstractSurfaceShape

addIntermediateLocations, applyInteriorState, applyInteriorTextureState, applyModelviewTransform, applyOutlineState, beginDrawing, canContainPole, clearCaches, combine, combineBounds, combineContours, computeEdgeIntervalsPerDegree, computeEdgeIntervalsPerDegree, computeSectors, computeSectors, containsPole, createActiveAttributes, createGeometry, createGeometryKey, cutAlongDateLine, determineActiveAttributes, determineActiveGeometry, doCombineContour, doCombineContours, doDrag, doDrawGeographic, doTessellateInterior, drag, drawGeographic, drawInterior, drawLineStrip, drawOutline, endDrawing, export, generateIntermediateLocations, getActiveAttributes, getActiveGeometry, getArea, getArea, getAttributes, getCachedGeometry, getExtent, getHeight, getHighlightAttributes, getInteriorTexture, getLength, getMinAndMaxEdgeIntervals, getPathType, getPerimeter, getRestorableState, getSectors, getTexelsPerEdgeInterval, getWidth, handleUnsuccessfulInteriorTessellation, isDragEnabled, isExportFormatSupported, isHighlighted, isSectorEmpty, makeOrderedPreRenderable, move, moveTo, moveTo, onShapeChanged, pathTypeFromString, repeatAroundDateline, restoreState, setAttributes, setDragEnabled, setHighlightAttributes, setHighlighted, setMinAndMaxEdgeIntervals, setPathType, setTexelsPerEdgeInterval, setupAreaMeasurer, tessellateInterior, tessellateInteriorVertices

Methods inherited from class gov.nasa.worldwind.render.AbstractSurfaceObject

buildPickRepresentation, computeExtent, computeExtent, createPickedObject, createPickTileBuilder, drawBoundingSectors, drawOrderedRenderable, drawPickRepresentation, getDelegateOwner, getDistanceFromEye, getExtent, getUniqueId, intersectsFrustum, intersectsPickFrustum, intersectsVisibleSector, isDrawBoundingSectors, isEnableBatchPicking, isVisible, makeOrderedRenderable, nextUniqueId, pick, pickBatched, pickOrderedRenderable, preRender, render, setDelegateOwner, setDrawBoundingSectors, setEnableBatchPicking, setVisible, updateModifiedTime

Methods inherited from class gov.nasa.worldwind.WWObjectImpl

onMessage, propertyChange

Methods inherited from class gov.nasa.worldwind.avlist.AVListImpl

addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getBooleanValue, getBooleanValue, getChangeSupport, getDoubleValue, getDoubleValue, getEntries, getIntegerValue, getIntegerValue, getLongValue, getLongValue, getRestorableStateForAVPair, getStringValue, getStringValue, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues

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.Exportable

export, isExportFormatSupported

Methods inherited from interface gov.nasa.worldwind.render.SurfaceObject

getDelegateOwner, getDistanceFromEye, getExtent, isEnableBatchPicking, isVisible, pick, preRender, setDelegateOwner, setEnableBatchPicking, setVisible

Methods inherited from interface gov.nasa.worldwind.render.Renderable

render

Methods inherited from interface gov.nasa.worldwind.avlist.AVList

addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getEntries, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues

Field Detail

center

protected LatLon center

heading

protected Angle heading

height

protected double height

width

protected double width

Constructor Detail

SurfaceQuad

public SurfaceQuad()

Constructs a new surface quad with the default attributes, default center location, default dimensions, and default heading.

SurfaceQuad

public SurfaceQuad(LatLon center,
                   double width,
                   double height)

Constructs a new surface quad with the default attributes, the specified center location and dimensions (in meters).

Parameters:

center - the quad's center location.

width - the quad's width, in meters.

height - the quad's height, in meters.

Throws:

IllegalArgumentException - if the center is null, or if the width or height are negative.

SurfaceQuad

public SurfaceQuad(LatLon center,
                   double width,
                   double height,
                   Angle heading)

Constructs a new surface quad with the default attributes, the specified center location, dimensions (in meters), and heading clockwise from North.

Parameters:

center - the quad's center location.

width - the quad's width, in meters.

height - the quad's height, in meters.

heading - the quad's heading, clockwise from North.

Throws:

IllegalArgumentException - if the center or heading are null, or if the width or height are negative.

SurfaceQuad

public SurfaceQuad(ShapeAttributes normalAttrs)

Constructs a new surface quad with the specified normal (as opposed to highlight) attributes, default center location, default dimensions, and default heading. Modifying the attribute reference after calling this constructor causes this shape's appearance to change accordingly.

Parameters:

normalAttrs - the normal attributes. May be null, in which case default attributes are used.

SurfaceQuad

public SurfaceQuad(ShapeAttributes normalAttrs,
                   LatLon center,
                   double width,
                   double height)

Constructs a new surface quad with the specified normal (as opposed to highlight) attributes, the specified center location and dimensions (in meters). Modifying the attribute reference after calling this constructor causes this shape's appearance to change accordingly.

Parameters:

normalAttrs - the normal attributes. May be null, in which case default attributes are used.

center - the quad's center location.

width - the quad's width, in meters.

height - the quad's height, in meters.

Throws:

IllegalArgumentException - if the center is null, or if the width or height are negative.

SurfaceQuad

public SurfaceQuad(ShapeAttributes normalAttrs,
                   LatLon center,
                   double width,
                   double height,
                   Angle heading)

Constructs a new surface quad with the specified normal (as opposed to highlight) attributes, the specified center location and dimensions (in meters). Modifying the attribute reference after calling this constructor causes this shape's appearance to change accordingly.

Parameters:

normalAttrs - the normal attributes. May be null, in which case default attributes are used.

center - the quad's center location.

width - the quad's width, in meters.

height - the quad's height, in meters.

heading - the quad's heading, clockwise from North.

Throws:

IllegalArgumentException - if the center or heading are null, or if the width or height are negative.

SurfaceQuad

public SurfaceQuad(SurfaceQuad source)

Creates a shallow copy of the specified source shape.

Parameters:

source - the shape to copy.

Method Detail

createGeometry

protected List<List<LatLon>> createGeometry(Globe globe,
                                            double edgeIntervalsPerDegree)

Specified by:

createGeometry in class AbstractSurfaceShape

doGetRestorableState

protected void doGetRestorableState(RestorableSupport rs,
                                    RestorableSupport.StateObject context)

Overrides:

doGetRestorableState in class AbstractSurfaceShape

doMoveTo

protected void doMoveTo(Globe globe,
                        Position oldReferencePosition,
                        Position newReferencePosition)

Specified by:

doMoveTo in class AbstractSurfaceShape

doMoveTo

protected void doMoveTo(Position oldReferencePosition,
                        Position newReferencePosition)

Specified by:

doMoveTo in class AbstractSurfaceShape

doRestoreState

protected void doRestoreState(RestorableSupport rs,
                              RestorableSupport.StateObject context)

Overrides:

doRestoreState in class AbstractSurfaceShape

exportAsKML

protected void exportAsKML(Object output)
                    throws IOException,
                           XMLStreamException

Export the polygon to KML as a <Placemark> element. The output object will receive the data. This object must be one of: java.io.Writer java.io.OutputStream javax.xml.stream.XMLStreamWriter

Overrides:

exportAsKML in class AbstractSurfaceShape

Parameters:

output - Object to receive the generated KML.

Throws:

XMLStreamException - If an exception occurs while writing the KML

IOException - if an exception occurs while exporting the data.

See Also:

AbstractSurfaceShape.export(String, Object)

getCenter

public LatLon getCenter()

getHeading

public Angle getHeading()

getHeight

public double getHeight()

getLocations

public Iterable<? extends LatLon> getLocations(Globe globe)

Description copied from interface: SurfaceShape

Returns the shape's locations as they appear on the specified globe, or null if the shape has no locations.

Specified by:

getLocations in interface SurfaceShape

Parameters:

globe - the globe the shape is related to.

Returns:

the shapes locations on the globe, or null if the shape has no locations.

getReferencePosition

public Position getReferencePosition()

Description copied from interface: Movable

A position associated with the object that indicates its aggregate geographic position. The chosen position varies among implementers of this interface. For objects defined by a list of positions, the reference position is typically the first position in the list. For symmetric objects the reference position is often the center of the object. In many cases the object's reference position may be explicitly specified by the application.

Specified by:

getReferencePosition in interface Movable

Specified by:

getReferencePosition in interface Movable2

Specified by:

getReferencePosition in class AbstractSurfaceShape

Returns:

the object's reference position, or null if no reference position is available.

getStateKey

public Object getStateKey(DrawContext dc)

Returns an object that uniquely identifies this renderable's state for the specified draw context.

Callers can perform an equality test on two state keys using Object.equals(Object) in order to determine whether or not a renderable has changed. The returned object is guaranteed to be globally unique with respect to other SurfaceRenderable state keys; an equality test with a state key from another renderable always returns false.

The returned state key is constructed the SurfaceShape's unique ID, last modified time, and its active attributes. The returned state key has no dependency on the Globe. Subclasses that depend on the Globe should return a state key that include the globe's state key.

Overridden to include the globe's state key in the returned state key.

Specified by:

getStateKey in interface SurfaceRenderable

Overrides:

getStateKey in class AbstractSurfaceShape

Parameters:

dc - the draw context for which to determine this renderable's current state.

Returns:

an object representing this renderable's current state.

See Also:

Globe.getStateKey(DrawContext)

getWidth

public double getWidth()

legacyRestoreState

protected void legacyRestoreState(RestorableSupport rs,
                                  RestorableSupport.StateObject context)

Description copied from class: AbstractSurfaceShape

Restores state values from previous versions of the SurfaceShape state XML. These values are stored or named differently than the current implementation. Those values which have not changed are ignored here, and will restored in AbstractSurfaceShape.doRestoreState(gov.nasa.worldwind.util.RestorableSupport, gov.nasa.worldwind.util.RestorableSupport.StateObject).

Overrides:

legacyRestoreState in class AbstractSurfaceShape

Parameters:

rs - RestorableSupport object which contains the state value properties.

context - active context in the RestorableSupport to read state from.

setCenter

public void setCenter(LatLon center)

setHeading

public void setHeading(Angle heading)

setHeight

public void setHeight(double height)

setSize

public void setSize(double width,
                    double height)

setWidth

public void setWidth(double width)