Public Member Functions | Private Attributes | Friends | List of all members
Ogre::Radian Class Reference

Wrapper class which indicates a given angle value is in Radians. More...

#include <OgreMath.h>

Public Member Functions

 Radian (const Degree &d)
 
 Radian (Real r=0)
 
bool operator!= (const Radian &r) const
 
Radian operator* (const Radian &f) const
 
Radian operator* (Real f) const
 
Radian & operator*= (Real f)
 
const Radian & operator+ () const
 
Radian operator+ (const Degree &d) const
 
Radian operator+ (const Radian &r) const
 
Radian & operator+= (const Degree &d)
 
Radian & operator+= (const Radian &r)
 
Radian operator- () const
 
Radian operator- (const Degree &d) const
 
Radian operator- (const Radian &r) const
 
Radian & operator-= (const Degree &d)
 
Radian & operator-= (const Radian &r)
 
Radian operator/ (Real f) const
 
Radian & operator/= (Real f)
 
bool operator< (const Radian &r) const
 
bool operator<= (const Radian &r) const
 
Radian & operator= (const Degree &d)
 
Radian & operator= (const Radian &r)
 
Radian & operator= (const Real &f)
 
bool operator== (const Radian &r) const
 
bool operator> (const Radian &r) const
 
bool operator>= (const Radian &r) const
 
Real valueAngleUnits () const
 
Real valueDegrees () const
 
Real valueRadians () const
 

Private Attributes

Real mRad
 

Friends

_OgreExport friend std::ostream & operator<< (std::ostream &o, const Radian &v)
 

Detailed Description

Wrapper class which indicates a given angle value is in Radians.

Remarks
Radian values are interchangeable with Degree values, and conversions will be done automatically between them.

Definition at line 47 of file OgreMath.h.

Constructor & Destructor Documentation

◆ Radian()

Ogre::Radian::Radian ( Real  r = 0)
explicit

Definition at line 52 of file OgreMath.h.

Referenced by operator*(), operator+(), operator-(), and operator/().

Member Function Documentation

◆ operator!=()

bool Ogre::Radian::operator!= ( const Radian &  r) const

Definition at line 81 of file OgreMath.h.

References mRad.

◆ operator*() [1/2]

Radian Ogre::Radian::operator* ( const Radian &  f) const

Definition at line 73 of file OgreMath.h.

References mRad, and Radian().

◆ operator*() [2/2]

Radian Ogre::Radian::operator* ( Real  f) const

Definition at line 72 of file OgreMath.h.

References mRad, and Radian().

◆ operator*=()

Radian& Ogre::Radian::operator*= ( Real  f)

Definition at line 74 of file OgreMath.h.

References mRad.

◆ operator+() [1/2]

const Radian& Ogre::Radian::operator+ ( ) const

Definition at line 62 of file OgreMath.h.

◆ operator+() [2/2]

Radian Ogre::Radian::operator+ ( const Radian &  r) const

Definition at line 63 of file OgreMath.h.

References mRad, and Radian().

◆ operator+=()

Radian& Ogre::Radian::operator+= ( const Radian &  r)

Definition at line 65 of file OgreMath.h.

References mRad.

◆ operator-() [1/2]

Radian Ogre::Radian::operator- ( ) const

Definition at line 67 of file OgreMath.h.

References mRad, and Radian().

◆ operator-() [2/2]

Radian Ogre::Radian::operator- ( const Radian &  r) const

Definition at line 68 of file OgreMath.h.

References mRad, and Radian().

◆ operator-=()

Radian& Ogre::Radian::operator-= ( const Radian &  r)

Definition at line 70 of file OgreMath.h.

References mRad.

◆ operator/()

Radian Ogre::Radian::operator/ ( Real  f) const

Definition at line 75 of file OgreMath.h.

References mRad, and Radian().

◆ operator/=()

Radian& Ogre::Radian::operator/= ( Real  f)

Definition at line 76 of file OgreMath.h.

References mRad.

◆ operator<()

bool Ogre::Radian::operator< ( const Radian &  r) const

Definition at line 78 of file OgreMath.h.

References mRad.

◆ operator<=()

bool Ogre::Radian::operator<= ( const Radian &  r) const

Definition at line 79 of file OgreMath.h.

References mRad.

◆ operator=() [1/2]

Radian& Ogre::Radian::operator= ( const Radian &  r)

Definition at line 55 of file OgreMath.h.

References mRad.

◆ operator=() [2/2]

Radian& Ogre::Radian::operator= ( const Real &  f)

Definition at line 54 of file OgreMath.h.

References mRad.

◆ operator==()

bool Ogre::Radian::operator== ( const Radian &  r) const

Definition at line 80 of file OgreMath.h.

References mRad.

◆ operator>()

bool Ogre::Radian::operator> ( const Radian &  r) const

Definition at line 83 of file OgreMath.h.

References mRad.

◆ operator>=()

bool Ogre::Radian::operator>= ( const Radian &  r) const

Definition at line 82 of file OgreMath.h.

References mRad.

◆ valueRadians()

Real Ogre::Radian::valueRadians ( ) const

Friends And Related Function Documentation

◆ operator<<

_OgreExport friend std::ostream& operator<< ( std::ostream &  o,
const Radian &  v 
)
friend

Definition at line 86 of file OgreMath.h.

Member Data Documentation

◆ mRad

Real Ogre::Radian::mRad
private

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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.