zeus::IAngle Class Reference

#include <IAngle.hpp>

Inheritance diagram for zeus::IAngle:

List of all members.

Public Types
enum	ESystem { etRadians = 0, etDegrees = 1 }
Public Member Functions
virtual Float MQUALIFIER	getRadians () const =0
virtual Float MQUALIFIER	getDegrees () const =0
virtual void MQUALIFIER	setRadians (const Float &fAngle)=0
virtual void MQUALIFIER	setDegrees (const Float &fAngle)=0
virtual void MQUALIFIER	assign (const IAngle &rAngle)=0
virtual bool MQUALIFIER	isEqual (const IAngle &rAngle, bool bNormalizeToSingleCircle=false) const =0
virtual Float MQUALIFIER	cos () const =0
virtual Float MQUALIFIER	sin () const =0
virtual Float MQUALIFIER	tan () const =0
virtual void MQUALIFIER	normalizeToInterval (const IAngle &rAngleMin, const IAngle &rAngleMax, bool bIncludeMin, bool bIncludeMax)=0
virtual void MQUALIFIER	normalizeToSingleCircle ()=0

---

Detailed Description

TAngle encapsulates a floating point angle. Its value can be read specifically as radians or degrees. The class also serves as convertor between different angle systems.

---

Member Enumeration Documentation

enum zeus::IAngle::ESystem

Enumeration for the different angle systems.

Enumerator:

etRadians
etDegrees

---

Member Function Documentation

virtual void MQUALIFIER zeus::IAngle::assign

(

const IAngle &

rAngle )

[pure virtual]

Assignment.

Parameters:

rAngle

[IN]: Reference to interface type object to be assigned to this object.

Implemented in zeus::TAngle.

virtual Float MQUALIFIER zeus::IAngle::cos

(

)

const [pure virtual]

Trigonometry.

Calculate the cosine of this angle.

Returns:

: Cosine of this angle.

Implemented in zeus::TAngle.

virtual Float MQUALIFIER zeus::IAngle::getDegrees

(

)

const [pure virtual]

Read the angle's value in degrees.

Returns:

: Angle in degrees.

Implemented in zeus::TAngle.

virtual Float MQUALIFIER zeus::IAngle::getRadians

(

)

const [pure virtual]

Read the angle's value in radians.

Returns:

: Angle in radians.

Implemented in zeus::TAngle.

virtual bool MQUALIFIER zeus::IAngle::isEqual	(	const IAngle &	rAngle,
		bool	bNormalizeToSingleCircle = false
	)		const [pure virtual]

Equality with another angle?

Parameters:

rAngle	[IN]: Angle to be compared to this angle.
bNormalizeToSingleCircle	[IN]: Normalize to a single circle angle interval before comparing.

Returns:

: Equality.

Implemented in zeus::TAngle.

virtual void MQUALIFIER zeus::IAngle::normalizeToInterval	(	const IAngle &	rAngleMin,
		const IAngle &	rAngleMax,
		bool	bIncludeMin,
		bool	bIncludeMax
	)		[pure virtual]

Normalize the angle to a given interval.

Parameters:

rAngleMin	[IN]: Minimum value of the given interval.
rAngleMax	[IN]: Maximum value of the given interval.
bIncludeMin	[IN]: Include the minimum value itself.
bIncludeMax	[IN]: Include the maximum value itself.

Implemented in zeus::TAngle.

virtual void MQUALIFIER zeus::IAngle::normalizeToSingleCircle

(

)

[pure virtual]

Normalize the angle to a single circle interval.

Implemented in zeus::TAngle.

virtual void MQUALIFIER zeus::IAngle::setDegrees

(

const Float &

fAngle )

[pure virtual]

Set the angle's value in degrees.

Parameters:

fAngle

[IN]: Angle in degrees.

Implemented in zeus::TAngle.

virtual void MQUALIFIER zeus::IAngle::setRadians

(

const Float &

fAngle )

[pure virtual]

Set the angle's value in radians.

Parameters:

fAngle

[IN]: Angle in radians.

Implemented in zeus::TAngle.

virtual Float MQUALIFIER zeus::IAngle::sin

(

)

const [pure virtual]

Calculate the sine of this angle.

Returns:

: Sine of this angle.

Implemented in zeus::TAngle.

virtual Float MQUALIFIER zeus::IAngle::tan

(

)

const [pure virtual]

Calculate the tangent of this angle.

Returns:

: Tangent of this angle.

Implemented in zeus::TAngle.

---

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

• IAngle.hpp