This class contains styling properties that can be used to configure pins for labels, see FeatureCanvas::LabelDrawCommand::pinStyle. More...

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

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

Public Types
enum class	EndPosition { ClosestEdge , ClosestPointOnEdge , MiddleOfBoundsOnEdge }
	Possible positions for the end of the pin. More...

Public Member Functions
PinStyle::Builder	asBuilder () const
	Returns a PinStyle builder that has all properties of this PinStyle. More...

EndPosition	getEndPosition () const
	Returns the location where the pin line connects to the label. More...

const LineStyle &	getLineStyle () const
	Returns the line style used to paint the pin. More...

double	getVisibilityThreshold () const
	Returns the number of pixels that determine the visibility of a pin line. More...

Static Public Member Functions
static Builder	newBuilder ()
	Returns a new builder for creating a `PinStyle`. More...

Detailed Description

This class contains styling properties that can be used to configure pins for labels, see FeatureCanvas::LabelDrawCommand::pinStyle.

You can create instances of this class using PinStyle::newBuilder.

Since: 2020.2

Member Enumeration Documentation

◆ EndPosition

enum class luciad::PinStyle::EndPosition

strong

Possible positions for the end of the pin.

This is the location where the pin line connects to the label.

Since: 2020.2

Enumerator

ClosestEdge

The pin connects to the label at the middle point of the label's edge that is closest to the label's anchor geometry.

ClosestPointOnEdge

The pin connects to the label at the position on any of the label's edges that is closest to the label's anchor geometry.

Note that this can include any of the corners of the label. This end position results in the smallest possible pin lines.

MiddleOfBoundsOnEdge

The pin connects to the label at the middle of the label bounds.

Additionally pin line is cut off where it crosses the edge of the label.

Member Function Documentation

◆ asBuilder()

PinStyle::Builder luciad::PinStyle::asBuilder ( ) const

Returns a PinStyle builder that has all properties of this PinStyle.

Returns: a PinStyle builder that has all properties of this PinStyle.

◆ getEndPosition()

EndPosition luciad::PinStyle::getEndPosition ( ) const

Returns the location where the pin line connects to the label.

Returns: the location where the pin line connects to the label.

◆ getLineStyle()

const LineStyle & luciad::PinStyle::getLineStyle ( ) const

Returns the line style used to paint the pin.

Returns: the line style used to paint the pin

◆ getVisibilityThreshold()

double luciad::PinStyle::getVisibilityThreshold ( ) const

Returns 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.

Returns: the number of pixels that determine the visibility of a pin line.

◆ newBuilder()

static Builder luciad::PinStyle::newBuilder ( )

static

Returns a new builder for creating a PinStyle.

Returns: a new builder for creating a PinStyle.

Classes

Public Types

Public Member Functions

Static Public Member Functions