CL_Angle Class Reference
[clanCore Math]

Angle class. More...

#include <angle.h>

List of all members.

Public Member Functions

Attributes

float to_degrees () const
 Returns the angle as degrees.
float to_radians () const
 Returns the angle as radians.
Operations

void set_degrees (float degrees)
 Set the angle value in degrees.
void set_radians (float radians)
 Set the angle value in radians.
CL_Anglenormalize ()
 Converts angle to range [0,360] degrees.
CL_Anglenormalize_180 ()
 Converts angle to range [-180,180] degrees.
Operators

void operator+= (const CL_Angle &angle)
 += operator.
void operator-= (const CL_Angle &angle)
 -= operator.
void operator*= (const CL_Angle &angle)
 *= operator.
void operator/= (const CL_Angle &angle)
 /= operator.
CL_Angle operator+ (const CL_Angle &angle) const
 + operator.
CL_Angle operator- (const CL_Angle &angle) const
 
  • operator.

CL_Angle operator* (const CL_Angle &angle) const
 * operator.
CL_Angle operator* (float value) const
 * operator.
CL_Angle operator/ (const CL_Angle &angle) const
 / operator.
CL_Angle operator/ (float value) const
 / operator.
bool operator< (const CL_Angle &angle) const
 < operator.
bool operator<= (const CL_Angle &angle) const
 < operator.
bool operator> (const CL_Angle &angle) const
 > operator.
bool operator>= (const CL_Angle &angle) const
 > operator.
bool operator== (const CL_Angle &angle) const
 == operator.
bool operator!= (const CL_Angle &angle) const
 != operator.

Construction



 CL_Angle ()
 Constructs an NULL Angle object.
 CL_Angle (float value, CL_AngleUnit unit)
 Constructs an Angle object.
static CL_Angle from_radians (float value)
 From radians.
static CL_Angle from_degrees (float value)
 From degrees.

Detailed Description

Angle class.


Constructor & Destructor Documentation

CL_Angle::CL_Angle (  ) 

Constructs an NULL Angle object.

CL_Angle::CL_Angle ( float  value,
CL_AngleUnit  unit 
)

Constructs an Angle object.


Member Function Documentation

static CL_Angle CL_Angle::from_degrees ( float  value  )  [static]

From degrees.

Parameters:
value = value
Returns:
Angle
static CL_Angle CL_Angle::from_radians ( float  value  )  [static]

From radians.

Parameters:
value = value
Returns:
Angle
CL_Angle& CL_Angle::normalize (  ) 

Converts angle to range [0,360] degrees.

Returns:
reference to this object
CL_Angle& CL_Angle::normalize_180 (  ) 

Converts angle to range [-180,180] degrees.

Returns:
reference to this object
bool CL_Angle::operator!= ( const CL_Angle angle  )  const

!= operator.

CL_Angle CL_Angle::operator* ( float  value  )  const

* operator.

CL_Angle CL_Angle::operator* ( const CL_Angle angle  )  const

* operator.

void CL_Angle::operator*= ( const CL_Angle angle  ) 

*= operator.

CL_Angle CL_Angle::operator+ ( const CL_Angle angle  )  const

+ operator.

void CL_Angle::operator+= ( const CL_Angle angle  ) 

+= operator.

CL_Angle CL_Angle::operator- ( const CL_Angle angle  )  const

  • operator.

void CL_Angle::operator-= ( const CL_Angle angle  ) 

-= operator.

CL_Angle CL_Angle::operator/ ( const CL_Angle angle  )  const

/ operator.

CL_Angle CL_Angle::operator/ ( float  value  )  const

/ operator.

void CL_Angle::operator/= ( const CL_Angle angle  ) 

/= operator.

bool CL_Angle::operator< ( const CL_Angle angle  )  const

< operator.

bool CL_Angle::operator<= ( const CL_Angle angle  )  const

< operator.

bool CL_Angle::operator== ( const CL_Angle angle  )  const

== operator.

bool CL_Angle::operator> ( const CL_Angle angle  )  const

> operator.

bool CL_Angle::operator>= ( const CL_Angle angle  )  const

> operator.

void CL_Angle::set_degrees ( float  degrees  ) 

Set the angle value in degrees.

void CL_Angle::set_radians ( float  radians  ) 

Set the angle value in radians.

float CL_Angle::to_degrees (  )  const

Returns the angle as degrees.

float CL_Angle::to_radians (  )  const

Returns the angle as radians.


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