Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

osg Namespace Reference


Compounds

struct  ComputeTransformCallback
 Callback attached to an Transform to specify how to compute the modelview transformation for the transform below the Transform node. More...

struct  EnabledArrayPair
struct  AttributeStack
class  DrawArrayLengths
class  DrawArrays
class  DrawElementsUByte
class  DrawElementsUInt
class  DrawElementsUShort
struct  ModeStack
class  AnimationPathCallback
 Callback which can be attached to a PositionAttitudeTransform as an app callback to allow it to follow the path defined by a AnimationPath. More...

class  AnimationPathCallback
 Callback which can be attached to a MatrixTransform as an app callback to allow it to follow the path defined by a AnimationPath. More...

struct  EvaluateLODCallback
 Callback attached to an LOD which allows the users to customize the selection of LOD children. More...

struct  AttributeDeleteFunctor
 function object which is used to handling the clean up of attribute arrays associated with GeoSet's. More...

class  AlphaFunc
 Encapsulate OpenGL glAlphaFunc. More...

class  AnimationPath
 AnimationPath for specify the time varying transformation pathway to use when update camera and model objects. More...

struct  ControlPoint
class  AttributeFunctor
struct  CullCallback
struct  AppCallback
class  Array
class  ArrayVisitor
class  Billboard
 Billboard - a Geode which orientates its child osg::Drawable's to face the eye point. More...

class  BlendFunc
 BlendFunc - encapsulates the OpenGL blend/transparency state. More...

class  BoundingBox
 General purpose axis-aligned bounding box class for enclosing objects/vertices. More...

class  BoundingSphere
 General purpose bounding sphere class for enclosing nodes/objects/vertices. More...

class  Camera
 Camera class for encapsulating the view position and orientation and projection (lens) used. More...

class  ClearNode
 ClearNode is a Group node which controls the clearing of the color and depth buffers at the start of each frame. More...

class  ClipNode
 Leaf Node for defining the position of ClipPlanes in the scene. More...

class  ClipPlane
 ClipPlane state class which encapsulates OpenGL glClipPlane() functionality. More...

class  CollectOccludersVisitor
class  ColorMask
 Encapsulate OpenGL glColorMaskFunc/Op/Mask functions. More...

class  ColorMatrix
 Texture Matrix state class for encapsulating OpenGL texture matrix functionality. More...

class  ConvexPlanarOccluder
 A class for representing convex clipping volumes made up. More...

class  ConvexPlanarPolygon
 A class for representing convex clipping volumes made up. More...

class  CopyOp
 Copy Op(erator) used to control the whether shallow or deep copy is used during copy construction and clone operation. More...

class  CullFace
 Class to globally enable/disable OpenGL's polygon culling mode=. More...

class  CullingSet
 A CullingSet class which contains a frustum and a list of occluder. More...

class  CullStack
 A CullStack class which accumulates the current project, modelview matrices and the CullingSet. More...

class  Depth
 Encapsulate OpenGL glDepthFunc/Mask/Range functions. More...

class  DisplaySettings
 DisplaySettings class for encapsulating what visuals are required and have been set up, and the status of stereo viewing. More...

class  DOFTransform
 DOFTransform - encapsulates Multigen DOF behavior. More...

class  Drawable
 Pure virtual base class for drawable Geometry. More...

struct  DrawCallback
 Callback attached to an Drawable which allows the users to customize the drawing of an exist Drawable object. More...

class  PrimitiveFunctor
class  DrawPixels
 DrawPixels is an osg::Drawable subclass which encapsulates the drawing of images using glDrawPixels. More...

class  fast_back_stack
 Simple stack implementation that keeps the back() cached locally for fast access rather than at the back of the vector which is the traditional stack implementation. More...

class  Fog
 Fog - encapsulates OpenGL fog state. More...

class  FrameStamp
 Class which encapsulates the frame number, reference time and calander time of specific frame, used to synchonize operations on the scene graph and other machines when using a graphics cluster. More...

class  FrontFace
 Class to specifies the orientation of front-facing polygons. More...

