Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

salt Namespace Reference


Classes

class  AABB3
 AABB3 provides an axis aligned three dimensional bounding box. More...
class  AABB2
 AABB2 provides an axis aligned two dimensional bounding box. More...
class  BoundingSphere
 BoundingSphere provides a three dimensional sphere. More...
class  RFile
 RFile defines an interface and some basic support functions for classes providing read only file services. More...
class  MemFile
 Memfile implements the RFile interface using an inmemory buffer. More...
class  WFile
 WFile extends the RFile interface with methods for writing to a file and related support funtions. More...
class  StdFile
 StdFile implements the WFile interface using the standard file system. More...
class  Frustum
 This class implements a frustum, which is an arbitrary volume in space (possibly infinite) defined by a set of planes. More...
class  Matrix
 Matrix provides a 4x4 float Matrix along with methods to set up and manipulate it. More...
class  Path
 This class serves as a helper for path strings within the object hierarchy. More...
class  Plane
 A mathematical plane is modeled by this class. More...
class  RandomEngine
 A wrapper to a boost random number generator. More...
class  UniformRNG
 This random number generator should be used to produce uniformly distributed random numbers. More...
class  NormalRNG
 A random number generator producing normally distributed numbers. More...
class  ExponentialRNG
 A random number generator with an exponential distribution. More...
class  Rect
 this class provides rectangle in two dimensional space More...
class  SharedLibrary
 SharedLibrary defines a commmon interface for the usage of shared libraries. More...
class  TVector
 TVector is a template class for vector implementations. More...
class  TVector2
 TVector2 is a two dimensional version of TVector. More...
class  TVector3
 TVector3 is a two dimensional version of TVector. More...
class  Vector2f
class  Vector3f

Enumerations

enum  EPlaneSide {
  PLANESIDE_BACK = 0, PLANESIDE_ONPLANE = 1, PLANESIDE_FRONT = 2, PLANESIDE_SPLIT = 3,
  PLANESIDE_FORCE_32BIT = 0xffffffff
}
 defines possible sides on the plane More...
enum  EPlane { PLANE_XY = 0, PLANE_XZ = 1, PLANE_YZ = 2, PLANE_FORCE_32BIT = 0xffffffff }
 defines possible dominant plane values More...

Functions

template<typename TYPE>
f_inline TYPE gSqrt (const TYPE &v)
template<class TYPE>
f_inline TYPE gClamp (TYPE &val, TYPE min, TYPE max)
template<class TYPE>
f_inline TYPE gMin (TYPE a, TYPE b)
template<class TYPE>
f_inline TYPE gMax (TYPE a, TYPE b)
template<class TYPE>
f_inline TYPE gFloor (TYPE a)
template<class TYPE>
f_inline TYPE gCeil (TYPE a)
template<class TYPE>
f_inline TYPE gAbs (TYPE a)
template<class TYPE>
f_inline TYPE gNeg (TYPE a)
template<class TYPE>
f_inline TYPE gCos (TYPE a)
template<class TYPE>
f_inline TYPE gSin (TYPE a)
template<class TYPE>
f_inline TYPE gArcCos (TYPE a)
template<class TYPE>
f_inline TYPE gArcSin (TYPE a)
template<class TYPE>
f_inline TYPE gArcTan (TYPE a)
template<class TYPE>
f_inline TYPE gArcTan2 (TYPE a, TYPE b)
template<class TYPE>
f_inline TYPE gPow (TYPE a, TYPE b)
template<class TYPE>
f_inline void gSwap (TYPE &a, TYPE &b)
template<class TYPE>
f_inline int gSign (TYPE a)
template<class TYPE>
f_inline TYPE gDegToRad (TYPE deg)
template<class TYPE>
f_inline TYPE gRadToDeg (TYPE rad)
template<class TYPE>
f_inline bool gInRange (const TYPE &val, const TYPE &low, const TYPE &high)
template<class TYPE>
f_inline double gNormalizeDeg (TYPE angle)
template<class TYPE>
f_inline double gNormalizeRad (TYPE angle)
template<typename DATATYPE, int ELEMENTS, typename TYPE>
std::ostream & operator<< (std::ostream &ost, const TVector< DATATYPE, ELEMENTS, TYPE > &v)
template<typename DATATYPE, int ELEMENTS, class TYPE>
f_inline const TYPE operator * (const DATATYPE &f, const TVector< DATATYPE, ELEMENTS, TYPE > &vec)

Variables

