rwlogo

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
List of all members | Public Member Functions | Protected Member Functions
IlvMapArea Class Referenceabstract

This abstract class is the base class of the map geometry that define an area. More...

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

Inheritance diagram for IlvMapArea:
IlvMapGeometry IlvMapImage IlvMapMultiArea IlvMapPolygon IlvMapRaster IlvMapRing IlvMapCircularRing IlvMapSegmentRing

Public Member Functions

virtual IlBoolean contains (const IlvCoordinate &coordinate) const =0
 Returns IlTrue if coordinate is contained in the object. More...
 
virtual IlvMapGeometrycopy () const =0
 Returns a copy of the object. More...
 
virtual IlvClassInfogetClassInfo () const =0
 Returns the IlvClassInfo of the instance. More...
 
virtual const IlvMapCurvegetStroke () const =0
 Returns the stroke of the area. More...
 
- Public Member Functions inherited from IlvMapGeometry
virtual const IlvMapGeometrygetSubElement (IlUInt index) const =0
 Returns a sub element of a collection geometry. 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
 Checks if this geometry is a collection of other geometries. More...
 

Protected Member Functions

 IlvMapArea ()
 Constructor. More...
 
- Protected Member Functions inherited from IlvMapGeometry
 IlvMapGeometry ()
 Constructor. More...
 

Additional Inherited Members

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

Detailed Description

This abstract class is the base class of the map geometry that define an area.

The instances of the predefined subclasses of IlvMapArea can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultAreaRenderer. Library: ilvmaps

Constructor & Destructor Documentation

IlvMapArea::IlvMapArea ( )
protected

Constructor.

The constructor of this abstract class is protected.

Member Function Documentation

virtual IlBoolean IlvMapArea::contains ( const IlvCoordinate coordinate) const
pure virtual

Returns IlTrue if coordinate is contained in the object.

Parameters
coordinateThe point to be checked.
Returns
IlTrue if coordinate is contained in the object.

Implemented in IlvMapRaster, IlvMapPolygon, IlvMapImage, IlvMapMultiArea, IlvMapSegmentRing, IlvMapCircularRing, and IlvMapRing.

virtual IlvMapGeometry* IlvMapArea::copy ( ) const
pure virtual

Returns a copy of the object.

Returns
An IlvMapGeometry that must be deleted by the user.

Implements IlvMapGeometry.

Implemented in IlvMapRaster, IlvMapPolygon, IlvMapMultiArea, IlvMapImage, IlvMapSegmentRing, IlvMapCircularRing, and IlvMapRing.

virtual IlvClassInfo* IlvMapArea::getClassInfo ( ) const
pure virtual

Returns the IlvClassInfo of the instance.

Returns
An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapGeometry.

Implemented in IlvMapRaster, IlvMapPolygon, IlvMapMultiArea, IlvMapImage, IlvMapSegmentRing, IlvMapCircularRing, and IlvMapRing.

virtual const IlvMapCurve* IlvMapArea::getStroke ( ) const
pure virtual

Returns the stroke of the area.

Returns
An IlvCurve object that should not be deleted nor modified.

Implemented in IlvMapRaster, IlvMapPolygon, IlvMapImage, IlvMapMultiArea, IlvMapSegmentRing, IlvMapCircularRing, and IlvMapRing.


© Copyright 2015, 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.