gov.nasa.worldwind.symbology.milstd2525.graphics.areas

Class LimitedAccessArea

java.lang.Object

gov.nasa.worldwind.avlist.AVListImpl

gov.nasa.worldwind.symbology.AbstractTacticalGraphic

gov.nasa.worldwind.symbology.milstd2525.AbstractMilStd2525TacticalGraphic

gov.nasa.worldwind.symbology.milstd2525.graphics.areas.LimitedAccessArea

All Implemented Interfaces:

AVList, Draggable, Movable, Highlightable, Renderable, MilStd2525TacticalGraphic, TacticalGraphic

public class LimitedAccessArea
extends AbstractMilStd2525TacticalGraphic

Implementation of the Limited Access Area graphic (2.X.2.1.3.10). This graphic draws a symbol inside of a pentagon. The graphic requires at least one control point, which specifies the position of the vertex of the pentagon. If a second control point is provided, then a line will be drawn from the vertex of the pentagon to this point. Note that the SymbologyConstants.SYMBOL_INDICATOR modifier must be set or the pentagon will not be rendered.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	altitudeMode Altitude mode for this graphic.
protected Position	attachmentPosition
protected Path	path
protected TacticalSymbol	symbol
protected TacticalSymbolAttributes	symbolAttributes Attributes applied to the symbol.
protected Position	symbolPosition

Fields inherited from class gov.nasa.worldwind.symbology.milstd2525.AbstractMilStd2525TacticalGraphic

maskedSymbolCode, OUTLINE_STIPPLE_FACTOR_ANTICIPATED, OUTLINE_STIPPLE_FACTOR_PRESENT, OUTLINE_STIPPLE_PATTERN, symbolCode

Fields inherited from class gov.nasa.worldwind.symbology.AbstractTacticalGraphic

activeOverrides, activeShapeAttributes, DEFAULT_HIGHLIGHT_MATERIAL, DEFAULT_LABEL_INTERIOR_OPACITY, delegateOwner, dragEnabled, draggableSupport, frameTimestamp, highlightAttributes, highlighted, labelOffset, labels, modifiers, mustCreateLabels, normalAttributes, showGraphicModifiers, showHostileIndicator, showLocation, showTextModifiers, text, unitsFormat, visible

Constructor Summary

Constructors

Constructor and Description
LimitedAccessArea(String symbolCode)

Method Summary

Modifier and Type	Method and Description
protected void	applyDelegateOwner(Object owner) Invoked each frame to apply to the current delegate owner to all renderable objects used to draw the graphic.
protected Path	createPath() Create and configure the Path used to render this graphic.
protected TacticalSymbol	createSymbol(String sidc)
protected void	determineActiveAttributes() Determine active attributes for this frame.
protected void	doRenderGraphic(DrawContext dc) Render this graphic, without modifiers.
int	getAltitudeMode() Indicates this graphic's altitude mode.
Object	getModifier(String modifier) Indicates the current value of a text or graphic modifier.
Iterable<? extends Position>	getPositions() Indicates the positions of the control points that place and orient the graphic.
Position	getReferencePosition() A position associated with the object that indicates its aggregate geographic position.
static List<String>	getSupportedGraphics() Indicates the graphics supported by this class.
String	getSymbol() Indicates a symbol drawn at the center of the range fan.
void	setAltitudeMode(int altitudeMode) Specifies this graphic's altitude mode.
void	setModifier(String modifier, Object value) Specifies the value of a text or graphic modifier.
void	setPositions(Iterable<? extends Position> positions) Specifies the positions of the control points that place and orient the graphic.
void	setSymbol(String sidc) Specifies a symbol to draw at the center of the range fan.

Methods inherited from class gov.nasa.worldwind.symbology.milstd2525.AbstractMilStd2525TacticalGraphic

applyDefaultAttributes, createSymbol, getDefaultMaterial, getIdentifier, getOutlineStippleFactor, getOutlineStipplePattern, getStatus, getText, mustShowHostileIndicator, setStatus

Methods inherited from class gov.nasa.worldwind.symbology.AbstractTacticalGraphic

addLabel, applyLabelAttributes, applyOverrideAttributes, computeGeometry, computeLabelInteriorOpacity, createLabels, determineDelegateOwner, determineLabelPositions, determinePerFrameAttributes, doDrag, doRenderGraphicModifiers, doRenderTextModifiers, drag, getActiveDelegateOwner, getActiveOverrideAttributes, getActiveShapeAttributes, getAttributes, getDefaultLabelOffset, getDelegateOwner, getHighlightAttributes, getLabelMaterial, getLabelOffset, getUnitsFormat, isDragEnabled, isHighlighted, isShowGraphicModifiers, isShowHostileIndicator, isShowLocation, isShowTextModifiers, isVisible, move, moveTo, onModifierChanged, render, setAttributes, setDelegateOwner, setDragEnabled, setHighlightAttributes, setHighlighted, setLabelOffset, setShowGraphicModifiers, setShowHostileIndicator, setShowLocation, setShowTextModifiers, setText, setUnitsFormat, setVisible

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.symbology.TacticalGraphic

