IlvMapGeometryCollection Class Reference

The class defines a collection of any geometry elements. More...

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

Inheritance diagram for IlvMapGeometryCollection:

List of all members.

Public Member Functions
	IlvMapGeometryCollection (const IlvMapGeometryCollection &source)
	Creates an IlvMapGeometryCollection by copying an existing one.
	IlvMapGeometryCollection ()
	Constructor.
void	addGeometry (IlvMapGeometry *geometry)
	Adds a geometry at the end of the collection. The collection becomes owner of the geometry.
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object.
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance.
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 all the geometries contained in the collection and deletes them.

---

Detailed Description

The class defines a collection of any geometry elements.

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

---

Constructor & Destructor Documentation

IlvMapGeometryCollection::IlvMapGeometryCollection

(

)

Constructor.

Creates an IlvMapGeometryCollection.

IlvMapGeometryCollection::IlvMapGeometryCollection

(

const IlvMapGeometryCollection &

source

)

Creates an IlvMapGeometryCollection by copying an existing one.

Parameters:

source

The object to be copied.

---

Member Function Documentation

void IlvMapGeometryCollection::addGeometry

(

IlvMapGeometry *

geometry

)

Adds a geometry at the end of the collection. The collection becomes owner of the geometry.

Parameters:

geometry

The geometry to be added.

virtual IlvMapGeometry* IlvMapGeometryCollection::copy

(

)

const [virtual]

Returns a copy of the object.

Returns:

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapGeometry.

virtual IlvClassInfo* IlvMapGeometryCollection::getClassInfo

(

)

const [virtual]

Returns the IlvClassInfo of the instance.

Returns:

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapGeometry.

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