static const double gPI = M_PI
static const double g2PI = 2*M_PI
static const double gHalfPI = M_PI_2


Enumeration Type Documentation

enum salt::EPlane
 

defines possible dominant plane values

Enumerator:
PLANE_XY 
PLANE_XZ 
PLANE_YZ 
PLANE_FORCE_32BIT 

Definition at line 54 of file plane.h.

enum salt::EPlaneSide
 

defines possible sides on the plane

Enumerator:
PLANESIDE_BACK 
PLANESIDE_ONPLANE 
PLANESIDE_FRONT 
PLANESIDE_SPLIT 
PLANESIDE_FORCE_32BIT 

Definition at line 43 of file plane.h.


Function Documentation

template<class TYPE>
f_inline TYPE salt::gAbs TYPE  a  ) 
 

Definition at line 84 of file gmath.h.

Referenced by SoccerRuleAspect::CheckBallLeftField(), RestrictedVisionPerceptor::DynamicAxisPercept(), salt::AABB3::GetDepth(), salt::Plane::GetDominantPlane(), salt::AABB2::GetHeight(), salt::AABB3::GetHeight(), salt::AABB2::GetWidth(), salt::AABB3::GetWidth(), PanTiltEffector::Realize(), KickEffector::Realize(), DriveEffector::SetForceFactor(), and RestrictedVisionPerceptor::StaticAxisPercept().

template<class TYPE>
f_inline TYPE salt::gArcCos TYPE  a  ) 
 

Definition at line 108 of file gmath.h.

Referenced by salt::Vector2f::GetAngleRad(), VisionPerceptor::StaticAxisPercept(), and RestrictedVisionPerceptor::StaticAxisPercept().

template<class TYPE>
f_inline TYPE salt::gArcSin TYPE  a  ) 
 

Definition at line 114 of file gmath.h.

template<class TYPE>
f_inline TYPE salt::gArcTan TYPE  a  ) 
 

Definition at line 120 of file gmath.h.

template<class TYPE>
f_inline TYPE salt::gArcTan2 TYPE  a,
TYPE  b
 

Definition at line 126 of file gmath.h.

Referenced by KickEffector::Realize(), VisionPerceptor::StaticAxisPercept(), and RestrictedVisionPerceptor::StaticAxisPercept().

template<class TYPE>
f_inline TYPE salt::gCeil TYPE  a  ) 
 

Definition at line 78 of file gmath.h.

template<class TYPE>
f_inline TYPE salt::gClamp TYPE &  val,
TYPE  min,
TYPE  max
 

Definition at line 54 of file gmath.h.

Referenced by oxygen::ContactJointHandler::SetContactSoftERP(), and oxygen::Camera::UpdateHierarchyInternal().

template<class TYPE>
f_inline TYPE salt::gCos TYPE  a  ) 
 

Definition at line 96 of file gmath.h.

Referenced by KickEffector::Realize(), salt::Matrix::RotateX(), salt::Matrix::RotateY(), salt::Matrix::RotateZ(), salt::Matrix::RotationX(), salt::Matrix::RotationY(), salt::Matrix::RotationZ(), and oxygen::StdMeshImporter::UnitCCylinder().

template<class TYPE>
f_inline TYPE salt::gDegToRad TYPE  deg  ) 
 

Definition at line 153 of file gmath.h.

Referenced by salt::Matrix::CalcInfiniteProjection(), oxygen::FPSController::PrePhysicsUpdateInternal(), KickEffector::Realize(), salt::Frustum::Set(), oxygen::Joint::SetAngularMotorVelocity(), oxygen::AngularMotor::SetAxisAngle(), oxygen::Joint::SetHighStopDeg(), oxygen::Transform::SetLocalRotation(), oxygen::Joint::SetLowStopDeg(), and oxygen::Camera::UpdateHierarchyInternal().

template<class TYPE>
f_inline TYPE salt::gFloor TYPE  a  ) 
 

Definition at line 72 of file gmath.h.

template<class TYPE>
f_inline bool salt::gInRange const TYPE &  val,
const TYPE &  low,
const TYPE &  high
 

Definition at line 165 of file gmath.h.

Referenced by salt::AABB2::Contains(), and salt::AABB3::Contains().

template<class TYPE>
f_inline TYPE salt::gMax TYPE  a,
TYPE  b
 

Definition at line 66 of file gmath.h.

Referenced by salt::AABB2::Encapsulate(), salt::AABB3::Encapsulate(), kerosin::Font::Init(), and KickEffector::Realize().

