luciad::OnPathLabelStyle Class Reference

This class contains styling properties to determine how a label is placed on a path. More...

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

Classes
class	Builder
	A builder class for creating an OnPathLabelStyle. More...

Public Member Functions
OnPathLabelStyle::Builder	asBuilder () const
	Returns a new builder that has all properties of this instance. More...
HorizontalAlignment	getHorizontalAlignment () const
double	getHorizontalOffset () const
std::optional< double >	getRelativeLocation () const
double	getVerticalOffset () const
PathLabelPosition	getVerticalPosition () const

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

Detailed Description

This class contains styling properties to determine how a label is placed on a path.

It can be used as parameter to the luciad::FeatureCanvas::LabelDrawCommand::onPath method.

Since

2021.0

Member Function Documentation

asBuilder()

OnPathLabelStyle::Builder luciad::OnPathLabelStyle::asBuilder

(

)

const

Returns a new builder that has all properties of this instance.

Returns

a new builder that has all properties of this instance.

getHorizontalAlignment()

HorizontalAlignment luciad::OnPathLabelStyle::getHorizontalAlignment

(

)

const

Returns

The horizontal alignment of the label relative to the curve.

getHorizontalOffset()

double luciad::OnPathLabelStyle::getHorizontalOffset

(

)

const

Returns

The horizontal offset in device independent pixels.

getRelativeLocation()

std::optional< double > luciad::OnPathLabelStyle::getRelativeLocation

(

)

const

Returns

The relative location on the curve. This value is in the interval [0,1]. A value of 0 represents the start of the curve and a value of 1 represents the end of the curve. If this value is std::nullopt, then the label can be placed anywhere along the path.

getVerticalOffset()

double luciad::OnPathLabelStyle::getVerticalOffset

(

)

const

Returns

The vertical offset in device independent pixels.

getVerticalPosition()

PathLabelPosition luciad::OnPathLabelStyle::getVerticalPosition

(

)

const

Returns

The vertical position of the label relative to the curve.

newBuilder()

static Builder luciad::OnPathLabelStyle::newBuilder ( )

static

Returns a new builder for creating a OnPathLabelStyle.

Returns

a new builder for creating a OnPathLabelStyle.