OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::Math Class Reference

Class to provide access to common mathematical functions. More...

#include <OgreMath.h>

+ Collaboration diagram for Ogre::Math:

Classes

class  RandomValueProvider
 This class is used to provide an external random value provider. More...
 

Public Types

enum  AngleUnit { AU_DEGREE, AU_RADIAN }
 The angular units used by the API. More...
 

Public Member Functions

 Math (unsigned int trigTableSize=4096)
 Default constructor. More...
 
 ~Math ()
 Default destructor. More...
 
template<>
float Clamp (float val, float minval, float maxval)
 
template<>
double Clamp (double val, double minval, double maxval)
 

Static Public Member Functions

static Real Abs (Real fValue)
 Absolute value function. More...
 
static Degree Abs (const Degree &dValue)
 Absolute value function. More...
 
static Radian Abs (const Radian &rValue)
 Absolute value function. More...
 
static Radian ACos (Real fValue)
 Arc cosine function. More...
 
static Real AngleUnitsToDegrees (Real units)
 Convert from the current AngleUnit to degrees. More...
 
static Real AngleUnitsToRadians (Real units)
 Convert from the current AngleUnit to radians. More...
 
static Radian ASin (Real fValue)
 Arc sine function. More...
 
static Radian ATan (Real fValue)
 Arc tangent function. More...
 
static Radian ATan2 (Real fY, Real fX)
 Arc tangent between two values function. More...
 
static Real boundingRadiusFromAABB (const AxisAlignedBox &aabb)
 Get a bounding radius value from a bounding box. More...
 
static Matrix4 buildReflectionMatrix (const Plane &p)
 Build a reflection matrix for the passed in plane. More...
 
static Vector3 calculateBasicFaceNormal (const Vector3 &v1, const Vector3 &v2, const Vector3 &v3)
 Calculate a face normal, no w-information. More...
 
static Vector3 calculateBasicFaceNormalWithoutNormalize (const Vector3 &v1, const Vector3 &v2, const Vector3 &v3)
 Calculate a face normal without normalize, no w-information. More...
 
static Vector4 calculateFaceNormal (const Vector3 &v1, const Vector3 &v2, const Vector3 &v3)
 Calculate a face normal, including the w component which is the offset from the origin. More...
 
static Vector4 calculateFaceNormalWithoutNormalize (const Vector3 &v1, const Vector3 &v2, const Vector3 &v3)
 Calculate a face normal without normalize, including the w component which is the offset from the origin. More...
 
static Vector3 calculateTangentSpaceVector (const Vector3 &position1, const Vector3 &position2, const Vector3 &position3, Real u1, Real v1, Real u2, Real v2, Real u3, Real v3)
 Calculates the tangent space vector for a given set of positions / texture coords. More...
 
static Real Ceil (Real fValue)
 Ceiling function Returns the smallest following integer. More...
 
template<typename T >
static T Clamp (T val, T minval, T maxval)
 Clamp a value within an inclusive range. More...
 
static Real Cos (const Radian &fValue, bool useTables=false)
 Cosine function. More...
 
static Real Cos (Real fValue, bool useTables=false)
 Cosine function. More...
 
static Real DegreesToAngleUnits (Real degrees)
 Convert from degrees to the current AngleUnit. More...
 
static Real DegreesToRadians (Real degrees)
 
static Real Exp (Real fValue)
 
static Real Floor (Real fValue)
 Floor function Returns the largest previous integer. More...
 
static Real gaussianDistribution (Real x, Real offset=0.0f, Real scale=1.0f)
 Generates a value based on the Gaussian (normal) distribution function with the given offset and scale parameters. More...
 
static AngleUnit getAngleUnit (void)
 Get the unit being used for angles. More...
 
static int IAbs (int iValue)
 
static int ICeil (float fValue)
 
static int IFloor (float fValue)
 
static std::pair< bool, Realintersects (const Ray &ray, const Plane &plane)
 Ray / plane intersection, returns boolean result and distance. More...
 
static std::pair< bool, Realintersects (const Ray &ray, const Sphere &sphere, bool discardInside=true)
 Ray / sphere intersection, returns boolean result and distance. More...
 
static std::pair< bool, Realintersects (const Ray &ray, const AxisAlignedBox &box)
 Ray / box intersection, returns boolean result and distance. More...
 
static bool intersects (const Ray &ray, const AxisAlignedBox &box, Real *d1, Real *d2)
 Ray / box intersection, returns boolean result and two intersection distance. More...
 
static std::pair< bool, Realintersects (const Ray &ray, const Vector3 &a, const Vector3 &b, const Vector3 &c, const Vector3 &normal, bool positiveSide=true, bool negativeSide=true)
 Ray / triangle intersection, returns boolean result and distance. More...
 
static std::pair< bool, Realintersects (const Ray &ray, const Vector3 &a, const Vector3 &b, const Vector3 &c, bool positiveSide=true, bool negativeSide=true)
 Ray / triangle intersection, returns boolean result and distance. More...
 
static bool intersects (const Sphere &sphere, const AxisAlignedBox &box)
 Sphere / box intersection test. More...
 
static bool intersects (const Plane &plane, const AxisAlignedBox &box)
 Plane / box intersection test. More...
 
static std::pair< bool, Realintersects (const Ray &ray, const vector< Plane >::type &planeList, bool normalIsOutside)
 Ray / convex plane list intersection test. More...
 
static std::pair< bool, Realintersects (const Ray &ray, const list< Plane >::type &planeList, bool normalIsOutside)
 Ray / convex plane list intersection test. More...
 
static bool intersects (const Sphere &sphere, const Plane &plane)
 Sphere / plane intersection test. More...
 
static Real InvSqrt (Real fValue)
 Inverse square root i.e. More...
 
static int ISign (int iValue)
 
static bool isNaN (Real f)
 
template<typename T , typename S >
static FORCEINLINElerp (const T &a, const T &b, const S &w)
 Linear interpolation. More...
 
static Real Log (Real fValue)
 
static Real Log2 (Real fValue)
 
static Real LogN (Real base, Real fValue)
 
static Matrix4 makeViewMatrix (const Vector3 &position, const Quaternion &orientation, const Matrix4 *reflectMatrix=0)
 
static bool pointInTri2D (const Vector2 &p, const Vector2 &a, const Vector2 &b, const Vector2 &c)
 Checks whether a given point is inside a triangle, in a 2-dimensional (Cartesian) space. More...
 
static bool pointInTri3D (const Vector3 &p, const Vector3 &a, const Vector3 &b, const Vector3 &c, const Vector3 &normal)
 Checks whether a given 3D point is inside a triangle. More...
 
static Real Pow (Real fBase, Real fExponent)
 
static Real RadiansToAngleUnits (Real radians)
 Convert from radians to the current AngleUnit . More...
 
static Real RadiansToDegrees (Real radians)
 
static Real RangeRandom (Real fLow, Real fHigh)
 Generate a random number within the range provided. More...
 
static bool RealEqual (Real a, Real b, Real tolerance=std::numeric_limits< Real >::epsilon())
 Compare 2 reals, using tolerance for inaccuracies. More...
 
static float saturate (float t)
 
static double saturate (double t)
 
static void setAngleUnit (AngleUnit unit)
 These functions used to set the assumed angle units (radians or degrees) expected when using the Angle type. More...
 
static void SetRandomValueProvider (RandomValueProvider *provider)
 
static Real Sign (Real fValue)
 
static Radian Sign (const Radian &rValue)
 
static Degree Sign (const Degree &dValue)
 
static Real Sin (const Radian &fValue, bool useTables=false)
 Sine function. More...
 
static Real Sin (Real fValue, bool useTables=false)
 Sine function. More...
 
static Real Sqr (Real fValue)
 Squared function. More...
 
static Real Sqrt (Real fValue)
 Square root function. More...
 
static Radian Sqrt (const Radian &fValue)
 Square root function. More...
 
static Degree Sqrt (const Degree &fValue)
 Square root function. More...
 
static Real SymmetricRandom ()
 Generate a random number in the range [-1,1]. More...
 
static Real Tan (const Radian &fValue, bool useTables=false)
 Tangent function. More...
 
static Real Tan (Real fValue, bool useTables=false)
 Tangent function. More...
 
static Real UnitRandom ()
 Generate a random number of unit length. More...
 

Static Public Attributes

static const Real fDeg2Rad
 
static const Real fRad2Deg
 
static const Real HALF_PI
 
static const Real LOG2
 Stored value of log(2) for frequent use. More...
 
static const Real NEG_INFINITY
 
static const Real PI
 
static const Real POS_INFINITY
 
static const Real TWO_PI
 

Protected Member Functions

void buildTrigTables ()
 Private function to build trig tables. More...
 

Static Protected Member Functions

static Real SinTable (Real fValue)
 
static Real TanTable (Real fValue)
 

Static Protected Attributes

static RandomValueProvidermRandProvider
 A random value provider. overriding the default random number generator. More...
 
static AngleUnit msAngleUnit
 Angle units used by the api. More...
 
static RealmSinTable
 
static RealmTanTable
 
static Real mTrigTableFactor
 Radian -> index factor value ( mTrigTableSize / 2 * PI ) More...
 
static int mTrigTableSize
 Size of the trig tables as determined by constructor. More...
 

Detailed Description

Class to provide access to common mathematical functions.

Remarks
Most of the maths functions are aliased versions of the C runtime library functions. They are aliased here to provide future optimisation opportunities, either from faster RTLs or custom math approximations.
Note

This is based on MgcMath.h from Wild Magic.

Definition at line 193 of file OgreMath.h.

Member Enumeration 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 201 of file OgreMath.h.

Constructor & Destructor Documentation

Ogre::Math::Math ( unsigned int  trigTableSize = 4096)

Default constructor.

Parameters
trigTableSizeOptional parameter to set the size of the tables used to implement Sin, Cos, Tan
Ogre::Math::~Math ( )

Default destructor.

Member Function Documentation

static Real Ogre::Math::Abs ( Real  fValue)
inlinestatic
static Degree Ogre::Math::Abs ( const Degree dValue)
inlinestatic

Absolute value function.

Parameters
dValueThe value, in degrees, whose absolute value will be returned.

Definition at line 266 of file OgreMath.h.

References Ogre::Degree::valueDegrees().

static Radian Ogre::Math::Abs ( const Radian rValue)
inlinestatic

Absolute value function.

Parameters
rValueThe value, in radians, whose absolute value will be returned.

Definition at line 272 of file OgreMath.h.

References Ogre::Radian::valueRadians().

static Radian Ogre::Math::ACos ( Real  fValue)
static

Arc cosine function.

Parameters
fValueThe value whose arc cosine will be returned.

Referenced by Ogre::Vector2::angleBetween(), Ogre::Vector3::angleBetween(), and Ogre::Vector3::directionEquals().

static Real Ogre::Math::AngleUnitsToDegrees ( Real  units)
static

Convert from the current AngleUnit to degrees.

Referenced by Ogre::Angle::operator Degree().

static Real Ogre::Math::AngleUnitsToRadians ( Real  units)
static

Convert from the current AngleUnit to radians.

Referenced by Ogre::Angle::operator Radian().

static Radian Ogre::Math::ASin ( Real  fValue)
static

Arc sine function.

Parameters
fValueThe value whose arc sine will be returned.
static Radian Ogre::Math::ATan ( Real  fValue)
inlinestatic

Arc tangent function.

Parameters
fValueThe value whose arc tangent will be returned.

Definition at line 290 of file OgreMath.h.

static Radian Ogre::Math::ATan2 ( Real  fY,
Real  fX 
)
inlinestatic

Arc tangent between two values function.

Parameters
fYThe first value to calculate the arc tangent with.
fXThe second value to calculate the arc tangent with.

Definition at line 298 of file OgreMath.h.

static Real Ogre::Math::boundingRadiusFromAABB ( const AxisAlignedBox aabb)
static

Get a bounding radius value from a bounding box.

static Matrix4 Ogre::Math::buildReflectionMatrix ( const Plane p)
static

Build a reflection matrix for the passed in plane.

void Ogre::Math::buildTrigTables ( )
protected

Private function to build trig tables.

static Vector3 Ogre::Math::calculateBasicFaceNormal ( const Vector3 v1,
const Vector3 v2,
const Vector3 v3 
)
static

Calculate a face normal, no w-information.

static Vector3 Ogre::Math::calculateBasicFaceNormalWithoutNormalize ( const Vector3 v1,
const Vector3 v2,
const Vector3 v3 
)
static

Calculate a face normal without normalize, no w-information.

static Vector4 Ogre::Math::calculateFaceNormal ( const Vector3 v1,
const Vector3 v2,
const Vector3 v3 
)
static

Calculate a face normal, including the w component which is the offset from the origin.

static Vector4 Ogre::Math::calculateFaceNormalWithoutNormalize ( const Vector3 v1,
const Vector3 v2,
const Vector3 v3 
)
static

Calculate a face normal without normalize, including the w component which is the offset from the origin.

static Vector3 Ogre::Math::calculateTangentSpaceVector ( const Vector3 position1,
const Vector3 position2,
const Vector3 position3,
Real  u1,
Real  v1,
Real  u2,
Real  v2,
Real  u3,
Real  v3 
)
static

Calculates the tangent space vector for a given set of positions / texture coords.

static Real Ogre::Math::Ceil ( Real  fValue)
inlinestatic

Ceiling function Returns the smallest following integer.

(example: Ceil(1.1) = 2)

Parameters
fValueThe value to round up to the nearest integer.

Definition at line 306 of file OgreMath.h.

template<typename T >
static T Ogre::Math::Clamp ( val,
minval,
maxval 
)
inlinestatic

Clamp a value within an inclusive range.

Definition at line 712 of file OgreMath.h.

References Ogre::max(), and Ogre::min().

Referenced by Ogre::Vector2::angleBetween(), and Ogre::Vector3::angleBetween().

static Real Ogre::Math::Cos ( const Radian fValue,
bool  useTables = false 
)
inlinestatic

Cosine function.

Parameters
fValueAngle in radians
useTablesIf true, uses lookup tables rather than calculation - faster but less accurate.

Definition at line 321 of file OgreMath.h.

References Ogre::Radian::valueRadians().

Referenced by Ogre::Vector2::randomDeviant().

static Real Ogre::Math::Cos ( Real  fValue,
bool  useTables = false 
)
inlinestatic

Cosine function.

Parameters
fValueAngle in radians
useTablesIf true, uses lookup tables rather than calculation - faster but less accurate.

Definition at line 331 of file OgreMath.h.

static Real Ogre::Math::DegreesToAngleUnits ( Real  degrees)
static

Convert from degrees to the current AngleUnit.

Referenced by Ogre::Degree::valueAngleUnits().

static Real Ogre::Math::DegreesToRadians ( Real  degrees)
inlinestatic

Definition at line 493 of file OgreMath.h.

Referenced by Ogre::Degree::valueRadians().

static Real Ogre::Math::Exp ( Real  fValue)
inlinestatic

Definition at line 335 of file OgreMath.h.

static Real Ogre::Math::Floor ( Real  fValue)
inlinestatic

Floor function Returns the largest previous integer.

(example: Floor(1.9) = 1)

Parameters
fValueThe value to round down to the nearest integer.

Definition at line 343 of file OgreMath.h.

static Real Ogre::Math::gaussianDistribution ( Real  x,
Real  offset = 0.0f,
Real  scale = 1.0f 
)
static

Generates a value based on the Gaussian (normal) distribution function with the given offset and scale parameters.

static AngleUnit Ogre::Math::getAngleUnit ( void  )
static

Get the unit being used for angles.

static int Ogre::Math::IAbs ( int  iValue)
inlinestatic

Definition at line 251 of file OgreMath.h.

static int Ogre::Math::ICeil ( float  fValue)
inlinestatic

Definition at line 252 of file OgreMath.h.

static int Ogre::Math::IFloor ( float  fValue)
inlinestatic

Definition at line 253 of file OgreMath.h.

static std::pair<bool, Real> Ogre::Math::intersects ( const Ray ray,
const Plane plane 
)
static

Ray / plane intersection, returns boolean result and distance.

Referenced by Ogre::Ray::intersects(), Ogre::Sphere::intersects(), Ogre::PlaneBoundedVolume::intersects(), and Ogre::AxisAlignedBox::intersects().

static std::pair<bool, Real> Ogre::Math::intersects ( const Ray ray,
const Sphere sphere,
bool  discardInside = true 
)
static

Ray / sphere intersection, returns boolean result and distance.

static std::pair<bool, Real> Ogre::Math::intersects ( const Ray ray,
const AxisAlignedBox box 
)
static

Ray / box intersection, returns boolean result and distance.

static bool Ogre::Math::intersects ( const Ray ray,
const AxisAlignedBox box,
Real d1,
Real d2 
)
static

Ray / box intersection, returns boolean result and two intersection distance.

Parameters
rayThe ray.
boxThe box.
d1A real pointer to retrieve the near intersection distance from the ray origin, maybe null which means don't care about the near intersection distance.
d2A real pointer to retrieve the far intersection distance from the ray origin, maybe null which means don't care about the far intersection distance.
Returns
If the ray is intersects the box, true is returned, and the near intersection distance is return by d1, the far intersection distance is return by d2. Guarantee 0 <= d1 <= d2.
If the ray isn't intersects the box, false is returned, and d1 and d2 is unmodified.
static std::pair<bool, Real> Ogre::Math::intersects ( const Ray ray,
const Vector3 a,
const Vector3 b,
const Vector3 c,
const Vector3 normal,
bool  positiveSide = true,
bool  negativeSide = true 
)
static

Ray / triangle intersection, returns boolean result and distance.

Parameters
rayThe ray.
aThe triangle's first vertex.
bThe triangle's second vertex.
cThe triangle's third vertex.
normalThe triangle plane's normal (passed in rather than calculated on demand since the caller may already have it), doesn't need normalised since we don't care.
positiveSideIntersect with "positive side" of the triangle
negativeSideIntersect with "negative side" of the triangle
Returns
If the ray is intersects the triangle, a pair of true and the distance between intersection point and ray origin returned.
If the ray isn't intersects the triangle, a pair of false and 0 returned.
static std::pair<bool, Real> Ogre::Math::intersects ( const Ray ray,
const Vector3 a,
const Vector3 b,
const Vector3 c,
bool  positiveSide = true,
bool  negativeSide = true 
)
static

Ray / triangle intersection, returns boolean result and distance.

Parameters
rayThe ray.
aThe triangle's first vertex.
bThe triangle's second vertex.
cThe triangle's third vertex.
positiveSideIntersect with "positive side" of the triangle
negativeSideIntersect with "negative side" of the triangle
Returns
If the ray is intersects the triangle, a pair of true and the distance between intersection point and ray origin returned.
If the ray isn't intersects the triangle, a pair of false and 0 returned.
static bool Ogre::Math::intersects ( const Sphere sphere,
const AxisAlignedBox box 
)
static

Sphere / box intersection test.

Sphere / box intersection test.

static bool Ogre::Math::intersects ( const Plane plane,
const AxisAlignedBox box 
)
static

Plane / box intersection test.

static std::pair<bool, Real> Ogre::Math::intersects ( const Ray ray,
const vector< Plane >::type &  planeList,
bool  normalIsOutside 
)
static

Ray / convex plane list intersection test.

Parameters
rayThe ray to test with
planeListList of planes which form a convex volume
normalIsOutsideDoes the normal point outside the volume
static std::pair<bool, Real> Ogre::Math::intersects ( const Ray ray,
const list< Plane >::type &  planeList,
bool  normalIsOutside 
)
static

Ray / convex plane list intersection test.

Parameters
rayThe ray to test with
planeListList of planes which form a convex volume
normalIsOutsideDoes the normal point outside the volume
static bool Ogre::Math::intersects ( const Sphere sphere,
const Plane plane 
)
static

Sphere / plane intersection test.

Remarks
NB just do a plane.getDistance(sphere.getCenter()) for more detail!
static Real Ogre::Math::InvSqrt ( Real  fValue)
static

Inverse square root i.e.

1 / Sqrt(x), good for vector normalisation.

Parameters
fValueThe value whose inverse square root will be calculated.
static int Ogre::Math::ISign ( int  iValue)
static
static bool Ogre::Math::isNaN ( Real  f)
inlinestatic
template<typename T , typename S >
static FORCEINLINE T Ogre::Math::lerp ( const T &  a,
const T &  b,
const S &  w 
)
inlinestatic

Linear interpolation.

Given 3 parameters a, b and wthe function returns the value of (1 – w)* a + w * b. Where a and b are matching vector or scalar types and w can be either a scalar or a vector of the same type as a and b.

Remarks
lerp( a, b, 0 ) = a lerp( a, b, 1 ) = b

Definition at line 387 of file OgreMath.h.

static Real Ogre::Math::Log ( Real  fValue)
inlinestatic

Definition at line 345 of file OgreMath.h.

static Real Ogre::Math::Log2 ( Real  fValue)
inlinestatic

Definition at line 350 of file OgreMath.h.

