A Halo is a type of Fill that is applied to the backgrounds of font glyphs. More...

#include <Halo.h>

Inheritance diagram for te::se::Halo:

Public Member Functions
Initializer Methods
Methods related to instantiation and destruction.
	Halo ()
	It initializes a new Halo. More...

	~Halo ()
	Destructor. More...

Accessor methods
Methods used to get or set properties.
ParameterValue *	m_radius
	The Radius element gives the absolute size of a halo radius in pixels encoded as a floating-point number. The radius is taken from the outside edge of a font glyph to extend the area of coverage of the glyph (and the inside edge of 'holes' in the glyphs). The halo of a text label is considered to be a single shape. (Optional) More...

Fill *	m_fill
	Specifies how the hallo text area will be filled. (Optional) More...

void	setRadius (ParameterValue *radius)

const ParameterValue *	getRadius () const

void	setFill (Fill *fill)

const Fill *	getFill () const

Halo *	clone () const
	It creates a new copy of this object. More...

Detailed Description

A Halo is a type of Fill that is applied to the backgrounds of font glyphs.

A Halo fills an extended area outside the glyphs of a rendered text label to make the label easier to read over a background. The Radius element gives the absolute size of a halo radius in pixels encoded as a floating-point number. The radius is taken from the outside edge of a font glyph to extend the area of coverage of the glyph (and the inside edge of "holes" in the glyphs). The halo of a text label is considered to be a single shape. The default radius is one pixel. Negative values are not allowed. The default halo fill is solid white (Color "#FFFFFF"). The glyph�s fill is plotted on top of the halo. The default font fill is solid black (Color "#000000"). If no Halo is selected in the containing TextSymbolizer, then no halo will be rendered.

See also: TextSymbolizer, Fill, ParameterValue

Definition at line 64 of file Halo.h.

Constructor & Destructor Documentation

◆ Halo()

te::se::Halo::Halo ( )

It initializes a new Halo.

◆ ~Halo()

te::se::Halo::~Halo ( )

Destructor.

Member Function Documentation

◆ clone()

Halo* te::se::Halo::clone ( ) const

It creates a new copy of this object.

◆ getFill()

const Fill* te::se::Halo::getFill ( ) const

◆ getRadius()

const ParameterValue* te::se::Halo::getRadius ( ) const

◆ setFill()

void te::se::Halo::setFill ( Fill * fill )

◆ setRadius()

void te::se::Halo::setRadius ( ParameterValue * radius )

Member Data Documentation

◆ m_fill

Fill* te::se::Halo::m_fill

private

Specifies how the hallo text area will be filled. (Optional)

Definition at line 102 of file Halo.h.

◆ m_radius

ParameterValue* te::se::Halo::m_radius