OpenGUI::Degree Class Reference
[Types]

#include <OpenGUI_Types.h>

List of all members.


Detailed Description

Represents degrees and provide some basic utility functions.

Degrees are not used by any functions in OpenGUI, but are offered here as a supported type since they are the most human familiar method of measuring angles.


Public Member Functions

 Degree (float degree_value=0.0f)
 Constructor initialized with degree in a float.
 Degree (const Radian &radian_value)
 Constructor initialized with a Radian.
float valueDegrees () const
 returns the current value as a float in degrees
float valueRadians () const
 returns the current value as a float in radians
const Degreeoperator= (const float &degree_float)
 assignment with a degree in a float
const Degreeoperator= (const Degree &degree)
 assignment with a Degree
const Degreeoperator= (const Radian &radian)
 assignment with a Radian
Degree operator+ (const Degree &right) const
 addition with a Degree
Degree operator+ (const Radian &right) const
 addition with a Radian
Degreeoperator+= (const Degree &right)
 addition/assignment with a Degree
Degreeoperator+= (const Radian &right)
 addition/assignment with a Radian
Degree operator- ()
 inverse operator
Degree operator- (const Degree &right) const
 subtraction with a Degree
Degree operator- (const Radian &right) const
 subtraction with a Radian
Degreeoperator-= (const Degree &right)
 subtraction/assignment with a Degree
Degreeoperator-= (const Radian &right)
 subtraction/assignment with a Radian
bool operator== (const Degree &right) const
 Equal.
bool operator!= (const Degree &right) const
 Not Equal.
bool operator< (const Degree &right) const
 Less than.
bool operator<= (const Degree &right) const
 Less than or equal.


Constructor & Destructor Documentation

OpenGUI::Degree::Degree float  degree_value = 0.0f  )  [inline, explicit]
 

Constructor initialized with degree in a float.

OpenGUI::Degree::Degree const Radian radian_value  )  [inline]
 

Constructor initialized with a Radian.


Member Function Documentation

bool OpenGUI::Degree::operator!= const Degree right  )  const [inline]
 

Not Equal.

Degree OpenGUI::Degree::operator+ const Radian right  )  const [inline]
 

addition with a Radian

Degree OpenGUI::Degree::operator+ const Degree right  )  const [inline]
 

addition with a Degree

Degree& OpenGUI::Degree::operator+= const Radian right  )  [inline]
 

addition/assignment with a Radian

Degree& OpenGUI::Degree::operator+= const Degree right  )  [inline]
 

addition/assignment with a Degree

Degree OpenGUI::Degree::operator- const Radian right  )  const [inline]
 

subtraction with a Radian

Degree OpenGUI::Degree::operator- const Degree right  )  const [inline]
 

subtraction with a Degree

Degree OpenGUI::Degree::operator-  )  [inline]
 

inverse operator

Degree& OpenGUI::Degree::operator-= const Radian right  )  [inline]
 

subtraction/assignment with a Radian

Degree& OpenGUI::Degree::operator-= const Degree right  )  [inline]
 

subtraction/assignment with a Degree

bool OpenGUI::Degree::operator< const Degree right  )  const [inline]
 

Less than.

bool OpenGUI::Degree::operator<= const Degree right  )  const [inline]
 

Less than or equal.

const Degree& OpenGUI::Degree::operator= const Radian radian  )  [inline]
 

assignment with a Radian

const Degree& OpenGUI::Degree::operator= const Degree degree  )  [inline]
 

assignment with a Degree

const Degree& OpenGUI::Degree::operator= const float &  degree_float  )  [inline]
 

assignment with a degree in a float

bool OpenGUI::Degree::operator== const Degree right  )  const [inline]
 

Equal.

float OpenGUI::Degree::valueDegrees  )  const [inline]
 

returns the current value as a float in degrees

float OpenGUI::Degree::valueRadians  )  const [inline]
 

returns the current value as a float in radians


The documentation for this class was generated from the following file:
Copyright © 2006 OpenGUI | OpenGUI.SF.net
Generated: Sun Sep 9 02:00:22 2007