static Real Ogre::Math::LogN ( Real  base,
Real  fValue 
)
inlinestatic

Definition at line 352 of file OgreMath.h.

static Matrix4 Ogre::Math::makeViewMatrix ( const Vector3 position,
const Quaternion orientation,
const Matrix4 reflectMatrix = 0 
)
static
static bool Ogre::Math::pointInTri2D ( const Vector2 p,
const Vector2 a,
const Vector2 b,
const Vector2 c 
)
static

Checks whether a given point is inside a triangle, in a 2-dimensional (Cartesian) space.

Remarks
The vertices of the triangle must be given in either trigonometrical (anticlockwise) or inverse trigonometrical (clockwise) order.
Parameters
pThe point.
aThe triangle's first vertex.
bThe triangle's second vertex.
cThe triangle's third vertex.
Returns
If the point resides in the triangle, true is returned.
If the point is outside the triangle, false is returned.
static bool Ogre::Math::pointInTri3D ( const Vector3 p,
const Vector3 a,
const Vector3 b,
const Vector3 c,
const Vector3 normal 
)
static

Checks whether a given 3D point is inside a triangle.

Remarks
The vertices of the triangle must be given in either trigonometrical (anticlockwise) or inverse trigonometrical (clockwise) order, and the point must be guaranteed to be in the same plane as the triangle
Parameters
pp The point.
aThe triangle's first vertex.
bThe triangle's second vertex.
cThe triangle's third vertex.
normalThe triangle plane's normal (passed in rather than calculated on demand since the caller may already have it)
Returns
If the point resides in the triangle, true is returned.
If the point is outside the triangle, false is returned.
static Real Ogre::Math::Pow ( Real  fBase,
Real  fExponent 
)
inlinestatic

Definition at line 354 of file OgreMath.h.

static Real Ogre::Math::RadiansToAngleUnits ( Real  radians)
static

Convert from radians to the current AngleUnit .

Referenced by Ogre::Radian::valueAngleUnits().

static Real Ogre::Math::RadiansToDegrees ( Real  radians)
inlinestatic

Definition at line 494 of file OgreMath.h.

Referenced by Ogre::Radian::valueDegrees().

static Real Ogre::Math::RangeRandom ( Real  fLow,
Real  fHigh 
)
static

Generate a random number within the range provided.

Parameters
fLowThe lower bound of the range.
fHighThe upper bound of the range.
Returns
A random number in the range from [fLow,fHigh].

Referenced by Ogre::Vector2::randomDeviant().

static bool Ogre::Math::RealEqual ( Real  a,
Real  b,
Real  tolerance = std::numeric_limits< Real >::epsilon() 
)
static
static float Ogre::Math::saturate ( float  t)
inlinestatic

Definition at line 367 of file OgreMath.h.

References Ogre::max(), and Ogre::min().

static double Ogre::Math::saturate ( double  t)
inlinestatic

Definition at line 373 of file OgreMath.h.

References Ogre::max(), and Ogre::min().

static void Ogre::Math::setAngleUnit ( AngleUnit  unit)
static

These functions used to set the assumed angle units (radians or degrees) expected when using the Angle type.

You can set this directly after creating a new Root, and also before/after resource creation, depending on whether you want the change to affect resource files.
static void Ogre::Math::SetRandomValueProvider ( RandomValueProvider provider)
static
static Real Ogre::Math::Sign ( Real  fValue)
static
static Radian Ogre::Math::Sign ( const Radian rValue)
inlinestatic

Definition at line 357 of file OgreMath.h.

References Ogre::Radian::valueRadians().

static Degree Ogre::Math::Sign ( const Degree dValue)
inlinestatic

Definition at line 361 of file OgreMath.h.

References Ogre::Degree::valueDegrees().

static Real Ogre::Math::Sin ( const Radian fValue,
bool  useTables = false 
)
inlinestatic

Sine function.

Parameters
fValueAngle in radians
useTablesIf true, uses lookup tables rather than calculation - faster but less accurate.

Definition at line 399 of file OgreMath.h.

References Ogre::Radian::valueRadians().

Referenced by Ogre::Vector2::randomDeviant().

static Real Ogre::Math::Sin ( Real  fValue,
bool  useTables = false 
)
inlinestatic

Sine function.

Parameters
fValueAngle in radians
useTablesIf true, uses lookup tables rather than calculation - faster but less accurate.

