Package armyc2.c5isr.renderer.utilities

Class MilStdSymbol

java.lang.Object

armyc2.c5isr.renderer.utilities.MilStdSymbol

public class MilStdSymbol
extends Object

Object that holds information on how to draw a multipoint symbol after WebRenderer.RenderMultiPointAsMilStdSymbol(String, String, String, String, String, String, double, String, Map, Map) is called.

Constructor Summary

Constructors

Constructor	Description
MilStdSymbol(String symbolID, String uniqueID, ArrayList<Point2D> Coordinates, Map<String,String> modifiers)	Creates a new MilStdSymbol.
MilStdSymbol(String symbolID, String uniqueID, ArrayList<Point2D> Coordinates, Map<String,String> modifiers, Boolean keepUnitRatio)

Method Summary

Modifier and Type	Method	Description
boolean	get_WasClipped()
String	getAltitudeMode()
DistanceUnit	getAltitudeUnit()
ArrayList<Point2D>	getCoordinates()
DistanceUnit	getDistanceUnit()
boolean	getDrawAffiliationModifierAsLabel()	Deprecated.
Color	getFillColor()
TexturePaint	getFillStyle()
boolean	getHideOptionalLabels()
boolean	getKeepUnitRatio()
Color	getLineColor()
int	getLineWidth()
String	getModifier(String modifier)
String	getModifier(String modifier, int index)
Double	getModifier_AM_AN_X(String modifier, int index)
Map<String,String>	getModifierMap()
ArrayList<Double>	getModifiers_AM_AN_X(String modifier)
ArrayList<ShapeInfo>	getModifierShapes()	Shapes that represent the symbol modifiers
Color	getOutlineColor()
int	getPatternFillType()	Deprecated.
double	getPatternScale()
String	getSymbolID()	The Symbol Id of the MilStdSymbol.
ArrayList<ShapeInfo>	getSymbolShapes()	the java shapes that make up the symbol
Object	getTag()	Deprecated.
Color	getTextBackgroundColor()
Color	getTextColor()
int	getUnitSize()
boolean	getUseDashArray()
boolean	getUseFillPattern()
boolean	getUseLineInterpolation()
String	getUUID()	Unique ID of the Symbol.
void	set_WasClipped(boolean value)
void	setAltitudeMode(String value)
void	setAltitudeUnit(DistanceUnit unit)
void	setCoordinates(ArrayList<Point2D> value)
void	setDistanceUnit(DistanceUnit unit)
void	setDrawAffiliationModifierAsLabel(boolean value)	Deprecated.
void	setFillColor(Color value)
void	setFillStyle(TexturePaint value)
void	setHideOptionalLabels(boolean value)
void	setKeepUnitRatio(boolean value)
void	setLineColor(Color value)	If value is null or SymbolUtilities.isGreenProtectionGraphic() is true then value is ignored
void	setLineWidth(int value)
void	setModifier(String modifier, String value)
void	setModifier(String modifier, String value, int index)	Modifiers must be added in order.
void	setModifier_AM_AN_X(String modifier, Double value, int index)
void	setModifierMap(Map<String,String> modifiers)
void	setModifiers_AM_AN_X(String modifier, ArrayList<Double> modifiers)
void	setModifierShapes(ArrayList<ShapeInfo> value)	Shapes that represent the symbol modifiers
void	setOutlineColor(Color value)	if null, renderer will use white or black for the outline based on the color of the symbol.
void	setPatternFillType(int value)	Deprecated.
void	setPatternScale(double scale)	Multipoint features and patterns scale with line width (getLineWidth()).
void	setSymbolID(String value)	Sets the Symbol ID for the symbol.
void	setSymbolShapes(ArrayList<ShapeInfo> value)	the java shapes that make up the symbol
void	setTag(Object value)	Deprecated.
void	setTextBackgroundColor(Color value)
void	setTextColor(Color value)
void	setUnitSize(int pixelSize)
void	setUseDashArray(boolean value)
void	setUseFillPattern(boolean value)
void	setUseLineInterpolation(boolean value)
void	setUUID(String ID)	Unique ID of the Symbol.

Methods inherited from class java.lang.Object

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

Constructor Details

MilStdSymbol

public MilStdSymbol(String symbolID,
 String uniqueID,
 ArrayList<Point2D> Coordinates,
 Map<String,String> modifiers)

Creates a new MilStdSymbol.

Parameters:

symbolID - code, 20-30 digits long that represents the symbol

uniqueID - for the client's use

Coordinates - modifiers

modifiers - use keys from Modifiers.

MilStdSymbol

public MilStdSymbol(String symbolID,
 String uniqueID,
 ArrayList<Point2D> Coordinates,
 Map<String,String> modifiers,
 Boolean keepUnitRatio)

Parameters:

symbolID - code, 20-30 digits long that represents the symbol

uniqueID - for the client's use

Coordinates -

modifiers - use keys from Modifiers.

keepUnitRatio - - default TRUE modifiers

Method Details

getFillStyle

public TexturePaint getFillStyle()

setFillStyle

public void setFillStyle(TexturePaint value)

getUseFillPattern

public boolean getUseFillPattern()

setUseFillPattern

public void setUseFillPattern(boolean value)

getPatternFillType

public int getPatternFillType()

Deprecated.

setPatternFillType

public void setPatternFillType(int value)

Deprecated.

0=Solid, 2=ForwardHatch, 3=BackwardHatch, 4=verticalHatch, 5=horizonalHatch, 8=CrossHatch Only affects Basic Shapes. Will not apply to MilStd Symbology so as to not confuse some symbols with others.

Parameters:

value -

getAltitudeMode

public String getAltitudeMode()

