IlvMapMultiCurve Class Reference

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

Inheritance diagram for IlvMapMultiCurve:

List of all members.

Public Member Functions
	IlvMapMultiCurve (const IlvMapMultiCurve &source)
	Creates a multi curve by copying an existing one.
	IlvMapMultiCurve ()
	Constructor.
void	addCurve (IlvMapCurve *curve)
	Adds a curve. In this operation, the IlvMapMultiCurve object becomes owner of curve.
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object.
IlUInt	getCardinal () const
	Returns the number of curves.
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance.
const IlvMapCurve *	getCurve (IlUInt i) const
	Returns the curve of index i.
virtual const IlvMapGeometry *	getSubElement (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.
virtual IlBoolean	isCollection () const
	Returns IlTrue if the geometry is a collection of other geometries.
void	removeAll ()
	Removes and deletes all the curves.
IlvMapCurve *	removeCurve (const IlvMapCurve *curve)
	Removes the specified curve and returns it.

---

Detailed Description

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

IlvMapMultiCurve does not have to be connected. The instances of this class can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultCurveRenderer. Library: ilvmaps

---

Constructor & Destructor Documentation

IlvMapMultiCurve::IlvMapMultiCurve

(

)

Constructor.

Initializes an instance of the class with an empty list of curves.

IlvMapMultiCurve::IlvMapMultiCurve

(

const IlvMapMultiCurve &

source

)

Creates a multi curve by copying an existing one.

Parameters:

source

The object to be copied.

---

Member Function Documentation

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.

virtual IlvMapGeometry* IlvMapMultiCurve::copy

(

)

const [virtual]

Returns a copy of the object.

Returns:

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapCurve.

IlUInt IlvMapMultiCurve::getCardinal

(

)

const

Returns the number of curves.

Returns:

The number of curves.

virtual IlvClassInfo* IlvMapMultiCurve::getClassInfo

(

)

const [virtual]

Returns the IlvClassInfo of the instance.

Returns:

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapCurve.

const IlvMapCurve* IlvMapMultiCurve::getCurve

(

IlUInt

i

)

const

Returns the curve of index i.

Parameters:

i

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

Returns:

An IlvMapCurve object that should not be modified nor deleted.

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

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

IlvMapCurve* IlvMapMultiCurve::removeCurve

(

const IlvMapCurve *

curve

)

Removes the specified curve and returns it.

If the curve is not part of the multi curve, the function returns a null pointer.

Parameters:

curve

The curve to be removed.

Returns:

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