luciad::PinStyle::Builder Class Reference

A builder class for creating pin styles that can be set up to labels, see FeatureCanvas::LabelDrawCommand::pinStyle. More...

#include <luciad/layers/styles/PinStyle.h>

Public Member Functions
	Builder (const Builder &other)
	~Builder ()
PinStyle	build () const
	Returns a newly created pin style, based on the properties set on this builder. More...
Builder &	endPosition (EndPosition endPosition)
	The pin's end position defines where the pin connects to the label. More...
Builder &	lineStyle (LineStyle lineStyle)
	Sets the line style used to paint the pin line. More...
Builder &	visibilityThreshold (double visibilityThreshold)
	Sets the number of pixels that determine the visibility of a pin line. More...

Detailed Description

A builder class for creating pin styles that can be set up to labels, see FeatureCanvas::LabelDrawCommand::pinStyle.

Since

2020.2

Constructor & Destructor Documentation

Builder()

luciad::PinStyle::Builder::Builder

(

const Builder &

other

)

~Builder()

luciad::PinStyle::Builder::~Builder

(

)

Member Function Documentation

build()

PinStyle luciad::PinStyle::Builder::build

(

)

const

Returns a newly created pin style, based on the properties set on this builder.

Returns

a newly created pin style.

endPosition()

Builder & luciad::PinStyle::Builder::endPosition

(

EndPosition

endPosition

)

The pin's end position defines where the pin connects to the label.

Note that the start position is a position that is chosen on the label's anchor geometry. For example, when a label is attached to a Point geometry the start position is that Point.

This property is optional. The default value is MiddleOfBoundsOnEdge.

Parameters

endPosition

the position where the pin connects to the label

Returns

this builder

lineStyle()

Builder & luciad::PinStyle::Builder::lineStyle

(

LineStyle

lineStyle

)

Sets the line style used to paint the pin line.

This property is optional. By default, pins use a line style of black color and a width of 1.

Parameters

lineStyle

a line style

Returns

this builder

visibilityThreshold()

Builder & luciad::PinStyle::Builder::visibilityThreshold

(

double

visibilityThreshold

)

Sets the number of pixels that determine the visibility of a pin line.

If the pin line length is smaller than this value, it will be discarded.

This property is optional. The default value is 3 pixels.

Parameters

visibilityThreshold

The number of pixels that determine the visibility of a pin line, in device independent pixels

Returns

this builder