rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvMapArea Class Reference

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

List of all members.

Public Member Functions

virtual IlBoolean contains (const IlvCoordinate &coordinate) const =0
 Returns IlTrue if coordinate is contained in the object.
virtual IlvMapGeometrycopy () const =0
 Returns a copy of the object.
virtual IlvClassInfogetClassInfo () const =0
 Returns the IlvClassInfo of the instance.
virtual const IlvMapCurvegetStroke () const =0
 Returns the stroke of the area.

Static Public Member Functions

static IlvClassInfoClassInfo ()
 Returns the class info.

Protected Member Functions

 IlvMapArea ()
 Constructor.

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

static IlvClassInfo* IlvMapArea::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.

Reimplemented from IlvMapGeometry.

Reimplemented in IlvMapRing.

virtual IlBoolean IlvMapArea::contains ( const IlvCoordinate coordinate  )  const [pure 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.

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

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 IlvMapCircularRing, IlvMapImage, IlvMapMultiArea, IlvMapPolygon, IlvMapRaster, IlvMapRing, and IlvMapSegmentRing.

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 IlvMapCircularRing, IlvMapImage, IlvMapMultiArea, IlvMapPolygon, IlvMapRaster, IlvMapRing, and IlvMapSegmentRing.

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 IlvMapCircularRing, IlvMapImage, IlvMapMultiArea, IlvMapPolygon, IlvMapRaster, IlvMapRing, and IlvMapSegmentRing.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

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