TSLMUPoint Class Reference

Inheritance diagram for TSLMUPoint:

Detailed Description

This class provides a container for a point in Map-Units.

This class may be used along with an appropriate feature rendering configuration in order to represent a MapLink symbol, or a textual entity.

In order to represent text the value must be added as an attribute, and setTextValueAttribute must be called.

Public Member Functions
virtual TSLMUGeometry *	clone ()
TSLMUCoord &	getPosition ()
void	setPosition (const TSLMUCoord &newPosition)
bool	setTextValueAttribute (const char *attributeName)
const char *	getTextValueAttribute () const
virtual bool	calculateExtent (TSLMUExtent &extent) const
Public Member Functions inherited from TSLMUGeometry
void	destroy ()
	Destructor.
TSLMUGeometry::GeometryType	type () const
TSLFeatureID	featureID () const
void	featureID (TSLFeatureID id)
const char *	featureName () const
void	featureName (const char *name)
unsigned int	numAttributes () const
bool	getAttribute (unsigned int index, TSLSimpleString *attributeName, TSLSimpleString *attributeValue)
const char *	getAttribute (const char *attributeName) const
void	setAttribute (const char *attributeName, const char *attributeValue)
void	clearAttribute (const char *attributeName)
void	clearAttributes ()
	Clear all attributes.
void	rotation (double rot)
double	rotation () const

Static Public Member Functions
static TSLMUPoint *	create (TSLMUCoord position=TSLMUCoord(), TSLFeatureID featureID=TSLFeatureID_Default, const char *featureName=NULL)

Protected Member Functions
	TSLMUPoint (TSLMUCoord position=TSLMUCoord(), TSLFeatureID featureID=TSLFeatureID_Default, const char *featureName=NULL)
	TSLMUPoint (const TSLMUPoint &other)
virtual	~TSLMUPoint ()
Protected Member Functions inherited from TSLMUGeometry
	TSLMUGeometry (TSLMUGeometry::GeometryType type, TSLFeatureID featureID=TSLFeatureID_Default, const char *featureName=NULL)
	TSLMUGeometry (const TSLMUGeometry &other)
virtual	~TSLMUGeometry ()

Additional Inherited Members
Public Types inherited from TSLMUGeometry
enum	GeometryType {   GeometryTypeNone , GeometryTypeSet , GeometryTypePoint , GeometryTypePolyline ,   GeometryTypePolygon }
	This enum represents the type of a given TSLMUGeometry instance. More...

Constructor & Destructor Documentation

TSLMUPoint() [1/2]

TSLMUPoint::TSLMUPoint ( TSLMUCoord position = TSLMUCoord(), TSLFeatureID featureID = TSLFeatureID_Default, const char * featureName = NULL )

protected

TSLMUPoint() [2/2]

TSLMUPoint::TSLMUPoint ( const TSLMUPoint & other )

protected

~TSLMUPoint()

virtual TSLMUPoint::~TSLMUPoint ( )

protectedvirtual

Member Function Documentation

calculateExtent()

virtual bool TSLMUPoint::calculateExtent ( TSLMUExtent & extent ) const

virtual

Calculate the extent of this geometry

A point's extent will always be of zero width and height.

Parameters

extent

Will be set to the calculated extent.

Returns

true if the extent was calculated, false otherwise.

Implements TSLMUGeometry.

clone()

virtual TSLMUGeometry * TSLMUPoint::clone ( )

virtual

Create a clone of this geometry

Returns

A clone of this geometry. This object is owned by the caller.

Implements TSLMUGeometry.

create()

static TSLMUPoint * TSLMUPoint::create ( TSLMUCoord position = TSLMUCoord(), TSLFeatureID featureID = TSLFeatureID_Default, const char * featureName = NULL )

static

Constructor

Parameters

position	The position of this point
featureID	The feature ID
featureName	The feature name

getPosition()

TSLMUCoord & TSLMUPoint::getPosition

(

)

Query the position of this point

Returns

The position of this point. This TSLMUCoord may be modified to set the position of the TSLMUPoint.

getTextValueAttribute()

const char * TSLMUPoint::getTextValueAttribute

(

)

const

Get the name of the displayed attribute

Returns

The name of the attribute to use when displaying text, or NULL if not set.

setPosition()

void TSLMUPoint::setPosition

(

const TSLMUCoord &

newPosition

)

Set the position of this point

Parameters

newPosition

The new position of this point

setTextValueAttribute()

bool TSLMUPoint::setTextValueAttribute

(

const char *

attributeName

)

Set the attribute to display

If this point is to be displayed, the provided attribute will be read to determine the displayed text.

Parameters

attributeName

The name of the attribute to use when displaying as text.

Returns

true if the provided attribute name was valid, false otherwise.