class  Geode
 Leaf Node for grouping Drawables. More...

class  Geometry
class  GeoSet
 Note, osg::GeoSet is now deprecated, please use osg::Geometry instead. More...

struct  IndexPointer
class  Group
 General group node which maintains a list of children. More...

class  Image
 Image class for encapsulating the storage texture image data. More...

class  Impostor
 Impostor - is a form of Level Of Detail group node which allows both switching between children depending on distance from eye point and image caching. More...

class  ImpostorSprite
 An ImposterSprite is a textured quad which is rendered in place a 3D geometry. More...

class  ImpostorSpriteManager
 Helper class for managing the reuse of ImpostorSprite resources. More...

class  Light
 Light state class which encapsulates OpenGL glLight() functionality. More...

class  LightModel
class  LightSource
 Leaf Node for defining a light in the scene. More...

class  LineSegment
 LineSegment class for representing a line segment. More...

class  LineStipple
class  LineWidth
 LineWidth - encapsulates the OpenGL glLineWidth for setting the width of lines in pixels. More...

class  LOD
 LOD - Level Of Detail group node which allows switching between children depending on distance from eye point. More...

class  Material
 Material - encapsulates OpenGL glMaterial state. More...

class  Matrix
class  MatrixTransform
 MatrixTransform - is a subclass of Transform which has an osg::Matrix which represent a 4x4 transformation of its children from local cordinates into the Transform's parent coordinates. More...

class  Node
 Base class for all internal nodes in the scene graph. More...

struct  NodeAcceptOp
 Convenience functor for assisting visiting of arrays of osg::Node's. More...

class  NodeCallback
class  NodeVisitor
 Visitor for type safe operations on osg::Node's. More...

class  Object
 Base class/standard interface for objects which require IO support, cloning and reference counting. More...

class  OccluderNode
 OccluderNode is a Group node which allows OccluderNodeing between children. More...

class  Plane
 A plane class. More...

class  Point
 Point - encapsulates the OpenGL point smoothing and size state. More...

class  PolygonMode
 Class to for setting OpenGL's polygon culling mode. More...

class  PolygonOffset
 PolygonOffset - encapsulates the OpenGL glPolygonOffset state. More...

class  Polytope
 A Polytope class for representing convex clipping volumes made up. More...

class  PositionAttitudeTransform
 PositionAttitideTransform - is Transform the set the coordinates transform up via a Vec3 position and Quat attitude. More...

class  Primitive
class  Projection
 Projection nodes set up the frustum/orthographic projection used when rendering the scene . More...

class  Quat
 A quaternion class. More...

class  ref_ptr
 Smart pointer for handling referenced counted objects. More...

class  Referenced
 Base class from providing referencing counted objects. More...

class  Sequence
 Sequence is a Group node which allows automatic, time based switching between children. More...

class  ShadeModel
 Class which encapsulates glShadeModel(..). More...

class  ShadowVolumeOccluder
 ShadowVolumeOccluder is a helper class for implementating shadow occlusion culling. More...

class  State
 State class for managing a state stack. More...

class  StateAttribute
 Base class for state attribuets. More...

class  StateSet
 Encapsulates OpenGL state modes and attributes. More...

class  Statistics
 Statistics base class. More...

class  Stencil
 Encapsulate OpenGL glStencilFunc/Op/Mask functions. More...

class  SubloadCallback
class  SubloadCallback
class  SubloadCallback
class  SubloadCallback
class  Switch
 Switch is a Group node which allows switching between children. More...

class  TemplateArray
class  TexEnv
 TexEnv - encapsulates the OpenGL glTexEnv (texture environment) state. More...

class  TexEnvCombine
 TexEnvCombine - encapsulates the OpenGL glTexEnvCombine (texture environment) state. More...

class  TexGen
 TexGen - encapsulates the OpenGL glTexGen (texture coordinate generation) state. More...

class  TexMat
 Texture Matrix state class for encapsulating OpenGL texture matrix functionality. More...

