te::se::Displacement Class Reference

A Displacement gives X and Y offset displacements to use for rendering a text label, graphic or other Symbolizer near a point. More...

#include <Displacement.h>

Inheritance diagram for te::se::Displacement:

Public Member Functions

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

Methods related to instantiation and destruction.

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

Methods used to get or set properties.

void setDisplacementX (ParameterValue *x)
 
const ParameterValuegetDisplacementX () const
 
void setDisplacementY (ParameterValue *y)
 
const ParameterValuegetDisplacementY () const
 

Private Attributes

ParameterValuem_x
 It gives the X offset displacement. More...
 
ParameterValuem_y
 It gives the Y offset displacement. More...
 

Detailed Description

A Displacement gives X and Y offset displacements to use for rendering a text label, graphic or other Symbolizer near a point.

This element may be used to avoid over-plotting of multiple graphic symbols used as part of the same point symbol. The displacements are in units of measure above and to the right of the point. The default displacement is X = 0, Y = 0.
If Displacement is used in conjunction with Size and/or Rotation then the graphic symbol shall be scaled and/or rotated before it is displaced.

See also
Graphic, ParameterValue, PointPlacement

Definition at line 58 of file Displacement.h.

Constructor & Destructor Documentation

te::se::Displacement::Displacement ( )

It initializes a new Displacement.

te::se::Displacement::~Displacement ( )

Destructor.

Member Function Documentation

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

It creates a new copy of this object.

const ParameterValue* te::se::Displacement::getDisplacementX ( ) const
const ParameterValue* te::se::Displacement::getDisplacementY ( ) const
void te::se::Displacement::setDisplacementX ( ParameterValue x)
void te::se::Displacement::setDisplacementY ( ParameterValue y)

Member Data Documentation

ParameterValue* te::se::Displacement::m_x
private

It gives the X offset displacement.

Definition at line 95 of file Displacement.h.

ParameterValue* te::se::Displacement::m_y
private

It gives the Y offset displacement.

Definition at line 96 of file Displacement.h.


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