getAttributes, getDelegateOwner, getHighlightAttributes, getLabelOffset, getUnitsFormat, isShowGraphicModifiers, isShowHostileIndicator, isShowLocation, isShowTextModifiers, isVisible, setAttributes, setDelegateOwner, setHighlightAttributes, setLabelOffset, setShowGraphicModifiers, setShowHostileIndicator, setShowLocation, setShowTextModifiers, setText, setUnitsFormat, setVisible

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

render

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

isHighlighted, setHighlighted

Methods inherited from interface gov.nasa.worldwind.Movable

move, moveTo

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

altitudeMode

protected int altitudeMode

Altitude mode for this graphic.

attachmentPosition

protected Position attachmentPosition

path

protected Path path

symbol

protected TacticalSymbol symbol

symbolAttributes

protected TacticalSymbolAttributes symbolAttributes

Attributes applied to the symbol.

symbolPosition

protected Position symbolPosition

Constructor Detail

LimitedAccessArea

public LimitedAccessArea(String symbolCode)

Method Detail

applyDelegateOwner

protected void applyDelegateOwner(Object owner)

Invoked each frame to apply to the current delegate owner to all renderable objects used to draw the graphic. This base class will apply the delegate owner to Label objects. Subclasses must implement this method to apply the delegate owner to any Renderables that they will draw in order to render the graphic.

Specified by:

applyDelegateOwner in class AbstractTacticalGraphic

Parameters:

owner - Current delegate owner.

createPath

protected Path createPath()

Create and configure the Path used to render this graphic.

Returns:

New path configured with defaults appropriate for this type of graphic.

createSymbol

protected TacticalSymbol createSymbol(String sidc)

determineActiveAttributes

protected void determineActiveAttributes()

Determine active attributes for this frame. Overridden to update symbol attributes.

Overrides:

determineActiveAttributes in class AbstractTacticalGraphic

doRenderGraphic

protected void doRenderGraphic(DrawContext dc)

Render this graphic, without modifiers.

Specified by:

doRenderGraphic in class AbstractTacticalGraphic

Parameters:

dc - Current draw context.

See Also:

AbstractTacticalGraphic.doRenderTextModifiers(gov.nasa.worldwind.render.DrawContext), AbstractTacticalGraphic.doRenderGraphicModifiers(gov.nasa.worldwind.render.DrawContext)

getAltitudeMode

public int getAltitudeMode()

Indicates this graphic's altitude mode. See setAltitudeMode(int) for a description of the valid altitude modes.

Returns:

this graphic's altitude mode.

getModifier

public Object getModifier(String modifier)

Indicates the current value of a text or graphic modifier.

Specified by:

getModifier in interface TacticalGraphic

Overrides:

getModifier in class AbstractMilStd2525TacticalGraphic

Parameters:

modifier - Key that identifies the modifier to retrieve. The possible modifiers depends on the symbol set.

Returns:

The value of the modifier, or null if the modifier is not set.

getPositions

public Iterable<? extends Position> getPositions()

Indicates the positions of the control points that place and orient the graphic.

Returns:

positions that orient the graphic. How many positions are returned depends on the type of graphic. Some graphics require only a single position, others require many.

getReferencePosition

public Position getReferencePosition()

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.

Returns:

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

getSupportedGraphics

public static List<String> getSupportedGraphics()

Indicates the graphics supported by this class.

Returns:

List of masked SIDC strings that identify graphics that this class supports.

getSymbol

public String getSymbol()

Indicates a symbol drawn at the center of the range fan.

Returns:

The symbol drawn at the center of the range fan. May be null.

setAltitudeMode

public void setAltitudeMode(int altitudeMode)

Specifies this graphic's altitude mode. Altitude mode defines how the altitude component of this graphic's position is interpreted. Recognized modes are:

• WorldWind.CLAMP_TO_GROUND -- this graphic is placed on the terrain at the latitude and longitude of its position.
• WorldWind.RELATIVE_TO_GROUND -- this graphic is placed above the terrain at the latitude and longitude of its position and the distance specified by its elevation.
• WorldWind.ABSOLUTE -- this graphic is placed at its specified position.

This symbol assumes the altitude mode WorldWind.ABSOLUTE if the specified mode is not recognized.

Parameters:

altitudeMode - this graphic new altitude mode.

setModifier

public void setModifier(String modifier,
                        Object value)

Specifies the value of a text or graphic modifier.

Specified by:

setModifier in interface TacticalGraphic

Overrides:

setModifier in class AbstractMilStd2525TacticalGraphic

Parameters:

modifier - Key that identifies the modifier to set. The possible modifiers depends on the symbol set.

value - New value for the modifier.

setPositions

public void setPositions(Iterable<? extends Position> positions)

Specifies the positions of the control points that place and orient the graphic.

Parameters:

positions - Positions that orient the graphic. How many positions are returned depends on the type of graphic. Some graphics require only a single position, others require many. The positions must be specified in the same order as the control points defined by the symbology set's template for this type of graphic.

setSymbol

public void setSymbol(String sidc)

Specifies a symbol to draw at the center of the range fan. Equivalent to setting the SymbologyConstants.SYMBOL_INDICATOR modifier. The symbol's position will be changed to match the range fan center position.

Parameters:

sidc - Identifier for a MIL-STD-2525C symbol to draw at the center of the range fan. May be null to indicate that no symbol is drawn.