gov.nasa.worldwind.symbology.milstd2525.graphics.lines

Class PhaseLine

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.lines.PhaseLine

All Implemented Interfaces:

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

Direct Known Subclasses:

Boundary, ForwardLineOfOwnTroops

public class PhaseLine
extends AbstractMilStd2525TacticalGraphic

Implementation of phase line graphics. This class implements the following graphics:

• Phase Line (2.X.2.1.2.4)
• Light Line (2.X.2.1.2.5)
• Final Coordination Line (2.X.2.5.2.3)
• Limits of Advance (2.X.2.5.2.5)
• Line of Departure (2.X.2.5.2.6)
• Line of Departure/Line of Contact (2.X.2.5.2.7)
• Line of Departure/Line of Contact (2.X.2.5.2.8)
• Release Line (2.X.2.6.1.3)
• No-Fire Line (2.X.4.2.2.3)

Field Summary

Fields

Modifier and Type	Field and Description
protected Path	path Path used to render the line.
protected static int	PLD_OUTLINE_STIPPLE_FACTOR Factor applied to the stipple pattern used to draw the dashed line for a Probable Line of Deployment.

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
PhaseLine(java.lang.String sidc) Create a new Phase Line.

Method Summary

Modifier and Type	Method and Description
protected void	applyDefaultAttributes(ShapeAttributes attributes) Apply defaults to the active attributes bundle.
protected void	applyDelegateOwner(java.lang.Object owner) Invoked each frame to apply to the current delegate owner to all renderable objects used to draw the graphic.
protected void	createLabels() Create labels for the start and end of the path.
protected Path	createPath() Create and configure the Path used to render this graphic.
protected void	determineLabelPositions(DrawContext dc) Determine positions for the start and end labels.
protected void	doRenderGraphic(DrawContext dc) Render this graphic, without modifiers.
protected java.lang.String	getGraphicLabel()
java.lang.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 java.util.List<java.lang.String>	getSupportedGraphics() Indicates the graphics supported by this class.
void	setPositions(java.lang.Iterable<? extends Position> positions) Specifies the positions of the control points that place and orient the graphic.

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

createSymbol, getDefaultMaterial, getIdentifier, getModifier, getOutlineStippleFactor, getOutlineStipplePattern, getStatus, getText, mustShowHostileIndicator, setModifier, setStatus

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

addLabel, applyLabelAttributes, applyOverrideAttributes, computeGeometry, computeLabelInteriorOpacity, determineActiveAttributes, determineDelegateOwner, 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

path

protected Path path

Path used to render the line.

PLD_OUTLINE_STIPPLE_FACTOR

protected static final int PLD_OUTLINE_STIPPLE_FACTOR

Factor applied to the stipple pattern used to draw the dashed line for a Probable Line of Deployment.

See Also:

Constant Field Values

Constructor Detail

PhaseLine

public PhaseLine(java.lang.String sidc)

Create a new Phase Line.

Parameters:

sidc - Symbol code the identifies the graphic.

Method Detail

applyDefaultAttributes

protected void applyDefaultAttributes(ShapeAttributes attributes)

Description copied from class: AbstractMilStd2525TacticalGraphic

Apply defaults to the active attributes bundle. The default attributes are determined by the type of graphic. This method is called each frame to reset the active shape attributes to the appropriate default state. Override attributes specified by the application may be applied after the defaults have been set.

Overrides:

applyDefaultAttributes in class AbstractMilStd2525TacticalGraphic

Parameters:

attributes - Attributes bundle to receive defaults.

applyDelegateOwner

protected void applyDelegateOwner(java.lang.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.

createLabels

protected void createLabels()

Create labels for the start and end of the path.

Overrides:

createLabels in class AbstractTacticalGraphic

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.

determineLabelPositions

protected void determineLabelPositions(DrawContext dc)

Determine positions for the start and end labels.

Overrides:

determineLabelPositions in class AbstractTacticalGraphic

Parameters:

dc - Current draw context.

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)

getGraphicLabel

protected java.lang.String getGraphicLabel()

getPositions

public java.lang.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 java.util.List<java.lang.String> getSupportedGraphics()

Indicates the graphics supported by this class.

Returns:

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

setPositions

public void setPositions(java.lang.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.