rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvMapText Class Reference

This class defines a georeferenced text. More...

Inheritance diagram for IlvMapText:
IlvMapGeometry

List of all members.

Public Member Functions

 IlvMapText (const IlvMapText &source)
 Creates a text by copying an existing point.
 IlvMapText (const IlvCoordinate &p, const char *text)
 Initializes an instance of text.
 IlvMapText ()
 Constructor.
virtual IlvMapGeometrycopy () const
 Returns a copy of the object.
virtual IlvClassInfogetClassInfo () const
 Returns the IlvClassInfo of the instance.
const IlvCoordinategetPoint () const
 Returns the anchor point of the text.
virtual const IlvMapGeometrygetSubElement (IlUInt index) const
 Returns the sub element of index index if the geometry is a collection.
virtual IlUInt getSubElementCount () const
 Returns the number of elements contained in the geometry if the geometry is a collection.
const char * getText () const
 Returns the value of the text.
virtual IlBoolean isCollection () const
 Returns IlTrue if the geometry is a collection of other geometries.
void setPoint (const IlvCoordinate &point)
 Sets the position of the text.
void setText (const char *text)
 Sets the value of the text.

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:
p An anchor point for the text.
text The value of the text.
IlvMapText::IlvMapText ( const IlvMapText source  ) 

Creates a text by copying an existing point.

Parameters:
source The 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 the sub element of index index if the geometry is a collection.

Otherwise, it returns a null pointer.

Returns:
The sub element of index index if the geometry is a collection.

Implements IlvMapGeometry.

virtual IlUInt IlvMapText::getSubElementCount (  )  const [virtual]

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

Otherwise, it returns 0.

Returns:
The number of elements contained in the geometry if the geometry is a collection. Otherwise, it 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]

Returns IlTrue if the 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:
An Anchor point for the text.
void IlvMapText::setText ( const char *  text  ) 

Sets the value of the text.

Parameters:
text The value of the text.

© Copyright 2012, 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.