osmscout::PathShieldStyle Class Reference

#include <libosmscout-map/include/osmscout/Styles.h>

Inheritance diagram for osmscout::PathShieldStyle:

Collaboration diagram for osmscout::PathShieldStyle:

Public Types
enum	Attribute {   attrPriority, attrSize, attrLabel, attrTextColor,   attrBgColor, attrBorderColor, attrShieldSpace }

Public Member Functions
	PathShieldStyle ()
	PathShieldStyle (const PathShieldStyle &style)
void	SetLabelValue (int attribute, const LabelProviderRef &value) override
void	SetColorValue (int attribute, const Color &value) override
void	SetDoubleValue (int attribute, double value) override
void	SetUIntValue (int attribute, size_t value) override
PathShieldStyle &	SetLabel (const LabelProviderRef &label)
PathShieldStyle &	SetPriority (size_t priority)
PathShieldStyle &	SetSize (double size)
PathShieldStyle &	SetTextColor (const Color &color)
PathShieldStyle &	SetBgColor (const Color &color)
PathShieldStyle &	SetBorderColor (const Color &color)
PathShieldStyle &	SetShieldSpace (double shieldSpace)
bool	IsVisible () const
double	GetAlpha () const
size_t	GetPriority () const
double	GetSize () const
const LabelProviderRef &	GetLabel () const
const Color &	GetTextColor () const
const Color &	GetBgColor () const
const Color &	GetBorderColor () const
double	GetShieldSpace () const
const ShieldStyleRef &	GetShieldStyle () const
void	CopyAttributes (const PathShieldStyle &other, const std::set< Attribute > &attributes)
Public Member Functions inherited from osmscout::Style
virtual	~Style ()=default
virtual void	SetBoolValue (int attribute, bool value)
virtual void	SetStringValue (int attribute, const std::string &value)
virtual void	SetMagnificationValue (int attribute, const Magnification &value)
virtual void	SetDoubleArrayValue (int attribute, const std::vector< double > &value)
virtual void	SetSymbolValue (int attribute, const SymbolRef &value)
virtual void	SetIntValue (int attribute, int value)

Static Public Member Functions
static StyleDescriptorRef	GetDescriptor ()

Detailed Description

A style defining repetive drawing of a shield label along a path. It consists mainly of the attributes of the shield itself (it internally holds a shield label for this) and some more attributes defining the way of repetition.

Member Enumeration Documentation

Attribute

enum osmscout::PathShieldStyle::Attribute

Enumerator
attrPriority
attrSize
attrLabel
attrTextColor
attrBgColor
attrBorderColor
attrShieldSpace

Constructor & Destructor Documentation

PathShieldStyle() [1/2]

osmscout::PathShieldStyle::PathShieldStyle

(

)

PathShieldStyle() [2/2]

osmscout::PathShieldStyle::PathShieldStyle

(

const PathShieldStyle &

style

)

Member Function Documentation

CopyAttributes()

void osmscout::PathShieldStyle::CopyAttributes	(	const PathShieldStyle &	other,
		const std::set< Attribute > &	attributes
	)

GetAlpha()

double osmscout::PathShieldStyle::GetAlpha ( ) const

inline

GetBgColor()

const Color& osmscout::PathShieldStyle::GetBgColor ( ) const

inline

GetBorderColor()

const Color& osmscout::PathShieldStyle::GetBorderColor ( ) const

inline

GetDescriptor()

static StyleDescriptorRef osmscout::PathShieldStyle::GetDescriptor ( )

static

GetLabel()

const LabelProviderRef& osmscout::PathShieldStyle::GetLabel ( ) const

inline

GetPriority()

size_t osmscout::PathShieldStyle::GetPriority ( ) const

inline

GetShieldSpace()

double osmscout::PathShieldStyle::GetShieldSpace ( ) const

inline

GetShieldStyle()

const ShieldStyleRef& osmscout::PathShieldStyle::GetShieldStyle ( ) const

inline

GetSize()

double osmscout::PathShieldStyle::GetSize ( ) const

inline

GetTextColor()

const Color& osmscout::PathShieldStyle::GetTextColor ( ) const

inline

IsVisible()

bool osmscout::PathShieldStyle::IsVisible ( ) const

inline

SetBgColor()

PathShieldStyle& osmscout::PathShieldStyle::SetBgColor

(

const Color &

color

)

SetBorderColor()

PathShieldStyle& osmscout::PathShieldStyle::SetBorderColor

(

const Color &

color

)

SetColorValue()

void osmscout::PathShieldStyle::SetColorValue ( int  attribute, const Color &  value  )

overridevirtual

Reimplemented from osmscout::Style.

SetDoubleValue()

void osmscout::PathShieldStyle::SetDoubleValue ( int  attribute, double  value  )

overridevirtual

Reimplemented from osmscout::Style.

SetLabel()

PathShieldStyle& osmscout::PathShieldStyle::SetLabel

(

const LabelProviderRef &

label

)

SetLabelValue()

void osmscout::PathShieldStyle::SetLabelValue ( int  attribute, const LabelProviderRef &  value  )

overridevirtual

Reimplemented from osmscout::Style.

SetPriority()

PathShieldStyle& osmscout::PathShieldStyle::SetPriority

(

size_t

priority

)

SetShieldSpace()

PathShieldStyle& osmscout::PathShieldStyle::SetShieldSpace

(

double

shieldSpace

)

SetSize()

PathShieldStyle& osmscout::PathShieldStyle::SetSize

(

double

size

)

SetTextColor()

PathShieldStyle& osmscout::PathShieldStyle::SetTextColor

(

const Color &

color

)

SetUIntValue()

void osmscout::PathShieldStyle::SetUIntValue ( int  attribute, size_t  value  )

overridevirtual

Reimplemented from osmscout::Style.

---

The documentation for this class was generated from the following file:

• libosmscout-map/include/osmscout/Styles.h