zeus::ICircle2D Class Reference

#include <ICircle2D.hpp>

Inheritance diagram for zeus::ICircle2D:

List of all members.

Public Member Functions
virtual const IVector2D &MQUALIFIER	getCenter () const =0
virtual void MQUALIFIER	setCenter (const IVector2D &rVecCenter)=0
virtual const Float &MQUALIFIER	getRadius () const =0
virtual void MQUALIFIER	setRadius (const Float &rfRadius)=0
virtual void MQUALIFIER	assign (const ICircle2D &rCircle)=0
virtual bool MQUALIFIER	isEqual (const ICircle2D &rCircle) const =0
virtual void MQUALIFIER	calcPointFromAngle (const IAngle &rAngle, IVector2D &rVecPoint) const =0
virtual bool MQUALIFIER	calcAngleFromPoint (const IVector2D &rVecPoint, IAngle &rAngle) const =0
virtual bool MQUALIFIER	isPointInside (const IVector2D &rVecPoint) const =0

---

Detailed Description

ICircle2D encapsulates a three dimensional floating point circle for vector geometry calculations.

---

Member Function Documentation

virtual void MQUALIFIER zeus::ICircle2D::assign

(

const ICircle2D &

rCircle )

[pure virtual]

Assignment.

Parameters:

rCircle

[IN]: Circle to be assigned to this circle.

Implemented in zeus::TCircle2D.

virtual bool MQUALIFIER zeus::ICircle2D::calcAngleFromPoint	(	const IVector2D &	rVecPoint,
		IAngle &	rAngle
	)		const [pure virtual]

Calculate the angle of a given point on this circle.

Parameters:

rVecPoint	[IN] : Vector to the given point.
rAngle	[OUT]: Angle. Only valid in case true is returned.

Returns:

: No error. Will be false in case vecPoint is not contained in this circle.

Implemented in zeus::TCircle2D.

virtual void MQUALIFIER zeus::ICircle2D::calcPointFromAngle	(	const IAngle &	rAngle,
		IVector2D &	rVecPoint
	)		const [pure virtual]

Angle calculations.

Calculate the point on this circle corresponding to a given angle.

Parameters:

rAngle	[IN] : The given angle.
rVecPoint	[OUT]: Vector to the point given by the parameter.

Implemented in zeus::TCircle2D.

virtual const IVector2D& MQUALIFIER zeus::ICircle2D::getCenter

(

)

const [pure virtual]

Get the center vector.

Implemented in zeus::TCircle2D.

virtual const Float& MQUALIFIER zeus::ICircle2D::getRadius

(

)

const [pure virtual]

Get the radius.

Implemented in zeus::TCircle2D.

virtual bool MQUALIFIER zeus::ICircle2D::isEqual

(

const ICircle2D &

rCircle )

const [pure virtual]

Comparisons.

Equality with another circle?

Parameters:

rCircle

[IN]: The other circle.

Returns:

: Equality.

Implemented in zeus::TCircle2D.

virtual bool MQUALIFIER zeus::ICircle2D::isPointInside

(

const IVector2D &

rVecPoint )

const [pure virtual]

Geometric calculations.

Is a given point inside this circle?

Parameters:

rVecPoint

[IN]: The given point.

Returns:

: Inside.

Implemented in zeus::TCircle2D.

virtual void MQUALIFIER zeus::ICircle2D::setCenter

(

const IVector2D &

rVecCenter )

[pure virtual]

Set the center vector.

Parameters:

rVecCenter

[IN]: The center vector.

Implemented in zeus::TCircle2D.

virtual void MQUALIFIER zeus::ICircle2D::setRadius

(

const Float &

rfRadius )

[pure virtual]

Set the radius.

Parameters:

rfRadius

[IN]: The new radius.

Implemented in zeus::TCircle2D.

---

The documentation for this class was generated from the following file:

• ICircle2D.hpp