IlvMapMultiCurve Class Reference

This class is used to represent 1-dimension geometries that are composed of a list of other curves. More...

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

Inheritance diagram for IlvMapMultiCurve:

Public Member Functions
	IlvMapMultiCurve ()
	Initializes a new IlvMapMultiCurve instance of the class with an empty list of curves.
	IlvMapMultiCurve (const IlvMapMultiCurve &source)
	Initializes a new IlvMapMultiCurve instance by copying an existing one. More...
void	addCurve (IlvMapCurve *curve)
	Adds a curve. More...
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object. More...
IlUInt	getCardinal () const
	Returns the number of curves. More...
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance. More...
const IlvMapCurve *	getCurve (IlUInt i) const
	Returns the curve at a given index. More...
virtual const IlvMapGeometry *	getSubElement (IlUInt) 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...
virtual IlBoolean	isCollection () const
	Checks if this geometry is a collection of other geometries. More...
void	removeAll ()
	Removes and deletes all the curves.
IlvMapCurve *	removeCurve (const IlvMapCurve *curve)
	Removes the specified curve and returns it. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvMapGeometry
static IlvClassInfo *	ClassInfo ()
	Returns the class info. More...
Protected Member Functions inherited from IlvMapCurve
	IlvMapCurve ()
	Initializes a new, empty, curve.
Protected Member Functions inherited from IlvMapGeometry
	IlvMapGeometry ()
	Constructor. More...

Detailed Description

This class is used to represent 1-dimension geometries that are composed of a list of other curves.

Library: ilvmaps
A IlvMapMultiCurve object does not have to be connected.

The instances of this class can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultCurveRenderer.

Constructor & Destructor Documentation

IlvMapMultiCurve()

IlvMapMultiCurve::IlvMapMultiCurve

(

const IlvMapMultiCurve &

source

)

Initializes a new IlvMapMultiCurve instance by copying an existing one.

Parameters

source

The object to be copied.

Member Function Documentation

addCurve()

void IlvMapMultiCurve::addCurve

(

IlvMapCurve *

curve

)

Adds a curve.

In this operation, the IlvMapMultiCurve object becomes owner of curve.

Parameters

curve

The curve to be added.

copy()

virtual IlvMapGeometry* IlvMapMultiCurve::copy ( ) const

virtual

Returns a copy of the object.

Returns

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapCurve.

getCardinal()

IlUInt IlvMapMultiCurve::getCardinal

(

)

const

Returns the number of curves.

Returns

The number of curves.

getClassInfo()

virtual IlvClassInfo* IlvMapMultiCurve::getClassInfo ( ) const

virtual

Returns the IlvClassInfo of the instance.

Returns

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapCurve.

getCurve()

const IlvMapCurve* IlvMapMultiCurve::getCurve

(

IlUInt

i

)

const

Returns the curve at a given index.

Parameters

i	The index that must be between 0 and getCardinal()-1

Returns

An IlvMapCurve object that should not be modified nor deleted.

getSubElement()

virtual const IlvMapGeometry* IlvMapMultiCurve::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 IlvMapMultiCurve::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.

isCollection()

virtual IlBoolean IlvMapMultiCurve::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.

removeCurve()

IlvMapCurve* IlvMapMultiCurve::removeCurve

(

const IlvMapCurve *

curve

)

Removes the specified curve and returns it.

Parameters

curve

The curve to be removed.

Returns

0 if curve is not a member of the IlvMapMultiCurve object, or an IlvMapCurve that has to be deleted by the user.