te::se::PointPlacement Class Reference

A PointPlacement specifies how a text label should be rendered relative to a geometric point. More...

#include <PointPlacement.h>

Inheritance diagram for te::se::PointPlacement:

Public Member Functions
PointPlacement *	clone () const
	It creates a new copy of this object. More...
Initializer Methods
Methods related to instantiation and destruction.
	PointPlacement ()
	It initializes a new PointPlacement. More...
	~PointPlacement ()
	Destructor. More...
Accessor methods
Methods used to get or set properties.
void	setAnchorPoint (AnchorPoint *a)
const AnchorPoint *	getAnchorPoint () const
void	setDisplacement (Displacement *d)
const Displacement *	getDisplacement () const
void	setRotation (ParameterValue *r)
const ParameterValue *	getRotation () const

Private Attributes
AnchorPoint *	m_anchorPoint
	It identifies the location inside of a text label to use an an 'anchor' for positioning it relative to a point geometry. (Optional) More...
Displacement *	m_displacement
	It gives X and Y offset displacements to use for rendering a text label, graphic or other Symbolizer near a point. (Optional) More...
ParameterValue *	m_rotation
	The Rotation element gives the rotation of a graphic in the clockwise direction about its center point in decimal degrees, encoded as a floating-point number. Negative values mean counter-clockwise rotation. (Optional) More...

Detailed Description

A PointPlacement specifies how a text label should be rendered relative to a geometric point.

For a PointPlacement, the anchor point of the label and a linear displacement from the point can be specified, to allow a graphic Symbolizer to be plotted directly at the point. This might be useful to label a city, for example. The AnchorPoint element of a PointPlacement gives the location inside of a label to use for anchoring the label to the main-geometry point. The Displacement element of a PointPlacement gives the X and Y displacements from the main-geometry point to render a text label. This will often be used to avoid over-plotting a graphic symbol marking a city or some such feature. The displacements are in units of pixels above and to the right of the point. A system may reflect this displacement about the X and/or Y axes to de-conflict labels. The default displacement is X = 0, Y = 0. The Rotation of a PointPlacement gives the clockwise rotation of the label in degrees from the normal direction for a font (left-to-right for Latin-derived human languages at least).

See also

LabelPlacement, AnchorPoint, Displacement, ParameterValue

Definition at line 74 of file PointPlacement.h.

Constructor & Destructor Documentation

te::se::PointPlacement::PointPlacement

(

)

It initializes a new PointPlacement.

te::se::PointPlacement::~PointPlacement

(

)

Destructor.

Member Function Documentation

PointPlacement* te::se::PointPlacement::clone

(

)

const

It creates a new copy of this object.

const AnchorPoint* te::se::PointPlacement::getAnchorPoint ( ) const

inline

Definition at line 98 of file PointPlacement.h.

const Displacement* te::se::PointPlacement::getDisplacement ( ) const

inline

Definition at line 102 of file PointPlacement.h.

const ParameterValue* te::se::PointPlacement::getRotation ( ) const

inline

Definition at line 106 of file PointPlacement.h.

void te::se::PointPlacement::setAnchorPoint

(

AnchorPoint *

a

)

void te::se::PointPlacement::setDisplacement

(

Displacement *

d

)

void te::se::PointPlacement::setRotation

(

ParameterValue *

r

)

Member Data Documentation

AnchorPoint* te::se::PointPlacement::m_anchorPoint

private

It identifies the location inside of a text label to use an an 'anchor' for positioning it relative to a point geometry. (Optional)

Definition at line 115 of file PointPlacement.h.

Displacement* te::se::PointPlacement::m_displacement

private

It gives X and Y offset displacements to use for rendering a text label, graphic or other Symbolizer near a point. (Optional)

Definition at line 116 of file PointPlacement.h.

ParameterValue* te::se::PointPlacement::m_rotation

private

The Rotation element gives the rotation of a graphic in the clockwise direction about its center point in decimal degrees, encoded as a floating-point number. Negative values mean counter-clockwise rotation. (Optional)

Definition at line 117 of file PointPlacement.h.

---

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

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