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 &Angle)=0
virtual bool MQUALIFIER	isEqual (const IAngle &Angle) const =0
virtual Float MQUALIFIER	cos () const =0
virtual Float MQUALIFIER	sin () const =0
virtual Float MQUALIFIER	tan () const =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 Float MQUALIFIER zeus::IAngle::getRadians

(

)

const [pure virtual]

Read the angle's value in radians.

Return values:

Angle in radians.

Implemented in zeus::TAngle.

virtual Float MQUALIFIER zeus::IAngle::getDegrees

(

)

const [pure virtual]

Read the angle's value in degrees.

Return values:

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 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::assign

(

const IAngle &

Angle

)

[pure virtual]

Assignment.

Parameters:

Angle

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

Implemented in zeus::TAngle.

virtual bool MQUALIFIER zeus::IAngle::isEqual

(

const IAngle &

Angle

)

const [pure virtual]

Equality with another angle?

Parameters:

Angle

[IN]: Angle to be compared to this angle.

Return values:

:

Equality.

Implemented in zeus::TAngle.

virtual Float MQUALIFIER zeus::IAngle::cos

(

)

const [pure virtual]

Trigonometry.

Calculate the cosine of this angle.

Return values:

Cosine of this angle.

Implemented in zeus::TAngle.

virtual Float MQUALIFIER zeus::IAngle::sin

(

)

const [pure virtual]

Calculate the sine of this angle.

Return values:

Sine of this angle.

Implemented in zeus::TAngle.

virtual Float MQUALIFIER zeus::IAngle::tan

(

)

const [pure virtual]

Calculate the tangent of this angle.

Return values:

Tangent of this angle.

Implemented in zeus::TAngle.

---

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

• IAngle.hpp