Classes | Typedefs | Enumerations | Functions
Math
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...
 
struct  Ogre::EdgeData::Edge
 Edge data. More...
 
struct  Ogre::EdgeData::EdgeGroup
 A group of edges sharing the same vertex data. More...
 
struct  Ogre::EdgeData::Triangle
 Basic triangle structure. More...
 
class  Ogre::EdgeListBuilder
 General utility class for building edge lists for geometry. More...
 
struct  Ogre::EdgeListBuilder::CommonVertex
 A vertex can actually represent several vertices in the final model, because vertices along texture seams etc will have been duplicated. More...
 
struct  Ogre::EdgeListBuilder::Geometry
 A set of indexed geometry data. More...
 
struct  Ogre::EdgeListBuilder::geometryLess
 Comparator for sorting geometries by vertex set. More...
 
struct  Ogre::EdgeListBuilder::vectorLess
 Comparator for unique vertex list. 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::Math::RandomValueProvider
 This class is used to provide an external random value provider. 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...
 
struct  Ogre::TangentSpaceCalc::IndexRemap
 Information about a remapped index. More...
 
struct  Ogre::TangentSpaceCalc::Result
 The result of having built a tangent space basis. More...
 
struct  Ogre::TangentSpaceCalc::VertexInfo
 
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::Math::AngleUnit { Ogre::Math::AU_DEGREE, Ogre::Math::AU_RADIAN }
 The angular units used by the API. More...
 
enum  Ogre::AxisAlignedBox::CornerEnum {
  Ogre::AxisAlignedBox::FAR_LEFT_BOTTOM = 0, Ogre::AxisAlignedBox::FAR_LEFT_TOP = 1, Ogre::AxisAlignedBox::FAR_RIGHT_TOP = 2, Ogre::AxisAlignedBox::FAR_RIGHT_BOTTOM = 3,
  Ogre::AxisAlignedBox::NEAR_RIGHT_BOTTOM = 7, Ogre::AxisAlignedBox::NEAR_LEFT_BOTTOM = 6, Ogre::AxisAlignedBox::NEAR_LEFT_TOP = 5, Ogre::AxisAlignedBox::NEAR_RIGHT_TOP = 4
}
 
enum  Ogre::AxisAlignedBox::Extent { Ogre::AxisAlignedBox::EXTENT_NULL, Ogre::AxisAlignedBox::EXTENT_FINITE, Ogre::AxisAlignedBox::EXTENT_INFINITE }
 
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...
 
enum  Ogre::Plane::Side { Ogre::Plane::NO_SIDE, Ogre::Plane::POSITIVE_SIDE, Ogre::Plane::NEGATIVE_SIDE, Ogre::Plane::BOTH_SIDE }
 The "positive side" of the plane is the half space to which the plane normal points. 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

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

Definition at line 128 of file OgrePlaneBoundedVolume.h.

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

Definition at line 160 of file OgrePlane.h.

typedef double Ogre::PreciseReal

Real type for numeric solvers.

Definition at line 44 of file OgreNumerics.h.

Enumeration Type Documentation

The angular units used by the API.

This functionality is now deprecated in favor of discreet angular unit types ( see Degree and Radian above ). The only place this functionality is actually still used is when parsing files. Search for usage of the Angle class for those instances

Enumerator
AU_DEGREE 
AU_RADIAN 

Definition at line 199 of file OgreMath.h.

Enumerator
FAR_LEFT_BOTTOM 
FAR_LEFT_TOP 
FAR_RIGHT_TOP 
FAR_RIGHT_BOTTOM 
NEAR_RIGHT_BOTTOM 
NEAR_LEFT_BOTTOM 
NEAR_LEFT_TOP 
NEAR_RIGHT_TOP 

Definition at line 81 of file OgreAxisAlignedBox.h.

Enumerator
EXTENT_NULL 
EXTENT_FINITE 
EXTENT_INFINITE 

Definition at line 57 of file OgreAxisAlignedBox.h.

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.

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.

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

Enumerator
PT_ORTHOGRAPHIC 
PT_PERSPECTIVE 

Definition at line 63 of file OgreFrustum.h.

The "positive side" of the plane is the half space to which the plane normal points.

The "negative side" is the other half space. The flag "no side" indicates the plane itself.

Enumerator
NO_SIDE 
POSITIVE_SIDE 
NEGATIVE_SIDE 
BOTH_SIDE 

Definition at line 80 of file OgrePlane.h.

Function Documentation

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

Definition at line 161 of file OgreMath.h.

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().

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().

Ogre::Angle::operator Degree ( ) const

Definition at line 742 of file OgreMath.h.

References Ogre::Math::AngleUnitsToDegrees().

Ogre::Angle::operator Radian ( ) const

Definition at line 737 of file OgreMath.h.

References Ogre::Math::AngleUnitsToRadians().

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.

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

Definition at line 747 of file OgreMath.h.

References Ogre::Radian::valueRadians().

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

Definition at line 757 of file OgreMath.h.

References Ogre::Degree::valueDegrees().

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

Definition at line 169 of file OgreMath.h.

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

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

Definition at line 176 of file OgreMath.h.

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

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

Definition at line 752 of file OgreMath.h.

References Ogre::Radian::valueRadians().

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

Definition at line 762 of file OgreMath.h.

References Ogre::Degree::valueDegrees().

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

Definition at line 163 of file OgreMath.h.

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

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().

template<class T >
static FORCEINLINE T* Ogre::rawOffsetPointer ( T *  ptr,
ptrdiff_t  offset 
)
static

Definition at line 219 of file OgreOptimisedUtil.h.

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().

Real Ogre::Degree::valueAngleUnits ( ) const

Definition at line 732 of file OgreMath.h.

References Ogre::Math::DegreesToAngleUnits(), and Ogre::Degree::mDeg.

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

Real Ogre::Radian::valueDegrees ( ) const
Real Ogre::Degree::valueRadians ( ) const

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