class  Texture
 Texture base class which encapsulates OpenGl texture functionality which common betweent the various types of OpenGL textures. More...

class  Texture1D
 Texture state class which encapsulates OpenGl 1D texture functionality. More...

class  Texture2D
 Texture state class which encapsulates OpenGl texture functionality. More...

class  Texture3D
 Texture state class which encapsulates OpenGl 3D texture functionality. More...

class  TextureCubeMap
 TextureCubeMap state class which encapsulates OpenGl texture cubemap functionality. More...

class  Timer
 A high resolution, low latency time stamper. More...

class  Transform
 A Transform is a group node for which all children are transformed by a 4x4 matrix. More...

class  TriangleFunctor
class  UByte4
 General purpose float quad, uses include representation of colour coordinates. More...

class  Vec2
 General purpose float pair, uses include representation of texture coordinates. More...

class  Vec3
 General purpose float triple for use as vertices, vectors and normals. More...

class  Vec4
 General purpose float quad, uses include representation of colour coordinates. More...

class  Viewport
 Encapsulte OpenGL glViewport. More...


Typedefs

typedef TemplateArray< GLbyte,
Array::ByteArrayType,
1, GL_BYTE > 
ByteArray
typedef TemplateArray< GLshort,
Array::ShortArrayType,
1, GL_SHORT > 
ShortArray
typedef TemplateArray< GLint,
Array::IntArrayType, 1, GL_INT > 
IntArray
typedef TemplateArray< GLubyte,
Array::UByteArrayType,
1, GL_UNSIGNED_BYTE > 
UByteArray
typedef TemplateArray< GLushort,
Array::UShortArrayType,
1, GL_UNSIGNED_SHORT > 
UShortArray
typedef TemplateArray< GLuint,
Array::UIntArrayType,
1, GL_UNSIGNED_INT > 
UIntArray
typedef TemplateArray< UByte4,
Array::UByte4ArrayType,
4, GL_UNSIGNED_BYTE > 
UByte4Array
typedef TemplateArray< float,
Array::FloatArrayType,
1, GL_FLOAT > 
FloatArray
typedef TemplateArray< Vec2,
Array::Vec2ArrayType,
2, GL_FLOAT > 
Vec2Array
typedef TemplateArray< Vec3,
Array::Vec3ArrayType,
3, GL_FLOAT > 
Vec3Array
typedef TemplateArray< Vec4,
Array::Vec4ArrayType,
4, GL_FLOAT > 
Vec4Array
typedef std::vector< Node * > NodePath
 A vector of Nodes pointers which is used to describe the path from a root node to a descendant.

typedef std::vector< GLsizei > VectorSizei
typedef std::vector< GLubyte > VectorUByte
typedef std::vector< GLushort > VectorUShort
typedef std::vector< GLuint > VectorUInt
typedef DrawElementsUByte UByteDrawElements
typedef DrawElementsUShort UShortDrawElements
typedef DrawElementsUInt UIntDrawElements
typedef std::vector< ShadowVolumeOccluderShadowVolumeOccluderList
 A list of ShadowVolumeOccluder, used by CollectOccluderVisitor and CullVistor's.

typedef std::clock_t Timer_t
typedef unsigned int uint
typedef unsigned short ushort
typedef unsigned char uchar
typedef uchar ubyte

Enumerations

enum  NotifySeverity {
  ALWAYS = 0, FATAL = 1, WARN = 2, NOTICE = 3,
  INFO = 4, DEBUG_INFO = 5, DEBUG_FP = 6
}
 Range of notify levels from DEBUG_FP through to FATAL, ALWAYS is reserved for forcing the absorption of all messages. More...


Functions

