Package com.luciad.view.lightspeed.style.complexstroke

Class ALspComplexStroke.ArrowBuilder

java.lang.Object

com.luciad.view.lightspeed.style.complexstroke.ALspComplexStroke.ArrowBuilder

Enclosing class:

ALspComplexStroke

public static class ALspComplexStroke.ArrowBuilder
extends Object

Used to build arrow strokes. For more information, see ALspComplexStroke.arrow().

Since:

2013.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ALspComplexStroke.ArrowBuilder.ArrowType	The arrow type.

Method Summary

Modifier and Type	Method	Description
ALspComplexStroke	build()	Returns a new arrow stroke
ALspComplexStroke.ArrowBuilder	fillColor(Color aFillColor)	Sets the fill color
ALspComplexStroke.ArrowBuilder	fillTexture(ILcdIcon aTextureIcon)	Specifies an icon that is used to retrieve the fill color.
ALspComplexStroke.ArrowBuilder	forward(boolean aForward)	Sets if the arrow should be oriented towards the end of the line.
ALspComplexStroke.ArrowBuilder	height(double aHeight)	Sets the height of the arrow.
ALspComplexStroke.ArrowBuilder	lineColor(Color aLineColor)	Sets the line color
ALspComplexStroke.ArrowBuilder	lineTexture(ILcdIcon aTextureIcon)	Specifies an icon that is used to retrieve the line color.
ALspComplexStroke.ArrowBuilder	lineWidth(double aLineWidth)	Sets the line width
ALspComplexStroke.ArrowBuilder	offset(double aOffset)	Sets the offset of the arrow from the base line.
ALspComplexStroke.ArrowBuilder	size(double aSize)	Sets the arrow size
ALspComplexStroke.ArrowBuilder	type(ALspComplexStroke.ArrowBuilder.ArrowType aType)	Sets the arrow type.

Methods inherited from class java.lang.Object

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

Method Details

type

public ALspComplexStroke.ArrowBuilder type(ALspComplexStroke.ArrowBuilder.ArrowType aType)

Sets the arrow type.

Parameters:

aType - the arrow type

Returns:

this

size

public ALspComplexStroke.ArrowBuilder size(double aSize)

Sets the arrow size

Parameters:

aSize - the arrow size

Returns:

this

height

public ALspComplexStroke.ArrowBuilder height(double aHeight)

Sets the height of the arrow. If this property is not set, the arrow uses a default height, depending on the arrow type.

Parameters:

aHeight - the height of the arrow.

Returns:

this

offset

public ALspComplexStroke.ArrowBuilder offset(double aOffset)

Sets the offset of the arrow from the base line. The default is 0.

Parameters:

aOffset - the offset from the base line

Returns:

this

forward

public ALspComplexStroke.ArrowBuilder forward(boolean aForward)

Sets if the arrow should be oriented towards the end of the line. The default is true.

Parameters:

aForward - true for arrows oriented towards the end of the line.

Returns:

this

lineWidth

public ALspComplexStroke.ArrowBuilder lineWidth(double aLineWidth)

Sets the line width

Parameters:

aLineWidth - the line width

Returns:

this

lineColor

public ALspComplexStroke.ArrowBuilder lineColor(Color aLineColor)

Sets the line color

Parameters:

aLineColor - the line color

Returns:

this

lineTexture

public ALspComplexStroke.ArrowBuilder lineTexture(ILcdIcon aTextureIcon)

Specifies an icon that is used to retrieve the line color. This texture icon is sampled in view space, i.e. one pixel of the icon corresponds with one pixel on the screen. If a line color is set as well, that color is used as a modulation color. For best results, the given icon should be tileable, see for example TLcdGXYHatchedFillStyle.asIcon().

Parameters:

aTextureIcon - a texture icon

Returns:

this

fillColor

public ALspComplexStroke.ArrowBuilder fillColor(Color aFillColor)

Sets the fill color

Parameters:

aFillColor - the fill color

Returns:

this

fillTexture

public ALspComplexStroke.ArrowBuilder fillTexture(ILcdIcon aTextureIcon)

Specifies an icon that is used to retrieve the fill color. This texture icon is sampled in view space, i.e. one pixel of the icon corresponds with one pixel on the screen. If a fill color is set as well, that color is used as a modulation color. For best results, the given icon should be tileable, see for example TLcdGXYHatchedFillStyle.asIcon().

Parameters:

aTextureIcon - a texture icon

Returns:

this

build

public ALspComplexStroke build()

Returns a new arrow stroke

Returns:

a new arrow stroke