te::se::AnchorPoint Class Reference

An AnchorPoint identifies the location inside of a text label to use an 'anchor' for positioning it relative to a point geometry. More...

#include <AnchorPoint.h>

Inheritance diagram for te::se::AnchorPoint:

Public Member Functions

AnchorPointclone () const
 It creates a new copy of this object. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 AnchorPoint ()
 It initializes a new AnchorPoint. More...
 
 ~AnchorPoint ()
 Destructor. More...
 
Accessor methods

Methods used to get or set properties.

void setAnchorPointX (ParameterValue *x)
 
const ParameterValuegetAnchorPointX () const
 
void setAnchorPointY (ParameterValue *y)
 
const ParameterValuegetAnchorPointY () const
 

Private Attributes

ParameterValuem_x
 Floating-point number of the the coordinate to anchoring (default = 0.5). More...
 
ParameterValuem_y
 Floating-point number of the the coordinate to anchoring (default = 0.5). More...
 

Detailed Description

An AnchorPoint identifies the location inside of a text label to use an 'anchor' for positioning it relative to a point geometry.

The AnchorPoint element of a PointSymbolizer gives the location inside of a Graphic (or label) to use for anchoring the graphic to the main-geometry point. The coordinates are given as two floating-point numbers in the AnchorPointX and AnchorPointY elements each with values between 0.0 and 1.0 inclusive. The bounding box of the graphic/label to be rendered is considered to be in a coordinate space from 0.0 (lower-left corner) to 1.0 (upper-right corner), and the anchor position is specified as a point in this space. The default point is X = 0.5, Y = 0.5, which is at the middle height and middle length of the graphic/label text. A system may choose different anchor points to de-conflict graphics/labels.

See also
Graphic, ParameterValue, PointPlacement

Definition at line 63 of file AnchorPoint.h.

Constructor & Destructor Documentation

te::se::AnchorPoint::AnchorPoint ( )

It initializes a new AnchorPoint.

te::se::AnchorPoint::~AnchorPoint ( )

Destructor.

Member Function Documentation

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

It creates a new copy of this object.

const ParameterValue* te::se::AnchorPoint::getAnchorPointX ( ) const
const ParameterValue* te::se::AnchorPoint::getAnchorPointY ( ) const
void te::se::AnchorPoint::setAnchorPointX ( ParameterValue x)
void te::se::AnchorPoint::setAnchorPointY ( ParameterValue y)

Member Data Documentation

ParameterValue* te::se::AnchorPoint::m_x
private

Floating-point number of the the coordinate to anchoring (default = 0.5).

Definition at line 100 of file AnchorPoint.h.

ParameterValue* te::se::AnchorPoint::m_y
private

Floating-point number of the the coordinate to anchoring (default = 0.5).

Definition at line 101 of file AnchorPoint.h.


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