rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvMapGeometryCollection Class Reference

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

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

Inheritance diagram for IlvMapGeometryCollection:
IlvMapGeometry

Public Member Functions

 IlvMapGeometryCollection ()
 Constructor. More...
 
 IlvMapGeometryCollection (const IlvMapGeometryCollection &source)
 Creates an IlvMapGeometryCollection by copying an existing one. More...
 
void addGeometry (IlvMapGeometry *geometry)
 Adds a geometry at the end of the collection. The collection becomes owner of the geometry. More...
 
virtual IlvMapGeometrycopy () const
 Returns a copy of the object. More...
 
virtual IlvClassInfogetClassInfo () const
 Returns the IlvClassInfo of the instance. More...
 
virtual const IlvMapGeometrygetSubElement (IlUInt index) const
 Returns the sub element of index index if the geometry is a collection. 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
 Returns IlTrue if the geometry is a collection of other geometries. More...
 
void removeAll ()
 Removes all the geometries contained in the collection and deletes them.
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvMapGeometry
static IlvClassInfoClassInfo ()
 Returns the class info. More...
 
- Protected Member Functions inherited from IlvMapGeometry
 IlvMapGeometry ()
 Constructor. More...
 

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
sourceThe 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
geometryThe 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.


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.