Namespace for the Symbology Encoding module of TerraLib. More...

Namespaces
	serialize

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

class	Categorize
	The transformation of continuous values to distinct values (Categorize function). More...

class	ChangeCase
	Changes the case of strings (String formatting functions). More...

class	ChannelSelection
	ChannelSelection specifies the false-color channel selection for a multi-spectral raster source (such as a multi-band satellite-imagery source). More...

class	ColorMap
	A ColorMap defines either the colors of a pallette-type raster source or the mapping of numeric pixel values to colors. More...

class	Concatenate
	Concatenates strings (String formatting functions). More...

class	ContrastEnhancement
	ContrastEnhancement defines the 'stretching' of contrast for a channel of a false-color image or for a whole grey/color image. More...

class	CoverageStyle
	The CoverageStyle defines the styling that is to be applied to a subset of Coverage data. More...

class	Description
	A Description gives human-readable descriptive information for the object it is included within. More...

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

class	ExternalGraphic
	The ExternalGraphic allows a reference to be made to an external graphic file with a Web URL or to in-line content. More...

class	FeatureTypeStyle
	The FeatureTypeStyle defines the styling that is to be applied to a dataset that can be viewed as a feature type. More...

class	Fill
	A Fill specifies the pattern for filling an area geometry. More...

class	Font
	A Font specifies the text font to use in a text symbolizer. More...

class	FormatDate
	Date formatting function. More...

class	FormatNumber
	Numeric formatting function. More...

class	Function
	Symbology Encoding functions. More...

class	Graphic
	A Graphic is a graphic symbol with an inherent shape, color(s), and possibly size. More...

class	GraphicStroke
	A GraphicStroke defines a repeated-linear graphic pattern to be used for stroking a line. More...

class	Halo
	A Halo is a type of Fill that is applied to the backgrounds of font glyphs. More...

class	ImageOutline
	ImageOutline specifies how individual source rasters in a multi-raster set (such as a set of satellite-image scenes) should be outlined to make the individual-image locations visible. More...

class	InlineContent
	InlineContent is XML- or base64-encoded encoded content in some externally-defined format that is included in an SE in-line. More...

class	Interpolate
	The transformation of continuous values to a number of values (Interpolate function). More...

class	InterpolationPoint
	They are used to define a graph of points. More...

class	LabelPlacement
	The LabelPlacement specifies where and how a text label should be rendered relative to a geometry. More...

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

class	LineSymbolizer
	A LineSymbolizer is used to style a stroke along a linear geometry type, such as a string of line segments. More...

class	MapItem

class	Mark
	A Mark specifies a geometric shape and applies coloring to it. More...

class	ParameterValue
	The "ParameterValueType" uses WFS-Filter expressions to give values for SE graphic parameters. More...

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

class	PointSymbolizer
	A PointSymbolizer specifies the rendering of a graphic Symbolizer at a point. More...

class	PolygonSymbolizer
	A PolygonSymbolizer is used to draw a polygon (or other area-type geometries), including filling its interior and stroking its border (outline). More...

class	RasterSymbolizer
	The RasterSymbolizer describes how to render raster/matrix-coverage data (e.g., satellite photos, DEMs). More...

class	Recode
	Transformation of discrete values to other values. More...

class	Rule
	A Rule is used to attach property/scale conditions to and group the individual symbols used for rendering. More...

class	SelectedChannel
	A selected channel to be display. More...

class	ShadedRelief
	ShadedRelief specifies the application of relief shading (or "hill shading") to a DEM raster to give it somewhat of a three-dimensional effect and to make elevation changes more visible. More...

class	StringLength
	Returns length of string (String formatting functions). More...

class	StringPosition
	It returns the position of first occurence of a substring (String formatting functions). More...

class	Stroke
	A Stroke specifies the appearance of a linear geometry. More...

class	Style
	The Style defines the styling that is to be applied to a geographic dataset (vector geometries or coverage). More...

class	Substring
	It returns the substring (String formatting functions). More...

class	SvgParameter
	A SvgParameter refers to an SVG/CSS graphical-formatting parameter. More...

class	Symbolizer
	A Symbolizer describes how a feature is to appear on a map. More...

class	SymbolizerColorFinder
	A Symbology Enconding visitor that finds a color given a symbolizer element. If you want to use this visitor, use a command like: `te::se::SymbolizerColorFinder scf; scf.find(symbolizer); te::color::RGBAColor color = scf.getColor();` More...

