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 | Static Public Member Functions | Protected Member Functions
IlvMapGeometry Class Referenceabstract

This abstract class is the base class of the map geometry objects. More...

#include <ilviews/maps/geometry.h>

Inheritance diagram for IlvMapGeometry:
IlvMapArea IlvMapCurve IlvMapGeometryCollection IlvMapMultiPoint IlvMapPoint IlvMapText IlvMapImage IlvMapMultiArea IlvMapPolygon IlvMapRaster IlvMapRing IlvMapCircle IlvMapMultiCurve IlvMapSegment

Public Member Functions

virtual IlvMapGeometrycopy () const =0
 Returns a copy of the object. More...
 
virtual IlvClassInfogetClassInfo () const =0
 Returns the IlvClassInfo of the instance. More...
 
virtual const IlvMapGeometrygetSubElement (IlUInt index) const =0
 Returns the sub element of index index if the geometry is a collection. More...
 
virtual IlUInt getSubElementCount () const =0
 Returns the number of elements contained in the geometry if the geometry is a collection. More...
 
virtual IlBoolean isCollection () const =0
 Returns IlTrue if the geometry is a collection of other geometries. More...
 

Static Public Member Functions

static IlvClassInfoClassInfo ()
 Returns the class info. More...
 

Protected Member Functions

 IlvMapGeometry ()
 Constructor. More...
 

Detailed Description

This abstract class is the base class of the map geometry objects.

The IlvMapGeometry classes represent the shape of the map features. There is a list of predefined geometries in the package ilog.views.maps.geometry. The instances of the predefined subclasses of IlvMapGeometry can be rendered by an IlvDefaultFeatureRenderer. Library: ilvmaps

Constructor & Destructor Documentation

IlvMapGeometry::IlvMapGeometry ( )
protected

Constructor.

Initializes an instance of the class.

Member Function Documentation

static IlvClassInfo* IlvMapGeometry::ClassInfo ( )
static

Returns the class info.

This static function, redefined for each subclass of IlvMapGeometry returns the IlvClassInfo of the class.

Returns
An IlvClassInfo that should not be modified nor deleted.
virtual IlvMapGeometry* IlvMapGeometry::copy ( ) const
pure virtual
virtual IlvClassInfo* IlvMapGeometry::getClassInfo ( ) const
pure virtual
virtual const IlvMapGeometry* IlvMapGeometry::getSubElement ( IlUInt  index) const
pure 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.

Implemented in IlvMapRaster, IlvMapPolygon, IlvMapSegmentString, IlvMapImage, IlvMapMultiArea, IlvMapMultiCurve, IlvMapArcSegment, IlvMapText, IlvMapCircle, IlvMapMultiPoint, IlvMapSegmentRing, IlvMapPoint, IlvMapCircularRing, IlvMapGeometryCollection, and IlvMapLinearSegment.

virtual IlUInt IlvMapGeometry::getSubElementCount ( ) const
pure 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.

Implemented in IlvMapRaster, IlvMapPolygon, IlvMapSegmentString, IlvMapImage, IlvMapMultiArea, IlvMapMultiCurve, IlvMapArcSegment, IlvMapText, IlvMapCircle, IlvMapMultiPoint, IlvMapSegmentRing, IlvMapPoint, IlvMapCircularRing, IlvMapGeometryCollection, and IlvMapLinearSegment.

virtual IlBoolean IlvMapGeometry::isCollection ( ) const
pure 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.

Implemented in IlvMapRaster, IlvMapPolygon, IlvMapSegmentString, IlvMapImage, IlvMapMultiArea, IlvMapMultiCurve, IlvMapArcSegment, IlvMapText, IlvMapCircle, IlvMapMultiPoint, IlvMapSegmentRing, IlvMapPoint, IlvMapCircularRing, IlvMapGeometryCollection, and IlvMapLinearSegment.


© 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.