Rogue Wave Views
Maps Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvMapCircle Class Reference

This class defines a circle. More...

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

Inheritance diagram for IlvMapCircle:
IlvMapCurve IlvMapGeometry

Public Member Functions

 IlvMapCircle (const IlvCoordinate &center, IlDouble radius)
 Initializes an instance of circle by specifying its center and its radius. More...
 
 IlvMapCircle (const IlvCoordinate &control1, const IlvCoordinate &control2, const IlvCoordinate &control3)
 Initializes an instance of IlvMapCircle by giving the three different points that are on the circle. More...
 
virtual IlvMapGeometrycopy () const
 Returns a copy of the object. More...
 
const IlvCoordinategetCenter () const
 Returns the center of the circle. More...
 
virtual IlvClassInfogetClassInfo () const
 Returns the IlvClassInfo of the instance. More...
 
IlDouble getRadius () const
 Returns the radius of the circle. More...
 
virtual const IlvMapGeometrygetSubElement (IlUInt index) const
 Returns a sub element of a collection geometry. 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
 Checks if this geometry is a collection of other geometries. More...
 
void setCenter (const IlvCoordinate &c)
 Sets the center of the circle. More...
 
void setRadius (IlDouble rad)
 Sets the radius of the circle. More...
 

Additional Inherited Members

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

Detailed Description

This class defines a circle.

The instances of this class can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultCurveRenderer. Library: ilvmaps

Constructor & Destructor Documentation

IlvMapCircle::IlvMapCircle ( const IlvCoordinate center,
IlDouble  radius 
)

Initializes an instance of circle by specifying its center and its radius.

Parameters
centerThe center of the circle.
radiusThe radius of the circle.
IlvMapCircle::IlvMapCircle ( const IlvCoordinate control1,
const IlvCoordinate control2,
const IlvCoordinate control3 
)

Initializes an instance of IlvMapCircle by giving the three different points that are on the circle.

Parameters
control1First control point.
control2Second control point.
control3Third control point.

Member Function Documentation

virtual IlvMapGeometry* IlvMapCircle::copy ( ) const
virtual

Returns a copy of the object.

Returns
An IlvMapGeometry that must be deleted by the user.

Implements IlvMapCurve.

const IlvCoordinate& IlvMapCircle::getCenter ( ) const

Returns the center of the circle.

Returns
The center of the circle.
virtual IlvClassInfo* IlvMapCircle::getClassInfo ( ) const
virtual

Returns the IlvClassInfo of the instance.

Returns
An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapCurve.

IlDouble IlvMapCircle::getRadius ( ) const

Returns the radius of the circle.

Returns
The radius of the circle.
virtual const IlvMapGeometry* IlvMapCircle::getSubElement ( IlUInt  index) const
virtual

Returns a sub element of a collection geometry.

Parameters
indexThe index of the sub-geometry to be retrieved.
Returns
The sub element of index index if the geometry is a collection or 0 if it is not.

Implements IlvMapGeometry.

virtual IlUInt IlvMapCircle::getSubElementCount ( ) const
virtual

Returns the number of elements contained in the geometry if the geometry is a collection.

Returns
The number of elements contained in the geometry if the geometry is a collection. If it is not, this method returns 0.

Implements IlvMapGeometry.

virtual IlBoolean IlvMapCircle::isCollection ( ) const
virtual

Checks if this 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.

void IlvMapCircle::setCenter ( const IlvCoordinate c)

Sets the center of the circle.

Parameters
cThe new center of the circle
void IlvMapCircle::setRadius ( IlDouble  rad)

Sets the radius of the circle.

Parameters
radThe new radius of the circle

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