Views
Maps Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
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:
IlvMapArea IlvMapGeometry

Public Member Functions

 IlvMapMultiArea ()
 Initializes a new IlvMapMultiArea instance.
 
 IlvMapMultiArea (const IlvMapMultiArea &source)
 Initializes a new IlvMapMultiArea by copying an existing one. More...
 
void addArea (IlvMapArea *area)
 Adds an area. More...
 
virtual IlBoolean contains (const IlvCoordinate &) const
 Returns IlTrue if some coordinate is contained in the object. More...
 
virtual IlvMapGeometrycopy () const
 Returns a copy of the object. More...
 
const IlvMapAreagetArea (IlUInt i) const
 Returns the area at a given index. More...
 
IlUInt getCardinal () const
 Returns the number of areas. More...
 
virtual IlvClassInfogetClassInfo () const
 Returns the IlvClassInfo of the instance. More...
 
virtual const IlvMapCurvegetStroke () const
 Returns the stroke of the area. More...
 
virtual const IlvMapGeometrygetSubElement (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 areas.
 
IlvMapArearemoveArea (const IlvMapArea *area)
 Removes the specified area and returns it. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvMapGeometry
static IlvClassInfoClassInfo ()
 Returns the class info. More...
 
- Protected Member Functions inherited from IlvMapArea
 IlvMapArea ()
 Initializes a new empty IlvMapArea instance.
 
- Protected Member Functions inherited from IlvMapGeometry
 IlvMapGeometry ()
 Constructor. More...
 

Detailed Description

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

Library: ilvmaps

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

Constructor & Destructor Documentation

◆ IlvMapMultiArea()

IlvMapMultiArea::IlvMapMultiArea ( const IlvMapMultiArea source)

Initializes a new IlvMapMultiArea by copying an existing one.

Parameters
sourceThe 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
areaThe area to be added.

◆ contains()

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

Returns IlTrue if some coordinate is contained in the object.

Parameters
coordinateThe 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 at a given index.

Parameters
iThe 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
indexThe 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.

Parameters
areaThe area to be removed.
Returns
The specified area if the specified area if part of the multi area, that should be deleted by the user. If the area is not part of the multi area this method returns 0.