class	SymbologyManager
	The SymbologyManager is a singleton that can be used to manage all loaded symbols in TerraLib. More...

class	TextSymbolizer
	A TextSymbolizer is used to render text labels according to various graphical parameters. More...

class	Trim
	Strips off chars from a string value (String formatting functions). More...

class	Visitor
	A visitor interface for the SymbologyEncoding hierarchy. More...

Enumerations
enum	ColorCompositionType { RGB_COMPOSITION, RED_COMPOSITION, GREEN_COMPOSITION, BLUE_COMPOSITION, GRAY_COMPOSITION, UNKNOWN_COMPOSITION }
	Allowed color compositions type. More...

enum	ColorMapSlicingType { EQUAL_STEP_SLICE, UNIQUE_VALUE_SLICE }

enum	ColorMapTransformationType { CATEGORIZE_TRANSFORMATION, INTERPOLATE_TRANSFORMATION, RECODE_TRANSFORMATION }
	Allowed color transformations type. More...

Functions
TESEEXPORT Style *	CreateCoverageStyle (const std::vector< te::rst::BandProperty * > &properties)
	Try creates an appropriate coverage style based on given band properties. More...

TESEEXPORT Style *	CreateCoverageStyle (const std::size_t &nBands)
	Try creates an appropriate coverage style based on given number of bands. More...

TESEEXPORT Description *	CreateDescription (const std::string &title, const std::string &abst)
	Creates a description. More...

TESEEXPORT Style *	CreateFeatureTypeStyle (const te::gm::GeomType &geomType)
	Try creates an appropriate feature type style based on given geometry type. More...

TESEEXPORT Fill *	CreateFill (const std::string &color, const std::string &opacity)
	Creates a fill. More...

TESEEXPORT Fill *	CreateFill (Graphic *graphicFill)
	Creates a fill. More...

TESEEXPORT Font *	CreateFont (const std::string &family, const std::string &size, const te::se::Font::FontStyleType &style=te::se::Font::StyleNormal, const te::se::Font::FontWeightType &weight=te::se::Font::WeightNormal)
	Creates a font. More...

TESEEXPORT Graphic *	CreateGraphic (Mark *mark, const std::string &size, const std::string &rotation, const std::string &opacity)
	Creates a graphic. More...

TESEEXPORT LineSymbolizer *	CreateLineSymbolizer (Stroke *stroke)
	Creates a line symbolizer. More...

TESEEXPORT Mark *	CreateMark (const std::string &wellKnownName, Stroke stroke, Fill fill)
	Creates a mark. More...

TESEEXPORT PointSymbolizer *	CreatePointSymbolizer (Graphic *graphic)
	Creates a point symbolizer. More...

TESEEXPORT PolygonSymbolizer *	CreatePolygonSymbolizer (Stroke stroke, Fill fill)
	Creates a polygon symbolizer. More...

TESEEXPORT RasterSymbolizer *	CreateRasterSymbolizer (const std::size_t &nBands)
	Try creates an appropriate raster symbolizer style based on given number of bands. More...

TESEEXPORT Stroke *	CreateStroke (const std::string &color, const std::string &width)
	Creates a stroke. More...

TESEEXPORT Stroke *	CreateStroke (const std::string &color, const std::string &width, const std::string &opacity)
	Creates a stroke. More...

TESEEXPORT Stroke *	CreateStroke (const std::string &color, const std::string &width, const std::string &opacity, const std::string &dasharray)
	Creates a stroke. More...

TESEEXPORT Stroke *	CreateStroke (const std::string &color, const std::string &width, const std::string &opacity, const std::string &dasharray, const std::string &linecap, const std::string &linejoin)
	Creates a stroke. More...

TESEEXPORT Stroke *	CreateStroke (Graphic *graphicFill, const std::string &width, const std::string &opacity, const std::string &dasharray, const std::string &linecap, const std::string &linejoin)
	Creates a stroke. More...

TESEEXPORT Symbolizer *	CreateSymbolizer (const te::gm::GeomType &geomType)
	Try creates an appropriate symbolizer based on given geometry type. More...

TESEEXPORT Symbolizer *	CreateSymbolizer (const te::gm::GeomType &geomType, const std::string &color)
	Try creates an appropriate symbolizer based on given geometry type and a default color. More...

TESEEXPORT TextSymbolizer *	CreateTextSymbolizer (const std::string &label, Fill fill, Font font)
	Creates a text symbolizer. More...

