Ogre::Radian Class Reference
Core » Math

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

`#include <OgreMath.h>`

## Public Member Functions

| Radian (Real r=0)
| Radian (const Degree &d)
bool | operator!= (const Radian &r) const
Radian | operator* (Real f) const
Radian | operator* (const Radian &f) const
Radian & | operator*= (Real f)
const Radian & | operator+ () const
Radian | operator+ (const Radian &r) const
Radian | operator+ (const Degree &d) const
Radian & | operator+= (const Radian &r)
Radian & | operator+= (const Degree &d)
Radian | operator- () const
Radian | operator- (const Radian &r) const
Radian | operator- (const Degree &d) const
Radian & | operator-= (const Radian &r)
Radian & | operator-= (const Degree &d)
Radian | operator/ (Real f) const
Radian & | operator/= (Real f)
bool | operator< (const Radian &r) const
bool | operator<= (const Radian &r) const
Radian & | operator= (const Real &f)
Radian & | operator= (const Radian &r)
Radian & | operator= (const Degree &d)
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 Ogre::Math::Abs(), Ogre::Angle::Angle(), Ogre::Math::ATan(), Ogre::Math::ATan2(), Ogre::Angle::operator Radian(), operator*(), Ogre::operator*(), operator+(), operator-(), operator/(), Ogre::operator/(), Ogre::Math::Sign(), and Ogre::Math::Sqrt().

## 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* | ( | Real | f | ) | const

Definition at line 72 of file OgreMath.h.

References Radian().

## operator*() [2/2]

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

Definition at line 73 of file OgreMath.h.

References mRad, and Radian().

## operator*=()

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

Definition at line 74 of file OgreMath.h.

## operator+() [1/2]

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

Definition at line 62 of file OgreMath.h.

Referenced by operator+().

## operator+() [2/2]

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

Definition at line 63 of file OgreMath.h.

References mRad, operator+(), 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 Radian().

Referenced by operator-().

## operator-() [2/2]

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

Definition at line 68 of file OgreMath.h.

References mRad, operator-(), 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 Radian().

## operator/=()

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

Definition at line 76 of file OgreMath.h.

## 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 Real & | f | ) |

Definition at line 54 of file OgreMath.h.

Referenced by operator=().

## operator=() [2/2]

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

Definition at line 55 of file OgreMath.h.

References mRad, operator=(), and valueDegrees().

## 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 _OgreExport, and 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

Definition at line 59 of file OgreMath.h.

References mRad, and valueAngleUnits().

Referenced by Ogre::Math::Abs(), Ogre::Math::Cos(), Ogre::Vector3::directionEquals(), Ogre::operator*(), Ogre::operator/(), Ogre::AnimableValue::setAsBaseValue(), Ogre::Math::Sign(), Ogre::Math::Sin(), Ogre::Math::Sqrt(), Ogre::Math::Tan(), and Ogre::Degree::valueDegrees().

## 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

Definition at line 49 of file OgreMath.h.

Referenced by operator!=(), operator*(), operator+(), operator+=(), operator-(), operator-=(), operator<(), operator<=(), operator=(), operator==(), operator>(), operator>=(), valueAngleUnits(), valueDegrees(), and valueRadians().

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

- OgreMath.h

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