luciad::TextPatternBuilder Class Reference

Creates a pattern containing text. More...

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

Public Member Functions
ComplexStrokePattern	build ()
	Build the text pattern as configured. More...
TextPatternBuilder &	offset (double offset)
	Sets the offset of the text, relative to the base line, in pixels. More...
TextPatternBuilder &	rotateUp (bool rotateUp)
	Indicates if the text should be flipped when it is turned upside down. More...
TextPatternBuilder &	text (std::string text)
	Sets the text as a single line. More...
TextPatternBuilder &	text (std::vector< std::string > text)
	Sets multiple lines of text, with each element being a separate line. More...
TextPatternBuilder &	textStyle (TextStyle textStyle)
	Sets the style of the text. More...

Detailed Description

Creates a pattern containing text.

See also

ComplexStrokePatternFactory::textBuilder()

Since

2023.1

Member Function Documentation

build()

ComplexStrokePattern luciad::TextPatternBuilder::build

(

)

Build the text pattern as configured.

Returns

the ComplexStrokePattern.

Exceptions

luciad::LogicException

when the text has not been set.

offset()

TextPatternBuilder & luciad::TextPatternBuilder::offset

(

double

offset

)

Sets the offset of the text, relative to the base line, in pixels.

Defaults to 0.

Parameters

offset

the offset of the text.

Returns

this builder.

rotateUp()

TextPatternBuilder & luciad::TextPatternBuilder::rotateUp

(

bool

rotateUp

)

Indicates if the text should be flipped when it is turned upside down.

Defaults to true.

Parameters

rotateUp

if the text should be flipped when it is turned upside down.

Returns

this builder.

text() [1/2]

TextPatternBuilder & luciad::TextPatternBuilder::text

(

std::string

text

)

Sets the text as a single line.

Parameters

text	the text to be displayed.

Returns

this builder.

text() [2/2]

TextPatternBuilder & luciad::TextPatternBuilder::text

(

std::vector< std::string >

text

)

Sets multiple lines of text, with each element being a separate line.

Parameters

text	the text to be displayed. May not be empty.

Returns

this builder.

Exceptions

luciad::InvalidArgumentException

text may not be empty.

textStyle()

TextPatternBuilder & luciad::TextPatternBuilder::textStyle

(

TextStyle

textStyle

)

Sets the style of the text.

Parameters

textStyle

the style of the text.

Returns

this builder.