envitia::maplink::earth::geometry::Symbol Class Reference

Inheritance diagram for envitia::maplink::earth::geometry::Symbol:

Detailed Description

A Symbol primitive.

A Symbol represents a single point or icon on the display, and will be rendered based on the SymbolStyle attributes.

Symbols may be rendered either by providing a symbol ID from the MapLink symbol set, or by loading an image directly.

Public Member Functions
	Symbol ()
	Constructor.
	Symbol (const char *style)
	Symbol (const char *style, const GeodeticPoint &p)
	Symbol (const Symbol &other)
	Copy Constructor.
virtual	~Symbol ()
	Destructor.
virtual GeometryType	type () const
	Query the type of the geometry instance.
virtual Geometry *	clone () const
void	position (const GeodeticPoint &p)
	Set the position of the symbol.
const GeodeticPoint &	position () const
	Query the position of the symbol.
void	displayRotation (double angle)
double	displayRotation () const
	Query the display rotation of the Symbol.
Public Member Functions inherited from envitia::maplink::earth::geometry::Geometry
virtual	~Geometry ()
	Destructor.
const char *	styleName () const
	Query the style used when rendering the geometry.
void	styleName (const char *style)
Interpolation	interpolation () const
void	interpolation (Interpolation i)
	Set the type of interpolation applied to edges.
void	visibility (bool v)
void	visibilityOnSurface (bool v, const Surface3D *surface)
bool	visibilityOnSurface (const Surface3D *surface) const
bool	setAttribute (const char *name, const char *value)
const char *	getAttribute (const char *name) const
bool	removeAttribute (const char *name)
unsigned int	numAttributes () const
const char *	attributeName (unsigned int index) const
const char *	attributeValue (unsigned int index) const
bool	removeAttribute (unsigned int index)
GeodeticPoint	centroid () const
	Query the centroid of the geometry.
void	translate (const GeodeticPoint &t)
void	scale (const GeodeticPoint &s)
void	scale (const GeodeticPoint &s, const GeodeticPoint &origin)
void	rotate (const GeodeticDirection &axis, double angle)

Additional Inherited Members
Public Types inherited from envitia::maplink::earth::geometry::Geometry
enum	GeometryType {   GeometryTypePolyline , GeometryTypePolygon , GeometryTypeSymbol , GeometryTypeText ,   GeometryTypeSet }
	The type of a geometry instance. More...
enum	Interpolation { GreatCircle , RhumbLine }
Protected Member Functions inherited from envitia::maplink::earth::geometry::Geometry
	Geometry ()
	Geometry (const char *style)
	Geometry (const Geometry &other)
Protected Attributes inherited from envitia::maplink::earth::geometry::Geometry
void *	m_p

Constructor & Destructor Documentation

Symbol() [1/4]

envitia::maplink::earth::geometry::Symbol::Symbol

(

)

Constructor.

Symbol() [2/4]

envitia::maplink::earth::geometry::Symbol::Symbol

(

const char *

style

)

Constructor

Parameters

style

The name of the style to use when rendering.

Symbol() [3/4]

envitia::maplink::earth::geometry::Symbol::Symbol	(	const char *	style,
		const GeodeticPoint &	p )

Constructor

Parameters

style	The name of the style to use when rendering.
p	The position of the Symbol.

Symbol() [4/4]

envitia::maplink::earth::geometry::Symbol::Symbol

(

const Symbol &

other

)

Copy Constructor.

~Symbol()

virtual envitia::maplink::earth::geometry::Symbol::~Symbol ( )

virtual

Destructor.

Member Function Documentation

clone()

virtual Geometry * envitia::maplink::earth::geometry::Symbol::clone ( ) const

virtual

Create a clone of this geometry

If the geometry is a set this will perform a deep copy (All children of the set will be cloned).

Implements envitia::maplink::earth::geometry::Geometry.

displayRotation() [1/2]

double envitia::maplink::earth::geometry::Symbol::displayRotation

(

)

const

Query the display rotation of the Symbol.

displayRotation() [2/2]

void envitia::maplink::earth::geometry::Symbol::displayRotation

(

double

angle

)

Set the display rotation of the Symbol.

The symbol will be displayed as a 2D 'billboard' on the display, rotated to this angle. For example a rotation of 90 degrees would result in the top of the symbol pointing to the right of the display.

Parameters

angle

The angle of rotation.

position() [1/2]

const GeodeticPoint & envitia::maplink::earth::geometry::Symbol::position

(

)

const

Query the position of the symbol.

position() [2/2]

void envitia::maplink::earth::geometry::Symbol::position

(

const GeodeticPoint &

p

)

Set the position of the symbol.

type()

virtual GeometryType envitia::maplink::earth::geometry::Symbol::type ( ) const

virtual

Query the type of the geometry instance.

Implements envitia::maplink::earth::geometry::Geometry.