Package armyc2.c2sd.renderer.utilities

Class SymbolDef

java.lang.Object

armyc2.c2sd.renderer.utilities.SymbolDef

public class SymbolDef
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DRAW_CATEGORY_3D_AIRSPACE	3D airspace, not a milstd graphic.
static final int	DRAW_CATEGORY_ARROW	A polyline with n points (entered in reverse order) 0 control points
static final int	DRAW_CATEGORY_AUTOSHAPE	An animated shape, uses the animate function to draw.
static final int	DRAW_CATEGORY_CIRCULAR_PARAMETERED_AUTOSHAPE	Circle that requires 1 AM modifier value.
static final int	DRAW_CATEGORY_CIRCULAR_RANGEFAN_AUTOSHAPE	Requires at least 1 distance/AM value" See ModifiersTG.java for modifier descriptions and constant key strings.
static final int	DRAW_CATEGORY_DONOTDRAW	Just a category in the milstd hierarchy.
static final int	DRAW_CATEGORY_LINE	A polyline, a line with n number of points.
static final int	DRAW_CATEGORY_POINT	Shape is defined by a single point 0 control points
static final int	DRAW_CATEGORY_POLYGON	An enclosed polygon with n points 0 control points
static final int	DRAW_CATEGORY_RECTANGULAR_PARAMETERED_AUTOSHAPE	Rectangle that requires 2 AM modifier values and 1 AN value."; See ModifiersTG.java for modifier descriptions and constant key strings.
static final int	DRAW_CATEGORY_ROUTE	A graphic with n points whose last point defines the width of the graphic.
static final int	DRAW_CATEGORY_SECTOR_PARAMETERED_AUTOSHAPE	Requires 2 AM values and 2 AN values per sector.
static final int	DRAW_CATEGORY_SUPERAUTOSHAPE	An animated shape, uses the animate function to draw.
static final int	DRAW_CATEGORY_TWO_POINT_RECT_PARAMETERED_AUTOSHAPE	Requires 1 AM value.
static final int	DRAW_CATEGORY_TWOPOINTARROW	A polyline with 2 points (entered in reverse order).
static final int	DRAW_CATEGORY_TWOPOINTLINE	A line defined only by 2 points, and cannot have more.
static final int	DRAW_CATEGORY_UNKNOWN	UNKNOWN.

Constructor Summary

Constructors

Constructor	Description
SymbolDef(String basicSymbolID, String description, int drawCategory, String hierarchy, int minPoints, int maxPoints, String modifiers, String fullPath)

Method Summary

Modifier and Type	Method	Description
String	getBasicSymbolId()	The basic 15 character basic symbol Id.
String	getDescription()	The description of this tactical graphic.
int	getDrawCategory()	How does this draw? (autoshape, superautoshape, polygon)
String	getFullPath()	Defines where the symbol goes in the ms2525 hierarchy.
String	getHierarchy()	Defines where the symbol goes in the ms2525 hierarchy.
int	getMaxPoints()	Defines the maximum points fields.
int	getMinPoints()	Defines the minimum points fields.
String	getModifiers()
Boolean	isMultiPoint()
static SymbolDef	readBinary(DataInputStream dis)

Methods inherited from class java.lang.Object

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

Field Details

DRAW_CATEGORY_DONOTDRAW

public static final int DRAW_CATEGORY_DONOTDRAW

Just a category in the milstd hierarchy. Not something we draw. WILL NOT RENDER

See Also:

• Constant Field Values

DRAW_CATEGORY_LINE

public static final int DRAW_CATEGORY_LINE

A polyline, a line with n number of points. 0 control points

See Also:

• Constant Field Values

DRAW_CATEGORY_AUTOSHAPE

public static final int DRAW_CATEGORY_AUTOSHAPE

An animated shape, uses the animate function to draw. 0 control points (every point shapes symbol)

See Also:

• Constant Field Values

DRAW_CATEGORY_POLYGON

public static final int DRAW_CATEGORY_POLYGON

An enclosed polygon with n points 0 control points

See Also:

• Constant Field Values

DRAW_CATEGORY_ARROW

public static final int DRAW_CATEGORY_ARROW

A polyline with n points (entered in reverse order) 0 control points

See Also:

• Constant Field Values

DRAW_CATEGORY_ROUTE

public static final int DRAW_CATEGORY_ROUTE

A graphic with n points whose last point defines the width of the graphic. 1 control point