TESEEXPORT std::string	GenerateRandomColor ()
	Creates a random RGB color encoded using two hexadecimal digits per primary-color component prefixed with a hash (#) sign. More...

TESEEXPORT void	GetColor (const te::se::Stroke *stroke, te::color::RGBAColor &color)
	It gets the RGBA color from the Stroke element. More...

TESEEXPORT void	GetColor (const te::se::Fill *fill, te::color::RGBAColor &color)
	It gets the RGBA color from the Fill element. More...

TESEEXPORT void	GetColor (const te::se::ParameterValue color, const te::se::ParameterValue opacity, te::color::RGBAColor &rgba)
	It gets the RGBA color from the parameter values. More...

TESEEXPORT te::color::RGBAColor	GetColor (const te::se::ParameterValue *param)
	It gets the parameter value as a RGBA color. More...

TESEEXPORT double	GetDouble (const te::se::ParameterValue *param)
	It gets the parameter value as a double. More...

TESEEXPORT int	GetInt (const te::se::ParameterValue *param)
	It gets the parameter value as an integer. More...

TESEEXPORT RasterSymbolizer *	GetRasterSymbolizer (Style *s)
	Try to get raster symbolizer from a style. More...

TESEEXPORT std::string	GetString (const te::se::ParameterValue *param)
	It gets the parameter value as a string. More...

Detailed Description

Namespace for the Symbology Encoding module of TerraLib.

Enumeration Type Documentation

enum te::se::ColorCompositionType

Allowed color compositions type.

Enumerator
RGB_COMPOSITION	Color composition with 3 bands
RED_COMPOSITION	Color composition with 1 band, red channel
GREEN_COMPOSITION	Color composition with 1 band, green channel
BLUE_COMPOSITION	Color composition with 1 band, blue channel
GRAY_COMPOSITION	Color composition with 1 band, gray channel
UNKNOWN_COMPOSITION	Color composition unknown or not defined

Definition at line 38 of file Enums.h.

enum te::se::ColorMapSlicingType

Enumerator
EQUAL_STEP_SLICE	The Equal step slicing type.
UNIQUE_VALUE_SLICE	The Unique Value slicing type

Definition at line 65 of file Enums.h.

enum te::se::ColorMapTransformationType

Allowed color transformations type.

Enumerator
CATEGORIZE_TRANSFORMATION	The transformation of continuous values to a number of values (Interpolate function).
INTERPOLATE_TRANSFORMATION	The transformation of continuous values to distinct values (Categorize function)
RECODE_TRANSFORMATION	Transformation of discrete values to other values.

Definition at line 53 of file Enums.h.

Function Documentation

TESEEXPORT Style* te::se::CreateCoverageStyle ( const std::vector< te::rst::BandProperty * > & properties )

Try creates an appropriate coverage style based on given band properties.

Parameters

properties The band properties.

Returns: A coverage style based on given geometry type.

Note: The caller of this method will take the ownership of the returned pointer.; The method will return a NULL pointer if a default style could not be created.

TESEEXPORT Style* te::se::CreateCoverageStyle ( const std::size_t & nBands )

Try creates an appropriate coverage style based on given number of bands.

Parameters

nBands The number of bands.

Returns: A coverage style based on given geometry type.

Note: The caller of this method will take the ownership of the returned pointer.; The method will return a NULL pointer if a default style could not be created.

TESEEXPORT Description* te::se::CreateDescription	(	const std::string &	title,
		const std::string &	abst
	)

Creates a description.

Parameters

title	The title of description.
abst	The abstratc of description.

Returns: The Symbology Enconding Description element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT Style* te::se::CreateFeatureTypeStyle ( const te::gm::GeomType & geomType )

Try creates an appropriate feature type style based on given geometry type.

Parameters

geomType The geometry type.

Returns: A feature type style based on given geometry type.

Note: The caller of this method will take the ownership of the returned pointer.; The method will return a NULL pointer if a default style could not be created.

TESEEXPORT Fill* te::se::CreateFill	(	const std::string &	color,
		const std::string &	opacity
	)

Creates a fill.

Parameters

color	The fill color enconded hexadecimal i.e "#FF0000".
opacity	The fill opacity.

Returns: The Symbology Enconding Fill element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT Fill* te::se::CreateFill ( Graphic * graphicFill )

Creates a fill.

Parameters

graphic The graphic fill.

Returns: The Symbology Enconding Fill element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT Font* te::se::CreateFont	(	const std::string &	family,
		const std::string &	size,
		const te::se::Font::FontStyleType &	style = `te::se::Font::StyleNormal`,
		const te::se::Font::FontWeightType &	weight = `te::se::Font::WeightNormal`
	)

Creates a font.

Parameters

family	The font family.
size	The font size.
style	The font style.
weight	The font weight.

Returns: The Symbology Enconding Font element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT Graphic* te::se::CreateGraphic	(	Mark *	mark,
		const std::string &	size,
		const std::string &	rotation,
		const std::string &	opacity
	)

Creates a graphic.

Parameters

mark	The graphic mark.
size	The graphic size.
rotation	The graphic rotation.
opacity	The graphic opacity.

Returns: The Symbology Enconding Graphic element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT LineSymbolizer* te::se::CreateLineSymbolizer ( Stroke * stroke )

Creates a line symbolizer.

Parameters

stroke The line symbolizer stroke.

Returns: The Symbology Enconding LineSymbolizer element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT Mark* te::se::CreateMark	(	const std::string &	wellKnownName,
		Stroke *	stroke,
		Fill *	fill
	)

Creates a mark.

Parameters

wellKnownName	The mark well-known name.
stroke	The mark stroke.
fill	The mark fill.

Returns: The Symbology Enconding Mark element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT PointSymbolizer* te::se::CreatePointSymbolizer ( Graphic * graphic )

Creates a point symbolizer.

Parameters

graphic The point symbolizer graphic.

Returns: The Symbology Enconding PointSymbolizer element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT PolygonSymbolizer* te::se::CreatePolygonSymbolizer	(	Stroke *	stroke,
		Fill *	fill
	)

Creates a polygon symbolizer.

Parameters

stroke	The polygon symbolizer stroke.
fill	The polygon symbolizer fill.

Returns: The Symbology Enconding PolygonSymbolizer element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT RasterSymbolizer* te::se::CreateRasterSymbolizer ( const std::size_t & nBands )

Try creates an appropriate raster symbolizer style based on given number of bands.

Parameters

nBands The number of bands.

Returns: A raster symbolizer based on number of bands.

Note: The caller of this method will take the ownership of the returned pointer.; The method will return a NULL pointer if a default raster symbolizer could not be created.

TESEEXPORT Stroke* te::se::CreateStroke	(	const std::string &	color,
		const std::string &	width
	)

Creates a stroke.

Parameters

color	The stroke color enconded hexadecimal i.e "#FF0000".
width	The stroke width.

Returns: The Symbology Enconding Stroke element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT Stroke* te::se::CreateStroke	(	const std::string &	color,
		const std::string &	width,
		const std::string &	opacity
	)

Creates a stroke.

Parameters

color	The stroke color enconded hexadecimal i.e "#FF0000".
width	The stroke width.
opacity	The stroke opacity [0,1].

Returns: The Symbology Enconding Stroke element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT Stroke* te::se::CreateStroke	(	const std::string &	color,
		const std::string &	width,
		const std::string &	opacity,
		const std::string &	dasharray
	)

Creates a stroke.

Parameters

color	The stroke color enconded hexadecimal i.e "#FF0000".
width	The stroke width.
opacity	The stroke opacity [0,1].
dasharray	The stroke dasharray.

Returns: The Symbology Enconding Stroke element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT Stroke* te::se::CreateStroke	(	const std::string &	color,
		const std::string &	width,
		const std::string &	opacity,
		const std::string &	dasharray,
		const std::string &	linecap,
		const std::string &	linejoin
	)

Creates a stroke.

Parameters

color	The stroke color enconded hexadecimal i.e "#FF0000".
width	The stroke width.
opacity	The stroke opacity [0,1].
dasharray	The stroke dasharray.
linecap	The stroke linecap {butt, square, round}.
linejoin	The stroke linejoin {miter, bevel, round}.

Returns: The Symbology Enconding Stroke element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT Stroke* te::se::CreateStroke	(	Graphic *	graphicFill,
		const std::string &	width,
		const std::string &	opacity,
		const std::string &	dasharray,
		const std::string &	linecap,
		const std::string &	linejoin
	)

Creates a stroke.

Parameters

graphic	The stroke graphic fill.
width	The stroke width.
opacity	The stroke opacity [0,1].
dasharray	The stroke dasharray.
linecap	The stroke linecap {butt, square, round}.
linejoin	The stroke linejoin {miter, bevel, round}.

Returns: The Symbology Enconding Stroke element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT Symbolizer* te::se::CreateSymbolizer ( const te::gm::GeomType & geomType )

Try creates an appropriate symbolizer based on given geometry type.

Parameters

geomType The geometry type.

Returns: A symbolizer based on given geometry type.

Note: Random colors will be generated.; The caller of this method will take the ownership of the returned pointer.; The method will return a NULL pointer if a default symbolizer could not be created.

TESEEXPORT Symbolizer* te::se::CreateSymbolizer	(	const te::gm::GeomType &	geomType,
		const std::string &	color
	)

Try creates an appropriate symbolizer based on given geometry type and a default color.

Parameters

geomType	The geometry type.
color	The fill color enconded hexadecimal i.e "#FF0000".

Returns: A symbolizer based on given geometry type.

Note: The caller of this method will take the ownership of the returned pointer.; The method will return a NULL pointer if a default symbolizer could not be created.

TESEEXPORT TextSymbolizer* te::se::CreateTextSymbolizer	(	const std::string &	label,
		Fill *	fill,
		Font *	font
	)

Creates a text symbolizer.

Parameters

label	The property name that will be labelled.
fill	The text symbolizer fill.
font	The text symbolizer font.

Returns: The Symbology Enconding TextSymbolizer element.

Note: The caller of this method will take the ownership of the returned pointer.

TESEEXPORT std::string te::se::GenerateRandomColor ( )

Creates a random RGB color encoded using two hexadecimal digits per primary-color component prefixed with a hash (#) sign.

Returns: A random color encoded using two hexadecimal digits per primary-color component prefixed with a hash (#) sign.

TESEEXPORT void te::se::GetColor	(	const te::se::Stroke *	stroke,
		te::color::RGBAColor &	color
	)

It gets the RGBA color from the Stroke element.

Parameters

stroke	The Symbology Enconding Stroke element.
color	A pre-created color that will be filled with the values extracted from Stroke.

Note: The given color will be altered based on "stroke" and "stroke-opacity" attributes, if availables.

TESEEXPORT void te::se::GetColor	(	const te::se::Fill *	fill,
		te::color::RGBAColor &	color
	)

It gets the RGBA color from the Fill element.

Parameters

fill	The Symbology Enconding Fill element.
color	A pre-created color that will be filled with the values extracted from Fill.

Note: The given color will be altered based on "fill" and "fill-opacity" attributes, if availables.

TESEEXPORT void te::se::GetColor	(	const te::se::ParameterValue *	color,
		const te::se::ParameterValue *	opacity,
		te::color::RGBAColor &	rgba
	)

It gets the RGBA color from the parameter values.

Parameters

color	The Symbology Enconding Parameter Value element that represents the color.
opacity	The Symbology Enconding Parameter Value element that represents the opacity.
color	A pre-created color that will be filled with the values extracted from color and opacity.

Note: The given color will be altered based on "color" and "opacity" parameters, if availables.; Warning: It considers that the paramater value is enconded using a Literal OGC Filter expression.

TESEEXPORT te::color::RGBAColor te::se::GetColor ( const te::se::ParameterValue * param )

It gets the parameter value as a RGBA color.

Parameters

param The Symbology Enconding Parameter Value element.

Returns: The RGBA color.

Note: Warning: It considers that the paramater value is enconded using a Literal OGC Filter expression.

TESEEXPORT double te::se::GetDouble ( const te::se::ParameterValue * param )

It gets the parameter value as a double.

Parameters

param The Symbology Encoding Parameter Value element.

Returns: The double value.

Note: Warning: It considers that the paramater value is enconded using a Literal OGC Filter expression.

TESEEXPORT int te::se::GetInt ( const te::se::ParameterValue * param )

It gets the parameter value as an integer.

Parameters

param The Symbology Enconding Parameter Value element.

Returns: The integer value.

Note: Warning: It considers that the paramater value is enconded using a Literal OGC Filter expression.

TESEEXPORT RasterSymbolizer* te::se::GetRasterSymbolizer ( Style * s )

Try to get raster symbolizer from a style.

Parameters

s Style.

Returns: A raster symbolizer.

Note: The method will return a NULL pointer if the symbolizer does not have a raster symbolizer.

TESEEXPORT std::string te::se::GetString ( const te::se::ParameterValue * param )

It gets the parameter value as a string.

Parameters

param The Symbology Encoding Parameter Value element.

Returns: The string value.

Note: Warning: It considers that the paramater value is encoded using a Literal OGC Filter expression.

Namespaces

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation