IlvMapCircle Class Reference

This class defines a circle. More...

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

Inheritance diagram for IlvMapCircle:

List of all members.

Public Member Functions
	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.
	IlvMapCircle (const IlvCoordinate &center, IlDouble radius)
	Initializes an instance of circle by specifying its center and its radius.
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object.
const IlvCoordinate &	getCenter () const
	Returns the center of the circle.
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance.
IlDouble	getRadius () const
	Returns the radius of the circle.
virtual const IlvMapGeometry *	getSubElement (IlUInt index) const
	Returns the sub element of index index if the geometry is a collection.
virtual IlUInt	getSubElementCount () const
	Returns the number of elements contained in the geometry if the geometry is a collection.
virtual IlBoolean	isCollection () const
	Returns IlTrue if the geometry is a collection of other geometries.
void	setCenter (const IlvCoordinate &c)
	Sets the center of the circle.
void	setRadius (IlDouble rad)
	Sets the radius of the circle.

---

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:

	center	The center of the circle.
	radius	The 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:

	control1	First control point.
	control2	Second control point.
	control3	Third 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 the sub element of index index if the geometry is a collection.

Otherwise, it returns a null pointer.

Returns:

The sub element of index index if the geometry is a collection.

Implements IlvMapGeometry.

virtual IlUInt IlvMapCircle::getSubElementCount

(

)

const [virtual]

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

Otherwise, it returns 0.

Returns:

The number of elements contained in the geometry if the geometry is a collection. Otherwise, it returns 0.

Implements IlvMapGeometry.

virtual IlBoolean IlvMapCircle::isCollection

(

)

const [virtual]

Returns IlTrue if the 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:

the

new center of the circle

void IlvMapCircle::setRadius

(

IlDouble

rad

)

Sets the radius of the circle.

Parameters:

the

new radius of the circle