Rogue Wave Views
Maps Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvMapRing Class Referenceabstract

This abstract class is the base class of all connected areas. More...

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

Inheritance diagram for IlvMapRing:
IlvMapArea IlvMapGeometry 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

 IlvMapRing ()
 Constructor. More...
 
- Protected Member Functions inherited from IlvMapArea
 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 all connected areas.

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

Constructor & Destructor Documentation

IlvMapRing::IlvMapRing ( )
protected

Constructor.

The constructor of this abstract class is protected.

Member Function Documentation

virtual IlBoolean IlvMapRing::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.

Implements IlvMapArea.

Implemented in IlvMapSegmentRing, and IlvMapCircularRing.

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

Returns a copy of the object.

Returns
An IlvMapGeometry that must be deleted by the user.

Implements IlvMapArea.

Implemented in IlvMapSegmentRing, and IlvMapCircularRing.

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

Returns the IlvClassInfo of the instance.

Returns
An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapArea.

Implemented in IlvMapSegmentRing, and IlvMapCircularRing.

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

Returns the stroke of the area.

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

Implements IlvMapArea.

Implemented in IlvMapSegmentRing, and IlvMapCircularRing.


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