Package armyc2.c5isr.renderer.utilities
Class MilStdSymbol
- java.lang.Object
-
- armyc2.c5isr.renderer.utilities.MilStdSymbol
-
public class MilStdSymbol extends java.lang.Object
Object that holds information on how to draw a multipoint symbol afterWebRenderer.RenderMultiPointAsMilStdSymbol(String, String, String, String, String, String, double, String, Map, Map)
is called.
-
-
Constructor Summary
Constructors Constructor Description MilStdSymbol(java.lang.String symbolID, java.lang.String uniqueID, java.util.ArrayList<java.awt.geom.Point2D> Coordinates, java.util.Map<java.lang.String,java.lang.String> modifiers)
Creates a new MilStdSymbol.MilStdSymbol(java.lang.String symbolID, java.lang.String uniqueID, java.util.ArrayList<java.awt.geom.Point2D> Coordinates, java.util.Map<java.lang.String,java.lang.String> modifiers, java.lang.Boolean keepUnitRatio)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
get_WasClipped()
java.lang.String
getAltitudeMode()
DistanceUnit
getAltitudeUnit()
java.util.ArrayList<java.awt.geom.Point2D>
getCoordinates()
DistanceUnit
getDistanceUnit()
boolean
getDrawAffiliationModifierAsLabel()
Deprecated.java.awt.Color
getFillColor()
java.awt.TexturePaint
getFillStyle()
boolean
getHideOptionalLabels()
boolean
getKeepUnitRatio()
java.awt.Color
getLineColor()
int
getLineWidth()
java.lang.String
getModifier(java.lang.String modifier)
Get a modifier valuejava.lang.String
getModifier(java.lang.String modifier, int index)
Gets modifier value based on modifier constant and index in arrayjava.lang.Double
getModifier_AM_AN_X(java.lang.String modifier, int index)
Get modifier value for AM, AN or Xjava.util.Map<java.lang.String,java.lang.String>
getModifierMap()
Returns the modifier map for the symboljava.util.ArrayList<java.lang.Double>
getModifiers_AM_AN_X(java.lang.String modifier)
java.util.ArrayList<ShapeInfo>
getModifierShapes()
Shapes that represent the symbol modifiersjava.awt.Color
getOutlineColor()
int
getPatternFillType()
Deprecated.double
getPatternScale()
java.lang.String
getSymbolID()
The Symbol Id of the MilStdSymbol.java.util.ArrayList<ShapeInfo>
getSymbolShapes()
the java shapes that make up the symboljava.lang.Object
getTag()
Deprecated.java.awt.Color
getTextBackgroundColor()
java.awt.Color
getTextColor()
int
getUnitSize()
boolean
getUseDashArray()
boolean
getUseFillPattern()
boolean
getUseLineInterpolation()
java.lang.String
getUUID()
Unique ID of the Symbol.void
set_WasClipped(boolean value)
void
setAltitudeMode(java.lang.String value)
void
setAltitudeUnit(DistanceUnit unit)
void
setCoordinates(java.util.ArrayList<java.awt.geom.Point2D> value)
void
setDistanceUnit(DistanceUnit unit)
void
setDrawAffiliationModifierAsLabel(boolean value)
Deprecated.void
setFillColor(java.awt.Color value)
void
setFillStyle(java.awt.TexturePaint value)
void
setHideOptionalLabels(boolean value)
void
setKeepUnitRatio(boolean value)
void
setLineColor(java.awt.Color value)
If value is null or SymbolUtilities.isGreenProtectionGraphic() is true then value is ignoredvoid
setLineWidth(int value)
void
setModifier(java.lang.String modifier, java.lang.String value)
Set a modifier valuevoid
setModifier(java.lang.String modifier, java.lang.String value, int index)
Modifiers must be added in order.void
setModifier_AM_AN_X(java.lang.String modifier, java.lang.Double value, int index)
void
setModifierMap(java.util.Map<java.lang.String,java.lang.String> modifiers)
sets the modifier map for the symbolvoid
setModifiers_AM_AN_X(java.lang.String modifier, java.util.ArrayList<java.lang.Double> modifiers)
void
setModifierShapes(java.util.ArrayList<ShapeInfo> value)
Shapes that represent the symbol modifiersvoid
setOutlineColor(java.awt.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(java.lang.String value)
Sets the Symbol ID for the symbol.void
setSymbolShapes(java.util.ArrayList<ShapeInfo> value)
the java shapes that make up the symbolvoid
setTag(java.lang.Object value)
Deprecated.void
setTextBackgroundColor(java.awt.Color value)
void
setTextColor(java.awt.Color value)
void
setUnitSize(int pixelSize)
void
setUseDashArray(boolean value)
void
setUseFillPattern(boolean value)
void
setUseLineInterpolation(boolean value)
void
setUUID(java.lang.String ID)
Unique ID of the Symbol.
-
-
-
Constructor Detail
-
MilStdSymbol
public MilStdSymbol(java.lang.String symbolID, java.lang.String uniqueID, java.util.ArrayList<java.awt.geom.Point2D> Coordinates, java.util.Map<java.lang.String,java.lang.String> modifiers)
Creates a new MilStdSymbol.- Parameters:
symbolID
- code, 20-30 digits long that represents the symboluniqueID
- for the client's usemodifiers
- use keys from Modifiers.Coordinates
- modifiers
-
MilStdSymbol
public MilStdSymbol(java.lang.String symbolID, java.lang.String uniqueID, java.util.ArrayList<java.awt.geom.Point2D> Coordinates, java.util.Map<java.lang.String,java.lang.String> modifiers, java.lang.Boolean keepUnitRatio)
- Parameters:
symbolID
- code, 20-30 digits long that represents the symboluniqueID
- for the client's usemodifiers
- use keys from Modifiers.Coordinates
-ArrayList
ofPoint2D
coordinates for the symbolkeepUnitRatio
- - default TRUE modifiers
-
-
Method Detail
-
getFillStyle
public java.awt.TexturePaint getFillStyle()
-
setFillStyle
public void setFillStyle(java.awt.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
-Integer
-
getAltitudeMode
public java.lang.String getAltitudeMode()
-
setAltitudeMode
public void setAltitudeMode(java.lang.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- Parameters:
value
-Boolean
-
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- Returns:
Boolean
-
getModifierMap
public java.util.Map<java.lang.String,java.lang.String> getModifierMap()
Returns the modifier map for the symbol- Returns:
Map
-
setModifierMap
public void setModifierMap(java.util.Map<java.lang.String,java.lang.String> modifiers)
sets the modifier map for the symbol- Parameters:
modifiers
-Map
-
getModifier
public java.lang.String getModifier(java.lang.String modifier)
Get a modifier value- Parameters:
modifier
-Modifiers
- Returns:
String
-
setModifier
public void setModifier(java.lang.String modifier, java.lang.String value)
Set a modifier value- Parameters:
modifier
-Modifiers
value
-String
-
getModifier
public java.lang.String getModifier(java.lang.String modifier, int index)
Gets modifier value based on modifier constant and index in array- Parameters:
modifier
-Modifiers
index
-Integer
array location, only applicable to AM, AN and X- Returns:
String
-
getModifier_AM_AN_X
public java.lang.Double getModifier_AM_AN_X(java.lang.String modifier, int index)
Get modifier value for AM, AN or X- Parameters:
modifier
-Modifiers
index
-Integer
array location- Returns:
Double
-
setModifier
public void setModifier(java.lang.String modifier, java.lang.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
-Modifiers
value
-String
index
-Integer
-
setModifier_AM_AN_X
public void setModifier_AM_AN_X(java.lang.String modifier, java.lang.Double value, int index)
-
getModifiers_AM_AN_X
public java.util.ArrayList<java.lang.Double> getModifiers_AM_AN_X(java.lang.String modifier)
-
setModifiers_AM_AN_X
public void setModifiers_AM_AN_X(java.lang.String modifier, java.util.ArrayList<java.lang.Double> modifiers)
-
setFillColor
public void setFillColor(java.awt.Color value)
- Parameters:
value
-Color
-
getFillColor
public java.awt.Color getFillColor()
- Returns:
Color
-
setTextColor
public void setTextColor(java.awt.Color value)
- Parameters:
value
-Color
-
getTextColor
public java.awt.Color getTextColor()
- Returns:
Color
-
setTextBackgroundColor
public void setTextBackgroundColor(java.awt.Color value)
- Parameters:
value
-Color
-
getTextBackgroundColor
public java.awt.Color getTextBackgroundColor()
- Returns:
Color
-
setLineWidth
public void setLineWidth(int value)
- Parameters:
value
-Integer
-
getLineWidth
public int getLineWidth()
- Returns:
Integer
-
setLineColor
public void setLineColor(java.awt.Color value)
If value is null or SymbolUtilities.isGreenProtectionGraphic() is true then value is ignored- Parameters:
value
-Color
-
getLineColor
public java.awt.Color getLineColor()
- Returns:
Color
-
setOutlineColor
public void setOutlineColor(java.awt.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
-Color
-
getOutlineColor
public java.awt.Color getOutlineColor()
-
setTag
public void setTag(java.lang.Object value)
Deprecated.Extra value for client. defaults to null. Not used for rendering by JavaRenderer- Parameters:
value
-Object
-
getTag
public java.lang.Object getTag()
Deprecated.Extra value for client. defaults to null. Not used for rendering by JavaRenderer- Returns:
Object
-
setCoordinates
public void setCoordinates(java.util.ArrayList<java.awt.geom.Point2D> value)
- Parameters:
value
-ArrayList
-
getCoordinates
public java.util.ArrayList<java.awt.geom.Point2D> getCoordinates()
- Returns:
ArrayList
-
setModifierShapes
public void setModifierShapes(java.util.ArrayList<ShapeInfo> value)
Shapes that represent the symbol modifiers- Parameters:
value
- ArrayList<Shape>
-
getModifierShapes
public java.util.ArrayList<ShapeInfo> getModifierShapes()
Shapes that represent the symbol modifiers- Returns:
ArrayList
-
setSymbolShapes
public void setSymbolShapes(java.util.ArrayList<ShapeInfo> value)
the java shapes that make up the symbol- Parameters:
value
- ArrayList<ShapeInfo>
-
getSymbolShapes
public java.util.ArrayList<ShapeInfo> getSymbolShapes()
the java shapes that make up the symbol- Returns:
ArrayList
-
getSymbolID
public java.lang.String getSymbolID()
The Symbol Id of the MilStdSymbol.- Returns:
String
-
getUUID
public java.lang.String getUUID()
Unique ID of the Symbol. For client use.- Returns:
String
-
setUUID
public void setUUID(java.lang.String ID)
Unique ID of the Symbol. For client use.- Parameters:
ID
-String
-
setSymbolID
public void setSymbolID(java.lang.String value)
Sets the Symbol ID for the symbol. Should be a 20-30 digit string from the milstd.- Parameters:
value
-String
-
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 withRendererSettings.setPatternScale(double)
andMilStdAttributes.PatternScale
- Parameters:
scale
-
-
getPatternScale
public double getPatternScale()
-
-