A LinePlacement specifies how a text label should be rendered relative to a linear geometry. More...

#include <LinePlacement.h>

Inheritance diagram for te::se::LinePlacement:

Public Member Functions
LinePlacement *	clone () const
	It creates a new copy of this object. More...

Initializer Methods
Methods related to instantiation and destruction.
	LinePlacement ()
	It initializes a new LinePlacement. More...

	~LinePlacement ()
	Destructor. More...

Accessor methods
Methods used to get or set properties.
void	setPerpendicularOffset (ParameterValue *p)

const ParameterValue *	getPerpendicularOffset () const

void	setIsRepeated (bool i)

bool	isRepeated () const

void	setInitialGap (ParameterValue *p)

const ParameterValue *	getInitialGap () const

void	setGap (ParameterValue *p)

const ParameterValue *	getGap () const

void	setIsAligned (bool i)

bool	isAligned () const

void	setGeneralizeLine (bool g)

bool	getGeneralizeLine () const

Private Attributes
ParameterValue *	m_gap
	Gap defines the empty space between two Graphics or Labels. (Optional) More...

bool	m_generalizeLine
	It allows the actual geometry, be it a linestring or polygon, to be generalized for label placement. This is e.g. useful for labelling polygons inside their interior when there is need for the label to resemble the shape of the polygon. (Optional) More...

ParameterValue *	m_initialGap
	Initial gap defines the initial empty space, before the first Graphic or Label should be rendered. (Optional) More...

bool	m_isAligned
	Labels can either be aligned to the line geometry if m_isAligned is "true" (the default) or are drawn horizontally. (Optional) More...

bool	m_isRepeated
	If IsRepeated is "true", the label will be repeatedly drawn along the line with m_initialGap and m_gap defining the spaces at the beginning and between labels. (Optional) More...

ParameterValue *	m_perpendicularOffset
	A perpendicular offset gives the perpendicular distance away from a line to draw a label. (Optional) More...

Detailed Description

A LinePlacement specifies how a text label should be rendered relative to a linear geometry.

For a LinePlacement, a perpendicular offset can be specified, to allow the line itself to be plotted also. This might be useful for labelling a road or a river, for example. The default behaviour of LinePlacement is to draw of the label along the line. If IsRepeated is "true", the label will be repeatedly drawn along the line with InitialGap and Gap defining the spaces at the beginning and between labels. GeneralizeLine allows the actual geometry, be it a linestring or polygon to be generalized for label placement. This is e.g. useful for labelling polygons inside their interior when there is need for the label to resemble the shape of the polygon.

See also: LabelPlacement, ParameterValue

Definition at line 61 of file LinePlacement.h.

Constructor & Destructor Documentation

te::se::LinePlacement::LinePlacement ( )

It initializes a new LinePlacement.

te::se::LinePlacement::~LinePlacement ( )

Destructor.

Member Function Documentation

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

It creates a new copy of this object.

const ParameterValue* te::se::LinePlacement::getGap ( ) const

inline

Definition at line 97 of file LinePlacement.h.

bool te::se::LinePlacement::getGeneralizeLine ( ) const

inline

Definition at line 105 of file LinePlacement.h.

const ParameterValue* te::se::LinePlacement::getInitialGap ( ) const

inline

Definition at line 93 of file LinePlacement.h.

const ParameterValue* te::se::LinePlacement::getPerpendicularOffset ( ) const

inline

Definition at line 85 of file LinePlacement.h.

bool te::se::LinePlacement::isAligned ( ) const

inline

Definition at line 101 of file LinePlacement.h.

bool te::se::LinePlacement::isRepeated ( ) const

inline

Definition at line 89 of file LinePlacement.h.

void te::se::LinePlacement::setGap ( ParameterValue * p )

void te::se::LinePlacement::setGeneralizeLine ( bool g )

void te::se::LinePlacement::setInitialGap ( ParameterValue * p )

void te::se::LinePlacement::setIsAligned ( bool i )

void te::se::LinePlacement::setIsRepeated ( bool i )

void te::se::LinePlacement::setPerpendicularOffset ( ParameterValue * p )

Member Data Documentation

ParameterValue* te::se::LinePlacement::m_gap

private

Gap defines the empty space between two Graphics or Labels. (Optional)

Definition at line 117 of file LinePlacement.h.

bool te::se::LinePlacement::m_generalizeLine

private

It allows the actual geometry, be it a linestring or polygon, to be generalized for label placement. This is e.g. useful for labelling polygons inside their interior when there is need for the label to resemble the shape of the polygon. (Optional)

Definition at line 119 of file LinePlacement.h.

ParameterValue* te::se::LinePlacement::m_initialGap

private

Initial gap defines the initial empty space, before the first Graphic or Label should be rendered. (Optional)

Definition at line 116 of file LinePlacement.h.

bool te::se::LinePlacement::m_isAligned

private

Labels can either be aligned to the line geometry if m_isAligned is "true" (the default) or are drawn horizontally. (Optional)

Definition at line 118 of file LinePlacement.h.

bool te::se::LinePlacement::m_isRepeated

private

If IsRepeated is "true", the label will be repeatedly drawn along the line with m_initialGap and m_gap defining the spaces at the beginning and between labels. (Optional)

Definition at line 115 of file LinePlacement.h.

ParameterValue* te::se::LinePlacement::m_perpendicularOffset

private

A perpendicular offset gives the perpendicular distance away from a line to draw a label. (Optional)

Definition at line 114 of file LinePlacement.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/se/LinePlacement.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation