Math
Core
Collaboration diagram for Math:

## Classes

class | Ogre::Angle
| Wrapper class which identifies a value as the currently default angle type, as defined by Math::setAngleUnit. More...
class | Ogre::AxisAlignedBox
| A 3D box aligned with the x/y/z axes. More...
class | Ogre::Bitwise
| Class for manipulating bit patterns. More...
class | Ogre::ConvexBody
| Holds a solid representation of a convex body. More...
class | Ogre::Degree
| Wrapper class which indicates a given angle value is in Degrees. More...
class | Ogre::DualQuaternion
| Implementation of a dual quaternion, i.e. More...
class | Ogre::EdgeData
| This class contains the information required to describe the edge connectivity of a given set of vertices and indexes. More...
class | Ogre::EdgeListBuilder
| General utility class for building edge lists for geometry. More...
class | Ogre::Frustum
| A frustum represents a pyramid, capped at the near and far end which is used to represent either a visible area or a projection area. More...
class | Ogre::Math
| Class to provide access to common mathematical functions. More...
class | Ogre::Matrix3
| A 3x3 matrix which can represent rotations around axes. More...
class | Ogre::Matrix4
| Class encapsulating a standard 4x4 homogeneous matrix. More...
class | Ogre::NumericSolver
| Provides numeric solvers for Ogre. More...
class | Ogre::OptimisedUtil
| Utility class for provides optimised functions. More...
class | Ogre::Plane
| Defines a plane in 3D space. More...
class | Ogre::PlaneBoundedVolume
| Represents a convex volume bounded by planes. More...
class | Ogre::Polygon
| The class represents a polygon in 3D space. More...
class | Ogre::Quaternion
| Implementation of a Quaternion, i.e. More...
class | Ogre::Radian
| Wrapper class which indicates a given angle value is in Radians. More...
class | Ogre::Ray
| Representation of a ray in space, i.e. More...
class | Ogre::RotationalSpline
| This class interpolates orientations (rotations) along a spline using derivatives of quaternions. More...
class | Ogre::SimpleSpline
| A very simple spline class which implements the Catmull-Rom class of splines. More...
class | Ogre::Sphere
| A sphere primitive, mostly used for bounds checking. More...
class | Ogre::TangentSpaceCalc
| Class for calculating a tangent space basis. More...
class | Ogre::Vector2
| Standard 2-dimensional vector. More...
class | Ogre::Vector3
| Standard 3-dimensional vector. More...
class | Ogre::Vector4
| 4-dimensional homogeneous vector. More...

## Typedefs

typedef vector< PlaneBoundedVolume >::type | Ogre::PlaneBoundedVolumeList
typedef vector< Plane >::type | Ogre::PlaneList
typedef double | Ogre::PreciseReal
| Real type for numeric solvers. More...

## Enumerations

enum | Ogre::FrustumPlane { Ogre::FRUSTUM_PLANE_NEAR = 0, Ogre::FRUSTUM_PLANE_FAR = 1, Ogre::FRUSTUM_PLANE_LEFT = 2, Ogre::FRUSTUM_PLANE_RIGHT = 3, Ogre::FRUSTUM_PLANE_TOP = 4, Ogre::FRUSTUM_PLANE_BOTTOM = 5 }
| Worldspace clipping planes. More...
enum | Ogre::OrientationMode { Ogre::OR_DEGREE_0 = 0, Ogre::OR_DEGREE_90 = 1, Ogre::OR_DEGREE_180 = 2, Ogre::OR_DEGREE_270 = 3, Ogre::OR_PORTRAIT = OR_DEGREE_0, Ogre::OR_LANDSCAPERIGHT = OR_DEGREE_90, Ogre::OR_LANDSCAPELEFT = OR_DEGREE_270 }
| Specifies orientation mode. More...
enum | Ogre::ProjectionType { Ogre::PT_ORTHOGRAPHIC, Ogre::PT_PERSPECTIVE }
| Specifies perspective (realistic) or orthographic (architectural) projection. More...

## Functions

| Ogre::Radian::Radian (const Degree &d)
template<class T >
static FORCEINLINE void | Ogre::advanceRawPointer (const T *&ptr, ptrdiff_t offset)
| Advance the pointer with raw offset. More...
template<class T >
static FORCEINLINE void | Ogre::advanceRawPointer (T *&ptr, ptrdiff_t offset)
| Ogre::Angle::operator Degree () const
| Ogre::Angle::operator Radian () const
Vector4 | Ogre::operator* (const Vector4 &v, const Matrix4 &mat)
Radian | Ogre::operator* (Real a, const Radian &b)
Degree | Ogre::operator* (Real a, const Degree &b)
Radian | Ogre::Radian::operator+ (const Degree &d) const
Radian & | Ogre::Radian::operator+= (const Degree &d)
Radian | Ogre::Radian::operator- (const Degree &d) const
Radian & | Ogre::Radian::operator-= (const Degree &d)
Radian | Ogre::operator/ (Real a, const Radian &b)
Degree | Ogre::operator/ (Real a, const Degree &b)
Radian & | Ogre::Radian::operator= (const Degree &d)
template<class T >
static FORCEINLINE const T * | Ogre::rawOffsetPointer (const T *ptr, ptrdiff_t offset)
| Returns raw offseted of the given pointer. More...
template<class T >
static FORCEINLINE T * | Ogre::rawOffsetPointer (T *ptr, ptrdiff_t offset)
Real | Ogre::Radian::valueAngleUnits () const
Real | Ogre::Degree::valueAngleUnits () const
Real | Ogre::Radian::valueDegrees () const
Real | Ogre::Degree::valueRadians () const

## Detailed Description

## Typedef Documentation

## PlaneBoundedVolumeList

typedef vector<PlaneBoundedVolume>::type Ogre::PlaneBoundedVolumeList

Definition at line 128 of file OgrePlaneBoundedVolume.h.

## PlaneList

typedef vector<Plane>::type Ogre::PlaneList

Definition at line 160 of file OgrePlane.h.

## PreciseReal

typedef double Ogre::PreciseReal

Real type for numeric solvers.

Definition at line 44 of file OgreNumerics.h.

## Enumeration Type Documentation

## FrustumPlane

enum Ogre::FrustumPlane

Worldspace clipping planes.

Enumerator
FRUSTUM_PLANE_NEAR |
FRUSTUM_PLANE_FAR |
FRUSTUM_PLANE_LEFT |
FRUSTUM_PLANE_RIGHT |
FRUSTUM_PLANE_TOP |
FRUSTUM_PLANE_BOTTOM |

Definition at line 71 of file OgreFrustum.h.

## OrientationMode

enum Ogre::OrientationMode

Specifies orientation mode.

Enumerator
OR_DEGREE_0 |
OR_DEGREE_90 |
OR_DEGREE_180 |
OR_DEGREE_270 |
OR_PORTRAIT |
OR_LANDSCAPERIGHT |
OR_LANDSCAPELEFT |

Definition at line 49 of file OgreFrustum.h.

## ProjectionType

enum Ogre::ProjectionType

Specifies perspective (realistic) or orthographic (architectural) projection.

Enumerator
PT_ORTHOGRAPHIC |
PT_PERSPECTIVE |

Definition at line 63 of file OgreFrustum.h.

## Function Documentation

## Radian()

Ogre::Radian::Radian | ( | const Degree & | d | ) |

Definition at line 161 of file OgreMath.h.

## advanceRawPointer() [1/2]

template<class T >

static FORCEINLINE void Ogre::advanceRawPointer | ( | const T *& | ptr,
|  | ptrdiff_t | offset
| ) |  |

static

Advance the pointer with raw offset.

Note
  The offset are in bytes, no matter what type of the pointer.

Definition at line 229 of file OgreOptimisedUtil.h.

References Ogre::rawOffsetPointer().

## advanceRawPointer() [2/2]

template<class T >

static FORCEINLINE void Ogre::advanceRawPointer | ( | T *& | ptr,
|  | ptrdiff_t | offset
| ) |  |

static

Definition at line 235 of file OgreOptimisedUtil.h.

References Ogre::rawOffsetPointer().

## operator Degree()

Ogre::Angle::operator Degree | ( |  | ) | const

Definition at line 742 of file OgreMath.h.

References Ogre::Math::AngleUnitsToDegrees().

## operator Radian()

Ogre::Angle::operator Radian | ( |  | ) | const

Definition at line 737 of file OgreMath.h.

References Ogre::Math::AngleUnitsToRadians(), and Ogre::Radian::Radian().

## operator*() [1/3]

Vector4 Ogre::operator* | ( | const Vector4 & | v,
|  | const Matrix4 & | mat
| ) |  |

Definition at line 647 of file OgreMatrix4.h.

References Ogre::Vector4::w, Ogre::Vector4::x, Ogre::Vector4::y, and Ogre::Vector4::z.

## operator*() [2/3]

Radian Ogre::operator* | ( | Real | a,
|  | const Radian & | b
| ) |  |

Definition at line 747 of file OgreMath.h.

References Ogre::Radian::Radian(), and Ogre::Radian::valueRadians().

Referenced by Ogre::Matrix3::operator!=(), Ogre::Quaternion::operator!=(), and Ogre::Quaternion::operator=().

## operator*() [3/3]

Degree Ogre::operator* | ( | Real | a,
|  | const Degree & | b
| ) |  |

Definition at line 757 of file OgreMath.h.

References Ogre::Degree::valueDegrees().

## operator+()

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

Definition at line 166 of file OgreMath.h.

References Ogre::Radian::mRad, Ogre::Radian::Radian(), and Ogre::Degree::valueRadians().

## operator+=()

Radian & Ogre::Radian::operator+= | ( | const Degree & | d | ) |

Definition at line 169 of file OgreMath.h.

References Ogre::Radian::mRad, and Ogre::Degree::valueRadians().

## operator-()

Radian Ogre::Radian::operator- | ( | const Degree & | d | ) | const

Definition at line 173 of file OgreMath.h.

References Ogre::Radian::mRad, Ogre::Radian::Radian(), and Ogre::Degree::valueRadians().

## operator-=()

Radian & Ogre::Radian::operator-= | ( | const Degree & | d | ) |

Definition at line 176 of file OgreMath.h.

References Ogre::Radian::mRad, and Ogre::Degree::valueRadians().

## operator/() [1/2]

Radian Ogre::operator/ | ( | Real | a,
|  | const Radian & | b
| ) |  |

Definition at line 752 of file OgreMath.h.

References Ogre::Radian::Radian(), and Ogre::Radian::valueRadians().

## operator/() [2/2]

Degree Ogre::operator/ | ( | Real | a,
|  | const Degree & | b
| ) |  |

Definition at line 762 of file OgreMath.h.

References Ogre::Degree::valueDegrees().

## operator=()

Radian & Ogre::Radian::operator= | ( | const Degree & | d | ) |

Definition at line 163 of file OgreMath.h.

References Ogre::Radian::mRad, and Ogre::Degree::valueRadians().

## rawOffsetPointer() [1/2]

template<class T >

static FORCEINLINE const T* Ogre::rawOffsetPointer | ( | const T * | ptr,
|  | ptrdiff_t | offset
| ) |  |

static

Returns raw offseted of the given pointer.

Note
  The offset are in bytes, no matter what type of the pointer.

Definition at line 213 of file OgreOptimisedUtil.h.

Referenced by Ogre::advanceRawPointer().

## rawOffsetPointer() [2/2]

template<class T >

static FORCEINLINE T* Ogre::rawOffsetPointer | ( | T * | ptr,
|  | ptrdiff_t | offset
| ) |  |

static

Definition at line 219 of file OgreOptimisedUtil.h.

## valueAngleUnits() [1/2]

Real Ogre::Radian::valueAngleUnits | ( |  | ) | const

Definition at line 722 of file OgreMath.h.

References Ogre::Radian::mRad, and Ogre::Math::RadiansToAngleUnits().

Referenced by Ogre::StringConverter::toString(), Ogre::Degree::valueDegrees(), and Ogre::Radian::valueRadians().

## valueAngleUnits() [2/2]

Real Ogre::Degree::valueAngleUnits | ( |  | ) | const

Definition at line 732 of file OgreMath.h.

References Ogre::Math::DegreesToAngleUnits().

Referenced by Ogre::StringConverter::toString().

## valueDegrees()

Real Ogre::Radian::valueDegrees | ( |  | ) | const

Definition at line 717 of file OgreMath.h.

References Ogre::Radian::mRad, and Ogre::Math::RadiansToDegrees().

Referenced by Ogre::Degree::operator+(), Ogre::Degree::operator+=(), Ogre::Degree::operator-(), Ogre::Degree::operator-=(), Ogre::Radian::operator=(), and Ogre::Degree::operator=().

## valueRadians()

Real Ogre::Degree::valueRadians | ( |  | ) | const

Definition at line 727 of file OgreMath.h.

References Ogre::Math::DegreesToRadians().

Referenced by Ogre::Radian::operator+(), Ogre::Radian::operator+=(), Ogre::Radian::operator-(), Ogre::Radian::operator-=(), Ogre::Radian::operator=(), and Ogre::AnimableValue::setAsBaseValue().

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