template<class TYPE>
f_inline TYPE salt::gMin TYPE  a,
TYPE  b
 

Definition at line 60 of file gmath.h.

Referenced by salt::AABB2::Encapsulate(), salt::AABB3::Encapsulate(), and KickEffector::Realize().

template<class TYPE>
f_inline TYPE salt::gNeg TYPE  a  ) 
 

Definition at line 90 of file gmath.h.

template<class TYPE>
f_inline double salt::gNormalizeDeg TYPE  angle  ) 
 

Definition at line 171 of file gmath.h.

Referenced by gClampAngleDeg(), RestrictedVisionPerceptor::SetPanRange(), RestrictedVisionPerceptor::SetPanTilt(), RestrictedVisionPerceptor::SetTiltRange(), and RestrictedVisionPerceptor::StaticAxisPercept().

template<class TYPE>
f_inline double salt::gNormalizeRad TYPE  angle  ) 
 

Definition at line 187 of file gmath.h.

Referenced by VisionPerceptor::DynamicAxisPercept(), and RestrictedVisionPerceptor::DynamicAxisPercept().

template<class TYPE>
f_inline TYPE salt::gPow TYPE  a,
TYPE  b
 

Definition at line 132 of file gmath.h.

template<class TYPE>
f_inline TYPE salt::gRadToDeg TYPE  rad  ) 
 

Definition at line 159 of file gmath.h.

Referenced by VisionPerceptor::DynamicAxisPercept(), RestrictedVisionPerceptor::DynamicAxisPercept(), oxygen::UniversalJoint::GetAngle(), oxygen::HingeJoint::GetAngle(), oxygen::Hinge2Joint::GetAngle(), salt::Vector2f::GetAngleDeg(), oxygen::UniversalJoint::GetAngleRate(), oxygen::HingeJoint::GetAngleRate(), oxygen::Hinge2Joint::GetAngleRate(), oxygen::Joint::GetAngularMotorVelocity(), oxygen::AngularMotor::GetAxisAngle(), oxygen::AngularMotor::GetAxisAngleRate(), oxygen::Joint::GetHighStopDeg(), oxygen::Joint::GetLowStopDeg(), VisionPerceptor::StaticAxisPercept(), and RestrictedVisionPerceptor::StaticAxisPercept().

template<class TYPE>
f_inline int salt::gSign TYPE  a  ) 
 

Definition at line 146 of file gmath.h.

Referenced by PanTiltEffector::Realize().

template<class TYPE>
f_inline TYPE salt::gSin TYPE  a  ) 
 

Definition at line 102 of file gmath.h.

Referenced by KickEffector::Realize(), salt::Matrix::RotateX(), salt::Matrix::RotateY(), salt::Matrix::RotateZ(), salt::Matrix::RotationX(), salt::Matrix::RotationY(), salt::Matrix::RotationZ(), and oxygen::StdMeshImporter::UnitCCylinder().

template<typename TYPE>
f_inline TYPE salt::gSqrt const TYPE &  v  ) 
 

Definition at line 48 of file gmath.h.

Referenced by salt::BoundingSphere::EncapsulateFast(), and salt::TVector< float, 3, Vector3f >::Length().

template<class TYPE>
f_inline void salt::gSwap TYPE &  a,
TYPE &  b
 

Definition at line 138 of file gmath.h.

Referenced by salt::Matrix::InvertRotationMatrix(), and salt::Rect::Normalize().

template<typename DATATYPE, int ELEMENTS, class TYPE>
f_inline const TYPE salt::operator * const DATATYPE &  f,
const TVector< DATATYPE, ELEMENTS, TYPE > &  vec
 

Definition at line 349 of file tvector.h.

template<typename DATATYPE, int ELEMENTS, typename TYPE>
std::ostream& salt::operator<< std::ostream &  ost,
const TVector< DATATYPE, ELEMENTS, TYPE > &  v
 

Definition at line 189 of file tvector.h.


Variable Documentation

const double salt::g2PI = 2*M_PI [static]
 

Definition at line 44 of file gmath.h.

Referenced by KickEffector::Realize(), and oxygen::StdMeshImporter::UnitCCylinder().

const double salt::gHalfPI = M_PI_2 [static]
 

Definition at line 45 of file gmath.h.

const double salt::gPI = M_PI [static]
 

Definition at line 43 of file gmath.h.


Generated on Thu Apr 6 15:48:12 2006 for rcssserver3d by  doxygen 1.4.4