See Also:

• Constant Field Values

DRAW_CATEGORY_TWOPOINTLINE

public static final int DRAW_CATEGORY_TWOPOINTLINE

A line defined only by 2 points, and cannot have more. 0 control points

See Also:

• Constant Field Values

DRAW_CATEGORY_POINT

public static final int DRAW_CATEGORY_POINT

Shape is defined by a single point 0 control points

See Also:

• Constant Field Values

DRAW_CATEGORY_TWOPOINTARROW

public static final int DRAW_CATEGORY_TWOPOINTARROW

A polyline with 2 points (entered in reverse order). 0 control points

See Also:

• Constant Field Values

DRAW_CATEGORY_SUPERAUTOSHAPE

public static final int DRAW_CATEGORY_SUPERAUTOSHAPE

An animated shape, uses the animate function to draw. Super Autoshape draw in 2 phases, usually one to define length, and one to define width. 0 control points (every point shapes symbol)

See Also:

• Constant Field Values

DRAW_CATEGORY_CIRCULAR_PARAMETERED_AUTOSHAPE

public static final int DRAW_CATEGORY_CIRCULAR_PARAMETERED_AUTOSHAPE

Circle that requires 1 AM modifier value. See ModifiersTG.java for modifier descriptions and constant key strings.

See Also:

• Constant Field Values

DRAW_CATEGORY_RECTANGULAR_PARAMETERED_AUTOSHAPE

public static final int DRAW_CATEGORY_RECTANGULAR_PARAMETERED_AUTOSHAPE

Rectangle that requires 2 AM modifier values and 1 AN value."; See ModifiersTG.java for modifier descriptions and constant key strings.

See Also:

• Constant Field Values

DRAW_CATEGORY_SECTOR_PARAMETERED_AUTOSHAPE

public static final int DRAW_CATEGORY_SECTOR_PARAMETERED_AUTOSHAPE

Requires 2 AM values and 2 AN values per sector. The first sector can have just one AM value although it is recommended to always use 2 values for each sector. X values are not required as our rendering is only 2D for the Sector Range Fan symbol. See ModifiersTG.java for modifier descriptions and constant key strings.

See Also:

• Constant Field Values

DRAW_CATEGORY_CIRCULAR_RANGEFAN_AUTOSHAPE

public static final int DRAW_CATEGORY_CIRCULAR_RANGEFAN_AUTOSHAPE

Requires at least 1 distance/AM value" See ModifiersTG.java for modifier descriptions and constant key strings.

See Also:

• Constant Field Values

DRAW_CATEGORY_TWO_POINT_RECT_PARAMETERED_AUTOSHAPE

public static final int DRAW_CATEGORY_TWO_POINT_RECT_PARAMETERED_AUTOSHAPE

Requires 1 AM value. See ModifiersTG.java for modifier descriptions and constant key strings.

See Also:

• Constant Field Values

DRAW_CATEGORY_3D_AIRSPACE

public static final int DRAW_CATEGORY_3D_AIRSPACE

3D airspace, not a milstd graphic.

See Also:

• Constant Field Values

DRAW_CATEGORY_UNKNOWN

public static final int DRAW_CATEGORY_UNKNOWN

UNKNOWN.

See Also:

• Constant Field Values

Constructor Details

SymbolDef

public SymbolDef(String basicSymbolID,
 String description,
 int drawCategory,
 String hierarchy,
 int minPoints,
 int maxPoints,
 String modifiers,
 String fullPath)

Method Details

getBasicSymbolId

public String getBasicSymbolId()

The basic 15 character basic symbol Id.

getDescription

public String getDescription()

The description of this tactical graphic. Typically the name of the tactical graphic in MIL-STD-2525B.

getDrawCategory

public int getDrawCategory()

How does this draw? (autoshape, superautoshape, polygon)

getMinPoints

public int getMinPoints()

Defines the minimum points fields.

getMaxPoints

public int getMaxPoints()

Defines the maximum points fields.

isMultiPoint

public Boolean isMultiPoint()

getModifiers

public String getModifiers()

getHierarchy

public String getHierarchy()

Defines where the symbol goes in the ms2525 hierarchy. 2.X.etc...

getFullPath

public String getFullPath()

Defines where the symbol goes in the ms2525 hierarchy. TacticalGraphics/Areas/stuff...

readBinary

public static SymbolDef readBinary(DataInputStream dis)
                            throws IOException

Throws:

IOException