template<class T> void clampGEQUAL (T &value, const T minValue, const char *valueName)
 if value is greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class T> void clampLEQUAL (T &value, const T maxValue, const char *valueName)
 if value is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class T> void clampBetweenRange (T &value, const T minValue, const T maxValue, const char *valueName)
 if value is between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArrayElementGEQUAL (A &value, const unsigned int i, const T minValue, const char *valueName)
 if array element value[i] is greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArrayElementLEQUAL (A &value, const unsigned int i, const T maxValue, const char *valueName)
 if array element value[i] is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArrayElementBetweenRange (A &value, const unsigned int i, const T minValue, const T maxValue, const char *valueName)
 if array element value[i] is between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArrayElementsGEQUAL (A &value, const unsigned int first, const unsigned int last, const T minValue, const char *valueName)
 if array elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArrayElementsLEQUAL (A &value, const unsigned int first, const unsigned int last, const T maxValue, const char *valueName)
 if array elements are less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArrayElementsBetweenRange (A &value, const unsigned int first, const unsigned int last, const T minValue, const T maxValue, const char *valueName)
 if array elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArray3GEQUAL (A &value, const T minValue, const char *valueName)
 if array4 elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArray3LEQUAL (A &value, const T maxValue, const char *valueName)
 if array4 elements are is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArray3BetweenRange (A &value, const T minValue, const T maxValue, const char *valueName)
 if array4 elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArray4GEQUAL (A &value, const T minValue, const char *valueName)
 if array4 elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArray4LEQUAL (A &value, const unsigned int first, const unsigned int last, const T maxValue, const char *valueName)
 if array4 elements are is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T> void clampArray4BetweenRange (A &value, const T minValue, const T maxValue, const char *valueName)
 if array4 elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.

template<class T> void for_each_triangle (GeoSet &gset, T &op)
 Template function for iterating through a GeoSet operating on triangles with templated functor.

SG_EXPORT const bool isGLExtensionSupported (const char *extension)
 return true if OpenGL "extension" is supported.

void * getGLExtensionFuncPtr (const char *funcName)
 return the address of the specified OpenGL function.

void * getGLExtensionFuncPtr (const char *funcName, const char *fallbackFuncName)
 return the address of the specified OpenGL function, if not found then check a second function name, if this fails then return NULL as function is not supported by OpenGL library.

SG_EXPORT const bool isGLUExtensionSupported (const char *extension)
 return true if OpenGL "extension" is supported.

void * getGLUExtensionFuncPtr (const char *funcName)
SG_EXPORT GeodecreateGeodeForImage (Image *image)
 Convenience function to be used by images loaders to generate a valid geode to return for readNode().

SG_EXPORT GeodecreateGeodeForImage (Image *image, const float s, const float t)
 Convenience function to be used by images loaders to generate a valid geode to return for readNode().

template<typename T> T clampTo (T v, T minimum, T maximum)
template<typename T> T clampAbove (T v, T minimum)
template<typename T> T clampBelow (T v, T maximum)
template<typename T> T sign (T v)
template<typename T> T square (T v)
template<typename T> T signedSquare (T v)
float inDegrees (float angle)
double inDegrees (double angle)
template<typename T> T inRadians (T angle)
float DegreesToRadians (float angle)
double DegreesToRadians (double angle)
float RadiansToDegrees (float angle)
double RadiansToDegrees (double angle)
bool isNaN (float v)
bool isNaN (double v)
template<typename T> float computeVolume (const T &a, const T &b, const T &c, const T &d)
 compute the volume of tetrahedron

template<typename T> float computeVolume (const T &f1, const T &f2, const T &f3, const T &b1, const T &b2, const T &b3)
 compute the volume of prism

Vec3 operator * (const Vec3 &v, const Matrix &m)
Vec4 operator * (const Vec4 &v, const Matrix &m)
std::ostream & operator<< (std::ostream &os, const Matrix &m)
SG_EXPORT void setNotifyLevel (NotifySeverity severity)
 set the notify level, overriding the default or value set by the environmental variable OSGNOTIFYLEVEL.

SG_EXPORT NotifySeverity getNotifyLevel ()
 get the notify level.

SG_EXPORT bool initNotifyLevel ()
 initialize notify level.

SG_EXPORT std::ostream & notify (const NotifySeverity severity)
 notify messaging function for providing fatal through to verbose debugging messages.

