A TextSymbolizer is used to render text labels according to various graphical parameters.
More...
#include <TextSymbolizer.h>
A TextSymbolizer is used to render text labels according to various graphical parameters.
In this case, if a line, polygon, or raster geometry is used with this Symbolizer, then the semantic is to use the centroid of the geometry, or any similar representative point.
- See also
- Symbolizer, ParameterValue, Font, LabelPlacement, Halo, Fill, te::fe::PropertyName
- Note
- If a Label element is not provided in a TextSymbolizer, then no text shall be rendered.
Definition at line 62 of file TextSymbolizer.h.
◆ ReturnType
◆ VisitorType
◆ TextSymbolizer() [1/2]
| te::se::TextSymbolizer::TextSymbolizer |
( |
| ) |
|
◆ TextSymbolizer() [2/2]
Copy constructor.
- Parameters
-
| rhs | The other text symbolizer. |
◆ ~TextSymbolizer()
| te::se::TextSymbolizer::~TextSymbolizer |
( |
| ) |
|
◆ accept()
It call the visit method from the guest object.
- Parameters
-
| guest | The guest or visitor. |
- Returns
- Any valid value define by the template type R.
◆ clone()
| Symbolizer * te::se::TextSymbolizer::clone |
( |
| ) |
const |
|
virtual |
◆ getBaseSymbolizer()
◆ getDescription()
| const Description * te::se::Symbolizer::getDescription |
( |
| ) |
const |
|
inherited |
◆ getFill()
| const Fill * te::se::TextSymbolizer::getFill |
( |
| ) |
const |
◆ getFont()
| const Font * te::se::TextSymbolizer::getFont |
( |
| ) |
const |
◆ getHalo()
| const Halo * te::se::TextSymbolizer::getHalo |
( |
| ) |
const |
◆ getLabel()
◆ getLabelPlacement()
| const LabelPlacement * te::se::TextSymbolizer::getLabelPlacement |
( |
| ) |
const |
◆ getName()
| const std::string & te::se::Symbolizer::getName |
( |
| ) |
const |
|
inherited |
◆ getType()
| const std::string & te::se::TextSymbolizer::getType |
( |
| ) |
const |
|
virtual |
It returns the symbolizer type.
- Returns
- The symbolizer type.
Implements te::se::Symbolizer.
◆ getUom()
| const te::common::BaseUnitOfMeasure * te::se::Symbolizer::getUom |
( |
| ) |
const |
|
inherited |
◆ getVersion()
| const std::string & te::se::Symbolizer::getVersion |
( |
| ) |
const |
|
inherited |
◆ setBaseSymbolizer()
◆ setDescription()
| void te::se::Symbolizer::setDescription |
( |
Description * |
d | ) |
|
|
inherited |
◆ setFill()
| void te::se::TextSymbolizer::setFill |
( |
Fill * |
f | ) |
|
◆ setFont()
| void te::se::TextSymbolizer::setFont |
( |
Font * |
f | ) |
|
◆ setGeometry()
◆ setHalo()
| void te::se::TextSymbolizer::setHalo |
( |
Halo * |
h | ) |
|
◆ setLabel()
◆ setLabelPlacement()
◆ setName()
| void te::se::Symbolizer::setName |
( |
const std::string & |
name | ) |
|
|
inherited |
◆ setUom()
| void te::se::Symbolizer::setUom |
( |
const te::common::BaseUnitOfMeasure * |
uom | ) |
|
|
inherited |
It sets the unit-of-measure.
All Symbolizers include an optional gml:uom-attribute as used by GML (this is set inside the abstract SymbolizerType and therefore inherited by all Symbolizers). This applies to all elements included inside a Symbolizer such as stroke-width, size, font-size, Gap, InitialGap, Displacement and PerpendicularOffset. If no uom is set inside of Symbolizer, all units are measured in pixel, the behaviour used by SLD 1.0.0. The following uom definitions are recommended to be used:
◆ setVersion()
| void te::se::Symbolizer::setVersion |
( |
const std::string & |
version | ) |
|
|
inherited |
◆ m_baseSymbolizer
A BaseSymbolizer (an OnlineResource) defines the default properties of a Symbolizer to be those of an external Symbolizer, which will frequently be inside of an OGC Symbolizer repository. The Symbolizer properties given in-line override the base-Symbolizer properties. (Optional)
Definition at line 164 of file Symbolizer.h.
◆ m_description
It gives the familiar short title for display lists and longer description for the symbolizer. (Optional)
Definition at line 163 of file Symbolizer.h.
◆ m_fill
| Fill* te::se::TextSymbolizer::m_fill |
|
private |
It specifies how the text area will be filled. (Optional)
Definition at line 129 of file TextSymbolizer.h.
◆ m_font
| Font* te::se::TextSymbolizer::m_font |
|
private |
The font element specifies the text font to use. (Optional)
Definition at line 126 of file TextSymbolizer.h.
◆ m_geometry
◆ m_halo
| Halo* te::se::TextSymbolizer::m_halo |
|
private |
A Halo is a type of Fill that is applied to the backgrounds of font glyphs. (Optional)
Definition at line 128 of file TextSymbolizer.h.
◆ m_label
The label specifies the textual content to be rendered. (Optional)
Definition at line 125 of file TextSymbolizer.h.
◆ m_labelPlacement
The label placement specifies where and how a text label should be rendered relative to a geometry. (Optional)
Definition at line 127 of file TextSymbolizer.h.
◆ m_name
| std::string te::se::Symbolizer::m_name |
|
privateinherited |
It allows the symbolizer to be referenced externally, which is needed in some methods of SE usage. (Optional)
Definition at line 162 of file Symbolizer.h.
◆ m_uom
| const te::common::BaseUnitOfMeasure* te::se::Symbolizer::m_uom |
|
privateinherited |
Unit of measurement. If no uom is set inside of Symbolizer, all units are measured in pixel. (Mandatory)
Definition at line 166 of file Symbolizer.h.
◆ m_version
| std::string te::se::Symbolizer::m_version |
|
privateinherited |
The version is an optional attribute on the FeatureType Style element that identifies the SE version number that the FeatureTypeStyle corresponds to. For now, the only allowed value is 1.1.0. (Mandatory)
Definition at line 165 of file Symbolizer.h.
◆ sm_type
| const std::string te::se::TextSymbolizer::sm_type |
|
staticprivate |
A static data member used in the implementation of getType method.
Definition at line 131 of file TextSymbolizer.h.
The documentation for this class was generated from the following file:
- /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/se/TextSymbolizer.h
