IlvMapText Class Reference

This class defines a georeferenced text. More...

#include <ilviews/maps/geometry/geotext.h>

Inheritance diagram for IlvMapText:

Public Member Functions
	IlvMapText ()
	Constructor. More...
	IlvMapText (const IlvCoordinate &p, const char *text)
	Initializes an instance of text. More...
	IlvMapText (const IlvMapText &source)
	Creates a text by copying an existing point. More...
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object. More...
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance. More...
const IlvCoordinate &	getPoint () const
	Returns the anchor point of the text. More...
virtual const IlvMapGeometry *	getSubElement (IlUInt index) const
	Returns a sub element of a collection geometry. More...
virtual IlUInt	getSubElementCount () const
	Returns the number of elements contained in the geometry if the geometry is a collection. More...
const char *	getText () const
	Returns the value of the text. More...
virtual IlBoolean	isCollection () const
	Checks if this geometry is a collection of other geometries. More...
void	setPoint (const IlvCoordinate &point)
	Sets the position of the text. More...
void	setText (const char *text)
	Sets the value of the text. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvMapGeometry
static IlvClassInfo *	ClassInfo ()
	Returns the class info. More...
Protected Member Functions inherited from IlvMapGeometry
	IlvMapGeometry ()
	Constructor. More...

Detailed Description

This class defines a georeferenced text.

The instances of this class can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultTextRenderer. Library: ilvmaps

Constructor & Destructor Documentation

IlvMapText() [1/3]

IlvMapText::IlvMapText

(

)

Constructor.

Initializes an instance of text.

IlvMapText() [2/3]

IlvMapText::IlvMapText	(	const IlvCoordinate &	p,
		const char *	text
	)

Initializes an instance of text.

Parameters

p	An anchor point for the text.
text	The value of the text.

IlvMapText() [3/3]

IlvMapText::IlvMapText

(

const IlvMapText &

source

)

Creates a text by copying an existing point.

Parameters

source

The source point.

Member Function Documentation

copy()

virtual IlvMapGeometry* IlvMapText::copy ( ) const

virtual

Returns a copy of the object.

Returns

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapGeometry.

getClassInfo()

virtual IlvClassInfo* IlvMapText::getClassInfo ( ) const

virtual

Returns the IlvClassInfo of the instance.

Returns

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapGeometry.

getPoint()

const IlvCoordinate& IlvMapText::getPoint

(

)

const

Returns the anchor point of the text.

Returns

The anchor point of the text.

getSubElement()

virtual const IlvMapGeometry* IlvMapText::getSubElement ( IlUInt  index ) const

virtual

Returns a sub element of a collection geometry.

Parameters

index

The index of the sub-geometry to be retrieved.

Returns

The sub element of index index if the geometry is a collection or 0 if it is not.

Implements IlvMapGeometry.

getSubElementCount()

virtual IlUInt IlvMapText::getSubElementCount ( ) const

virtual

Returns the number of elements contained in the geometry if the geometry is a collection.

Returns

The number of elements contained in the geometry if the geometry is a collection. If it is not, this method returns 0.

Implements IlvMapGeometry.

getText()

const char* IlvMapText::getText

(

)

const

Returns the value of the text.

Returns

The value of the text.

isCollection()

virtual IlBoolean IlvMapText::isCollection ( ) const

virtual

Checks if this geometry is a collection of other geometries.

The composite geometries predefined in Rogue Wave Views Maps are: IlvMapGeometryCollection, IlvMapMultiPoint, IlvMapSegmentString and its subclasses, IlvMapMultiCurve and IlvMapMultiArea.

Returns

IlTrue if the geometry is a collection of other geometries.

Implements IlvMapGeometry.

setPoint()

void IlvMapText::setPoint

(

const IlvCoordinate &

point

)

Sets the position of the text.

Parameters

point

An Anchor point for the text.

setText()

void IlvMapText::setText

(

const char *

text

)

Sets the value of the text.

Parameters

text	The value of the text.