std::ostream & notify (void)
std::ostream & operator<< (std::ostream &output, const Plane &pl)
std::ostream & operator<< (std::ostream &output, const Quat &vec)
std::ostream & operator<< (std::ostream &output, const Vec3 &vec)
const Vec3 X_AXIS (1.0f, 0.0f, 0.0f)
const Vec3 Y_AXIS (0.0f, 1.0f, 0.0f)
const Vec3 Z_AXIS (0.0f, 0.0f, 1.0f)
float operator * (const Vec3 &lhs, const Vec4 &rhs)
 Compute the dot product of a (Vec3,1.0) and a Vec4.

float operator * (const Vec4 &lhs, const Vec3 &rhs)
 Compute the dot product of a Vec4 and a (Vec3,1.0).


Variables

const double PI = 3.14159265358979323846
const double PI_2 = 1.57079632679489661923
const double PI_4 = 0.78539816339744830962


Typedef Documentation

typedef TemplateArray<GLbyte,Array::ByteArrayType,1,GL_BYTE> osg::ByteArray
 

typedef TemplateArray<float,Array::FloatArrayType,1,GL_FLOAT> osg::FloatArray
 

typedef TemplateArray<GLint,Array::IntArrayType,1,GL_INT> osg::IntArray
 

typedef std::vector<Node*> osg::NodePath
 

A vector of Nodes pointers which is used to describe the path from a root node to a descendant.

typedef std::vector<ShadowVolumeOccluder> osg::ShadowVolumeOccluderList
 

A list of ShadowVolumeOccluder, used by CollectOccluderVisitor and CullVistor's.

typedef TemplateArray<GLshort,Array::ShortArrayType,1,GL_SHORT> osg::ShortArray
 

typedef std::clock_t osg::Timer_t
 

typedef uchar osg::ubyte
 

typedef TemplateArray<UByte4,Array::UByte4ArrayType,4,GL_UNSIGNED_BYTE> osg::UByte4Array
 

typedef TemplateArray<GLubyte,Array::UByteArrayType,1,GL_UNSIGNED_BYTE> osg::UByteArray
 

typedef DrawElementsUByte osg::UByteDrawElements
 

typedef unsigned char osg::uchar
 

typedef unsigned int osg::uint
 

typedef TemplateArray<GLuint,Array::UIntArrayType,1,GL_UNSIGNED_INT> osg::UIntArray
 

typedef DrawElementsUInt osg::UIntDrawElements
 

typedef unsigned short osg::ushort
 

typedef TemplateArray<GLushort,Array::UShortArrayType,1,GL_UNSIGNED_SHORT> osg::UShortArray
 

typedef DrawElementsUShort osg::UShortDrawElements
 

typedef TemplateArray<Vec2,Array::Vec2ArrayType,2,GL_FLOAT> osg::Vec2Array
 

typedef TemplateArray<Vec3,Array::Vec3ArrayType,3,GL_FLOAT> osg::Vec3Array
 

typedef TemplateArray<Vec4,Array::Vec4ArrayType,4,GL_FLOAT> osg::Vec4Array
 

typedef std::vector<GLsizei> osg::VectorSizei
 

typedef std::vector<GLubyte> osg::VectorUByte
 

typedef std::vector<GLuint> osg::VectorUInt
 

typedef std::vector<GLushort> osg::VectorUShort
 


Enumeration Type Documentation

enum osg::NotifySeverity
 

Range of notify levels from DEBUG_FP through to FATAL, ALWAYS is reserved for forcing the absorption of all messages.

The keywords are also used verbatim when specified by the environmental variable OSGNOTIFYLEVEL. See documentation on osg::notify() for further details.

Enumeration values:
ALWAYS 
FATAL 
WARN 
NOTICE 
INFO 
DEBUG_INFO 
DEBUG_FP 


Function Documentation

template<typename T>
T clampAbove   v,
  minimum
[inline]
 

template<class A, class T>
void clampArray3BetweenRange A &    value,
const T    minValue,
const T    maxValue,
const char *    valueName
[inline]
 

