IlvMapMultiArea Class Reference

This class defines an area that is composed of a list of IlvMapArea. More...

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

Inheritance diagram for IlvMapMultiArea:

Public Member Functions
	IlvMapMultiArea ()
	Constructor. More...
	IlvMapMultiArea (const IlvMapMultiArea &source)
	Creates a multi area by copying an existing one. More...
void	addArea (IlvMapArea *area)
	Adds an area. In this operation, the multi area becomes owner of the area. More...
virtual IlBoolean	contains (const IlvCoordinate &coordinate) const
	Returns IlTrue if coordinate is contained in the object. More...
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object. More...
const IlvMapArea *	getArea (IlUInt i) const
	Returns the area of index i. More...
IlUInt	getCardinal () const
	Returns the number of areas. More...
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance. More...
virtual const IlvMapCurve *	getStroke () const
	Returns the stroke of the area. More...
virtual const IlvMapGeometry *	getSubElement (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...
virtual IlBoolean	isCollection () const
	Checks if this geometry is a collection of other geometries. More...
void	removeAll ()
	Removes and deletes all the areas.
IlvMapArea *	removeArea (const IlvMapArea *area)
	Removes the specified area 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 IlvMapArea
	IlvMapArea ()
	Constructor. More...
Protected Member Functions inherited from IlvMapGeometry
	IlvMapGeometry ()
	Constructor. More...

Detailed Description

This class defines an area that is composed of a list of IlvMapArea.

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

Constructor & Destructor Documentation

IlvMapMultiArea() [1/2]

IlvMapMultiArea::IlvMapMultiArea

(

)

Constructor.

Initializes an instance of the class.

IlvMapMultiArea() [2/2]

IlvMapMultiArea::IlvMapMultiArea

(

const IlvMapMultiArea &

source

)

Creates a multi area by copying an existing one.

Parameters

source

The source area.

Member Function Documentation

addArea()

void IlvMapMultiArea::addArea

(

IlvMapArea *

area

)

Adds an area. In this operation, the multi area becomes owner of the area.

Parameters

area	The area to be added.

contains()

virtual IlBoolean IlvMapMultiArea::contains ( const IlvCoordinate &  coordinate ) const

virtual

Returns IlTrue if coordinate is contained in the object.

Parameters

coordinate

The point to be checked.

Returns

IlTrue if coordinate is contained in the object.

Implements IlvMapArea.

copy()

virtual IlvMapGeometry* IlvMapMultiArea::copy ( ) const

virtual

Returns a copy of the object.

Returns

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapArea.

getArea()

const IlvMapArea* IlvMapMultiArea::getArea

(

IlUInt

i

)

const

Returns the area of index i.

Parameters

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

Returns

An IlvMapArea object that should not be modified nor deleted.

getCardinal()

IlUInt IlvMapMultiArea::getCardinal

(

)

const

Returns the number of areas.

Returns

The number of areas.

getClassInfo()

virtual IlvClassInfo* IlvMapMultiArea::getClassInfo ( ) const

virtual

Returns the IlvClassInfo of the instance.

Returns

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapArea.

getStroke()

virtual const IlvMapCurve* IlvMapMultiArea::getStroke ( ) const

virtual

Returns the stroke of the area.

Returns

An IlvCurve object that should not be deleted nor modified.

Implements IlvMapArea.

getSubElement()

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

removeArea()

IlvMapArea* IlvMapMultiArea::removeArea

(

const IlvMapArea *

area

)

Removes the specified area and returns it.

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

Parameters

area	A null pointer if area is not a member of the object, or an IlvMapArea that should be deleted by the user.

Returns

The specified area if the specified area if part of the multi area.