IlvMapCircle Class Reference

This class defines a circle. More...

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

Inheritance diagram for IlvMapCircle:

Public Member Functions
	IlvMapCircle (const IlvCoordinate &center, IlDouble radius)
	Initializes a new circle by specifying its center and its radius. More...
	IlvMapCircle (const IlvCoordinate &control1, const IlvCoordinate &control2, const IlvCoordinate &control3)
	Initializes a new circle by giving the three different points that are on the circle. More...
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object. More...
const IlvCoordinate &	getCenter () const
	Returns the center of the circle. More...
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance. More...
IlDouble	getRadius () const
	Returns the radius of the circle. More...
virtual const IlvMapGeometry *	getSubElement (IlUInt) 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 IlvClassInfo *	ClassInfo ()
	Returns the class info. More...
Protected Member Functions inherited from IlvMapCurve
	IlvMapCurve ()
	Initializes a new, empty, curve.
Protected Member Functions inherited from IlvMapGeometry
	IlvMapGeometry ()
	Constructor. More...

Detailed Description

This class defines a circle.

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

Constructor & Destructor Documentation

IlvMapCircle() [1/2]

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

Initializes a new circle by specifying its center and its radius.

Parameters

center	The center of the circle.
radius	The radius of the circle.

IlvMapCircle() [2/2]

IlvMapCircle::IlvMapCircle	(	const IlvCoordinate &	control1,
		const IlvCoordinate &	control2,
		const IlvCoordinate &	control3
	)

Initializes a new circle by giving the three different points that are on the circle.

Parameters

control1	First control point.
control2	Second control point.
control3	Third control point.

Member Function Documentation

copy()

virtual IlvMapGeometry* IlvMapCircle::copy ( ) const

virtual

Returns a copy of the object.

Returns

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapCurve.

getCenter()

const IlvCoordinate& IlvMapCircle::getCenter

(

)

const

Returns the center of the circle.

Returns

The center of the circle.

getClassInfo()

virtual IlvClassInfo* IlvMapCircle::getClassInfo ( ) const

virtual

Returns the IlvClassInfo of the instance.

Returns

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapCurve.

getRadius()

IlDouble IlvMapCircle::getRadius

(

)

const

Returns the radius of the circle.

Returns

The radius of the circle.

getSubElement()

virtual const IlvMapGeometry* IlvMapCircle::getSubElement ( IlUInt  index ) const

virtual

Returns a sub element of a collection geometry.

Parameters

index

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

getSubElementCount()

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.

isCollection()

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.

setCenter()

void IlvMapCircle::setCenter

(

const IlvCoordinate &

c

)

Sets the center of the circle.

Parameters

c	The new center of the circle

setRadius()

void IlvMapCircle::setRadius

(

IlDouble

rad

)

Sets the radius of the circle.

Parameters

rad	The new radius of the circle