Package com.luciad.view.lightspeed.style

Class TLspLineStyle.DashPattern

java.lang.Object

com.luciad.view.lightspeed.style.TLspLineStyle.DashPattern

Enclosing class:

TLspLineStyle

public static class TLspLineStyle.DashPattern
extends Object

Dash pattern for line styles.

Since:

2012.0

Field Summary

Fields

Modifier and Type	Field	Description
static final short	DASH_DOUBLE_DOT	Stipple pattern for a dash-double dotted line
static final short	DOT	Stipple pattern for a dotted line
static final short	DOT_DASH	Stipple pattern for a dot-dashed line
static final short	LONG_DASH	Stipple pattern for a long-dashed line
static final short	LONG_SHORT_DASH	Stipple pattern for a long-short-short dashed line
static final short	SHORT_DASH	Stipple pattern for a short dashed line
static final short	SOLID	Stipple pattern for a solid line

Constructor Summary

Constructors

Constructor	Description
DashPattern(short aStipplePattern, int aPatternScale)	A dash pattern is characterized by two attributes: a stipple pattern and a pattern scale.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	getPatternScale()	Gets the stipple pattern pattern scale.
short	getStipplePattern()	Gets the stipple pattern.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SOLID

public static final short SOLID

Stipple pattern for a solid line

See Also:

• Constant Field Values

DOT

public static final short DOT

Stipple pattern for a dotted line

See Also:

• Constant Field Values

DOT_DASH

public static final short DOT_DASH

Stipple pattern for a dot-dashed line

See Also:

• Constant Field Values

LONG_DASH

public static final short LONG_DASH

Stipple pattern for a long-dashed line

See Also:

• Constant Field Values

LONG_SHORT_DASH

public static final short LONG_SHORT_DASH

Stipple pattern for a long-short-short dashed line

See Also:

• Constant Field Values

SHORT_DASH

public static final short SHORT_DASH

Stipple pattern for a short dashed line

See Also:

• Constant Field Values

DASH_DOUBLE_DOT

public static final short DASH_DOUBLE_DOT

Stipple pattern for a dash-double dotted line

See Also:

• Constant Field Values

Constructor Details

DashPattern

public DashPattern(short aStipplePattern,
 int aPatternScale)

A dash pattern is characterized by two attributes: a stipple pattern and a pattern scale. The stipple pattern must contain exactly 16 bits and it defines how the line will be dashed (0 = gap, 1 = line being drawn). The pattern scale specifies a multiplier for each bit in the stipple pattern. For example, if the pattern scale is 3, each bit in the pattern will be used 3 times before progressing to the next bit.

Parameters:

aStipplePattern - the stipple pattern

aPatternScale - the pattern scale

Method Details

getStipplePattern

public short getStipplePattern()

Gets the stipple pattern. It is a pattern represented as 16 bits (one short value) that defines how the line will be dashed.

Returns:

the stipple pattern

getPatternScale

public int getPatternScale()

Gets the stipple pattern pattern scale. The pattern scale specifies a multiplier for each bit in the stipple pattern. For example, if the pattern scale is 3, each bit in the pattern will be used 3 times before progressing to the next bit.

Returns:

the pattern scale

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object