if array4 elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.

Equivilant to calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName);

template<class A, class T>
void clampArray3GEQUAL A &    value,
const T    minValue,
const char *    valueName
[inline]
 

if array4 elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T>
void clampArray3LEQUAL A &    value,
const T    maxValue,
const char *    valueName
[inline]
 

if array4 elements are is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T>
void clampArray4BetweenRange A &    value,
const T    minValue,
const T    maxValue,
const char *    valueName
[inline]
 

if array4 elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.

Equivilant to calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName);

template<class A, class T>
void clampArray4GEQUAL A &    value,
const T    minValue,
const char *    valueName
[inline]
 

if array4 elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T>
void clampArray4LEQUAL A &    value,
const unsigned int    first,
const unsigned int    last,
const T    maxValue,
const char *    valueName
[inline]
 

if array4 elements are is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T>
void clampArrayElementBetweenRange A &    value,
const unsigned int    i,
const T    minValue,
const T    maxValue,
const char *    valueName
[inline]
 

if array element value[i] is between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.

Equivilant to calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName);

template<class A, class T>
void clampArrayElementGEQUAL A &    value,
const unsigned int    i,
const T    minValue,
const char *    valueName
[inline]
 

if array element value[i] is greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T>
void clampArrayElementLEQUAL A &    value,
const unsigned int    i,
const T    maxValue,
const char *    valueName
[inline]
 

if array element value[i] is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T>
void clampArrayElementsBetweenRange A &    value,
const unsigned int    first,
const unsigned int    last,
const T    minValue,
const T    maxValue,
const char *    valueName
[inline]
 

if array elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.

Equivalent to calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName);

template<class A, class T>
void clampArrayElementsGEQUAL A &    value,
const unsigned int    first,
const unsigned int    last,
const T    minValue,
const char *    valueName
[inline]
 

if array elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class A, class T>
void clampArrayElementsLEQUAL A &    value,
const unsigned int    first,
const unsigned int    last,
const T    maxValue,
const char *    valueName
[inline]
 

if array elements are less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<typename T>
T clampBelow   v,
  maximum
[inline]
 

template<class T>
void clampBetweenRange T &    value,
const T    minValue,
const T    maxValue,
const char *    valueName
[inline]
 

if value is between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.

Equivilant to calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName);

template<class T>
void clampGEQUAL T &    value,
const T    minValue,
const char *    valueName
[inline]
 

if value is greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<class T>
void clampLEQUAL T &    value,
const T    maxValue,
const char *    valueName
[inline]
 

if value is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped.

template<typename T>
T clampTo   v,
  minimum,
  maximum
[inline]
 

template<typename T>
float computeVolume const T &    f1,
const T &    f2,
const T &    f3,
const T &    b1,
const T &    b2,
const T &    b3
[inline]
 

compute the volume of prism

template<typename T>
float computeVolume const T &    a,
const T &    b,
const T &    c,
const T &    d
[inline]
 

compute the volume of tetrahedron

SG_EXPORT Geode* createGeodeForImage Image   image,
const float    s,
const float    t
 

Convenience function to be used by images loaders to generate a valid geode to return for readNode().

Use the specified s and t values scale the dimensions of the image.

SG_EXPORT Geode* createGeodeForImage Image   image
 

Convenience function to be used by images loaders to generate a valid geode to return for readNode().

Use the images s and t values scale the dimensions of the image.

double DegreesToRadians double    angle [inline]
 

float DegreesToRadians float    angle [inline]
 

template<class T>
void for_each_triangle GeoSet   gset,
T &    op
 

Template function for iterating through a GeoSet operating on triangles with templated functor.

Function automatically decomposes quads and polygons into sub triangles which are passed onto functor.

void* getGLExtensionFuncPtr const char *    funcName,
const char *    fallbackFuncName
[inline]
 

return the address of the specified OpenGL function, if not found then check a second function name, if this fails then return NULL as function is not supported by OpenGL library.

