Rogue Wave Views
Maps Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvMapText Class Reference

This class defines a georeferenced text. More...

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

Inheritance diagram for IlvMapText:
IlvMapGeometry

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 IlvMapGeometrycopy () const
 Returns a copy of the object. More...
 
virtual IlvClassInfogetClassInfo () const
 Returns the IlvClassInfo of the instance. More...
 
const IlvCoordinategetPoint () const
 Returns the anchor point of the text. More...
 
virtual const IlvMapGeometrygetSubElement (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 IlvClassInfoClassInfo ()
 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::IlvMapText ( )

Constructor.

Initializes an instance of text.

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

Initializes an instance of text.

Parameters
pAn anchor point for the text.
textThe value of the text.
IlvMapText::IlvMapText ( const IlvMapText source)

Creates a text by copying an existing point.

Parameters
sourceThe source point.

Member Function Documentation

virtual IlvMapGeometry* IlvMapText::copy ( ) const
virtual

Returns a copy of the object.

Returns
An IlvMapGeometry that must be deleted by the user.

Implements IlvMapGeometry.

virtual IlvClassInfo* IlvMapText::getClassInfo ( ) const
virtual

Returns the IlvClassInfo of the instance.

Returns
An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapGeometry.

const IlvCoordinate& IlvMapText::getPoint ( ) const

Returns the anchor point of the text.

Returns
The anchor point of the text.
virtual const IlvMapGeometry* IlvMapText::getSubElement ( IlUInt  index) const
virtual

Returns a sub element of a collection geometry.

Parameters
indexThe 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.

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.

const char* IlvMapText::getText ( ) const

Returns the value of the text.

Returns
The value of the text.
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.

void IlvMapText::setPoint ( const IlvCoordinate point)

Sets the position of the text.

Parameters
pointAn Anchor point for the text.
void IlvMapText::setText ( const char *  text)

Sets the value of the text.

Parameters
textThe value of the text.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.