luciad::ArrowPatternBuilder Class Reference

Creates a pattern with an arrow shape. More...

#include <luciad/layers/styles/complexstrokes/builders/ArrowPatternBuilder.h>

Public Member Functions
ComplexStrokePattern	build ()
	Build the arrow pattern as configured. More...
ArrowPatternBuilder &	fillColor (Color color)
	Sets the fill color. More...
ArrowPatternBuilder &	forward (bool forward)
	If true, the arrow is oriented towards the end of the line. More...
ArrowPatternBuilder &	height (double height)
	The height of the arrow, in pixels. More...
ArrowPatternBuilder &	lineColor (Color color)
	Sets the line color. More...
ArrowPatternBuilder &	lineWidth (double lineWidth)
	Sets the line width. More...
ArrowPatternBuilder &	offset (double offset)
	The offset of the arrow, relative to the base line, in pixels. More...
ArrowPatternBuilder &	size (double size)
	The size (~length) of the arrow, in pixels. More...
ArrowPatternBuilder &	type (ComplexStrokePatternArrowType type)
	Sets the arrow's type. More...

Detailed Description

Creates a pattern with an arrow shape.

See also

ComplexStrokePatternFactory::arrowBuilder()

Since

2023.1

Member Function Documentation

build()

ComplexStrokePattern luciad::ArrowPatternBuilder::build

(

)

Build the arrow pattern as configured.

Returns

the ComplexStrokePattern.

fillColor()

ArrowPatternBuilder & luciad::ArrowPatternBuilder::fillColor

(

Color

color

)

Sets the fill color.

Parameters

color

the arrow's fill color, defaults to white.

Returns

this builder.

forward()

ArrowPatternBuilder & luciad::ArrowPatternBuilder::forward

(

bool

forward

)

If true, the arrow is oriented towards the end of the line.

Defaults to true.

Parameters

forward

whether the arrow is oriented towards the end of the line.

Returns

this builder.

height()

ArrowPatternBuilder & luciad::ArrowPatternBuilder::height

(

double

height

)

The height of the arrow, in pixels.

Must be strictly greater than 0. If it is not set, the arrow uses a default height, depending on the arrow type.

Parameters

height

the height of the arrow.

Returns

this builder.

Exceptions

luciad::InvalidArgumentException

height must be >0.

lineColor()

ArrowPatternBuilder & luciad::ArrowPatternBuilder::lineColor

(

Color

color

)

Sets the line color.

Parameters

color

the arrow's line color, defaults to black.

Returns

this builder.

lineWidth()

ArrowPatternBuilder & luciad::ArrowPatternBuilder::lineWidth

(

double

lineWidth

)

Sets the line width.

Parameters

lineWidth

the line's width, defaults to 1.

Returns

this builder.

Exceptions

luciad::InvalidArgumentException

lineWidth must be >0.

offset()

ArrowPatternBuilder & luciad::ArrowPatternBuilder::offset

(

double

offset

)

The offset of the arrow, relative to the base line, in pixels.

Defaults to 0.

Parameters

offset

the offset of the arrow.

Returns

this builder.

size()

ArrowPatternBuilder & luciad::ArrowPatternBuilder::size

(

double

size

)

The size (~length) of the arrow, in pixels.

Defaults to 5.

Parameters

size	the size of the arrow.

Returns

this builder.

Exceptions

luciad::InvalidArgumentException

size must be >0.

type()

ArrowPatternBuilder & luciad::ArrowPatternBuilder::type

(

ComplexStrokePatternArrowType

type

)

Sets the arrow's type.

Defaults to ArrowType.RegularFilled.

Parameters

type	the arrow's type.

Returns

this builder.