This is usual for checking something like glActiveTexture (which is in OGL1.3) or glActiveTextureARB.

void* getGLExtensionFuncPtr const char *    funcName [inline]
 

return the address of the specified OpenGL function.

return NULL if function not supported by OpenGL library. Note, glGLExtensionFuncPtr is declared inline so that the code is compiled localy to the calling code. This should get by Windows dumb implementation of having different GL function ptr's for each library when links to it.

void* getGLUExtensionFuncPtr const char *    funcName [inline]
 

SG_EXPORT NotifySeverity getNotifyLevel  
 

get the notify level.

double inDegrees double    angle [inline]
 

float inDegrees float    angle [inline]
 

SG_EXPORT bool initNotifyLevel  
 

initialize notify level.

template<typename T>
T inRadians   angle [inline]
 

SG_EXPORT const bool isGLExtensionSupported const char *    extension
 

return true if OpenGL "extension" is supported.

note: Must only called within a valid OpenGL context, undefined behavior may occur otherwise.

SG_EXPORT const bool isGLUExtensionSupported const char *    extension
 

return true if OpenGL "extension" is supported.

note: Must only called within a valid OpenGL context, undefined behavior may occur otherwise.

bool isNaN double    v [inline]
 

bool isNaN float    v [inline]
 

std::ostream& notify void    [inline]
 

SG_EXPORT std::ostream& notify const NotifySeverity    severity
 

notify messaging function for providing fatal through to verbose debugging messages.

Level of messages sent to the console can be controlled by setting the NotifyLevel either within your application or via the an environmental variable. For instance setenv OSGNOTIFYLEVEL DEBUG (for tsh), export OSGNOTIFYLEVEL=DEBUG (for bourne shell) or set OSGNOTIFYLEVEL=DEBUG (for Windows) all set tell the osg to redirect all debugging and more important messages to the console (useful for debugging :-) setting ALWAYS will force all messages to be absorbed, which might be appropriate for final applications. Default NotifyLevel is NOTICE. Check the enum NotifySeverity for full range of possibilities. To use the notify with your code simply use the notify function as a normal file stream (like cout) i.e osg::notify(osg::DEBUG) << "Hello Bugs!"<<endl;

float operator * const Vec4   lhs,
const Vec3   rhs
[inline]
 

Compute the dot product of a Vec4 and a (Vec3,1.0).

float operator * const Vec3   lhs,
const Vec4   rhs
[inline]
 

Compute the dot product of a (Vec3,1.0) and a Vec4.

Vec4 operator * const Vec4   v,
const Matrix   m
[inline]
 

Vec3 operator * const Vec3   v,
const Matrix   m
[inline]
 

std::ostream& operator<< std::ostream &    output,
const Vec3   vec
[inline]
 

std::ostream& operator<< std::ostream &    output,
const Quat   vec
[inline]
 

std::ostream& operator<< std::ostream &    output,
const Plane   pl
[inline]
 

std::ostream& operator<< std::ostream &    os,
const Matrix   m
[inline]
 

double RadiansToDegrees double    angle [inline]
 

float RadiansToDegrees float    angle [inline]
 

SG_EXPORT void setNotifyLevel NotifySeverity    severity
 

set the notify level, overriding the default or value set by the environmental variable OSGNOTIFYLEVEL.

template<typename T>
T sign   v [inline]
 

template<typename T>
T signedSquare   v [inline]
 

template<typename T>
T square   v [inline]
 

const Vec3 X_AXIS 1.    0f,
0.    0f,
0.    0f
 

const Vec3 Y_AXIS 0.    0f,
1.    0f,
0.    0f
 

const Vec3 Z_AXIS 0.    0f,
0.    0f,
1.    0f
 


Variable Documentation

const double osg::PI = 3.14159265358979323846
 

const double osg::PI_2 = 1.57079632679489661923
 

const double osg::PI_4 = 0.78539816339744830962
 


Generated at Wed Sep 18 13:55:23 2002 for the Open Scene Graph by doxygen 1.2.16.