Definition at line 409 of file OgreMath.h.

static Real Ogre::Math::SinTable ( Real  fValue)
staticprotected
static Real Ogre::Math::Sqr ( Real  fValue)
inlinestatic

Squared function.

Parameters
fValueThe value to be squared (fValue^2)

Definition at line 417 of file OgreMath.h.

Referenced by Ogre::Sphere::intersects(), and Ogre::Sphere::merge().

static Real Ogre::Math::Sqrt ( Real  fValue)
inlinestatic

Square root function.

Parameters
fValueThe value whose square root will be calculated.

Definition at line 423 of file OgreMath.h.

Referenced by Ogre::AxisAlignedBox::distance(), Ogre::Vector3::getRotationTo(), Ogre::Vector2::length(), Ogre::Vector3::length(), Ogre::Sphere::merge(), Ogre::Vector2::normalise(), and Ogre::Vector3::normalise().

static Radian Ogre::Math::Sqrt ( const Radian fValue)
inlinestatic

Square root function.

Parameters
fValueThe value, in radians, whose square root will be calculated.
Returns
The square root of the angle in radians.

Definition at line 431 of file OgreMath.h.

References Ogre::Radian::valueRadians().

static Degree Ogre::Math::Sqrt ( const Degree fValue)
inlinestatic

Square root function.

Parameters
fValueThe value, in degrees, whose square root will be calculated.
Returns
The square root of the angle in degrees.

Definition at line 439 of file OgreMath.h.

References Ogre::Degree::valueDegrees().

static Real Ogre::Math::SymmetricRandom ( )
static

Generate a random number in the range [-1,1].

Returns
A random number in the range from [-1,1].
static Real Ogre::Math::Tan ( const Radian fValue,
bool  useTables = false 
)
inlinestatic

Tangent function.

Parameters
fValueAngle in radians
useTablesIf true, uses lookup tables rather than calculation - faster but less accurate.

Definition at line 479 of file OgreMath.h.

References Ogre::Radian::valueRadians().

static Real Ogre::Math::Tan ( Real  fValue,
bool  useTables = false 
)
inlinestatic

Tangent function.

Parameters
fValueAngle in radians
useTablesIf true, uses lookup tables rather than calculation - faster but less accurate.

Definition at line 489 of file OgreMath.h.

static Real Ogre::Math::TanTable ( Real  fValue)
staticprotected
static Real Ogre::Math::UnitRandom ( )
static

Generate a random number of unit length.

Returns
A random number in the range from [0,1].

Referenced by Ogre::Vector3::randomDeviant().

Member Data Documentation

const Real Ogre::Math::fDeg2Rad
static

Definition at line 731 of file OgreMath.h.

const Real Ogre::Math::fRad2Deg
static

Definition at line 732 of file OgreMath.h.

const Real Ogre::Math::HALF_PI
static

Definition at line 730 of file OgreMath.h.

const Real Ogre::Math::LOG2
static

Stored value of log(2) for frequent use.

Definition at line 348 of file OgreMath.h.

RandomValueProvider* Ogre::Math::mRandProvider
staticprotected

A random value provider. overriding the default random number generator.

Definition at line 231 of file OgreMath.h.

AngleUnit Ogre::Math::msAngleUnit
staticprotected

Angle units used by the api.

Definition at line 220 of file OgreMath.h.

Real* Ogre::Math::mSinTable
staticprotected

Definition at line 227 of file OgreMath.h.

Real* Ogre::Math::mTanTable
staticprotected

Definition at line 228 of file OgreMath.h.

Real Ogre::Math::mTrigTableFactor
staticprotected

Radian -> index factor value ( mTrigTableSize / 2 * PI )

Definition at line 226 of file OgreMath.h.

int Ogre::Math::mTrigTableSize
staticprotected

Size of the trig tables as determined by constructor.

Definition at line 223 of file OgreMath.h.

const Real Ogre::Math::NEG_INFINITY
static

Definition at line 727 of file OgreMath.h.

const Real Ogre::Math::PI
static

Definition at line 728 of file OgreMath.h.

Referenced by Ogre::Vector3::getRotationTo().

const Real Ogre::Math::TWO_PI
static

Definition at line 729 of file OgreMath.h.

Referenced by Ogre::Vector2::angleTo(), and Ogre::Vector3::randomDeviant().


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