setAltitudeMode

public void setAltitudeMode(String value)

getAltitudeUnit

public DistanceUnit getAltitudeUnit()

setAltitudeUnit

public void setAltitudeUnit(DistanceUnit unit)

getDistanceUnit

public DistanceUnit getDistanceUnit()

setDistanceUnit

public void setDistanceUnit(DistanceUnit unit)

getUseDashArray

public boolean getUseDashArray()

setUseDashArray

public void setUseDashArray(boolean value)

getHideOptionalLabels

public boolean getHideOptionalLabels()

setHideOptionalLabels

public void setHideOptionalLabels(boolean value)

setUseLineInterpolation

public void setUseLineInterpolation(boolean value)

getUseLineInterpolation

public boolean getUseLineInterpolation()

setUnitSize

public void setUnitSize(int pixelSize)

getUnitSize

public int getUnitSize()

setKeepUnitRatio

public void setKeepUnitRatio(boolean value)

getKeepUnitRatio

public boolean getKeepUnitRatio()

setDrawAffiliationModifierAsLabel

public void setDrawAffiliationModifierAsLabel(boolean value)

Deprecated.

Determines how to draw the Affiliation Modifier. True to draw as modifier label in the "E/F" location. False to draw at the top right corner of the symbol

getDrawAffiliationModifierAsLabel

public boolean getDrawAffiliationModifierAsLabel()

Deprecated.

True to draw as modifier label in the "E/F" location. False to draw at the top right corner of the symbol

getModifierMap

public Map<String,String> getModifierMap()

Returns:

setModifierMap

public void setModifierMap(Map<String,String> modifiers)

Parameters:

modifiers -

getModifier

public String getModifier(String modifier)

Parameters:

modifier -

Returns:

setModifier

public void setModifier(String modifier,
 String value)

Parameters:

modifier -

value -

getModifier

public String getModifier(String modifier,
 int index)

Parameters:

modifier -

index -

Returns:

getModifier_AM_AN_X

public Double getModifier_AM_AN_X(String modifier,
 int index)

Parameters:

modifier -

index -

Returns:

setModifier

public void setModifier(String modifier,
 String value,
 int index)

Modifiers must be added in order. No setting index 2 without first setting index 0 and 1. If setting out of order is attempted, the value will just be added to the end of the list.

Parameters:

modifier -

value -

index -

setModifier_AM_AN_X

public void setModifier_AM_AN_X(String modifier,
 Double value,
 int index)

getModifiers_AM_AN_X

public ArrayList<Double> getModifiers_AM_AN_X(String modifier)

setModifiers_AM_AN_X

public void setModifiers_AM_AN_X(String modifier,
 ArrayList<Double> modifiers)

setFillColor

public void setFillColor(Color value)

Parameters:

value -

getFillColor

public Color getFillColor()

Returns:

setTextColor

public void setTextColor(Color value)

Parameters:

value -

getTextColor

public Color getTextColor()

Returns:

setTextBackgroundColor

public void setTextBackgroundColor(Color value)

Parameters:

value -

getTextBackgroundColor

public Color getTextBackgroundColor()

Returns:

setLineWidth

public void setLineWidth(int value)

Parameters:

value -

getLineWidth

public int getLineWidth()

Returns:

setLineColor

public void setLineColor(Color value)

If value is null or SymbolUtilities.isGreenProtectionGraphic() is true then value is ignored

Parameters:

value -

getLineColor

public Color getLineColor()

Returns:

setOutlineColor

public void setOutlineColor(Color value)

if null, renderer will use white or black for the outline based on the color of the symbol. Otherwise, it will used the passed color value.

Parameters:

value -

getOutlineColor

public Color getOutlineColor()

setTag

public void setTag(Object value)

Deprecated.

Extra value for client. defaults to null. Not used for rendering by JavaRenderer

Parameters:

value -

getTag

public Object getTag()

Deprecated.

Extra value for client. defaults to null. Not used for rendering by JavaRenderer

Returns:

setCoordinates

public void setCoordinates(ArrayList<Point2D> value)

Parameters:

value -

getCoordinates

public ArrayList<Point2D> getCoordinates()

Returns:

setModifierShapes

public void setModifierShapes(ArrayList<ShapeInfo> value)

Shapes that represent the symbol modifiers

Parameters:

value - ArrayList<Shape>

getModifierShapes

public ArrayList<ShapeInfo> getModifierShapes()

Shapes that represent the symbol modifiers

Returns:

setSymbolShapes

public void setSymbolShapes(ArrayList<ShapeInfo> value)

the java shapes that make up the symbol

Parameters:

value - ArrayList<ShapeInfo>

getSymbolShapes

public ArrayList<ShapeInfo> getSymbolShapes()

the java shapes that make up the symbol

Returns:

getSymbolID

public String getSymbolID()

The Symbol Id of the MilStdSymbol.

Returns:

getUUID

public String getUUID()

Unique ID of the Symbol. For client use.

Returns:

setUUID

public void setUUID(String ID)

Unique ID of the Symbol. For client use.

Parameters:

ID -

setSymbolID

public void setSymbolID(String value)

Sets the Symbol ID for the symbol. Should be a 20-30 digit string from the milstd.

Parameters:

value -

set_WasClipped

public void set_WasClipped(boolean value)

get_WasClipped

public boolean get_WasClipped()

setPatternScale

public void setPatternScale(double scale)

Multipoint features and patterns scale with line width (getLineWidth()). patternScale is the ratio of how much to increase features and patterns by with line width. default value is 1.0. Can be set with RendererSettings.setPatternScale(double) and MilStdAttributes.PatternScale

Parameters:

scale -

getPatternScale

public double getPatternScale()