From a0cb66ed78a093f003e96f158e38df4ac20799a0 Mon Sep 17 00:00:00 2001
From: Robert Osfield
Date: Sun, 21 Apr 2002 21:53:03 +0000
Subject: [PATCH] A second try at commit these updates to docs.
---
doc/doc++/osg/AlphaFunc.html | 33 +-
doc/doc++/osg/AttributeFunctor.html | 32 +-
doc/doc++/osg/Billboard.html | 327 +++-----
doc/doc++/osg/BoundingBox.html | 116 +--
doc/doc++/osg/BoundingSphere.html | 76 +-
doc/doc++/osg/Camera.html | 585 +++++---------
doc/doc++/osg/ClipPlane.html | 95 ++-
doc/doc++/osg/ClippingVolume.html | 100 +--
doc/doc++/osg/ColorMask.html | 87 ++-
doc/doc++/osg/ColorMatrix.html | 67 +-
doc/doc++/osg/CopyOp.html | 72 +-
doc/doc++/osg/CullFace.html | 83 +-
doc/doc++/osg/Depth.html | 127 ++--
doc/doc++/osg/DisplaySettings.html | 324 +++++---
doc/doc++/osg/Drawable.html | 314 ++++----
doc/doc++/osg/EarthSky.html | 215 +-----
doc/doc++/osg/Fog.html | 135 ++--
doc/doc++/osg/FrameStamp.html | 88 +--
doc/doc++/osg/FrontFace.html | 77 +-
doc/doc++/osg/General.html | 121 ++-
doc/doc++/osg/GeoSet.html | 713 +++++++++---------
doc/doc++/osg/Geode.html | 225 +-----
doc/doc++/osg/Group.html | 242 ++----
doc/doc++/osg/HIER.html | 54 +-
doc/doc++/osg/HIERjava.html | 38 +-
doc/doc++/osg/Image.html | 322 +++++---
doc/doc++/osg/Impostor.html | 247 ++----
doc/doc++/osg/ImpostorSprite.html | 228 +++---
doc/doc++/osg/ImpostorSpriteManager.html | 52 +-
doc/doc++/osg/LOD.html | 269 ++-----
doc/doc++/osg/Light.html | 195 ++---
doc/doc++/osg/LightSource.html | 197 +----
doc/doc++/osg/LineSegment.html | 96 +--
doc/doc++/osg/LineStipple.html | 79 +-
doc/doc++/osg/LineWidth.html | 65 +-
doc/doc++/osg/META_Object.html | 2 +-
doc/doc++/osg/Material.html | 251 +++---
doc/doc++/osg/Matrix.html | 476 ++++++++----
doc/doc++/osg/NodeAcceptOp.html | 20 +-
doc/doc++/osg/NodeCallback.html | 99 +--
doc/doc++/osg/NodeVisitor.html | 202 ++---
doc/doc++/osg/NotifySeverity.html | 28 +-
doc/doc++/osg/Object.html | 92 ++-
doc/doc++/osg/Plane.html | 110 +--
doc/doc++/osg/Point.html | 95 ++-
doc/doc++/osg/PolygonMode.html | 103 +--
doc/doc++/osg/PolygonOffset.html | 79 +-
doc/doc++/osg/PositionAttitudeTransform.html | 245 ++----
doc/doc++/osg/Quat.html | 175 +++--
doc/doc++/osg/Referenced.html | 51 +-
doc/doc++/osg/ShadeModel.html | 77 +-
doc/doc++/osg/State.html | 181 +++--
doc/doc++/osg/StateAttribute.html | 342 +++++----
doc/doc++/osg/StateSet.html | 249 +++---
doc/doc++/osg/Statistics.html | 176 ++---
doc/doc++/osg/Stencil.html | 179 +++--
doc/doc++/osg/Switch.html | 217 +-----
doc/doc++/osg/TexEnv.html | 81 +-
doc/doc++/osg/TexGen.html | 131 ++--
doc/doc++/osg/TexMat.html | 67 +-
doc/doc++/osg/Texture.html | 467 +++++++-----
doc/doc++/osg/Timer.html | 32 +-
doc/doc++/osg/Transform.html | 394 +++-------
doc/doc++/osg/Transparency.html | 109 +--
doc/doc++/osg/Vec2.html | 124 +--
doc/doc++/osg/Vec3.html | 136 ++--
doc/doc++/osg/Vec4.html | 140 ++--
doc/doc++/osg/Viewport.html | 115 +--
doc/doc++/osg/clampArray3BetweenRange.html | 2 +-
doc/doc++/osg/clampArray3GEQUAL.html | 2 +-
doc/doc++/osg/clampArray3LEQUAL.html | 2 +-
doc/doc++/osg/clampArray4BetweenRange.html | 2 +-
doc/doc++/osg/clampArray4GEQUAL.html | 2 +-
doc/doc++/osg/clampArray4LEQUAL.html | 2 +-
.../osg/clampArrayElementBetweenRange.html | 2 +-
doc/doc++/osg/clampArrayElementGEQUAL.html | 2 +-
doc/doc++/osg/clampArrayElementLEQUAL.html | 2 +-
.../osg/clampArrayElementsBetweenRange.html | 2 +-
doc/doc++/osg/clampArrayElementsGEQUAL.html | 2 +-
doc/doc++/osg/clampArrayElementsLEQUAL.html | 2 +-
doc/doc++/osg/clampBetweenRange.html | 2 +-
doc/doc++/osg/clampGEQUAL.html | 2 +-
doc/doc++/osg/clampLEQUAL.html | 2 +-
doc/doc++/osg/createGeodeForImage.2.html | 2 +-
doc/doc++/osg/for_each_triangle.html | 2 +-
doc/doc++/osg/g_NotifyNulStream.html | 4 +-
doc/doc++/osg/index.html | 54 +-
doc/doc++/osg/osg.html | 173 ++---
doc/doc++/osg/ref_ptr.html | 110 +--
doc/doc++/osgDB/Registry.html | 14 +-
doc/doc++/osgGLUT/GLUTEventAdapter.html | 32 +-
doc/doc++/osgGLUT/Viewer.html | 212 +++---
doc/doc++/osgGLUT/Window.html | 166 ++--
doc/doc++/osgUtil/AppVisitor.html | 34 +-
doc/doc++/osgUtil/CameraManipulator.html | 52 +-
doc/doc++/osgUtil/CullViewState.html | 82 +-
doc/doc++/osgUtil/CullVisitor.html | 550 +++++++-------
doc/doc++/osgUtil/DriveManipulator.html | 12 +
doc/doc++/osgUtil/FlightManipulator.html | 12 +
doc/doc++/osgUtil/GUIEventAdapter.html | 4 +-
doc/doc++/osgUtil/RenderLeaf.html | 24 +-
doc/doc++/osgUtil/RenderStage.html | 92 +--
doc/doc++/osgUtil/RenderToTextureStage.html | 8 -
doc/doc++/osgUtil/SceneView.html | 466 +++++++-----
doc/doc++/osgUtil/TrackballManipulator.html | 12 +
105 files changed, 6625 insertions(+), 6863 deletions(-)
diff --git a/doc/doc++/osg/AlphaFunc.html b/doc/doc++/osg/AlphaFunc.html
index d46bca51c..55a0b2fd5 100644
--- a/doc/doc++/osg/AlphaFunc.html
+++ b/doc/doc++/osg/AlphaFunc.html
@@ -28,14 +28,14 @@
AlphaFunc(const AlphaFunc& af, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
Copy constructor using CopyOp to manage deep vs shallow copy
-
META_StateAttribute(AlphaFunc, ALPHAFUNC)
+
META_StateAttribute(AlphaFunc, ALPHAFUNC)
virtual int compare(const StateAttribute& sa) const
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
inline void setFunction(const ComparisonFunction func, const float ref)
+
inline void setFunction(const ComparisonFunction func, const float ref)
inline const ComparisonFunction getFunction() const
@@ -74,7 +74,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -103,6 +103,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -114,6 +131,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -141,7 +160,7 @@
-
META_StateAttribute(AlphaFunc, ALPHAFUNC)
+
META_StateAttribute(AlphaFunc, ALPHAFUNC)
@@ -150,7 +169,7 @@
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
@@ -192,7 +211,7 @@
-
inline void setFunction(const ComparisonFunction func, const float ref)
+
inline void setFunction(const ComparisonFunction func, const float ref)
diff --git a/doc/doc++/osg/AttributeFunctor.html b/doc/doc++/osg/AttributeFunctor.html
index 33373f836..d34411b3a 100644
--- a/doc/doc++/osg/AttributeFunctor.html
+++ b/doc/doc++/osg/AttributeFunctor.html
@@ -22,24 +22,24 @@
Public Methods
-
-
AttributeFunctor(AttributeBitMask abm)
+
AttributeFunctor(AttributeBitMask abm)
-
-
virtual ~AttributeFunctor()
+
virtual ~AttributeFunctor()
-
-
void setAttributeBitMask(AttributeBitMask abm)
+
void setAttributeBitMask(AttributeBitMask abm)
-
-
AttributeBitMask getAttributeBitMask() const
+
AttributeBitMask getAttributeBitMask() const
-
-
virtual bool apply(AttributeBitMask, Vec2*, Vec2*)
+
virtual bool apply(AttributeBitMask, Vec2*, Vec2*)
-
-
virtual bool apply(AttributeBitMask, Vec3*, Vec3*)
+
virtual bool apply(AttributeBitMask, Vec3*, Vec3*)
-
-
virtual bool apply(AttributeBitMask, Vec4*, Vec4*)
+
virtual bool apply(AttributeBitMask, Vec4*, Vec4*)
Protected Fields
-
-
AttributeBitMask _abm
+
AttributeBitMask _abm
@@ -50,35 +50,35 @@
-
+
AttributeFunctor(AttributeBitMask abm)
-
+
virtual ~AttributeFunctor()
-
+
void setAttributeBitMask(AttributeBitMask abm)
-
+
AttributeBitMask getAttributeBitMask() const
-
+
virtual bool apply(AttributeBitMask, Vec2*, Vec2*)
-
+
virtual bool apply(AttributeBitMask, Vec3*, Vec3*)
-
+
virtual bool apply(AttributeBitMask, Vec4*, Vec4*)
-
+
AttributeBitMask _abm
diff --git a/doc/doc++/osg/Billboard.html b/doc/doc++/osg/Billboard.html
index 270f227df..b7470a5ab 100644
--- a/doc/doc++/osg/Billboard.html
+++ b/doc/doc++/osg/Billboard.html
@@ -11,11 +11,11 @@
Inheritance:
-
-META_Object macro define the standard clone, isSameKindAs and className methods.
+META_Object macro define the standard clone, isSameKindAs and className methods.
diff --git a/doc/doc++/osg/Material.html b/doc/doc++/osg/Material.html
index cb2bcaa86..b5394ebfc 100644
--- a/doc/doc++/osg/Material.html
+++ b/doc/doc++/osg/Material.html
@@ -23,115 +23,115 @@
Public Methods
-
-
Material()
+
Material()
-
-
Material(const Material& mat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
Material(const Material& mat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(Material, MATERIAL)
+
META_StateAttribute(Material, MATERIAL)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
-
-
inline void setColorMode(const ColorMode mode)
+
inline void setColorMode(const ColorMode mode)
-
-
inline const ColorMode getColorMode() const
+
inline const ColorMode getColorMode() const
-
-
void setAmbient( const Face face, const Vec4& ambient )
+
void setAmbient( const Face face, const Vec4& ambient )
-
-
const Vec4& getAmbient(const Face face) const
+
const Vec4& getAmbient(const Face face) const
-
-
inline const bool getAmbientFrontAndBack() const
+
inline const bool getAmbientFrontAndBack() const
-
-
void setDiffuse( const Face face, const Vec4& diffuse )
+
void setDiffuse( const Face face, const Vec4& diffuse )
-
-
const Vec4& getDiffuse(const Face face) const
+
const Vec4& getDiffuse(const Face face) const
-
-
inline const bool getDiffuseFrontAndBack() const
+
inline const bool getDiffuseFrontAndBack() const
-
-
void setSpecular( const Face face, const Vec4& specular )
+
void setSpecular( const Face face, const Vec4& specular )
- Set specular value of specified face(s) of the material, valid specular[03] range is 00 to 10
-
-
const Vec4& getSpecular(const Face face) const
+
const Vec4& getSpecular(const Face face) const
- Get the specular value for specified face
-
-
inline const bool getSpecularFrontAndBack() const
+
inline const bool getSpecularFrontAndBack() const
- Get the whether specular values are equal for front and back faces
-
-
void setEmission( const Face face, const Vec4& emission )
+
void setEmission( const Face face, const Vec4& emission )
- Set emission value of specified face(s) of the material, valid emmison[03] range is 00 to 10
-
-
const Vec4& getEmission(const Face face) const
+
const Vec4& getEmission(const Face face) const
- Get the emmsion value for specified face
-
-
inline const bool getEmissionFrontAndBack() const
+
inline const bool getEmissionFrontAndBack() const
- Get the whether emission values are equal for front and back faces
-
-
void setShininess( const Face face, float shininess )
+
void setShininess( const Face face, float shininess )
- Set shininess of specified face(s) of the material, valid shininess range is 00 to 10
-
-
const float getShininess(const Face face) const
+
const float getShininess(const Face face) const
- Get the shininess value for specified face
-
-
inline const bool getShininessFrontAndBack() const
+
inline const bool getShininessFrontAndBack() const
- Get the whether shininess values are equal for front and back faces
-
-
void setTransparency(const Face face, float trans)
+
void setTransparency(const Face face, float trans)
- Set the alpha value of ambient,diffuse,specular and emission colors, of specified face, to 1-transparency.
-
-
void setAlpha(const Face face, float alpha)
+
void setAlpha(const Face face, float alpha)
- Set the alpha value of ambient,diffuse,specular and emission colors.
Public Members
-
-
enum Face
+
enum Face
-
-
enum ColorMode
+
enum ColorMode
Protected Fields
-
-
ColorMode _colorMode
+
ColorMode _colorMode
-
-
bool _ambientFrontAndBack
+
bool _ambientFrontAndBack
-
-
Vec4 _ambientFront
+
Vec4 _ambientFront
-
-
Vec4 _ambientBack
+
Vec4 _ambientBack
-
-
bool _diffuseFrontAndBack
+
bool _diffuseFrontAndBack
-
-
Vec4 _diffuseFront
+
Vec4 _diffuseFront
-
-
Vec4 _diffuseBack
+
Vec4 _diffuseBack
-
-
bool _specularFrontAndBack
+
bool _specularFrontAndBack
-
-
Vec4 _specularFront
+
Vec4 _specularFront
-
-
Vec4 _specularBack
+
Vec4 _specularBack
-
-
bool _emissionFrontAndBack
+
bool _emissionFrontAndBack
-
-
Vec4 _emissionFront
+
Vec4 _emissionFront
-
-
Vec4 _emissionBack
+
Vec4 _emissionBack
-
-
bool _shininessFrontAndBack
+
bool _shininessFrontAndBack
-
-
float _shininessFront
+
float _shininessFront
-
-
float _shininessBack
+
float _shininessBack
Protected Methods
-
-
virtual ~Material()
+
virtual ~Material()
@@ -147,7 +147,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -176,6 +176,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -187,6 +204,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -204,236 +223,236 @@
-
+
Material()
-
-
Material(const Material& mat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
Material(const Material& mat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(Material, MATERIAL)
+
+
META_StateAttribute(Material, MATERIAL)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
virtual void apply(State& state) const
-
+
enum Face
-
+
FRONT
-
+
BACK
-
+
FRONT_AND_BACK
-
+
enum ColorMode
-
+
AMBIENT
-
+
DIFFUSE
-
+
SPECULAR
-
+
EMISSION
-
+
AMBIENT_AND_DIFFUSE
-
+
OFF
-
-
inline void setColorMode(const ColorMode mode)
+
+
inline void setColorMode(const ColorMode mode)
-
-
inline const ColorMode getColorMode() const
+
+
inline const ColorMode getColorMode() const
-
-
void setAmbient( const Face face, const Vec4& ambient )
+
+
void setAmbient( const Face face, const Vec4& ambient )
-
-
const Vec4& getAmbient(const Face face) const
+
+
const Vec4& getAmbient(const Face face) const
-
+
inline const bool getAmbientFrontAndBack() const
-
-
void setDiffuse( const Face face, const Vec4& diffuse )
+
+
void setDiffuse( const Face face, const Vec4& diffuse )
-
-
const Vec4& getDiffuse(const Face face) const
+
+
const Vec4& getDiffuse(const Face face) const
-
+
inline const bool getDiffuseFrontAndBack() const
-
-
void setSpecular( const Face face, const Vec4& specular )
+
+
void setSpecular( const Face face, const Vec4& specular )
- Set specular value of specified face(s) of the material,
valid specular[03] range is 00 to 10
-
-
const Vec4& getSpecular(const Face face) const
+
+
const Vec4& getSpecular(const Face face) const
- Get the specular value for specified face
-
+
inline const bool getSpecularFrontAndBack() const
- Get the whether specular values are equal for front and back faces
-
-
void setEmission( const Face face, const Vec4& emission )
+
+
void setEmission( const Face face, const Vec4& emission )
- Set emission value of specified face(s) of the material,
valid emmison[03] range is 00 to 10
-
-
const Vec4& getEmission(const Face face) const
+
+
const Vec4& getEmission(const Face face) const
- Get the emmsion value for specified face
-
+
inline const bool getEmissionFrontAndBack() const
- Get the whether emission values are equal for front and back faces
-
-
void setShininess( const Face face, float shininess )
+
+
void setShininess( const Face face, float shininess )
- Set shininess of specified face(s) of the material, valid shininess range is 00 to 10
-
-
const float getShininess(const Face face) const
+
+
const float getShininess(const Face face) const
- Get the shininess value for specified face
-
+
inline const bool getShininessFrontAndBack() const
- Get the whether shininess values are equal for front and back faces
-
-
void setTransparency(const Face face, float trans)
+
+
void setTransparency(const Face face, float trans)
- Set the alpha value of ambient,diffuse,specular and emission colors,
of specified face, to 1-transparency. Valid transparency range is 0.0 to 1.0.
-
-
void setAlpha(const Face face, float alpha)
+
+
void setAlpha(const Face face, float alpha)
- Set the alpha value of ambient,diffuse,specular and emission colors.
Valid transparency range is 0.0 to 1.0.
-
+
virtual ~Material()
-
-
ColorMode _colorMode
+
+
ColorMode _colorMode
-
+
bool _ambientFrontAndBack
-
+
Vec4 _ambientFront
-
+
Vec4 _ambientBack
-
+
bool _diffuseFrontAndBack
-
+
Vec4 _diffuseFront
-
+
Vec4 _diffuseBack
-
+
bool _specularFrontAndBack
-
+
Vec4 _specularFront
-
+
Vec4 _specularBack
-
+
bool _emissionFrontAndBack
-
+
Vec4 _emissionFront
-
+
Vec4 _emissionBack
-
+
bool _shininessFrontAndBack
-
+
float _shininessFront
-
+
float _shininessBack
diff --git a/doc/doc++/osg/Matrix.html b/doc/doc++/osg/Matrix.html
index bbd06b810..34c369c68 100644
--- a/doc/doc++/osg/Matrix.html
+++ b/doc/doc++/osg/Matrix.html
@@ -22,152 +22,217 @@
Public Methods
-
-
Matrix()
+
Matrix()
-
-
Matrix( const Matrix& other)
+
Matrix( const Matrix& other)
-
-
explicit Matrix( float const* const def )
+
explicit Matrix( float const* const def )
-
-
Matrix( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
+
Matrix( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
-
-
virtual Object* cloneType() const
+
virtual Object* cloneType() const
-
-
virtual Object* clone(const CopyOp&) const
+
virtual Object* clone(const CopyOp&) const
-
-
virtual bool isSameKindAs(const Object* obj) const
+
virtual bool isSameKindAs(const Object* obj) const
-
-
virtual const char* className() const
+
virtual const char* className() const
-
-
virtual ~Matrix()
+
virtual ~Matrix()
-
-
Matrix& operator = (const Matrix& )
+
int compare(const Matrix& m) const
-
-
int compare(const Matrix& m) const
+
bool operator < (const Matrix& m) const
-
-
bool operator < (const Matrix& m) const
+
bool operator == (const Matrix& m) const
-
-
bool operator == (const Matrix& m) const
+
bool operator != (const Matrix& m) const
-
-
bool operator != (const Matrix& m) const
+
inline float& operator()(int row, int col)
-
-
inline float& operator()(int row, int col)
+
inline float operator()(int row, int col) const
-
-
inline float operator()(int row, int col) const
+
inline const bool valid() const
-
-
inline const bool valid() const
+
inline const bool isNaN() const
-
-
inline const bool isNaN() const
+
inline Matrix& operator = (const Matrix& other)
-
-
void set( float const* const )
+
inline void set(const Matrix& other)
-
-
void set( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
+
inline void set(float const* const ptr)
-
-
float* ptr()
+
void set( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
-
-
const float* ptr() const
+
float* ptr()
-
-
void makeIdentity()
+
const float* ptr() const
-
-
void makeScale( const Vec3& )
+
void makeIdentity()
-
-
void makeScale( float, float, float )
+
void makeScale( const Vec3& )
-
-
void makeTranslate( const Vec3& )
+
void makeScale( float, float, float )
-
-
void makeTranslate( float, float, float )
+
void makeTranslate( const Vec3& )
-
-
void makeRotate( const Vec3& from, const Vec3& to )
+
void makeTranslate( float, float, float )
-
-
void makeRotate( float angle, const Vec3& axis )
+
void makeRotate( const Vec3& from, const Vec3& to )
-
-
void makeRotate( float angle, float x, float y, float z )
+
void makeRotate( float angle, const Vec3& axis )
-
-
void makeRotate( const Quat& )
+
void makeRotate( float angle, float x, float y, float z )
-
-
void makeRotate( float, float, float )
+
void makeRotate( const Quat& )
-
-
bool invert( const Matrix& )
+
void makeRotate( float heading, float pitch, float roll)
+ - make a rotation Matrix from euler angles.
-
-
bool invertAffine( const Matrix& )
+
void makeOrtho(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+ - Set to a orthographic projection.
-
-
inline static Matrix identity( void )
+
inline void makeOrtho2D(const double left, const double right, const double bottom, const double top)
+ - Set to a 2D orthographic projection.
-
-
inline static Matrix scale( const Vec3& )
+
void makeFrustum(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+ - Set to a perspective projection.
-
-
inline static Matrix scale( float, float, float )
+
void makePerspective(const double fovy, const double aspectRatio, const double zNear, const double zFar)
+ - Set to a symmetrical perspective projection, See gluPerspective for further details.
-
-
inline static Matrix translate( const Vec3& )
+
void makeLookAt(const Vec3& eye, const Vec3& center, const Vec3& up)
+ - Set to the position and orientation as per a camera, using the same convention as gluLookAt.
-
-
inline static Matrix translate( float, float, float )
+
bool invert( const Matrix& )
-
-
inline static Matrix rotate( const Vec3&, const Vec3& )
+
inline static Matrix identity( void )
-
-
inline static Matrix rotate( float, float, float, float )
+
inline static Matrix scale( const Vec3& sv)
-
-
inline static Matrix rotate( float angle, const Vec3& axis)
+
inline static Matrix scale( float sx, float sy, float sz)
-
-
inline static Matrix rotate( const Quat& )
+
inline static Matrix translate( const Vec3& dv)
-
-
void setTrans( float tx, float ty, float tz )
+
inline static Matrix translate( float x, float y, float z)
-
-
void setTrans( const Vec3& v )
+
inline static Matrix rotate( const Vec3& from, const Vec3& to)
-
-
Vec3 getTrans() const
+
inline static Matrix rotate( float angle, float x, float y, float z)
-
-
inline static Vec3 transform3x3(const Vec3& v, const Matrix& m)
+
inline static Matrix rotate( float angle, const Vec3& axis)
+-
+
inline static Matrix rotate( float heading, float pitch, float roll)
+ - construct rotation matrix from euler angles, for conventions see makeRotate()
+
-
+
inline static Matrix rotate( const Quat& quat)
+-
+
inline static Matrix inverse( const Matrix& matrix)
+-
+
inline static Matrix ortho(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+ - Create a orthographic projection.
+
-
+
inline static Matrix ortho2D(const double left, const double right, const double bottom, const double top)
+ - Create a 2D orthographic projection.
+
-
+
inline static Matrix frustum(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+ - Create a perspective projection.
+
-
+
inline static Matrix perspective(const double fovy, const double aspectRatio, const double zNear, const double zFar)
+ - Create a symmetrical perspective projection, See gluPerspective for further details.
+
-
+
inline static Matrix lookAt(const Vec3& eye, const Vec3& center, const Vec3& up)
+ - Create the position and orientation as per a camera, using the same convention as gluLookAt.
+
-
+
void setTrans( float tx, float ty, float tz )
+-
+
void setTrans( const Vec3& v )
+-
+
Vec3 getTrans() const
+-
+
inline static Vec3 transform3x3(const Vec3& v, const Matrix& m)
- apply apply an 3x3 transform of v*M[02,02]
-
-
inline static Vec3 transform3x3(const Matrix& m, const Vec3& v)
+
inline static Vec3 transform3x3(const Matrix& m, const Vec3& v)
- apply apply an 3x3 transform of M[02,02]*v
-
-
void mult( const Matrix&, const Matrix& )
+
void mult( const Matrix&, const Matrix& )
-
-
void preMult( const Matrix& )
+
void preMult( const Matrix& )
-
-
void postMult( const Matrix& )
+
void postMult( const Matrix& )
-
-
inline void operator *= ( const Matrix& other )
+
inline void operator *= ( const Matrix& other )
-
-
inline Matrix operator * ( const Matrix &m ) const
+
inline Matrix operator * ( const Matrix &m ) const
-
-
inline Matrix identity(void)
+
inline Matrix identity(void)
-
-
inline Matrix scale(float sx, float sy, float sz)
+
inline Matrix scale(float sx, float sy, float sz)
-
-
inline Matrix scale(const Vec3& v )
+
inline Matrix scale(const Vec3& v )
-
-
inline Matrix translate(float tx, float ty, float tz)
+
inline Matrix translate(float tx, float ty, float tz)
-
-
inline Matrix translate(const Vec3& v )
+
inline Matrix translate(const Vec3& v )
-
-
inline Matrix rotate( const Quat& q )
+
inline Matrix rotate( const Quat& q )
-
-
inline Matrix rotate(float angle, float x, float y, float z )
+
inline Matrix rotate(float angle, float x, float y, float z )
-
-
inline Matrix rotate(float angle, const Vec3& axis )
+
inline Matrix rotate(float angle, const Vec3& axis )
-
-
inline Matrix rotate(const Vec3& from, const Vec3& to )
+
inline Matrix rotate(float heading, float pitch, float roll)
-
-
inline Vec3 postMult( const Vec3& v ) const
+
inline Matrix rotate(const Vec3& from, const Vec3& to )
-
-
inline Vec3 preMult( const Vec3& v ) const
+
inline Matrix ortho(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
-
-
inline Vec4 postMult( const Vec4& v ) const
+
inline Matrix ortho2D(const double left, const double right, const double bottom, const double top)
-
-
inline Vec4 preMult( const Vec4& v ) const
+
inline Matrix frustum(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
-
-
inline Vec3 transform3x3(const Vec3& v, const Matrix& m)
+
inline Matrix perspective(const double fovy, const double aspectRatio, const double zNear, const double zFar)
-
-
inline Vec3 transform3x3(const Matrix& m, const Vec3& v)
+
inline Matrix lookAt(const Vec3& eye, const Vec3& center, const Vec3& up)
-
-
inline Vec3 operator* (const Vec3& v) const
+
inline Vec3 postMult( const Vec3& v ) const
-
-
inline Vec4 operator* (const Vec4& v) const
+
inline Vec3 preMult( const Vec3& v ) const
+-
+
inline Vec4 postMult( const Vec4& v ) const
+-
+
inline Vec4 preMult( const Vec4& v ) const
+-
+
inline Vec3 transform3x3(const Vec3& v, const Matrix& m)
+-
+
inline Vec3 transform3x3(const Matrix& m, const Vec3& v)
+-
+
inline Vec3 operator* (const Vec3& v) const
+-
+
inline Vec4 operator* (const Vec4& v) const
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -177,6 +242,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -193,285 +260,376 @@
-
+
Matrix()
-
-
Matrix( const Matrix& other)
+
+
Matrix( const Matrix& other)
-
+
explicit Matrix( float const* const def )
-
+
Matrix( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
-
+
virtual Object* cloneType() const
-
+
virtual Object* clone(const CopyOp&) const
-
+
virtual bool isSameKindAs(const Object* obj) const
-
+
virtual const char* className() const
-
+
virtual ~Matrix()
-
-
-
Matrix& operator = (const Matrix& )
-
-
+
int compare(const Matrix& m) const
-
+
bool operator < (const Matrix& m) const
-
+
bool operator == (const Matrix& m) const
-
+
bool operator != (const Matrix& m) const
-
+
inline float& operator()(int row, int col)
-
+
inline float operator()(int row, int col) const
-
+
inline const bool valid() const
-
+
inline const bool isNaN() const
-
-
-
void set( float const* const )
+
+
+
inline Matrix& operator = (const Matrix& other)
-
+
+
inline void set(const Matrix& other)
+
+
+
+
inline void set(float const* const ptr)
+
+
+
void set( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
-
+
float* ptr()
-
+
const float* ptr() const
-
+
void makeIdentity()
-
+
void makeScale( const Vec3& )
-
+
void makeScale( float, float, float )
-
+
void makeTranslate( const Vec3& )
-
+
void makeTranslate( float, float, float )
-
+
void makeRotate( const Vec3& from, const Vec3& to )
-
+
void makeRotate( float angle, const Vec3& axis )
-
-
void makeRotate( float angle, float x, float y, float z )
+
+
void makeRotate( float angle, float x, float y, float z )
-
+
void makeRotate( const Quat& )
-
-
void makeRotate( float, float, float )
+
+
void makeRotate( float heading, float pitch, float roll)
+- make a rotation Matrix from euler angles.
+assume Z up, Y north, X east and euler convention
+as per Open Flight & Performer.
+Applies a positive rotation about Y axis for roll,
+then applies a positive roation about X for pitch,
+and finally a negative rotation about the Z axis.
+
+
+
+
void makeOrtho(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+- Set to a orthographic projection. See glOrtho for further details.
+
+
+
+
inline void makeOrtho2D(const double left, const double right, const double bottom, const double top)
+- Set to a 2D orthographic projection. See glOrtho2D for further details.
+
+
+
+
void makeFrustum(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+- Set to a perspective projection. See glFrustum for further details.
+
+
+
+
void makePerspective(const double fovy, const double aspectRatio, const double zNear, const double zFar)
+- Set to a symmetrical perspective projection, See gluPerspective for further details.
+Aspect ratio is defined as width/height.
+
+
+
+
void makeLookAt(const Vec3& eye, const Vec3& center, const Vec3& up)
+- Set to the position and orientation as per a camera, using the same convention as gluLookAt.
-
+
bool invert( const Matrix& )
-
-
-
bool invertAffine( const Matrix& )
-
-
+
inline static Matrix identity( void )
-
-
inline static Matrix scale( const Vec3& )
+
+
inline static Matrix scale( const Vec3& sv)
-
-
inline static Matrix scale( float, float, float )
+
+
inline static Matrix scale( float sx, float sy, float sz)
-
-
inline static Matrix translate( const Vec3& )
+
+
inline static Matrix translate( const Vec3& dv)
-
-
inline static Matrix translate( float, float, float )
+
+
inline static Matrix translate( float x, float y, float z)
-
-
inline static Matrix rotate( const Vec3&, const Vec3& )
+
+
inline static Matrix rotate( const Vec3& from, const Vec3& to)
-
-
inline static Matrix rotate( float, float, float, float )
+
+
inline static Matrix rotate( float angle, float x, float y, float z)
-
+
inline static Matrix rotate( float angle, const Vec3& axis)
-
-
inline static Matrix rotate( const Quat& )
+
+
inline static Matrix rotate( float heading, float pitch, float roll)
+- construct rotation matrix from euler angles, for conventions see makeRotate()
+
+
+
+
inline static Matrix rotate( const Quat& quat)
+
+
+
+
inline static Matrix inverse( const Matrix& matrix)
+
+
+
+
inline static Matrix ortho(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+- Create a orthographic projection. See glOrtho for further details.
+
+
+
+
inline static Matrix ortho2D(const double left, const double right, const double bottom, const double top)
+- Create a 2D orthographic projection. See glOrtho for further details.
+
+
+
+
inline static Matrix frustum(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+- Create a perspective projection. See glFrustum for further details.
+
+
+
+
inline static Matrix perspective(const double fovy, const double aspectRatio, const double zNear, const double zFar)
+- Create a symmetrical perspective projection, See gluPerspective for further details.
+Aspect ratio is defined as width/height.
+
+
+
+
inline static Matrix lookAt(const Vec3& eye, const Vec3& center, const Vec3& up)
+- Create the position and orientation as per a camera, using the same convention as gluLookAt.
-
+
void setTrans( float tx, float ty, float tz )
-
+
void setTrans( const Vec3& v )
-
+
Vec3 getTrans() const
-
+
inline static Vec3 transform3x3(const Vec3& v, const Matrix& m)
- apply apply an 3x3 transform of v*M[02,02]
-
+
inline static Vec3 transform3x3(const Matrix& m, const Vec3& v)
- apply apply an 3x3 transform of M[02,02]*v
-
+
void mult( const Matrix&, const Matrix& )
-
+
void preMult( const Matrix& )
-
+
void postMult( const Matrix& )
-
+
inline void operator *= ( const Matrix& other )
-
+
inline Matrix operator * ( const Matrix &m ) const
-
+
inline Matrix identity(void)
-
+
inline Matrix scale(float sx, float sy, float sz)
-
+
inline Matrix scale(const Vec3& v )
-
+
inline Matrix translate(float tx, float ty, float tz)
-
+
inline Matrix translate(const Vec3& v )
-
+
inline Matrix rotate( const Quat& q )
-
-
inline Matrix rotate(float angle, float x, float y, float z )
+
+
inline Matrix rotate(float angle, float x, float y, float z )
-
+
inline Matrix rotate(float angle, const Vec3& axis )
-
+
+
inline Matrix rotate(float heading, float pitch, float roll)
+
+
+
inline Matrix rotate(const Vec3& from, const Vec3& to )
+
+
+
inline Matrix ortho(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+
+
+
+
inline Matrix ortho2D(const double left, const double right, const double bottom, const double top)
+
+
+
+
inline Matrix frustum(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+
+
+
+
inline Matrix perspective(const double fovy, const double aspectRatio, const double zNear, const double zFar)
+
+
+
+
inline Matrix lookAt(const Vec3& eye, const Vec3& center, const Vec3& up)
+
-
+
inline Vec3 postMult( const Vec3& v ) const
-
+
inline Vec3 preMult( const Vec3& v ) const
-
+
inline Vec4 postMult( const Vec4& v ) const
-
+
inline Vec4 preMult( const Vec4& v ) const
-
+
inline Vec3 transform3x3(const Vec3& v, const Matrix& m)
-
+
inline Vec3 transform3x3(const Matrix& m, const Vec3& v)
-
+
inline Vec3 operator* (const Vec3& v) const
-
+
inline Vec4 operator* (const Vec4& v) const
diff --git a/doc/doc++/osg/NodeAcceptOp.html b/doc/doc++/osg/NodeAcceptOp.html
index aa1dd8c83..50f12e5b2 100644
--- a/doc/doc++/osg/NodeAcceptOp.html
+++ b/doc/doc++/osg/NodeAcceptOp.html
@@ -12,13 +12,13 @@
-
-
NodeVisitor& _nv
+
NodeVisitor& _nv
-
-
NodeAcceptOp(NodeVisitor& nv)
+
NodeAcceptOp(NodeVisitor& nv)
-
-
void operator () (Node* node)
+
void operator () (Node* node)
-
-
void operator () (ref_ptr<Node> node)
+
void operator () (ref_ptr<Node> node)
@@ -29,20 +29,20 @@
-
+
NodeVisitor& _nv
-
+
NodeAcceptOp(NodeVisitor& nv)
-
-
void operator () (Node* node)
+
+
void operator () (Node* node)
-
-
void operator () (ref_ptr<Node> node)
+
+
void operator () (ref_ptr<Node> node)
Alphabetic index HTML hierarchy of classes or Java
diff --git a/doc/doc++/osg/NodeCallback.html b/doc/doc++/osg/NodeCallback.html
index 0f9a43d41..3fe5ddb68 100644
--- a/doc/doc++/osg/NodeCallback.html
+++ b/doc/doc++/osg/NodeCallback.html
@@ -22,42 +22,28 @@
Public Fields
-
-
Requirements _requirements
--
-
ref_ptr<NodeCallback> _nestedCallback
+
ref_ptr<NodeCallback> _nestedCallback
Public Methods
-
-
NodeCallback(const Requirements ncr=NO_REQUIREMENTS)
+
NodeCallback()
-
-
virtual ~NodeCallback()
+
virtual ~NodeCallback()
-
-
inline void setRequirements(const Requirements ncr)
- - Set what values from traversal are required by this NodeCallback
-
-
-
inline const Requirements getRequirements() const
- - Get what values from traversal are required by this NodeCallback
-
-
-
virtual void operator()(Node*, NodeVisitor*)
+
virtual void operator()(Node* node, NodeVisitor* nv)
- Callback method call by the NodeVisitor when visiting a node
-
-
void traverse(Node* node, NodeVisitor* nv)
+
void traverse(Node* node, NodeVisitor* nv)
- Call any nested callbacks and then traverse the scene graph.
-
-
void setNestedCallback(NodeCallback* nc)
+
void setNestedCallback(NodeCallback* nc)
-
-
NodeCallback* getNestedCallback()
+
NodeCallback* getNestedCallback()
-
-
inline void addNestedCallback(NodeCallback* nc)
+
inline void addNestedCallback(NodeCallback* nc)
-
-
inline void removeNestedCallback(NodeCallback* nc)
-
-
-
-Public Members
-
-
enum Requirements
- - The range of values which can be accumulated by the NodeVisitor.
+
inline void removeNestedCallback(NodeCallback* nc)
@@ -71,6 +57,8 @@
inline void unref() const
+
inline void unref_nodelete() const
+
inline const int referenceCount() const
@@ -86,83 +74,42 @@
Documentation
-
-
-
enum Requirements
-- The range of values which can be accumulated by the NodeVisitor.
-
-
-
-
-
NO_REQUIREMENTS
-
-
-
-
REQUIRES_TRAVERSAL
-
-
-
-
REQUIRES_PARENT_PATH
-
-
-
-
REQUIRES_ACCUMULATED_MATRIX
-
-
-
-
REQUIRES_ACCUMULATED_INVERSE
-
-
-
-
NodeCallback(const Requirements ncr=NO_REQUIREMENTS)
+
+
NodeCallback()
-
+
virtual ~NodeCallback()
-
-
-
inline void setRequirements(const Requirements ncr)
-- Set what values from traversal are required by this NodeCallback
-
-
-
-
inline const Requirements getRequirements() const
-- Get what values from traversal are required by this NodeCallback
-
-
-
virtual void operator()(Node*, NodeVisitor*)
+
+
virtual void operator()(Node* node, NodeVisitor* nv)
- Callback method call by the NodeVisitor when visiting a node
-
-
void traverse(Node* node, NodeVisitor* nv)
+
+
void traverse(Node* node, NodeVisitor* nv)
- Call any nested callbacks and then traverse the scene graph.
-
+
void setNestedCallback(NodeCallback* nc)
-
+
NodeCallback* getNestedCallback()
-
+
inline void addNestedCallback(NodeCallback* nc)
-
+
inline void removeNestedCallback(NodeCallback* nc)
-
-
-
Requirements _requirements
-
-
+
ref_ptr<NodeCallback> _nestedCallback
diff --git a/doc/doc++/osg/NodeVisitor.html b/doc/doc++/osg/NodeVisitor.html
index 14cc5d9fd..6c06396eb 100644
--- a/doc/doc++/osg/NodeVisitor.html
+++ b/doc/doc++/osg/NodeVisitor.html
@@ -23,114 +23,116 @@
Public Methods
-
-
NodeVisitor(TraversalMode tm=TRAVERSE_NONE)
+
NodeVisitor(TraversalMode tm=TRAVERSE_NONE)
-
-
virtual ~NodeVisitor()
+
virtual ~NodeVisitor()
-
-
virtual void reset()
+
virtual void reset()
- Method to call to reset visitor.
-
-
inline void setTraversalNumber(const int fn)
+
inline void setTraversalNumber(const int fn)
- Set the traversal number.
-
-
inline const int getTraversalNumber() const
+
inline const int getTraversalNumber() const
- Get the traversal number.
-
-
inline void setFrameStamp(FrameStamp* fs)
+
inline void setFrameStamp(FrameStamp* fs)
- Set the FrameStamp that this traversal is assoicated with
-
-
inline const FrameStamp* getFrameStamp() const
+
inline const FrameStamp* getFrameStamp() const
- Get the FrameStamp that this traversal is assoicated with
-
-
inline void setTraversalMask(const Node::NodeMask mask)
+
inline void setTraversalMask(const Node::NodeMask mask)
- Set the TraversalMask of this NodeVisitor.
-
-
inline const Node::NodeMask getTraversalMask() const
+
inline const Node::NodeMask getTraversalMask() const
- Get the TraversalMask
-
-
inline void setNodeMaskOverride(const Node::NodeMask mask)
+
inline void setNodeMaskOverride(const Node::NodeMask mask)
- Set the NodeMaskOverride mask.
-
-
inline const Node::NodeMask getNodeMaskOverride() const
+
inline const Node::NodeMask getNodeMaskOverride() const
- Get the NodeMaskOverride mask
-
-
inline const bool validNodeMask(const osg::Node& node) const
+
inline const bool validNodeMask(const osg::Node& node) const
- Method to called by Node and its subclass' Node::accept() method, if the result is true to be used to cull operations of nodes and their subgraphs.
-
-
void setTraversalMode(const TraversalMode mode)
+
void setTraversalMode(const TraversalMode mode)
- Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse.
-
-
inline const TraversalMode getTraversalMode() const
+
inline const TraversalMode getTraversalMode() const
- Get the traversal mode
-
-
void setTraversalVisitor(NodeVisitor* nv)
+
void setTraversalVisitor(NodeVisitor* nv)
- Set a visitor to handle traversal.
-
-
inline NodeVisitor* getTraversalVisitor()
+
inline NodeVisitor* getTraversalVisitor()
- Get the traversal visitor, returns NULL if none is attached
-
-
inline void traverse(Node& node)
+
inline void traverse(Node& node)
- Method for handling traversal of a nodes.
-
-
inline void pushOntoNodePath(Node* node)
+
inline void pushOntoNodePath(Node* node)
- Method called by osg::Node::accept() method before a call the NodeVisitor::apply().
-
-
inline void popFromNodePath()
+
inline void popFromNodePath()
- Method callby osg::Node::accept() method after a call the NodeVisitor::apply().
-
-
NodePath& getNodePath()
+
NodePath& getNodePath()
- Get the non const NodePath from the top most node applied down to the current Node being visited
-
-
const NodePath& getNodePath() const
+
const NodePath& getNodePath() const
- Get the const NodePath from the top most node applied down to the current Node being visited
-
-
const bool getLocalToWorldMatrix(Matrix& matrix, MatrixMode mode, Node* node)
+
const bool getLocalToWorldMatrix(Matrix& matrix, Node* node)
- Get the Local To World Matrix from the NodePath for specified Transform::Mode, and u
-
-
const bool getWorldToLocalMatrix(Matrix& matrix, MatrixMode mode, Node* node)
+
const bool getWorldToLocalMatrix(Matrix& matrix, Node* node)
- Get the World To Local Matrix from the NodePath for specified Transform::Mode
-
-
virtual void apply(Node& node)
+
virtual void apply(Node& node)
-
-
virtual void apply(Geode& node)
+
virtual void apply(Geode& node)
-
-
virtual void apply(Billboard& node)
+
virtual void apply(Billboard& node)
-
-
virtual void apply(LightSource& node)
+
virtual void apply(LightSource& node)
-
-
virtual void apply(Group& node)
+
virtual void apply(Group& node)
-
-
virtual void apply(Transform& node)
+
virtual void apply(Projection& node)
-
-
virtual void apply(Switch& node)
+
virtual void apply(Transform& node)
-
-
virtual void apply(LOD& node)
+
virtual void apply(Switch& node)
-
-
virtual void apply(Impostor& node)
+
virtual void apply(LOD& node)
-
-
virtual void apply(EarthSky& node)
+
virtual void apply(Impostor& node)
+-
+
virtual void apply(EarthSky& node)
Public Members
-
-
enum TraversalMode
+
enum TraversalMode
Protected Fields
-
-
int _traversalNumber
+
int _traversalNumber
-
-
ref_ptr<FrameStamp> _frameStamp
+
ref_ptr<FrameStamp> _frameStamp
-
-
ref_ptr<NodeVisitor> _traversalVisitor
+
ref_ptr<NodeVisitor> _traversalVisitor
-
-
TraversalMode _traversalMode
+
TraversalMode _traversalMode
-
-
Node::NodeMask _traversalMask
+
Node::NodeMask _traversalMask
-
-
Node::NodeMask _nodeMaskOverride
+
Node::NodeMask _nodeMaskOverride
-
-
NodePath _nodePath
+
NodePath _nodePath
@@ -144,6 +146,8 @@
inline void unref() const
+
inline void unref_nodelete() const
+
inline const int referenceCount() const
@@ -174,41 +178,41 @@ not be called.
-
+
enum TraversalMode
-
+
TRAVERSE_NONE
-
+
TRAVERSE_PARENTS
-
+
TRAVERSE_ALL_CHILDREN
-
+
TRAVERSE_ACTIVE_CHILDREN
-
+
TRAVERSE_VISITOR
-
-
NodeVisitor(TraversalMode tm=TRAVERSE_NONE)
+
+
NodeVisitor(TraversalMode tm=TRAVERSE_NONE)
-
+
virtual ~NodeVisitor()
-
+
virtual void reset()
- Method to call to reset visitor. Useful for your visitor accumulates
state during a traversal, and you plan to reuse the visitor.
@@ -216,27 +220,27 @@ To flush that state for the next traversal than call reset() prior
to each traversal.
-
+
inline void setTraversalNumber(const int fn)
- Set the traversal number. Typically used to denote the frame count.
-
+
inline const int getTraversalNumber() const
- Get the traversal number. Typically used to denote the frame count.
-
+
inline void setFrameStamp(FrameStamp* fs)
- Set the FrameStamp that this traversal is assoicated with
-
+
inline const FrameStamp* getFrameStamp() const
- Get the FrameStamp that this traversal is assoicated with
-
+
inline void setTraversalMask(const Node::NodeMask mask)
- Set the TraversalMask of this NodeVisitor.
The TraversalMask is used by the NodeVisitor::validNodeMask() method
@@ -249,12 +253,12 @@ _nodeMaskOverride to 0xffffffff will allow a visitor to work on all nodes
regardless of their own Node::_nodeMask state.
-
+
inline const Node::NodeMask getTraversalMask() const
- Get the TraversalMask
-
+
inline void setNodeMaskOverride(const Node::NodeMask mask)
- Set the NodeMaskOverride mask.
Used in validNodeMask() to determine whether to operate on a node or its
@@ -263,13 +267,13 @@ Typically used to force on nodes which may have
been switched off by their own Node::_nodeMask.
-
+
inline const Node::NodeMask getNodeMaskOverride() const
- Get the NodeMaskOverride mask
-
-
inline const bool validNodeMask(const osg::Node& node) const
+
+
inline const bool validNodeMask(const osg::Node& node) const
- Method to called by Node and its subclass' Node::accept() method, if the result is true
to be used to cull operations of nodes and their subgraphs.
Return true if the result of a bit wise and of the NodeVisitor::_traversalMask
@@ -278,8 +282,8 @@ default values for _traversalMask is 0xffffffff, _nodeMaskOverride is 0x0,
and osg::Node::_nodeMask is 0xffffffff.
-
-
void setTraversalMode(const TraversalMode mode)
+
+
void setTraversalMode(const TraversalMode mode)
- Set the traversal mode for Node::traverse() to use when
deciding which children of a node to traverse. If a
NodeVisitor has been attached via setTraverseVisitor()
@@ -287,32 +291,32 @@ and the new mode is not TRAVERSE_VISITOR then the attached
visitor is detached. Default mode is TRAVERSE_NONE.
-
-
inline const TraversalMode getTraversalMode() const
+
+
inline const TraversalMode getTraversalMode() const
- Get the traversal mode
-
+
void setTraversalVisitor(NodeVisitor* nv)
- Set a visitor to handle traversal.
Overrides the traverse mode setting it to TRAVERSAL_VISITOR.
-
+
inline NodeVisitor* getTraversalVisitor()
- Get the traversal visitor, returns NULL if none is attached
-
-
inline void traverse(Node& node)
+
+
inline void traverse(Node& node)
- Method for handling traversal of a nodes.
If you intend to use the visitor for actively traversing
the scene graph then make sure the accept() methods call
this method unless they handle traversal directly.
-
-
inline void pushOntoNodePath(Node* node)
+
+
inline void pushOntoNodePath(Node* node)
- Method called by osg::Node::accept() method before
a call the NodeVisitor::apply(). The back of the list will,
therefore, be the current node being visited inside the apply(..),
@@ -322,7 +326,7 @@ Note, the user does not typically call pushNodeOnPath() as it
will be called automatically by the Node::accept() method.
-
+
inline void popFromNodePath()
- Method callby osg::Node::accept() method after
a call the NodeVisitor::apply().
@@ -330,93 +334,97 @@ Note, the user does not typically call pushNodeOnPath() as it
will be called automatically by the Node::accept() method.
-
+
NodePath& getNodePath()
- Get the non const NodePath from the top most node applied down
to the current Node being visited
-
+
const NodePath& getNodePath() const
- Get the const NodePath from the top most node applied down
to the current Node being visited
-
-
const bool getLocalToWorldMatrix(Matrix& matrix, MatrixMode mode, Node* node)
+
+
const bool getLocalToWorldMatrix(Matrix& matrix, Node* node)
- Get the Local To World Matrix from the NodePath for specified Transform::Mode, and u
-
-
const bool getWorldToLocalMatrix(Matrix& matrix, MatrixMode mode, Node* node)
+
+
const bool getWorldToLocalMatrix(Matrix& matrix, Node* node)
- Get the World To Local Matrix from the NodePath for specified Transform::Mode
-
-
virtual void apply(Node& node)
+
+
virtual void apply(Node& node)
-
+
virtual void apply(Geode& node)
-
+
virtual void apply(Billboard& node)
-
+
virtual void apply(LightSource& node)
-
+
virtual void apply(Group& node)
-
+
+
virtual void apply(Projection& node)
+
+
+
virtual void apply(Transform& node)
-
+
virtual void apply(Switch& node)
-
+
virtual void apply(LOD& node)
-
+
virtual void apply(Impostor& node)
-
+
virtual void apply(EarthSky& node)
-
+
int _traversalNumber
-
+
ref_ptr<FrameStamp> _frameStamp
-
+
ref_ptr<NodeVisitor> _traversalVisitor
-
-
TraversalMode _traversalMode
+
+
TraversalMode _traversalMode
-
+
Node::NodeMask _traversalMask
-
+
Node::NodeMask _nodeMaskOverride
-
+
NodePath _nodePath
diff --git a/doc/doc++/osg/NotifySeverity.html b/doc/doc++/osg/NotifySeverity.html
index 0e5eaf600..8a75a050e 100644
--- a/doc/doc++/osg/NotifySeverity.html
+++ b/doc/doc++/osg/NotifySeverity.html
@@ -12,19 +12,19 @@
-
-
ALWAYS
+
ALWAYS
-
-
FATAL
+
FATAL
-
-
WARN
+
WARN
-
-
NOTICE
+
NOTICE
-
-
INFO
+
INFO
-
-
DEBUG_INFO
+
DEBUG_INFO
-
-
DEBUG_FP
+
DEBUG_FP
@@ -39,31 +39,31 @@ further details.
-
+
ALWAYS
-
+
FATAL
-
+
WARN
-
+
NOTICE
-
+
INFO
-
+
DEBUG_INFO
-
+
DEBUG_FP
Alphabetic index HTML hierarchy of classes or Java
diff --git a/doc/doc++/osg/Object.html b/doc/doc++/osg/Object.html
index f1a057155..48128ea73 100644
--- a/doc/doc++/osg/Object.html
+++ b/doc/doc++/osg/Object.html
@@ -11,11 +11,11 @@
Inheritance:
-
-
-
-
-
+
+
+
+
+
@@ -23,27 +23,43 @@
Public Methods
-
-
Object()
+
inline Object()
- Construct an object.
-
-
Object(const Object&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
Object(const Object&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data
-
-
virtual Object* cloneType() const = 0
+
virtual Object* cloneType() const = 0
- Clone the type of an object, with Object* return type.
-
-
virtual Object* clone(const CopyOp&) const = 0
+
virtual Object* clone(const CopyOp&) const = 0
- Clone the an object, with Object* return type.
-
-
virtual bool isSameKindAs(const Object*) const
+
virtual bool isSameKindAs(const Object*) const
-
-
virtual const char* className() const = 0
+
virtual const char* className() const = 0
- return the name of the object's class type.
+
-
+
inline void setDataVariance(const DataVariance dv)
+ - Set the data variance of this object.
+
-
+
inline const DataVariance getDataVariance() const
+ - Get the data variance of this object
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
Protected Methods
-
-
virtual ~Object()
+
virtual ~Object()
- Object destructor.
@@ -58,6 +74,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -77,43 +95,70 @@ Based on GOF Composite, Prototype and Template Method patterns.
-
-
Object()
+
+
inline Object()
- Construct an object. Note Object is a pure virtual base class
and therefore cannot be constructed on its own, only derived
classes which override the clone and className methods are
concrete classes and can be constructed.
-
-
Object(const Object&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
Object(const Object&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor, optional CopyOp object can be used to control
shallow vs deep copying of dynamic data
-
+
virtual Object* cloneType() const = 0
- Clone the type of an object, with Object* return type.
Must be defined by derived classes.
-
+
virtual Object* clone(const CopyOp&) const = 0
- Clone the an object, with Object* return type.
Must be defined by derived classes.
-
+
virtual bool isSameKindAs(const Object*) const
-
+
virtual const char* className() const = 0
- return the name of the object's class type. Must be defined
by derived classes.
+
+
+
enum DataVariance
+
+
+
+
+
DYNAMIC
+
+
+
+
STATIC
+
+
+
+
+
inline void setDataVariance(const DataVariance dv)
+- Set the data variance of this object.
+Can be set to either STATIC for values that do not change over the lifetime of the object,
+or DYNAMIC for values that vary over the lifetime of the object. The DataVariance value
+can be used be routines such as optimzation codes that wish to share static data.
+
+
+
+
inline const DataVariance getDataVariance() const
+- Get the data variance of this object
+
-
+
virtual ~Object()
- Object destructor. Note, is protected so that Objects cannot
be deleted other than by being dereferenced and the reference
@@ -122,12 +167,15 @@ of nodes which are still in use. This also means that
Node's cannot be created on stack i.e Node node will not compile,
forcing all nodes to be created on the heap i.e Node* node
= new Node().
+
+
+
+
DataVariance _dataVariance
- Direct child classes:
- StateSet
StateAttribute
-Node
Matrix
Image
Drawable
diff --git a/doc/doc++/osg/Plane.html b/doc/doc++/osg/Plane.html
index 0b4d46eb0..57b02554c 100644
--- a/doc/doc++/osg/Plane.html
+++ b/doc/doc++/osg/Plane.html
@@ -13,68 +13,68 @@
Public Methods
-
-
inline Plane()
+
inline Plane()
-
-
inline Plane(const Plane& pl)
+
inline Plane(const Plane& pl)
-
-
inline Plane(const float a, const float b, const float c, const float d)
+
inline Plane(const float a, const float b, const float c, const float d)
-
-
inline Plane(const Vec4& vec)
+
inline Plane(const Vec4& vec)
-
-
inline Plane(const Vec3& norm, const float d)
+
inline Plane(const Vec3& norm, const float d)
-
-
inline Plane(const Vec3& v1, const Vec3& v2, const Vec3& v3)
+
inline Plane(const Vec3& v1, const Vec3& v2, const Vec3& v3)
-
-
inline Plane& operator = (const Plane& pl)
+
inline Plane& operator = (const Plane& pl)
-
-
inline void set(const Plane& pl)
+
inline void set(const Plane& pl)
-
-
inline void set(const float a, const float b, const float c, const float d)
+
inline void set(const float a, const float b, const float c, const float d)
-
-
inline void set(const Vec4& vec)
+
inline void set(const Vec4& vec)
-
-
inline void set(const Vec3& norm, const float d)
+
inline void set(const Vec3& norm, const float d)
-
-
inline void set(const Vec3& v1, const Vec3& v2, const Vec3& v3)
+
inline void set(const Vec3& v1, const Vec3& v2, const Vec3& v3)
-
-
inline void makeUnitLength()
+
inline void makeUnitLength()
-
-
inline void calculateUpperLowerBBCorners()
+
inline void calculateUpperLowerBBCorners()
- calculate the upper and lower bounding box corners to be used in the intersect(BoundingBox&) method for speeding calculations
-
-
inline const bool valid() const
+
inline const bool valid() const
-
-
inline Vec4& asVec4()
+
inline Vec4& asVec4()
-
-
inline const Vec4& asVec4() const
+
inline const Vec4& asVec4() const
-
-
inline float& operator [] (const int i)
+
inline float& operator [] (const int i)
-
-
inline float operator [] (const int i) const
+
inline float operator [] (const int i) const
-
-
inline const float distance(const osg::Vec3& v) const
+
inline const float distance(const osg::Vec3& v) const
- calculate the distance between a point and the plane
-
-
inline const int intersect(const BoundingSphere& bs) const
+
inline const int intersect(const BoundingSphere& bs) const
- intersection test between plane and bounding sphere.
-
-
inline const int intersect(const BoundingBox& bb) const
+
inline const int intersect(const BoundingBox& bb) const
- intersection test between plane and bounding sphere.
-
-
inline void transform(const osg::Matrix& matrix)
+
inline void transform(const osg::Matrix& matrix)
- Transform the plane by matrix.
-
-
inline void transformProvidingInverse(const osg::Matrix& matrix)
+
inline void transformProvidingInverse(const osg::Matrix& matrix)
- Transform the plane by provide a pre inverted matrix.
Protected Fields
-
-
Vec4 _fv
+
Vec4 _fv
-
-
unsigned int _upperBBCorner
+
unsigned int _upperBBCorner
-
-
unsigned int _lowerBBCorner
+
unsigned int _lowerBBCorner
@@ -86,90 +86,90 @@
-
+
inline Plane()
-
-
inline Plane(const Plane& pl)
+
+
inline Plane(const Plane& pl)
-
+
inline Plane(const float a, const float b, const float c, const float d)
-
+
inline Plane(const Vec4& vec)
-
+
inline Plane(const Vec3& norm, const float d)
-
+
inline Plane(const Vec3& v1, const Vec3& v2, const Vec3& v3)
-
+
inline Plane& operator = (const Plane& pl)
-
+
inline void set(const Plane& pl)
-
+
inline void set(const float a, const float b, const float c, const float d)
-
+
inline void set(const Vec4& vec)
-
+
inline void set(const Vec3& norm, const float d)
-
+
inline void set(const Vec3& v1, const Vec3& v2, const Vec3& v3)
-
+
inline void makeUnitLength()
-
+
inline void calculateUpperLowerBBCorners()
- calculate the upper and lower bounding box corners to be used
in the intersect(BoundingBox&) method for speeding calculations
-
+
inline const bool valid() const
-
+
inline Vec4& asVec4()
-
+
inline const Vec4& asVec4() const
-
+
inline float& operator [] (const int i)
-
+
inline float operator [] (const int i) const
-
+
inline const float distance(const osg::Vec3& v) const
- calculate the distance between a point and the plane
-
+
inline const int intersect(const BoundingSphere& bs) const
- intersection test between plane and bounding sphere.
return 1 if the bs is completely above plane,
@@ -177,7 +177,7 @@ return 0 if the bs intersects the plane,
return -1 if the bs is completely below the plane.
-
+
inline const int intersect(const BoundingBox& bb) const
- intersection test between plane and bounding sphere.
return 1 if the bs is completely above plane,
@@ -185,7 +185,7 @@ return 0 if the bs intersects the plane,
return -1 if the bs is completely below the plane.
-
+
inline void transform(const osg::Matrix& matrix)
- Transform the plane by matrix. Note, this operations carries out
the calculation of the inverse of the matrix since to transforms
@@ -195,21 +195,21 @@ calculated elsewhere then use transformProvidingInverse() instead.
See http://www.worldserver.com/turk/computergraphics/NormalTransformations.pdf
-
+
inline void transformProvidingInverse(const osg::Matrix& matrix)
- Transform the plane by provide a pre inverted matrix.
see transform for details.
-
+
Vec4 _fv
-
+
unsigned int _upperBBCorner
-
+
unsigned int _lowerBBCorner
diff --git a/doc/doc++/osg/Point.html b/doc/doc++/osg/Point.html
index d33bd261f..d9754fe1e 100644
--- a/doc/doc++/osg/Point.html
+++ b/doc/doc++/osg/Point.html
@@ -23,47 +23,47 @@
Public Methods
-
-
Point()
+
Point()
-
-
Point(const Point& point, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
Point(const Point& point, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(Point, POINT)
+
META_StateAttribute(Point, POINT)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
void setSize(const float size)
+
void setSize(const float size)
-
-
inline const float getSize() const
+
inline const float getSize() const
-
-
void setFadeThresholdSize(const float fadeThresholdSize)
+
void setFadeThresholdSize(const float fadeThresholdSize)
-
-
inline const float getFadeThresholdSize() const
+
inline const float getFadeThresholdSize() const
-
-
void setDistanceAttenuation(const Vec3& distanceAttenuation)
+
void setDistanceAttenuation(const Vec3& distanceAttenuation)
-
-
inline const Vec3& getDistanceAttenuation() const
+
inline const Vec3& getDistanceAttenuation() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
-
-
static void init_GL_EXT()
+
static void init_GL_EXT()
Protected Fields
-
-
float _size
+
float _size
-
-
float _fadeThresholdSize
+
float _fadeThresholdSize
-
-
Vec3 _distanceAttenuation
+
Vec3 _distanceAttenuation
Protected Methods
-
-
virtual ~Point()
+
virtual ~Point()
@@ -79,7 +79,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -108,6 +108,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -119,6 +136,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -136,73 +155,73 @@
-
+
Point()
-
-
Point(const Point& point, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
Point(const Point& point, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(Point, POINT)
+
+
META_StateAttribute(Point, POINT)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
void setSize(const float size)
-
+
inline const float getSize() const
-
+
void setFadeThresholdSize(const float fadeThresholdSize)
-
+
inline const float getFadeThresholdSize() const
-
+
void setDistanceAttenuation(const Vec3& distanceAttenuation)
-
+
inline const Vec3& getDistanceAttenuation() const
-
+
virtual void apply(State& state) const
-
+
static void init_GL_EXT()
-
+
virtual ~Point()
-
+
float _size
-
+
float _fadeThresholdSize
-
+
Vec3 _distanceAttenuation
diff --git a/doc/doc++/osg/PolygonMode.html b/doc/doc++/osg/PolygonMode.html
index 06738315e..8fd8d8a2c 100644
--- a/doc/doc++/osg/PolygonMode.html
+++ b/doc/doc++/osg/PolygonMode.html
@@ -23,44 +23,44 @@
Public Methods
-
-
PolygonMode()
+
PolygonMode()
-
-
PolygonMode(const PolygonMode& pm, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
PolygonMode(const PolygonMode& pm, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(PolygonMode, POLYGONMODE)
+
META_StateAttribute(PolygonMode, POLYGONMODE)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
void setMode(const Face face, const Mode mode)
+
void setMode(const Face face, const Mode mode)
-
-
const Mode getMode(const Face face) const
+
const Mode getMode(const Face face) const
-
-
inline const bool getFrontAndBack() const
+
inline const bool getFrontAndBack() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Face
+
enum Face
-
-
enum Mode
+
enum Mode
Protected Fields
-
-
bool _frontAndBack
+
bool _frontAndBack
-
-
Mode _modeFront
+
Mode _modeFront
-
-
Mode _modeBack
+
Mode _modeBack
Protected Methods
-
-
virtual ~PolygonMode()
+
virtual ~PolygonMode()
@@ -76,7 +76,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -84,7 +84,7 @@
bool operator != (const StateAttribute& rhs) const
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
virtual void compile(State&) const
@@ -107,6 +107,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -118,6 +135,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -135,90 +154,90 @@
-
+
PolygonMode()
-
-
PolygonMode(const PolygonMode& pm, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
PolygonMode(const PolygonMode& pm, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(PolygonMode, POLYGONMODE)
+
+
META_StateAttribute(PolygonMode, POLYGONMODE)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
enum Face
-
+
FRONT
-
+
BACK
-
+
FRONT_AND_BACK
-
+
enum Mode
-
+
POINT
-
+
LINE
-
+
FILL
-
-
void setMode(const Face face, const Mode mode)
+
+
void setMode(const Face face, const Mode mode)
-
-
const Mode getMode(const Face face) const
+
+
const Mode getMode(const Face face) const
-
+
inline const bool getFrontAndBack() const
-
+
virtual void apply(State& state) const
-
+
virtual ~PolygonMode()
-
+
bool _frontAndBack
-
-
Mode _modeFront
+
+
Mode _modeFront
-
-
Mode _modeBack
+
+
Mode _modeBack
- This class has no child classes.
diff --git a/doc/doc++/osg/PolygonOffset.html b/doc/doc++/osg/PolygonOffset.html
index 4ed75f91a..5b184a3dc 100644
--- a/doc/doc++/osg/PolygonOffset.html
+++ b/doc/doc++/osg/PolygonOffset.html
@@ -23,39 +23,39 @@
Public Methods
-
-
PolygonOffset()
+
PolygonOffset()
-
-
PolygonOffset(const PolygonOffset& po, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
PolygonOffset(const PolygonOffset& po, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(PolygonOffset, POLYGONOFFSET)
+
META_StateAttribute(PolygonOffset, POLYGONOFFSET)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
inline void setFactor(const float factor)
+
inline void setFactor(const float factor)
-
-
inline const float getFactor() const
+
inline const float getFactor() const
-
-
inline void setUnits(const float units)
+
inline void setUnits(const float units)
-
-
inline const float getUnits() const
+
inline const float getUnits() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Protected Fields
-
-
float _factor
+
float _factor
-
-
float _units
+
float _units
Protected Methods
-
-
virtual ~PolygonOffset()
+
virtual ~PolygonOffset()
@@ -71,7 +71,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -100,6 +100,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -111,6 +128,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -128,57 +147,57 @@
-
+
PolygonOffset()
-
-
PolygonOffset(const PolygonOffset& po, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
PolygonOffset(const PolygonOffset& po, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(PolygonOffset, POLYGONOFFSET)
+
+
META_StateAttribute(PolygonOffset, POLYGONOFFSET)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
inline void setFactor(const float factor)
-
+
inline const float getFactor() const
-
+
inline void setUnits(const float units)
-
+
inline const float getUnits() const
-
+
virtual void apply(State& state) const
-
+
virtual ~PolygonOffset()
-
+
float _factor
-
+
float _units
diff --git a/doc/doc++/osg/PositionAttitudeTransform.html b/doc/doc++/osg/PositionAttitudeTransform.html
index a78d8633a..c413aa9e3 100644
--- a/doc/doc++/osg/PositionAttitudeTransform.html
+++ b/doc/doc++/osg/PositionAttitudeTransform.html
@@ -11,11 +11,11 @@
Inheritance:
-
-
-
-
-
+
+
+
+
+
@@ -23,33 +23,33 @@
Public Methods
-
-
PositionAttitudeTransform()
+
PositionAttitudeTransform()
-
-
PositionAttitudeTransform(const PositionAttitudeTransform& pat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
PositionAttitudeTransform(const PositionAttitudeTransform& pat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
-
-
META_Node(PositionAttitudeTransform)
+
META_Node(PositionAttitudeTransform)
-
-
void setPosition(const Vec3& pos)
+
void setPosition(const Vec3& pos)
-
-
const Vec3& getPosition() const
+
const Vec3& getPosition() const
-
-
void setAttitude(const Quat& quat)
+
void setAttitude(const Quat& quat)
-
-
const Quat& getAttitude() const
+
const Quat& getAttitude() const
Protected Fields
-
-
Vec3 _position
+
Vec3 _position
-
-
Quat _attitude
+
Quat _attitude
Protected Methods
-
-
virtual const bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const
+
virtual const bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const
-
-
virtual const bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const
+
virtual const bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const
@@ -57,23 +57,15 @@
Public Methods
-
-
inline void setType(Type type)
+
void setReferenceFrame(ReferenceFrame rf)
-
-
inline const Type getType() const
+
const ReferenceFrame getReferenceFrame() const
-
-
inline void setMatrixMode(MatrixMode mode)
+
void setComputeTransformCallback(ComputeTransformCallback* ctc)
-
-
inline const MatrixMode getMatrixMode() const
+
ComputeTransformCallback* getComputeTransformCallback()
-
-
inline const bool isProjectionTransform() const
--
-
inline const bool isModelViewTransform() const
--
-
void setComputeTransformCallback(ComputeTransformCallback* ctc)
--
-
ComputeTransformCallback* getComputeTransformCallback()
--
-
const ComputeTransformCallback* getComputeTransformCallback() const
+
const ComputeTransformCallback* getComputeTransformCallback() const
-
inline const bool getLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const
-
@@ -90,18 +82,16 @@
Public Members
-
-
enum Type
+
enum ReferenceFrame
-
struct ComputeTransformCallback: public osg::Referenced
Protected Fields
-
-
Type _type
+
ref_ptr<ComputeTransformCallback> _computeTransformCallback
-
-
MatrixMode _mode
--
-
ref_ptr<ComputeTransformCallback> _computeTransformCallback
+
ReferenceFrame _referenceFrame
-
ref_ptr<Matrix> _matrix
-
@@ -124,23 +114,23 @@
Public Methods
-
virtual void traverse(NodeVisitor& nv)
-
-
virtual bool addChild( Node* child )
+
virtual bool addChild( Node* child )
-
-
virtual bool removeChild( Node* child )
+
virtual bool removeChild( Node* child )
-
-
virtual bool replaceChild( Node* origChild, Node* newChild )
+
virtual bool replaceChild( Node* origChild, Node* newChild )
-
inline const int getNumChildren() const
-
-
inline Node* getChild( const int i )
+
inline Node* getChild( const int i )
-
-
inline const Node* getChild( const int i ) const
+
inline const Node* getChild( const int i ) const
-
-
inline bool containsNode( const Node* node ) const
+
inline bool containsNode( const Node* node ) const
-
-
inline ChildList::iterator findNode( const Node* node )
+
inline ChildList::iterator findNode( const Node* node )
-
-
inline ChildList::const_iterator findNode( const Node* node ) const
+
inline ChildList::const_iterator findNode( const Node* node ) const
@@ -148,153 +138,6 @@
ChildList _children
-
-
Inherited from Node:
-
-
-Public Methods
-
-
virtual Object* cloneType() const
--
-
virtual Object* clone(const CopyOp& copyop) const
--
-
virtual bool isSameKindAs(const Object* obj) const
--
-
virtual const char* className() const
--
-
virtual void accept(NodeVisitor& nv)
--
-
virtual void ascend(NodeVisitor& nv)
--
-
inline void setName( const std::string& name )
--
-
inline void setName( const char* name )
--
-
inline const std::string& getName() const
--
-
inline const ParentList& getParents() const
--
-
inline ParentList getParents()
--
-
inline Group* getParent(const int i)
--
-
inline const Group* getParent(const int i) const
--
-
inline const int getNumParents() const
--
-
void setAppCallback(NodeCallback* nc)
--
-
inline NodeCallback* getAppCallback()
--
-
inline const NodeCallback* getAppCallback() const
--
-
inline const int getNumChildrenRequiringAppTraversal() const
--
-
void setCullingActive(const bool active)
--
-
inline const bool getCullingActive() const
--
-
inline const int getNumChildrenWithCullingDisabled() const
--
-
inline void setUserData(osg::Referenced* obj)
--
-
inline Referenced* getUserData()
--
-
inline const Referenced* getUserData() const
--
-
inline void setNodeMask(const NodeMask nm)
--
-
inline const NodeMask getNodeMask() const
--
-
inline const DescriptionList& getDescriptions() const
--
-
inline DescriptionList& getDescriptions()
--
-
inline const std::string& getDescription(const int i) const
--
-
inline std::string& getDescription(const int i)
--
-
inline const int getNumDescriptions() const
--
-
void addDescription(const std::string& desc)
--
-
inline void setStateSet(osg::StateSet* dstate)
--
-
inline osg::StateSet* getStateSet()
--
-
inline const osg::StateSet* getStateSet() const
--
-
inline const BoundingSphere& getBound() const
--
-
void dirtyBound()
-
-
-
-Public Members
-
-
typedef std::vector<Group*> ParentList
--
-
typedef std::vector<std::string> DescriptionList
-
-
-
-Protected Fields
-
-
mutable BoundingSphere _bsphere
--
-
mutable bool _bsphere_computed
--
-
std::string _name
--
-
ParentList _parents
--
-
ref_ptr<NodeCallback> _appCallback
--
-
int _numChildrenRequiringAppTraversal
--
-
bool _cullingActive
--
-
int _numChildrenWithCullingDisabled
--
-
osg::ref_ptr<Referenced> _userData
--
-
NodeMask _nodeMask
--
-
DescriptionList _descriptions
--
-
ref_ptr<StateSet> _dstate
-
-
-
-Protected Methods
-
-
void addParent(osg::Group* node)
--
-
void removeParent(osg::Group* node)
--
-
void setNumChildrenRequiringAppTraversal(const int num)
--
-
void setNumChildrenWithCullingDisabled(const int num)
-
-
-
-
Inherited from Object:
-
-
-
-
-
-Public Methods
-
-
inline Referenced& operator = (Referenced&)
--
-
inline void ref() const
--
-
inline void unref() const
--
-
inline const int referenceCount() const
-
-
-
-Protected Fields
-
-
mutable int _refCount
-
-
@@ -305,47 +148,47 @@ up via a Vec3 position and Quat attitude
-
+
PositionAttitudeTransform()
-
-
PositionAttitudeTransform(const PositionAttitudeTransform& pat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
PositionAttitudeTransform(const PositionAttitudeTransform& pat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
-
+
META_Node(PositionAttitudeTransform)
-
+
void setPosition(const Vec3& pos)
-
+
const Vec3& getPosition() const
-
+
void setAttitude(const Quat& quat)
-
+
const Quat& getAttitude() const
-
+
virtual const bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const
-
+
virtual const bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const
-
+
Vec3 _position
-
+
Quat _attitude
diff --git a/doc/doc++/osg/Quat.html b/doc/doc++/osg/Quat.html
index 0614aaa86..310474b53 100644
--- a/doc/doc++/osg/Quat.html
+++ b/doc/doc++/osg/Quat.html
@@ -13,98 +13,104 @@
Public Fields
-
-
Vec4 _fv
+
Vec4 _fv
Public Methods
-
-
Quat()
+
Quat()
-
-
Quat( float x, float y, float z, float w )
+
Quat( float x, float y, float z, float w )
-
-
Quat( const Vec4& v )
+
Quat( const Vec4& v )
-
-
inline Vec4& asVec4()
+
inline Vec4& asVec4()
-
-
inline const Vec4& asVec4() const
+
inline const Vec4& asVec4() const
-
-
inline const Vec3 asVec3() const
+
inline const Vec3 asVec3() const
-
-
inline void set(const float x, const float y, const float z, const float w)
+
inline void set(const float x, const float y, const float z, const float w)
-
-
inline void set(const osg::Vec4& v)
+
inline void set(const osg::Vec4& v)
-
-
inline const Quat operator * (const float& rhs) const
+
inline const Quat operator * (const float rhs) const
- Multiply by scalar
-
-
inline Quat& operator *= (const float& rhs)
+
inline Quat& operator *= (const float rhs)
- Unary multiply by scalar
-
-
inline const Quat operator*(const Quat& rhs) const
+
inline const Quat operator*(const Quat& rhs) const
- Binary multiply
-
-
inline Quat& operator*=(const Quat& rhs)
+
inline Quat& operator*=(const Quat& rhs)
- Unary multiply
-
-
inline const Quat operator / (const float& rhs) const
+
inline const Quat operator / (const float& rhs) const
- Divide by scalar
-
-
inline Quat& operator /= (const float& rhs)
+
inline Quat& operator /= (const float& rhs)
- Unary divide by scalar
-
-
inline const Quat operator/(const Quat& denom) const
+
inline const Quat operator/(const Quat& denom) const
- Binary divide
-
-
inline Quat& operator/=(const Quat& denom)
+
inline Quat& operator/=(const Quat& denom)
- Unary divide
-
-
inline const Quat operator + (const Quat& rhs) const
+
inline const Quat operator + (const Quat& rhs) const
- Binary addition
-
-
inline Quat& operator += (const Quat& rhs)
+
inline Quat& operator += (const Quat& rhs)
- Unary addition
-
-
inline const Quat operator - (const Quat& rhs) const
+
inline const Quat operator - (const Quat& rhs) const
- Binary subtraction
-
-
inline Quat& operator -= (const Quat& rhs)
+
inline Quat& operator -= (const Quat& rhs)
- Unary subtraction
-
-
inline const Quat operator - () const
+
inline const Quat operator - () const
- Negation operator - returns the negative of the quaternion.
-
-
const float length() const
+
const float length() const
- Length of the quaternion = sqrt( vec .
-
-
const float length2() const
+
const float length2() const
- Length of the quaternion = vec .
-
-
inline const Quat conj() const
+
inline const Quat conj() const
- Conjugate
-
-
inline const Quat inverse() const
+
inline const Quat inverse() const
- Multiplicative inverse method: q^(-1) = q^*/(qq^*)
-
-
void makeRotate( const float angle, const float x, const float y, const float z )
+
void makeRotate( const float angle, const float x, const float y, const float z )
-
-
void makeRotate( const float angle, const Vec3& vec )
+
void makeRotate( const float angle, const Vec3& vec )
-
-
void makeRotate( const Vec3& vec1, const Vec3& vec2 )
+
void makeRotate( const Vec3& vec1, const Vec3& vec2 )
- Make a rotation Quat which will rotate vec1 to vec2.
-
-
void getRotate( float& angle, float& x, float& y, float& z ) const
+
void makeRotate( float heading, float pitch, float roll)
+ - make a rotation Quat from euler angles.
+
-
+
void getRotate( float& angle, float& x, float& y, float& z ) const
- Return the angle and vector components represented by the quaternion
-
-
void getRotate( float& angle, Vec3& vec ) const
+
void getRotate( float& angle, Vec3& vec ) const
- Return the angle and vector represented by the quaternion
-
-
void slerp( const float t, const Quat& from, const Quat& to)
+
void slerp( const float t, const Quat& from, const Quat& to)
- Spherical Linear Interpolation.
-
-
void set( const osg::Matrix& m )
+
void set( const Matrix& m )
- Set quaternion to be equivalent to specified matrix
-
-
void get( osg::Matrix& m ) const
+
void get( Matrix& m ) const
+ - Get the equivalent matrix for this quaternion
+
-
+
Matrix getMatrix() const
- Get the equivalent matrix for this quaternion
@@ -117,137 +123,137 @@
-
+
Vec4 _fv
-
+
Quat()
-
-
Quat( float x, float y, float z, float w )
+
+
Quat( float x, float y, float z, float w )
-
+
Quat( const Vec4& v )
-
+
inline Vec4& asVec4()
-
+
inline const Vec4& asVec4() const
-
+
inline const Vec3 asVec3() const
-
-
inline void set(const float x, const float y, const float z, const float w)
+
+
inline void set(const float x, const float y, const float z, const float w)
-
+
inline void set(const osg::Vec4& v)
-
-
inline const Quat operator * (const float& rhs) const
+
+
inline const Quat operator * (const float rhs) const
- Multiply by scalar
-
-
inline Quat& operator *= (const float& rhs)
+
+
inline Quat& operator *= (const float rhs)
- Unary multiply by scalar
-
+
inline const Quat operator*(const Quat& rhs) const
- Binary multiply
-
+
inline Quat& operator*=(const Quat& rhs)
- Unary multiply
-
+
inline const Quat operator / (const float& rhs) const
- Divide by scalar
-
+
inline Quat& operator /= (const float& rhs)
- Unary divide by scalar
-
+
inline const Quat operator/(const Quat& denom) const
- Binary divide
-
+
inline Quat& operator/=(const Quat& denom)
- Unary divide
-
+
inline const Quat operator + (const Quat& rhs) const
- Binary addition
-
+
inline Quat& operator += (const Quat& rhs)
- Unary addition
-
+
inline const Quat operator - (const Quat& rhs) const
- Binary subtraction
-
+
inline Quat& operator -= (const Quat& rhs)
- Unary subtraction
-
+
inline const Quat operator - () const
- Negation operator - returns the negative of the quaternion.
Basically just calls operator - () on the Vec4
-
+
const float length() const
- Length of the quaternion = sqrt( vec . vec )
-
+
const float length2() const
- Length of the quaternion = vec . vec
-
+
inline const Quat conj() const
- Conjugate
-
+
inline const Quat inverse() const
- Multiplicative inverse method: q^(-1) = q^*/(qq^*)
-
-
void makeRotate( const float angle, const float x, const float y, const float z )
+
+
void makeRotate( const float angle, const float x, const float y, const float z )
-
+
void makeRotate( const float angle, const Vec3& vec )
-
+
void makeRotate( const Vec3& vec1, const Vec3& vec2 )
- Make a rotation Quat which will rotate vec1 to vec2.
Generally take adot product to get the angle between these
@@ -255,30 +261,45 @@ and then use a cross product to get the rotation axis
Watch out for the two special cases of when the vectors
are co-incident or opposite in direction.
+
+
+
void makeRotate( float heading, float pitch, float roll)
+- make a rotation Quat from euler angles.
+assume Z up, Y north, X east and euler convention
+as per Open Flight & Performer.
+Applies a positive rotation about Y axis for roll,
+then applies a positive roation about X for pitch,
+and finally a negative rotation about the Z axis.
+
-
-
void getRotate( float& angle, float& x, float& y, float& z ) const
+
+
void getRotate( float& angle, float& x, float& y, float& z ) const
- Return the angle and vector components represented by the quaternion
-
+
void getRotate( float& angle, Vec3& vec ) const
- Return the angle and vector represented by the quaternion
-
-
void slerp( const float t, const Quat& from, const Quat& to)
+
+
void slerp( const float t, const Quat& from, const Quat& to)
- Spherical Linear Interpolation.
As t goes from 0 to 1, the Quat object goes from "from" to "to".
-
-
void set( const osg::Matrix& m )
+
+
void set( const Matrix& m )
- Set quaternion to be equivalent to specified matrix
-
-
void get( osg::Matrix& m ) const
+
+
void get( Matrix& m ) const
+- Get the equivalent matrix for this quaternion
+
+
+
+
Matrix getMatrix() const
- Get the equivalent matrix for this quaternion
diff --git a/doc/doc++/osg/Referenced.html b/doc/doc++/osg/Referenced.html
index 3944e211d..98ee30d4c 100644
--- a/doc/doc++/osg/Referenced.html
+++ b/doc/doc++/osg/Referenced.html
@@ -12,7 +12,7 @@
Inheritance:
-
+
@@ -23,30 +23,33 @@
Public Methods
-
-
Referenced()
+
Referenced()
-
-
Referenced(const Referenced&)
+
Referenced(const Referenced&)
-
-
inline Referenced& operator = (Referenced&)
+
inline Referenced& operator = (Referenced&)
-
-
inline void ref() const
+
inline void ref() const
- increment the reference count by one, indicating that this object has another pointer which is referencing it
-
-
inline void unref() const
+
inline void unref() const
- decrement the reference count by one, indicating that a pointer to this object is referencing it.
-
-
inline const int referenceCount() const
+
inline void unref_nodelete() const
+ - decrement the reference count by one, indicating that a pointer to this object is referencing it.
+
-
+
inline const int referenceCount() const
- return the number pointers currently referencing this object.
Protected Fields
-
-
mutable int _refCount
+
mutable int _refCount
Protected Methods
-
-
virtual ~Referenced()
+
virtual ~Referenced()
@@ -58,42 +61,52 @@
-
+
Referenced()
-
-
Referenced(const Referenced&)
+
+
Referenced(const Referenced&)
-
+
inline Referenced& operator = (Referenced&)
-
+
inline void ref() const
- increment the reference count by one, indicating that
this object has another pointer which is referencing it
-
+
inline void unref() const
- decrement the reference count by one, indicating that
a pointer to this object is referencing it. If the
reference count goes to zero, it is assumed that this object
is no longer referenced and is automatically deleted.
+
+
+
inline void unref_nodelete() const
+- decrement the reference count by one, indicating that
+a pointer to this object is referencing it. However, do
+not delete it, even if ref count goes to 0. Warning, unref_nodelete()
+should only be called if the user knows exactly who will
+be resonsible for, one should prefer unref() over unref_nodelete()
+as the later can lead to memory leaks.
+
-
+
inline const int referenceCount() const
- return the number pointers currently referencing this object.
-
+
virtual ~Referenced()
-
+
mutable int _refCount
@@ -103,12 +116,12 @@ is no longer referenced and is automatically deleted.
Object
NodeVisitor
NodeCallback
-MemoryAdapter
LineSegment
ImpostorSpriteManager
FrameStamp
DisplaySettings
Camera
+AnimationPath
Alphabetic index HTML hierarchy of classes or Java
diff --git a/doc/doc++/osg/ShadeModel.html b/doc/doc++/osg/ShadeModel.html
index e22b9eef3..8c561fa47 100644
--- a/doc/doc++/osg/ShadeModel.html
+++ b/doc/doc++/osg/ShadeModel.html
@@ -23,36 +23,36 @@
Public Methods
-
-
ShadeModel()
+
ShadeModel()
-
-
ShadeModel(const ShadeModel& sm, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
ShadeModel(const ShadeModel& sm, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(ShadeModel, SHADEMODEL)
+
META_StateAttribute(ShadeModel, SHADEMODEL)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
inline void setMode(const Mode mode)
+
inline void setMode(const Mode mode)
-
-
inline const Mode getMode() const
+
inline const Mode getMode() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Mode
+
enum Mode
Protected Fields
-
-
Mode _mode
+
Mode _mode
Protected Methods
-
-
virtual ~ShadeModel()
+
virtual ~ShadeModel()
@@ -68,7 +68,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -76,7 +76,7 @@
-
bool operator != (const StateAttribute& rhs) const
-
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
-
virtual void compile(State&) const
@@ -99,6 +99,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -110,6 +127,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -127,56 +146,56 @@
-
+
ShadeModel()
-
-
ShadeModel(const ShadeModel& sm, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
ShadeModel(const ShadeModel& sm, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(ShadeModel, SHADEMODEL)
+
+
META_StateAttribute(ShadeModel, SHADEMODEL)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
enum Mode
-
+
FLAT
-
+
SMOOTH
-
-
inline void setMode(const Mode mode)
+
+
inline void setMode(const Mode mode)
-
-
inline const Mode getMode() const
+
+
inline const Mode getMode() const
-
+
virtual void apply(State& state) const
-
+
virtual ~ShadeModel()
-
-
Mode _mode
+
+
Mode _mode
- This class has no child classes.
diff --git a/doc/doc++/osg/State.html b/doc/doc++/osg/State.html
index fe6986eb7..39aaa87c4 100644
--- a/doc/doc++/osg/State.html
+++ b/doc/doc++/osg/State.html
@@ -23,62 +23,72 @@
Public Methods
-
-
State()
+
State()
-
-
virtual ~State()
+
virtual ~State()
-
-
void pushStateSet(const StateSet* dstate)
+
void pushStateSet(const StateSet* dstate)
- push stateset onto state stack
-
-
void popStateSet()
+
void popStateSet()
- pop drawstate off state stack
-
-
void captureCurrentState(StateSet& stateset) const
+
void captureCurrentState(StateSet& stateset) const
- copy the modes and attributes which captures the current state
-
-
void reset()
+
void reset()
- reset the state object to an empty stack
-
-
inline const bool apply_mode(const StateAttribute::GLMode mode, const bool enabled)
+
inline const bool applyMode(const StateAttribute::GLMode mode, const bool enabled)
- apply an OpenGL mode if required.
-
-
inline const bool apply_attribute(const StateAttribute* attribute)
+
inline const bool applyAttribute(const StateAttribute* attribute)
- apply an attribute if required.
-
-
void apply(const StateSet* dstate)
+
inline void applyProjectionMatrix(const osg::Matrix* matrix)
+-
+
const osg::Matrix& getProjectionMatrix() const
+-
+
inline void applyModelViewMatrix(const osg::Matrix* matrix)
+-
+
const osg::Matrix& getModelViewMatrix() const
+-
+
ClippingVolume getClippingVolume() const
+-
+
void apply(const StateSet* dstate)
- apply stateset
-
-
void apply()
+
void apply()
- apply the state
-
-
void have_applied(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
+
void haveAppliedMode(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
- mode has been set externally, update state to reflect this setting
-
-
void have_applied(const StateAttribute* attribute)
+
void haveAppliedMode(const StateAttribute::GLMode mode)
+ - mode has been set externally, therefore dirty the associated mode in osg::State so it is applied on next call to osg::State::apply()
+
-
+
void haveAppliedAttribute(const StateAttribute* attribute)
- attribute has been applied externally, update state to reflect this setting
-
-
inline void setContextID(unsigned int contextID)
+
void haveAppliedAttribute(const StateAttribute::Type type)
+ - attribute has been applied externally, and therefore this attribute type has been dirtied and will need to be re-appplied on next osg::Stateapply().
+
-
+
inline void setContextID(unsigned int contextID)
- Set the current OpenGL context uniqueID.
-
-
inline const unsigned int getContextID() const
+
inline const unsigned int getContextID() const
- Get the current OpenGL context unique ID
-
-
inline void setFrameStamp(FrameStamp* fs)
+
inline void setFrameStamp(FrameStamp* fs)
- Set the frame stamp for the current frame
-
-
inline const FrameStamp* getFrameStamp() const
+
inline const FrameStamp* getFrameStamp() const
- Set the frame stamp for the current frame
-
-
inline void setCamera(Camera* camera)
- - Set the camera.
-
-
-
inline const Camera* getCamera() const
- - Get the camera
-
-
-
inline void setDisplaySettings(DisplaySettings* vs)
+
inline void setDisplaySettings(DisplaySettings* vs)
- Set the DisplaySettings.
-
-
inline const DisplaySettings* getDisplaySettings() const
+
inline const DisplaySettings* getDisplaySettings() const
- Get the DisplaySettings
@@ -93,6 +103,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -111,65 +123,102 @@ Lazy state updating is used to minimize state changes.
-
+
State()
-
+
virtual ~State()
-
+
void pushStateSet(const StateSet* dstate)
- push stateset onto state stack
-
+
void popStateSet()
- pop drawstate off state stack
-
+
void captureCurrentState(StateSet& stateset) const
- copy the modes and attributes which captures the current state
-
+
void reset()
- reset the state object to an empty stack
-
-
-
inline const bool apply_mode(const StateAttribute::GLMode mode, const bool enabled)
+
+
+
inline const bool applyMode(const StateAttribute::GLMode mode, const bool enabled)
- apply an OpenGL mode if required.
-
-
-
inline const bool apply_attribute(const StateAttribute* attribute)
+
+
+
inline const bool applyAttribute(const StateAttribute* attribute)
- apply an attribute if required.
+
+
+
inline void applyProjectionMatrix(const osg::Matrix* matrix)
+
+
+
+
const osg::Matrix& getProjectionMatrix() const
+
+
+
+
inline void applyModelViewMatrix(const osg::Matrix* matrix)
+
+
+
+
const osg::Matrix& getModelViewMatrix() const
+
+
+
+
ClippingVolume getClippingVolume() const
+
-
+
void apply(const StateSet* dstate)
- apply stateset
-
+
void apply()
- apply the state
-
-
-
void have_applied(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
+
+
+
void haveAppliedMode(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
- mode has been set externally, update state to reflect this setting
-
-
-
void have_applied(const StateAttribute* attribute)
+
+
+
void haveAppliedMode(const StateAttribute::GLMode mode)
+- mode has been set externally, therefore dirty the associated mode in osg::State
+so it is applied on next call to osg::State::apply()
+
+
+
+
void haveAppliedAttribute(const StateAttribute* attribute)
- attribute has been applied externally, update state to reflect this setting
+
+
+
void haveAppliedAttribute(const StateAttribute::Type type)
+- attribute has been applied externally,
+and therefore this attribute type has been dirtied
+and will need to be re-appplied on next osg::Stateapply().
+note, if you have an osg::StateAttribute which you have applied externally
+then use the have_applied(attribute) method as this will the osg::State to
+track the current state more accuratly and enable lazy state updating such
+that only changed state will be applied.
+
-
+
inline void setContextID(unsigned int contextID)
- Set the current OpenGL context uniqueID.
Note, it is the application developers responsibility to
@@ -179,86 +228,74 @@ help manage OpenGL display list and texture binds appropriate
for each context.
-
+
inline const unsigned int getContextID() const
- Get the current OpenGL context unique ID
-
+
inline void setFrameStamp(FrameStamp* fs)
- Set the frame stamp for the current frame
-
+
inline const FrameStamp* getFrameStamp() const
- Set the frame stamp for the current frame
-
-
-
inline void setCamera(Camera* camera)
-- Set the camera. Note, nothing is applied, the camera is just used
-used in the State object to pass the current camera to Drawables
-during rendering.
-
-
-
-
inline const Camera* getCamera() const
-- Get the camera
-
-
+
inline void setDisplaySettings(DisplaySettings* vs)
- Set the DisplaySettings. Note, nothing is applied, the visual settings are just used
used in the State object to pass the current visual settings to Drawables
during rendering.
-
+
inline const DisplaySettings* getDisplaySettings() const
- Get the DisplaySettings
-
+
ModeStack()
-
+
bool changed
-
+
bool last_applied_value
-
+
bool global_default_value
-
+
ValueVec valueVec
-
+
AttributeStack()
-
+
bool changed
- apply an attribute if required, passing in attribute and appropriate attribute stack
-
+
const StateAttribute* last_applied_attribute
-
+
ref_ptr<StateAttribute> global_default_attribute
-
+
AttributeVec attributeVec
diff --git a/doc/doc++/osg/StateAttribute.html b/doc/doc++/osg/StateAttribute.html
index 40e124019..7129d4998 100644
--- a/doc/doc++/osg/StateAttribute.html
+++ b/doc/doc++/osg/StateAttribute.html
@@ -11,11 +11,11 @@
Inheritance:
-
-
-
-
-
+
+
+
+
+
@@ -23,72 +23,89 @@
Public Methods
-
-
StateAttribute()
+
StateAttribute()
-
-
StateAttribute(const StateAttribute& sa, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
StateAttribute(const StateAttribute& sa, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
-
-
virtual Object* cloneType() const = 0
+
virtual Object* cloneType() const = 0
- Clone the type of an attribute, with Object* return type.
-
-
virtual Object* clone(const CopyOp&) const = 0
+
virtual Object* clone(const CopyOp&) const = 0
- Clone an attribute, with Object* return type.
-
-
virtual bool isSameKindAs(const Object* obj) const
+
virtual bool isSameKindAs(const Object* obj) const
- return true if this and obj are of the same kind of object
-
-
virtual const char* className() const
+
virtual const char* className() const
- return the name of the attribute's class type
-
-
virtual const Type getType() const = 0
+
virtual const Type getType() const = 0
- return the Type identifier of the attribute's class type
-
-
virtual int compare(const StateAttribute& sa) const = 0
+
virtual int compare(const StateAttribute& sa) const = 0
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
bool operator < (const StateAttribute& rhs) const
+
bool operator < (const StateAttribute& rhs) const
-
-
bool operator == (const StateAttribute& rhs) const
+
bool operator == (const StateAttribute& rhs) const
-
-
bool operator != (const StateAttribute& rhs) const
+
bool operator != (const StateAttribute& rhs) const
-
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
-
-
virtual void apply(State&) const = 0
+
virtual void apply(State&) const = 0
- apply the OpenGL state attributes.
-
-
virtual void compile(State&) const
+
virtual void compile(State&) const
- default to nothing to compile - all state is applied immediately.
Public Members
-
-
typedef GLenum GLMode
+
typedef GLenum GLMode
- GLMode is the value used in glEnable/glDisable(mode)
-
-
typedef unsigned int GLModeValue
+
typedef unsigned int GLModeValue
- GLModeValue is used to specified whether an mode is enabled (ON) or disabled (OFF).
-
-
typedef unsigned int OverrideValue
+
typedef unsigned int OverrideValue
- Override is used to specified the override behavior of StateAttributes from from parent to children.
-
-
enum Values
+
enum Values
- list values which can be used in to set either GLModeValues or OverrideValues.
-
-
typedef unsigned int Type
+
typedef unsigned int Type
- Type identifier to differentiate between different state types.
-
-
enum Types
+
enum Types
- Values of StateAttribute::Type used to aid identification of different StateAttribute subclasses.
Protected Methods
-
-
virtual ~StateAttribute()
+
virtual ~StateAttribute()
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -100,6 +117,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -117,26 +136,26 @@
-
+
typedef GLenum GLMode
- GLMode is the value used in glEnable/glDisable(mode)
-
+
typedef unsigned int GLModeValue
- GLModeValue is used to specified whether an mode is enabled (ON) or disabled (OFF).
GLMoveValue is also used to specify the override behavior of modes from parent to children.
See enum Value description for more details.
-
+
typedef unsigned int OverrideValue
- Override is used to specified the override behavior of StateAttributes
from from parent to children.
See enum Value description for more details.
-
+
enum Values
- list values which can be used in to set either GLModeValues
or OverrideValues. When using in conjunction with GLModeValues
@@ -148,43 +167,43 @@ StateSet::setAttributeAndModes(..).
-
+
OFF
- means that associated GLMode and Override is disabled
-
+
ON
- means that associated GLMode is enabled and Override is disabled
-
+
OVERRIDE
- Overriding of GLMode's or StateAttributes is enabled
-
+
OVERRIDE_OFF
- Equivilant to OFF | OVERRIDE
-
+
OVERRIDE_ON
- Equivilant to ON | OVERRIDE
-
+
INHERIT
- means that GLMode or StateAttribute should in inherited from above
-
+
typedef unsigned int Type
- Type identifier to differentiate between different state types.
-
+
enum Types
- Values of StateAttribute::Type used to aid identification
of different StateAttribute subclasses. Each subclass defines
@@ -197,236 +216,240 @@ that types value.
-
+
TEXTURE
-
+
TEXTURE_0
-
+
TEXTURE_1
-
+
TEXTURE_2
-
+
TEXTURE_3
-
-
-
MATERIAL
-
-
-
-
ALPHAFUNC
-
-
-
-
ANTIALIAS
-
-
-
-
COLORTABLE
-
-
-
-
CULLFACE
-
-
-
-
FOG
-
-
-
-
FRONTFACE
-
-
-
-
LIGHT
-
-
-
-
LIGHT_0
-
-
-
-
LIGHT_1
-
-
-
-
LIGHT_2
-
-
-
-
LIGHT_3
-
-
-
-
LIGHT_4
-
-
-
-
LIGHT_5
-
-
-
-
LIGHT_6
-
-
-
-
LIGHT_7
-
-
-
-
POINT
-
-
-
-
LINEWIDTH
-
-
-
-
LINESTIPPLE
-
-
-
-
SHADEMODEL
-
-
+
POLYGONMODE
-
+
POLYGONOFFSET
+
+
+
MATERIAL
+
+
+
+
ALPHAFUNC
+
+
+
+
ANTIALIAS
+
+
+
+
COLORTABLE
+
+
+
+
CULLFACE
+
+
+
+
FOG
+
+
+
+
FRONTFACE
+
+
+
+
LIGHT
+
+
+
+
LIGHT_0
+
+
+
+
LIGHT_1
+
+
+
+
LIGHT_2
+
+
+
+
LIGHT_3
+
+
+
+
LIGHT_4
+
+
+
+
LIGHT_5
+
+
+
+
LIGHT_6
+
+
+
+
LIGHT_7
+
+
+
+
POINT
+
+
+
+
LINEWIDTH
+
+
+
+
LINESTIPPLE
+
+
+
+
SHADEMODEL
+
-
+
TEXENV
-
+
TEXGEN
-
+
TEXMAT
+
+
+
LIGHTMODEL
+
-
+
TRANSPARENCY
-
+
STENCIL
-
+
COLORMASK
-
+
DEPTH
-
+
VIEWPORT
-
+
CLIPPLANE
-
+
CLIPPLANE_0
-
+
CLIPPLANE_1
-
+
CLIPPLANE_2
-
+
CLIPPLANE_3
-
+
CLIPPLANE_4
-
+
CLIPPLANE_5
-
+
COLORMATRIX
-
+
StateAttribute()
-
-
StateAttribute(const StateAttribute& sa, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
StateAttribute(const StateAttribute& sa, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
-
+
virtual Object* cloneType() const = 0
- Clone the type of an attribute, with Object* return type.
Must be defined by derived classes.
-
+
virtual Object* clone(const CopyOp&) const = 0
- Clone an attribute, with Object* return type.
Must be defined by derived classes.
-
+
virtual bool isSameKindAs(const Object* obj) const
- return true if this and obj are of the same kind of object
-
+
virtual const char* className() const
- return the name of the attribute's class type
-
-
virtual const Type getType() const = 0
+
+
virtual const Type getType() const = 0
- return the Type identifier of the attribute's class type
-
+
virtual int compare(const StateAttribute& sa) const = 0
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
bool operator < (const StateAttribute& rhs) const
-
+
bool operator == (const StateAttribute& rhs) const
-
+
bool operator != (const StateAttribute& rhs) const
-
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
-
+
virtual void apply(State&) const = 0
- apply the OpenGL state attributes.
The global state for the current OpenGL context is passed
@@ -434,12 +457,12 @@ in to allow the StateAttribute to obtain details on the
the current context and state.
-
+
virtual void compile(State&) const
- default to nothing to compile - all state is applied immediately.
-
+
virtual ~StateAttribute()
@@ -458,6 +481,7 @@ the current context and state.
Material
LineWidth
LineStipple
+LightModel
Light
FrontFace
Fog
diff --git a/doc/doc++/osg/StateSet.html b/doc/doc++/osg/StateSet.html
index e40bd0a7b..d6af71321 100644
--- a/doc/doc++/osg/StateSet.html
+++ b/doc/doc++/osg/StateSet.html
@@ -23,144 +23,161 @@
Public Methods
-
-
StateSet()
+
StateSet()
-
-
StateSet(const StateSet&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
StateSet(const StateSet&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
-
-
virtual Object* cloneType() const
+
virtual Object* cloneType() const
-
-
virtual Object* clone(const CopyOp& copyop) const
+
virtual Object* clone(const CopyOp& copyop) const
-
-
virtual bool isSameKindAs(const Object* obj) const
+
virtual bool isSameKindAs(const Object* obj) const
-
-
virtual const char* className() const
+
virtual const char* className() const
-
-
int compare(const StateSet& rhs, bool compareAttributeContents=false) const
+
int compare(const StateSet& rhs, bool compareAttributeContents=false) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
bool operator < (const StateSet& rhs) const
+
bool operator < (const StateSet& rhs) const
-
-
bool operator == (const StateSet& rhs) const
+
bool operator == (const StateSet& rhs) const
-
-
bool operator != (const StateSet& rhs) const
+
bool operator != (const StateSet& rhs) const
-
-
void setGlobalDefaults()
+
void setGlobalDefaults()
- set all the modes to on or off so that it defines a complete state, typically used for a default global state
-
-
void setAllToInherit()
+
void setAllToInherit()
- set all the modes to inherit, typically used to signify nodes which inherit all of their modes for the global state
-
-
void merge(const StateSet& rhs)
+
void merge(const StateSet& rhs)
- merge this stateset with stateset rhs, this overrides the rhs if OVERRIDE is specified, otherwise rhs takes precedence
-
-
void setMode(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
+
void setMode(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
- set this StateSet to contain specified GLMode and value
-
-
void setModeToInherit(const StateAttribute::GLMode mode)
+
void setModeToInherit(const StateAttribute::GLMode mode)
- set this StateSet to inherit specified GLMode type from parents.
-
-
const StateAttribute::GLModeValue getMode(const StateAttribute::GLMode mode) const
+
const StateAttribute::GLModeValue getMode(const StateAttribute::GLMode mode) const
- get specified GLModeValue for specified GLMode.
-
-
inline ModeList& getModeList()
+
inline ModeList& getModeList()
- return the list of all GLModes contained in this StateSet
-
-
inline const ModeList& getModeList() const
+
inline const ModeList& getModeList() const
- return the const list of all GLModes contained in this const StateSet
-
-
void setAttribute(StateAttribute* attribute, const StateAttribute::OverrideValue value=StateAttribute::OFF)
+
void setAttribute(StateAttribute* attribute, const StateAttribute::OverrideValue value=StateAttribute::OFF)
- set this StateSet to contain specified attribute and override flag
-
-
void setAttributeAndModes(StateAttribute* attribute, const StateAttribute::GLModeValue value=StateAttribute::ON)
+
void setAttributeAndModes(StateAttribute* attribute, const StateAttribute::GLModeValue value=StateAttribute::ON)
- set this StateSet to contain specified attribute and set the associated GLMode's to specified value
-
-
void setAttributeToInherit(const StateAttribute::Type type)
+
void setAttributeToInherit(const StateAttribute::Type type)
- set this StateSet to inherit specified attribute type from parents.
-
-
StateAttribute* getAttribute(const StateAttribute::Type type)
+
StateAttribute* getAttribute(const StateAttribute::Type type)
- get specified StateAttribute for specified type.
-
-
const StateAttribute* getAttribute(const StateAttribute::Type type) const
+
const StateAttribute* getAttribute(const StateAttribute::Type type) const
- get specified const StateAttribute for specified type.
-
-
const RefAttributePair* getAttributePair(const StateAttribute::Type type) const
+
const RefAttributePair* getAttributePair(const StateAttribute::Type type) const
- get specified RefAttributePair for specified type.
-
-
inline AttributeList& getAttributeList()
+
inline AttributeList& getAttributeList()
- return the list of all StateAttributes contained in this StateSet
-
-
inline const AttributeList& getAttributeList() const
+
inline const AttributeList& getAttributeList() const
- return the const list of all StateAttributes contained in this const StateSet
-
-
void setRenderingHint(const int hint)
+
void setRenderingHint(const int hint)
- set the RenderingHint of the StateSet.
-
-
inline const int getRenderingHint() const
+
inline const int getRenderingHint() const
- get the RenderingHint of the StateSet
-
-
void setRenderBinDetails(const int binNum, const std::string& binName, const RenderBinMode mode=USE_RENDERBIN_DETAILS)
+
void setRenderBinDetails(const int binNum, const std::string& binName, const RenderBinMode mode=USE_RENDERBIN_DETAILS)
- set the render bin details
-
-
void setRendingBinToInherit()
+
void setRendingBinToInherit()
- set the render bin details to inherit
-
-
inline const RenderBinMode getRenderBinMode() const
+
inline const RenderBinMode getRenderBinMode() const
- get the render bin mode
-
-
inline const bool useRenderBinDetails() const
+
inline const bool useRenderBinDetails() const
- get whether the render bin details are set and should be used
-
-
inline const int getBinNumber() const
+
inline const int getBinNumber() const
- get the render bin number
-
-
inline const std::string& getBinName() const
+
inline const std::string& getBinName() const
- get the render bin name
-
-
void compile(State& state) const
+
void compile(State& state) const
- call compile on all StateAttributes contained within this StateSet
Public Members
-
-
typedef std::map<StateAttribute::GLMode,StateAttribute::GLModeValue> ModeList
+
typedef std::map<StateAttribute::GLMode,StateAttribute::GLModeValue> ModeList
- a container to map GLModes to their respective GLModeValues
-
-
typedef std::pair<ref_ptr<StateAttribute>,StateAttribute::OverrideValue> RefAttributePair
+
typedef std::pair<ref_ptr<StateAttribute>,StateAttribute::OverrideValue> RefAttributePair
- simple pairing between an attribute and its override flag
-
-
typedef std::map<StateAttribute::Type,RefAttributePair> AttributeList
+
typedef std::map<StateAttribute::Type,RefAttributePair> AttributeList
- a container to map StateAttribyte::Types to their respective RefAttributePair
-
-
enum RenderingHint
+
enum RenderingHint
-
-
enum RenderBinMode
+
enum RenderBinMode
Protected Fields
-
-
ModeList _modeList
+
ModeList _modeList
-
-
AttributeList _attributeList
+
AttributeList _attributeList
-
-
int _renderingHint
+
int _renderingHint
-
-
RenderBinMode _binMode
+
RenderBinMode _binMode
-
-
int _binNum
+
int _binNum
-
-
std::string _binName
+
std::string _binName
Protected Methods
-
-
virtual ~StateSet()
+
virtual ~StateSet()
-
-
StateSet& operator = (const StateSet&)
+
StateSet& operator = (const StateSet&)
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -170,6 +187,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -192,170 +211,170 @@ in the graphics pipeline.
-
+
StateSet()
-
-
StateSet(const StateSet&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
StateSet(const StateSet&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
-
+
virtual Object* cloneType() const
-
+
virtual Object* clone(const CopyOp& copyop) const
-
+
virtual bool isSameKindAs(const Object* obj) const
-
+
virtual const char* className() const
-
+
int compare(const StateSet& rhs, bool compareAttributeContents=false) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
bool operator < (const StateSet& rhs) const
-
+
bool operator == (const StateSet& rhs) const
-
+
bool operator != (const StateSet& rhs) const
-
+
void setGlobalDefaults()
- set all the modes to on or off so that it defines a
complete state, typically used for a default global state
-
+
void setAllToInherit()
- set all the modes to inherit, typically used to signify
nodes which inherit all of their modes for the global state
-
+
void merge(const StateSet& rhs)
- merge this stateset with stateset rhs, this overrides
the rhs if OVERRIDE is specified, otherwise rhs takes precedence
-
+
typedef std::map<StateAttribute::GLMode,StateAttribute::GLModeValue> ModeList
- a container to map GLModes to their respective GLModeValues
-
+
void setMode(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
- set this StateSet to contain specified GLMode and value
-
+
void setModeToInherit(const StateAttribute::GLMode mode)
- set this StateSet to inherit specified GLMode type from parents.
has the effect of deleting any GlMode of specified type from StateSet.
-
+
const StateAttribute::GLModeValue getMode(const StateAttribute::GLMode mode) const
- get specified GLModeValue for specified GLMode.
returns INHERIT if no GLModeValue is contained within StateSet.
-
-
inline ModeList& getModeList()
+
+
inline ModeList& getModeList()
- return the list of all GLModes contained in this StateSet
-
-
inline const ModeList& getModeList() const
+
+
inline const ModeList& getModeList() const
- return the const list of all GLModes contained in this const StateSet
-
+
typedef std::pair<ref_ptr<StateAttribute>,StateAttribute::OverrideValue> RefAttributePair
- simple pairing between an attribute and its override flag
-
-
typedef std::map<StateAttribute::Type,RefAttributePair> AttributeList
+
+
typedef std::map<StateAttribute::Type,RefAttributePair> AttributeList
- a container to map StateAttribyte::Types to their respective RefAttributePair
-
+
void setAttribute(StateAttribute* attribute, const StateAttribute::OverrideValue value=StateAttribute::OFF)
- set this StateSet to contain specified attribute and override flag
-
+
void setAttributeAndModes(StateAttribute* attribute, const StateAttribute::GLModeValue value=StateAttribute::ON)
- set this StateSet to contain specified attribute and set the associated GLMode's to specified value
-
+
void setAttributeToInherit(const StateAttribute::Type type)
- set this StateSet to inherit specified attribute type from parents.
has the effect of deleting any state attributes of specified type from StateSet.
-
+
StateAttribute* getAttribute(const StateAttribute::Type type)
- get specified StateAttribute for specified type.
returns NULL if no type is contained within StateSet.
-
+
const StateAttribute* getAttribute(const StateAttribute::Type type) const
- get specified const StateAttribute for specified type.
returns NULL if no type is contained within const StateSet.
-
-
const RefAttributePair* getAttributePair(const StateAttribute::Type type) const
+
+
const RefAttributePair* getAttributePair(const StateAttribute::Type type) const
- get specified RefAttributePair for specified type.
returns NULL if no type is contained within StateSet.
-
-
inline AttributeList& getAttributeList()
+
+
inline AttributeList& getAttributeList()
- return the list of all StateAttributes contained in this StateSet
-
-
inline const AttributeList& getAttributeList() const
+
+
inline const AttributeList& getAttributeList() const
- return the const list of all StateAttributes contained in this const StateSet
-
+
enum RenderingHint
-
+
DEFAULT_BIN
-
+
OPAQUE_BIN
-
+
TRANSPARENT_BIN
-
+
void setRenderingHint(const int hint)
- set the RenderingHint of the StateSet.
RenderingHint is used by osgUtil::Renderer to determine which
@@ -364,97 +383,97 @@ objects OPAQUE_BIN would typical used, which TRANSPARENT_BIN
should be used for objects which need to be depth sorted.
-
+
inline const int getRenderingHint() const
- get the RenderingHint of the StateSet
-
+
enum RenderBinMode
-
+
INHERIT_RENDERBIN_DETAILS
-
+
USE_RENDERBIN_DETAILS
-
+
OVERRIDE_RENDERBIN_DETAILS
-
+
ENCLOSE_RENDERBIN_DETAILS
-
-
void setRenderBinDetails(const int binNum, const std::string& binName, const RenderBinMode mode=USE_RENDERBIN_DETAILS)
+
+
void setRenderBinDetails(const int binNum, const std::string& binName, const RenderBinMode mode=USE_RENDERBIN_DETAILS)
- set the render bin details
-
+
void setRendingBinToInherit()
- set the render bin details to inherit
-
-
inline const RenderBinMode getRenderBinMode() const
+
+
inline const RenderBinMode getRenderBinMode() const
- get the render bin mode
-
+
inline const bool useRenderBinDetails() const
- get whether the render bin details are set and should be used
-
+
inline const int getBinNumber() const
- get the render bin number
-
+
inline const std::string& getBinName() const
- get the render bin name
-
+
void compile(State& state) const
- call compile on all StateAttributes contained within this StateSet
-
+
virtual ~StateSet()
-
+
StateSet& operator = (const StateSet&)
-
-
ModeList _modeList
+
+
ModeList _modeList
-
-
AttributeList _attributeList
+
+
AttributeList _attributeList
-
+
int _renderingHint
-
-
RenderBinMode _binMode
+
+
RenderBinMode _binMode
-
+
int _binNum
-
+
std::string _binName
diff --git a/doc/doc++/osg/Statistics.html b/doc/doc++/osg/Statistics.html
index b9a3ff992..484c2d97c 100644
--- a/doc/doc++/osg/Statistics.html
+++ b/doc/doc++/osg/Statistics.html
@@ -23,71 +23,71 @@
Public Fields
-
-
int numOpaque
+
int numOpaque
-
-
int nummat
+
int nummat
-
-
int nbins
+
int nbins
-
-
int nprims
+
int nprims
-
-
int nlights
+
int nlights
-
-
int depth
+
int depth
-
-
int _binNo
+
int _binNo
-
-
statsType stattype
+
statsType stattype
-
-
int nimpostor
+
int nimpostor
-
-
int numprimtypes[16]
+
int numprimtypes[16]
-
-
int primtypes[16]
+
int primtypes[16]
-
-
int primlens[16]
+
int primlens[16]
-
-
int primverts[16]
+
int primverts[16]
Public Methods
-
-
Statistics()
+
Statistics()
-
-
~Statistics()
+
~Statistics()
-
-
void reset()
+
void reset()
-
-
void setType(statsType t)
+
void setType(statsType t)
-
-
virtual bool apply(osg::Drawable::AttributeBitMask abm, osg::Vec3* begin, osg::Vec3* end)
+
virtual bool apply(osg::Drawable::AttributeBitMask abm, osg::Vec3* begin, osg::Vec3* end)
-
-
void addNumPrims(const int typ, const int nprimlen, const int numprimtype, const int primvert)
+
void addNumPrims(const int typ, const int nprimlen, const int numprimtype, const int primvert)
-
-
void addOpaque()
+
void addOpaque()
-
-
void addMatrix()
+
void addMatrix()
-
-
void addLight(const int np)
+
void addLight(const int np)
-
-
void addNumPrims(const int np)
+
void addNumPrims(const int np)
-
-
void addImpostor(const int np)
+
void addImpostor(const int np)
-
-
inline const int getBins()
+
inline const int getBins()
-
-
void setDepth(const int d)
+
void setDepth(const int d)
-
-
void addBins(const int np)
+
void addBins(const int np)
-
-
void setBinNo(const int n)
+
void setBinNo(const int n)
Public Members
-
-
enum PrimitiveType
+
enum PrimitiveType
-
-
enum statsType
+
enum statsType
@@ -101,6 +101,8 @@
inline void unref() const
+
inline void unref_nodelete() const
+
inline const int referenceCount() const
@@ -143,223 +145,223 @@ each trifan or tristrip = (length-2) triangles and so on.
-
+
Statistics()
-
+
enum PrimitiveType
-
+
NO_TYPE
-
+
POINTS
-
+
LINES
-
+
LINE_STRIP
-
+
FLAT_LINE_STRIP
-
+
LINE_LOOP
-
+
TRIANGLES
-
+
TRIANGLE_STRIP
-
+
FLAT_TRIANGLE_STRIP
-
+
TRIANGLE_FAN
-
+
FLAT_TRIANGLE_FAN
-
+
QUADS
-
+
QUAD_STRIP
-
+
POLYGON
-
+
IMPOSTOR
-
+
~Statistics()
-
+
enum statsType
-
+
STAT_NONE
-
+
STAT_FRAMERATE
-
+
STAT_GRAPHS
-
+
STAT_VIEWPARMS
-
+
STAT_PRIMS
-
+
STAT_PRIMSPERVIEW
-
+
STAT_PRIMSPERBIN
-
+
STAT_DC
-
+
STAT_RESTART
-
+
void reset()
-
-
void setType(statsType t)
+
+
void setType(statsType t)
-
-
virtual bool apply(osg::Drawable::AttributeBitMask abm, osg::Vec3* begin, osg::Vec3* end)
+
+
virtual bool apply(osg::Drawable::AttributeBitMask abm, osg::Vec3* begin, osg::Vec3* end)
-
+
void addNumPrims(const int typ, const int nprimlen, const int numprimtype, const int primvert)
-
+
void addOpaque()
-
+
void addMatrix()
-
+
void addLight(const int np)
-
+
void addNumPrims(const int np)
-
+
void addImpostor(const int np)
-
+
inline const int getBins()
-
+
void setDepth(const int d)
-
+
void addBins(const int np)
-
+
void setBinNo(const int n)
-
+
int numOpaque
-
+
int nummat
-
+
int nbins
-
+
int nprims
-
+
int nlights
-
+
int depth
-
+
int _binNo
-
-
statsType stattype
+
+
statsType stattype
-
+
int nimpostor
-
+
int numprimtypes[16]
-
+
int primtypes[16]
-
+
int primlens[16]
-
+
int primverts[16]
diff --git a/doc/doc++/osg/Stencil.html b/doc/doc++/osg/Stencil.html
index 059e6b68a..0f174d980 100644
--- a/doc/doc++/osg/Stencil.html
+++ b/doc/doc++/osg/Stencil.html
@@ -23,72 +23,72 @@
Public Methods
-
-
Stencil()
+
Stencil()
-
-
Stencil(const Stencil& stencil, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
Stencil(const Stencil& stencil, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(Stencil, STENCIL)
+
META_StateAttribute(Stencil, STENCIL)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
inline void setFunction(const Function func, int ref, uint mask)
+
inline void setFunction(const Function func, int ref, uint mask)
-
-
inline const Function getFunction() const
+
inline const Function getFunction() const
-
-
inline const int getFunctionRef() const
+
inline const int getFunctionRef() const
-
-
inline const uint getFunctionMask() const
+
inline const uint getFunctionMask() const
-
-
inline void setOperation(const Operation sfail, const Operation zfail, const Operation zpass)
+
inline void setOperation(const Operation sfail, const Operation zfail, const Operation zpass)
- set the operations to apply when the various stencil and depth tests fail or pass.
-
-
inline const Operation getStencilFailOperation() const
+
inline const Operation getStencilFailOperation() const
- get the operation when the stencil test fails
-
-
inline const Operation getStencilPassAndDepthFailOperation() const
+
inline const Operation getStencilPassAndDepthFailOperation() const
- get the operation when the stencil test passes but the depth test fails
-
-
inline const Operation getStencilPassAndDepthPassOperation() const
+
inline const Operation getStencilPassAndDepthPassOperation() const
- get the operation when both the stencil test and the depth test pass
-
-
inline void setWriteMask(uint mask)
+
inline void setWriteMask(uint mask)
-
-
inline const uint getWriteMask() const
+
inline const uint getWriteMask() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Function
+
enum Function
-
-
enum Operation
+
enum Operation
Protected Fields
-
-
Function _func
+
Function _func
-
-
int _funcRef
+
int _funcRef
-
-
uint _funcMask
+
uint _funcMask
-
-
Operation _sfail
+
Operation _sfail
-
-
Operation _zfail
+
Operation _zfail
-
-
Operation _zpass
+
Operation _zpass
-
-
uint _writeMask
+
uint _writeMask
Protected Methods
-
-
virtual ~Stencil()
+
virtual ~Stencil()
@@ -104,7 +104,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -133,6 +133,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -144,6 +161,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -161,114 +180,114 @@
-
+
Stencil()
-
-
Stencil(const Stencil& stencil, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
Stencil(const Stencil& stencil, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(Stencil, STENCIL)
+
+
META_StateAttribute(Stencil, STENCIL)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
enum Function
-
+
NEVER
-
+
LESS
-
+
EQUAL
-
+
LEQUAL
-
+
GREATER
-
+
NOTEQUAL
-
+
GEQUAL
-
+
ALWAYS
-
-
inline void setFunction(const Function func, int ref, uint mask)
+
+
inline void setFunction(const Function func, int ref, uint mask)
-
-
inline const Function getFunction() const
+
+
inline const Function getFunction() const
-
+
inline const int getFunctionRef() const
-
+
inline const uint getFunctionMask() const
-
+
enum Operation
-
+
KEEP
-
+
ZERO
-
+
REPLACE
-
+
INCR
-
+
DECR
-
+
INVERT
-
-
inline void setOperation(const Operation sfail, const Operation zfail, const Operation zpass)
+
+
inline void setOperation(const Operation sfail, const Operation zfail, const Operation zpass)
- set the operations to apply when the various stencil and depth
tests fail or pass. First parameter is to control the operation
when the stencil test fails. The second parameter is to control the
@@ -278,62 +297,62 @@ and depth pass. Ordering of parameter is the same as if using
glStencilOp(,,).
-
-
inline const Operation getStencilFailOperation() const
+
+
inline const Operation getStencilFailOperation() const
- get the operation when the stencil test fails
-
-
inline const Operation getStencilPassAndDepthFailOperation() const
+
+
inline const Operation getStencilPassAndDepthFailOperation() const
- get the operation when the stencil test passes but the depth test fails
-
-
inline const Operation getStencilPassAndDepthPassOperation() const
+
+
inline const Operation getStencilPassAndDepthPassOperation() const
- get the operation when both the stencil test and the depth test pass
-
+
inline void setWriteMask(uint mask)
-
+
inline const uint getWriteMask() const
-
+
virtual void apply(State& state) const
-
+
virtual ~Stencil()
-
-
Function _func
+
+
Function _func
-
+
int _funcRef
-
+
uint _funcMask
-
-
Operation _sfail
+
+
Operation _sfail
-
-
Operation _zfail
+
+
Operation _zfail
-
-
Operation _zpass
+
+
Operation _zpass
-
+
uint _writeMask
diff --git a/doc/doc++/osg/Switch.html b/doc/doc++/osg/Switch.html
index e26217b35..978f3f3b2 100644
--- a/doc/doc++/osg/Switch.html
+++ b/doc/doc++/osg/Switch.html
@@ -11,11 +11,11 @@
Inheritance:
-
-
-
-
-
+
+
+
+
+
@@ -23,37 +23,37 @@
Public Methods
-
-
Switch()
+
Switch()
-
-
Switch(const Switch&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
Switch(const Switch&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_Node(Switch)
+
META_Node(Switch)
-
-
virtual void traverse(NodeVisitor& nv)
+
virtual void traverse(NodeVisitor& nv)
-
-
inline void setValue(const int value)
+
inline void setValue(const int value)
- Selects the active child Node or enables a special SwitchType mode.
-
-
inline const int getValue() const
+
inline const int getValue() const
- Returns the number of the active child Node or the SwitchType
Public Members
-
-
enum SwitchType
+
enum SwitchType
- Special mode values for the Switch.
Protected Fields
-
-
int _value
+
int _value
- The current Switch value.
Protected Methods
-
-
virtual ~Switch()
+
virtual ~Switch()
@@ -61,23 +61,23 @@
Public Methods
-
-
virtual bool addChild( Node* child )
+
virtual bool addChild( Node* child )
-
-
virtual bool removeChild( Node* child )
+
virtual bool removeChild( Node* child )
-
-
virtual bool replaceChild( Node* origChild, Node* newChild )
+
virtual bool replaceChild( Node* origChild, Node* newChild )
-
inline const int getNumChildren() const
-
-
inline Node* getChild( const int i )
+
inline Node* getChild( const int i )
-
-
inline const Node* getChild( const int i ) const
+
inline const Node* getChild( const int i ) const
-
-
inline bool containsNode( const Node* node ) const
+
inline bool containsNode( const Node* node ) const
-
-
inline ChildList::iterator findNode( const Node* node )
+
inline ChildList::iterator findNode( const Node* node )
-
-
inline ChildList::const_iterator findNode( const Node* node ) const
+
inline ChildList::const_iterator findNode( const Node* node ) const
@@ -90,153 +90,6 @@
virtual const bool computeBound() const
-
-
Inherited from Node:
-
-
-Public Methods
-
-
virtual Object* cloneType() const
--
-
virtual Object* clone(const CopyOp& copyop) const
--
-
virtual bool isSameKindAs(const Object* obj) const
--
-
virtual const char* className() const
--
-
virtual void accept(NodeVisitor& nv)
--
-
virtual void ascend(NodeVisitor& nv)
--
-
inline void setName( const std::string& name )
--
-
inline void setName( const char* name )
--
-
inline const std::string& getName() const
--
-
inline const ParentList& getParents() const
--
-
inline ParentList getParents()
--
-
inline Group* getParent(const int i)
--
-
inline const Group* getParent(const int i) const
--
-
inline const int getNumParents() const
--
-
void setAppCallback(NodeCallback* nc)
--
-
inline NodeCallback* getAppCallback()
--
-
inline const NodeCallback* getAppCallback() const
--
-
inline const int getNumChildrenRequiringAppTraversal() const
--
-
void setCullingActive(const bool active)
--
-
inline const bool getCullingActive() const
--
-
inline const int getNumChildrenWithCullingDisabled() const
--
-
inline void setUserData(osg::Referenced* obj)
--
-
inline Referenced* getUserData()
--
-
inline const Referenced* getUserData() const
--
-
inline void setNodeMask(const NodeMask nm)
--
-
inline const NodeMask getNodeMask() const
--
-
inline const DescriptionList& getDescriptions() const
--
-
inline DescriptionList& getDescriptions()
--
-
inline const std::string& getDescription(const int i) const
--
-
inline std::string& getDescription(const int i)
--
-
inline const int getNumDescriptions() const
--
-
void addDescription(const std::string& desc)
--
-
inline void setStateSet(osg::StateSet* dstate)
--
-
inline osg::StateSet* getStateSet()
--
-
inline const osg::StateSet* getStateSet() const
--
-
inline const BoundingSphere& getBound() const
--
-
void dirtyBound()
-
-
-
-Public Members
-
-
typedef std::vector<Group*> ParentList
--
-
typedef std::vector<std::string> DescriptionList
-
-
-
-Protected Fields
-
-
mutable BoundingSphere _bsphere
--
-
mutable bool _bsphere_computed
--
-
std::string _name
--
-
ParentList _parents
--
-
ref_ptr<NodeCallback> _appCallback
--
-
int _numChildrenRequiringAppTraversal
--
-
bool _cullingActive
--
-
int _numChildrenWithCullingDisabled
--
-
osg::ref_ptr<Referenced> _userData
--
-
NodeMask _nodeMask
--
-
DescriptionList _descriptions
--
-
ref_ptr<StateSet> _dstate
-
-
-
-Protected Methods
-
-
void addParent(osg::Group* node)
--
-
void removeParent(osg::Group* node)
--
-
void setNumChildrenRequiringAppTraversal(const int num)
--
-
void setNumChildrenWithCullingDisabled(const int num)
-
-
-
-
Inherited from Object:
-
-
-
-
-
-Public Methods
-
-
inline Referenced& operator = (Referenced&)
--
-
inline void ref() const
--
-
inline void unref() const
--
-
inline const int referenceCount() const
-
-
-
-Protected Fields
-
-
mutable int _refCount
-
-
@@ -249,7 +102,7 @@ to represent the different states of a traffic light.
-
+
enum SwitchType
-
Special mode values for the Switch. Use these if you want to
@@ -257,55 +110,55 @@ turn on/off all child nodes.
-
+
ALL_CHILDREN_ON
- Turn on all children.
-
+
ALL_CHILDREN_OFF
- Turn off all children.
-
+
Switch()
-
-
Switch(const Switch&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
Switch(const Switch&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
+
META_Node(Switch)
-
+
virtual void traverse(NodeVisitor& nv)
-
+
inline void setValue(const int value)
-
Selects the active child Node or enables a special
SwitchType mode.
- Parameters:
- value - the number of the active child
-(first child == number 0) or SwitchType. Invalid values
+(first child == number 0) or SwitchType. Invalid values
will be ignored.
-
+
inline const int getValue() const
-
Returns the number of the active child Node or the SwitchType
-
+
virtual ~Switch()
-
+
int _value
- The current Switch value.
diff --git a/doc/doc++/osg/TexEnv.html b/doc/doc++/osg/TexEnv.html
index cb3f53dc7..62e7c5506 100644
--- a/doc/doc++/osg/TexEnv.html
+++ b/doc/doc++/osg/TexEnv.html
@@ -23,36 +23,36 @@
Public Methods
-
-
TexEnv()
+
TexEnv()
-
-
TexEnv(const TexEnv& texenv, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
TexEnv(const TexEnv& texenv, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(TexEnv, TEXENV)
+
META_StateAttribute(TexEnv, TEXENV)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
void setMode( const Mode mode )
+
void setMode( const Mode mode )
-
-
const Mode getMode() const
+
const Mode getMode() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Mode
+
enum Mode
Protected Fields
-
-
Mode _mode
+
Mode _mode
Protected Methods
-
-
virtual ~TexEnv( void )
+
virtual ~TexEnv( void )
@@ -68,7 +68,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -76,7 +76,7 @@
bool operator != (const StateAttribute& rhs) const
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
virtual void compile(State&) const
@@ -99,6 +99,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -110,6 +127,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -127,64 +146,64 @@
-
+
TexEnv()
-
-
TexEnv(const TexEnv& texenv, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
TexEnv(const TexEnv& texenv, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(TexEnv, TEXENV)
+
+
META_StateAttribute(TexEnv, TEXENV)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
enum Mode
-
+
DECAL
-
+
MODULATE
-
+
BLEND
-
+
REPLACE
-
-
void setMode( const Mode mode )
+
+
void setMode( const Mode mode )
-
-
const Mode getMode() const
+
+
const Mode getMode() const
-
+
virtual void apply(State& state) const
-
+
virtual ~TexEnv( void )
-
-
Mode _mode
+
+
Mode _mode
- This class has no child classes.
diff --git a/doc/doc++/osg/TexGen.html b/doc/doc++/osg/TexGen.html
index 814edc85a..f49262eaa 100644
--- a/doc/doc++/osg/TexGen.html
+++ b/doc/doc++/osg/TexGen.html
@@ -23,53 +23,53 @@
Public Methods
-
-
TexGen()
+
TexGen()
-
-
TexGen(const TexGen& texgen, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
TexGen(const TexGen& texgen, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(TexGen, TEXGEN)
+
META_StateAttribute(TexGen, TEXGEN)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
-
-
inline void setMode( const Mode mode )
+
inline void setMode( const Mode mode )
-
-
const Mode getMode() const
+
const Mode getMode() const
-
-
void setPlane(const Coord which, const Vec4& plane)
+
void setPlane(const Coord which, const Vec4& plane)
-
-
const Vec4& getPlane(const Coord which) const
+
const Vec4& getPlane(const Coord which) const
Public Members
-
-
enum Mode
+
enum Mode
-
-
enum Coord
+
enum Coord
Protected Fields
-
-
Mode _mode
+
Mode _mode
-
-
Vec4 _plane_s
+
Vec4 _plane_s
- additional texgen coefficents for GL_OBJECT_PLANE or GL_EYE_PLANE,
-
-
Vec4 _plane_t
+
Vec4 _plane_t
-
-
Vec4 _plane_r
+
Vec4 _plane_r
-
-
Vec4 _plane_q
+
Vec4 _plane_q
Protected Methods
-
-
virtual ~TexGen( void )
+
virtual ~TexGen( void )
@@ -85,7 +85,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -114,6 +114,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -125,6 +142,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -142,110 +161,118 @@
-
+
TexGen()
-
-
TexGen(const TexGen& texgen, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
TexGen(const TexGen& texgen, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(TexGen, TEXGEN)
+
+
META_StateAttribute(TexGen, TEXGEN)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
virtual void apply(State& state) const
-
+
enum Mode
-
+
OBJECT_LINEAR
-
+
EYE_LINEAR
-
+
SPHERE_MAP
+
+
+
+
NORMAL_MAP
+
+
+
+
REFLECTION_MAP
-
-
inline void setMode( const Mode mode )
+
+
inline void setMode( const Mode mode )
-
-
const Mode getMode() const
+
+
const Mode getMode() const
-
+
enum Coord
-
+
S
-
+
T
-
+
R
-
+
Q
-
-
void setPlane(const Coord which, const Vec4& plane)
+
+
void setPlane(const Coord which, const Vec4& plane)
-
-
const Vec4& getPlane(const Coord which) const
+
+
const Vec4& getPlane(const Coord which) const
-
+
virtual ~TexGen( void )
-
-
Mode _mode
+
+
Mode _mode
-
+
Vec4 _plane_s
- additional texgen coefficents for GL_OBJECT_PLANE or GL_EYE_PLANE,
-
+
Vec4 _plane_t
-
+
Vec4 _plane_r
-
+
Vec4 _plane_q
diff --git a/doc/doc++/osg/TexMat.html b/doc/doc++/osg/TexMat.html
index bafc21720..c8e55d41d 100644
--- a/doc/doc++/osg/TexMat.html
+++ b/doc/doc++/osg/TexMat.html
@@ -23,37 +23,37 @@
Public Methods
-
-
TexMat()
+
TexMat()
-
-
TexMat(const TexMat& texmat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
TexMat(const TexMat& texmat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(TexMat, TEXMAT)
+
META_StateAttribute(TexMat, TEXMAT)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
inline void setMatrix(const Matrix& matrix)
+
inline void setMatrix(const Matrix& matrix)
- Set the texture matrix
-
-
inline Matrix& getMatrix()
+
inline Matrix& getMatrix()
- Get the texture matrix
-
-
inline const Matrix& getMatrix() const
+
inline const Matrix& getMatrix() const
- Get the const texture matrix
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
- apply as OpenGL texture matrix
Protected Fields
-
-
Matrix _matrix
+
Matrix _matrix
Protected Methods
-
-
virtual ~TexMat( void )
+
virtual ~TexMat( void )
@@ -69,7 +69,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -77,7 +77,7 @@
bool operator != (const StateAttribute& rhs) const
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
virtual void compile(State&) const
@@ -100,6 +100,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -111,6 +128,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -128,49 +147,49 @@
-
+
TexMat()
-
-
TexMat(const TexMat& texmat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
TexMat(const TexMat& texmat, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(TexMat, TEXMAT)
+
+
META_StateAttribute(TexMat, TEXMAT)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
inline void setMatrix(const Matrix& matrix)
- Set the texture matrix
-
+
inline Matrix& getMatrix()
- Get the texture matrix
-
+
inline const Matrix& getMatrix() const
- Get the const texture matrix
-
+
virtual void apply(State& state) const
- apply as OpenGL texture matrix
-
+
virtual ~TexMat( void )
-
+
Matrix _matrix
diff --git a/doc/doc++/osg/Texture.html b/doc/doc++/osg/Texture.html
index 09a7d9c95..a5d8c2768 100644
--- a/doc/doc++/osg/Texture.html
+++ b/doc/doc++/osg/Texture.html
@@ -11,11 +11,11 @@
Inheritance:
-
-
-
-
-
+
+
+
+
+
@@ -23,163 +23,189 @@
Public Methods
-
-
Texture()
+
Texture()
-
-
Texture(const Texture& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
Texture(const Texture& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(Texture, (Type)(TEXTURE_0+_textureUnit))
+
META_StateAttribute(Texture, (Type)(TEXTURE_0+_textureUnit))
-
-
virtual int compare(const StateAttribute& rhs) const
+
virtual int compare(const StateAttribute& rhs) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
void setImage(Image* image)
+
void setImage(Image* image)
- Set the texture image.
-
-
Image* getImage()
+
Image* getImage()
- Get the texture image.
-
-
inline const Image* getImage() const
+
inline const Image* getImage() const
- Get the const texture image.
-
-
void copyTexImage2D(State& state, int x, int y, int width, int height )
+
void copyTexImage2D(State& state, int x, int y, int width, int height )
- Copy pixels into a 2D texture imageAs per glCopyTexImage2D.
-
-
void copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height )
+
void copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height )
- Copy a two-dimensional texture subimage.
-
-
inline void setTextureUnit(const unsigned int textureUnit)
+
inline void setTextureUnit(const unsigned int textureUnit)
- Set the texture unit.
-
-
inline const unsigned int getTextureUnit() const
+
inline const unsigned int getTextureUnit() const
- get the texture unit
-
-
void setWrap(const WrapParameter which, const WrapMode wrap)
+
void setWrap(const WrapParameter which, const WrapMode wrap)
- Set the texture wrap mode
-
-
const WrapMode getWrap(const WrapParameter which) const
+
const WrapMode getWrap(const WrapParameter which) const
- Get the texture wrap mode
-
-
void setFilter(const FilterParameter which, const FilterMode filter)
+
void setBorderColor(const Vec4& color)
+ - Sets the border color for this texture.
+
-
+
const Vec4& borderColor(void) const
+-
+
void setFilter(const FilterParameter which, const FilterMode filter)
- Set the texture filter mode
-
-
const FilterMode getFilter(const FilterParameter which) const
+
const FilterMode getFilter(const FilterParameter which) const
- Get the texture filter mode
-
-
inline void setInternalFormatMode(const InternalFormatMode mode)
+
inline void setInternalFormatMode(const InternalFormatMode mode)
- Set the internal format mode.
-
-
inline const InternalFormatMode getInternalFormatMode() const
+
inline const InternalFormatMode getInternalFormatMode() const
- Get the internal format mode
-
-
inline void setInternalFormatValue(const int internalFormat)
+
inline void setInternalFormatValue(const int internalFormat)
- Set the internal format to use when creating OpenGL textures.
-
-
inline const int getInternalFormatValue() const
+
inline const int getInternalFormatValue() const
- Get the internal format to use when creating OpenGL textures
-
-
inline const uint getTextureObject(const uint contextID) const
+
inline const uint getTextureObject(const uint contextID) const
- return the OpenGL texture object for specified context
-
-
inline const uint getTextureObjectSize() const
+
inline const uint getTextureObjectSize() const
- return the memory size of texture object.
-
-
inline void setSubloadMode(const SubloadMode mode)
+
inline void setSubloadMode(const SubloadMode mode)
- Set the texture subload mode.
-
-
inline const SubloadMode getSubloadMode() const
+
inline const SubloadMode getSubloadMode() const
- Get the texture subload mode.
-
-
inline void setSubloadOffset(const int x, const int y)
+
inline void setSubloadOffset(const int x, const int y)
- Set the texture subload offsets.
-
-
inline void getSubloadOffset(int& x, int& y) const
+
inline void getSubloadOffset(int& x, int& y) const
- Get the texture subload offsets.
-
-
inline GLuint& getHandle(const uint contextID) const
+
inline void setSubloadSize(const int width, const int height)
+ - Set the texture subload width.
+
-
+
inline void getSubloadSize(int& width, int& height) const
+ - Get the texture subload width.
+
-
+
inline GLuint& getHandle(const uint contextID) const
- Get the handle to the texture object for the current context
-
-
void dirtyTextureObject()
+
inline uint& getModifiedTag(const uint contextID) const
+-
+
void dirtyTextureObject()
- Force a recompile on next apply() of associated OpenGL texture objects
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
- On first apply (unless already compiled), create the minmapped texture and bind it, subsequent apply will simple bind to texture
-
-
virtual void compile(State& state) const
+
virtual void compile(State& state) const
- Compile the texture mip maps.
-
-
virtual void applyImmediateMode(State& state) const
- - Method which does the creation of the texture itself, and does not set or use texture binding.
-
-
-
static void deleteTextureObject(uint contextID, GLuint handle)
+
static void deleteTextureObject(uint contextID, GLuint handle)
- use deleteTextureObject instead of glDeleteTextures to allow OpenGL texture objects to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID
-
-
static void flushDeletedTextureObjects(uint contextID)
+
static void flushDeletedTextureObjects(uint contextID)
- flush all the cached display list which need to be deleted in the OpenGL context related to contextID
Public Members
-
-
enum WrapParameter
+
enum WrapParameter
-
-
enum WrapMode
+
enum WrapMode
-
-
enum FilterParameter
+
enum FilterParameter
-
-
enum FilterMode
+
enum FilterMode
-
-
enum InternalFormatMode
+
enum InternalFormatMode
-
-
enum SubloadMode
+
enum SubloadMode
Protected Fields
-
-
mutable uint _textureObjectSize
+
mutable uint _textureObjectSize
-
-
mutable ref_ptr<Image> _image
+
mutable ref_ptr<Image> _image
-
-
unsigned int _textureUnit
+
GLenum _target
-
-
WrapMode _wrap_s
+
unsigned int _textureUnit
-
-
WrapMode _wrap_t
+
WrapMode _wrap_s
-
-
WrapMode _wrap_r
+
WrapMode _wrap_t
-
-
FilterMode _min_filter
+
WrapMode _wrap_r
-
-
FilterMode _mag_filter
+
FilterMode _min_filter
-
-
InternalFormatMode _internalFormatMode
+
FilterMode _mag_filter
-
-
int _internalFormatValue
+
mutable bool _texParamtersDirty
-
-
mutable unsigned int _textureWidth
+
InternalFormatMode _internalFormatMode
-
-
mutable unsigned int _textureHeight
+
int _internalFormatValue
-
-
SubloadMode _subloadMode
+
Vec4 _borderColor
-
-
unsigned int _subloadOffsX
+
mutable GLsizei _textureWidth
-
-
unsigned int _subloadOffsY
+
mutable GLsizei _textureHeight
+-
+
SubloadMode _subloadMode
+-
+
GLint _subloadOffsX
+-
+
GLint _subloadOffsY
+-
+
GLsizei _subloadWidth
+-
+
GLsizei _subloadHeight
Protected Methods
-
-
virtual ~Texture()
+
virtual ~Texture()
+-
+
void applyTexParameters(GLenum target, State& state) const
+ - Method which does setting of texture paramters.
+
-
+
virtual void applyTexImage(GLenum target, Image* image, State& state) const
+ - Method which does the creation of the texture itself, and does not set or use texture binding.
Protected Members
-
-
typedef std::vector<GLuint> TextureNameList mutable TextureNameList _handleList
+
typedef std::vector<GLuint> TextureNameList mutable TextureNameList _handleList
-
-
typedef std::vector<uint> ImageModifiedTag mutable ImageModifiedTag _modifiedTag
+
typedef std::vector<uint> ImageModifiedTag mutable ImageModifiedTag _modifiedTag
-
-
typedef std::map<uint,std::set<uint> >static DeletedTextureObjectCache DeletedTextureObjectCache s_deletedTextureObjectCache
+
typedef std::map<uint,std::set<uint> >static DeletedTextureObjectCache DeletedTextureObjectCache s_deletedTextureObjectCache
@@ -195,7 +221,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -222,6 +248,23 @@
Inherited from Object:
+
+Public Methods
-
+
inline void setDataVariance(const DataVariance dv)
+-
+
inline const DataVariance getDataVariance() const
+
+
+
+Public Members
-
+
enum DataVariance
+
+
+
+Protected Fields
-
+
DataVariance _dataVariance
+
+
@@ -233,6 +276,8 @@
-
inline void unref() const
-
+
inline void unref_nodelete() const
+-
inline const int referenceCount() const
@@ -250,53 +295,53 @@
-
+
Texture()
-
-
Texture(const Texture& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
Texture(const Texture& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
META_StateAttribute(Texture, (Type)(TEXTURE_0+_textureUnit))
+
+
META_StateAttribute(Texture, (Type)(TEXTURE_0+_textureUnit))
-
+
virtual int compare(const StateAttribute& rhs) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
void setImage(Image* image)
- Set the texture image.
-
+
Image* getImage()
- Get the texture image.
-
+
inline const Image* getImage() const
- Get the const texture image.
-
-
void copyTexImage2D(State& state, int x, int y, int width, int height )
+
+
void copyTexImage2D(State& state, int x, int y, int width, int height )
- Copy pixels into a 2D texture imageAs per glCopyTexImage2D.
Creates an OpenGL texture object from the current OpenGL background
framebuffer contents at pos \a x, \a y with width \a width and
height \a height. \a width and \a height must be a power of two.
-
-
void copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height )
+
+
void copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height )
- Copy a two-dimensional texture subimage. As per glCopyTexSubImage2D.
Updates portion of an existing OpenGL texture object from the current OpenGL background
framebuffer contents at pos \a x, \a y with width \a width and
@@ -304,7 +349,7 @@ height \a height. \a width and \a height must be a power of two,
and writing into the texture with offset \a xoffset and \a yoffset.
-
+
inline void setTextureUnit(const unsigned int textureUnit)
- Set the texture unit.
Valid values are 0,1,2,3.
@@ -312,179 +357,193 @@ Default value of texture unit is 0.
note, multi-texturing not fully implemented yet... April 2001.
-
+
inline const unsigned int getTextureUnit() const
- get the texture unit
-
+
enum WrapParameter
-
+
WRAP_S
-
+
WRAP_T
-
+
WRAP_R
-
+
enum WrapMode
-
+
CLAMP
-
+
CLAMP_TO_EDGE
+
+
+
CLAMP_TO_BORDER
+
-
+
REPEAT
-
+
MIRROR
-
-
void setWrap(const WrapParameter which, const WrapMode wrap)
+
+
void setWrap(const WrapParameter which, const WrapMode wrap)
- Set the texture wrap mode
-
-
const WrapMode getWrap(const WrapParameter which) const
+
+
const WrapMode getWrap(const WrapParameter which) const
- Get the texture wrap mode
+
+
+
void setBorderColor(const Vec4& color)
+- Sets the border color for this texture. Makes difference only if
+wrap mode is CLAMP_TO_BORDER
+
+
+
+
const Vec4& borderColor(void) const
+
-
+
enum FilterParameter
-
+
MIN_FILTER
-
+
MAG_FILTER
-
+
enum FilterMode
-
+
LINEAR
-
+
LINEAR_MIPMAP_LINEAR
-
+
LINEAR_MIPMAP_NEAREST
-
+
NEAREST
-
+
NEAREST_MIPMAP_LINEAR
-
+
NEAREST_MIPMAP_NEAREST
-
+
ANISOTROPIC
-
-
void setFilter(const FilterParameter which, const FilterMode filter)
+
+
void setFilter(const FilterParameter which, const FilterMode filter)
- Set the texture filter mode
-
-
const FilterMode getFilter(const FilterParameter which) const
+
+
const FilterMode getFilter(const FilterParameter which) const
- Get the texture filter mode
-
+
enum InternalFormatMode
-
+
USE_IMAGE_DATA_FORMAT
-
+
USE_USER_DEFINED_FORMAT
-
+
USE_ARB_COMPRESSION
-
+
USE_S3TC_DXT1_COMPRESSION
-
+
USE_S3TC_DXT3_COMPRESSION
-
+
USE_S3TC_DXT5_COMPRESSION
-
-
inline void setInternalFormatMode(const InternalFormatMode mode)
+
+
inline void setInternalFormatMode(const InternalFormatMode mode)
- Set the internal format mode.
Note, If the mode is set USE_IMAGE_DATA_FORMAT, USE_ARB_COMPRESSION,
USE_S3TC_COMPRESSION the internalFormat is automatically selected,
and will overwrite the previous _internalFormatValue.
-
-
inline const InternalFormatMode getInternalFormatMode() const
+
+
inline const InternalFormatMode getInternalFormatMode() const
- Get the internal format mode
-
-
inline void setInternalFormatValue(const int internalFormat)
+
+
inline void setInternalFormatValue(const int internalFormat)
- Set the internal format to use when creating OpenGL textures.
Also sets the internalFormatMode to USE_USER_DEFINED_FORMAT.
-
+
inline const int getInternalFormatValue() const
- Get the internal format to use when creating OpenGL textures
-
+
inline const uint getTextureObject(const uint contextID) const
- return the OpenGL texture object for specified context
-
+
inline const uint getTextureObjectSize() const
- return the memory size of texture object.
Texture object size can be used for estimating the cost of
@@ -492,72 +551,81 @@ uploading the texture to graphics hardware, which in turn can
be used for setting texture residence priorities.
-
+
enum SubloadMode
-
+
OFF
-
+
AUTO
-
+
IF_DIRTY
-
-
inline void setSubloadMode(const SubloadMode mode)
+
+
inline void setSubloadMode(const SubloadMode mode)
- Set the texture subload mode.
-
-
inline const SubloadMode getSubloadMode() const
+
+
inline const SubloadMode getSubloadMode() const
- Get the texture subload mode.
-
-
inline void setSubloadOffset(const int x, const int y)
+
+
inline void setSubloadOffset(const int x, const int y)
- Set the texture subload offsets.
-
-
inline void getSubloadOffset(int& x, int& y) const
+
+
inline void getSubloadOffset(int& x, int& y) const
- Get the texture subload offsets.
+
+
+
inline void setSubloadSize(const int width, const int height)
+- Set the texture subload width. If width or height are zero then
+the repsective size value is calculated from the source image sizes.
+
+
+
+
inline void getSubloadSize(int& width, int& height) const
+- Get the texture subload width.
+
-
+
inline GLuint& getHandle(const uint contextID) const
- Get the handle to the texture object for the current context
+
+
+
inline uint& getModifiedTag(const uint contextID) const
+
-
+
void dirtyTextureObject()
- Force a recompile on next apply() of associated OpenGL texture objects
-
+
virtual void apply(State& state) const
- On first apply (unless already compiled), create the minmapped
texture and bind it, subsequent apply will simple bind to texture
-
+
virtual void compile(State& state) const
- Compile the texture mip maps. Implemented by simply calling apply().
-
-
-
virtual void applyImmediateMode(State& state) const
-- Method which does the creation of the texture itself, and
-does not set or use texture binding.
-
-
+
static void deleteTextureObject(uint contextID, GLuint handle)
- use deleteTextureObject instead of glDeleteTextures to allow
OpenGL texture objects to cached until they can be deleted
@@ -565,89 +633,122 @@ by the OpenGL context in which they were created, specified
by contextID
-
+
static void flushDeletedTextureObjects(uint contextID)
- flush all the cached display list which need to be deleted
in the OpenGL context related to contextID
-
+
virtual ~Texture()
+
+
+
void applyTexParameters(GLenum target, State& state) const
+- Method which does setting of texture paramters.
+
+
+
+
virtual void applyTexImage(GLenum target, Image* image, State& state) const
+- Method which does the creation of the texture itself, and
+does not set or use texture binding.
+
-
+
typedef std::vector<GLuint> TextureNameList mutable TextureNameList _handleList
-
+
typedef std::vector<uint> ImageModifiedTag mutable ImageModifiedTag _modifiedTag
-
+
mutable uint _textureObjectSize
-
+
mutable ref_ptr<Image> _image
+
+
+
GLenum _target
+
-
+
unsigned int _textureUnit
-
-
WrapMode _wrap_s
+
+
WrapMode _wrap_s
-
-
WrapMode _wrap_t
+
+
WrapMode _wrap_t
-
-
WrapMode _wrap_r
+
+
WrapMode _wrap_r
-
-
FilterMode _min_filter
+
+
FilterMode _min_filter
-
-
FilterMode _mag_filter
+
+
FilterMode _mag_filter
+
+
+
+
mutable bool _texParamtersDirty
-
-
InternalFormatMode _internalFormatMode
+
+
InternalFormatMode _internalFormatMode
-
+
int _internalFormatValue
+
+
+
Vec4 _borderColor
+
-
-
mutable unsigned int _textureWidth
+
+
mutable GLsizei _textureWidth
-
-
mutable unsigned int _textureHeight
+
+
mutable GLsizei _textureHeight
-
-
SubloadMode _subloadMode
+
+
SubloadMode _subloadMode
-
-
unsigned int _subloadOffsX
+
+
GLint _subloadOffsX
-
-
unsigned int _subloadOffsY
+
+
GLint _subloadOffsY
+
+
+
+
GLsizei _subloadWidth
+
+
+
+
GLsizei _subloadHeight
-
+
typedef std::map<uint,std::set<uint> >static DeletedTextureObjectCache DeletedTextureObjectCache s_deletedTextureObjectCache
-
-
- This class has no child classes.
+
+- Direct child classes:
+
- TextureCubeMap
+
Alphabetic index HTML hierarchy of classes or Java
diff --git a/doc/doc++/osg/Timer.html b/doc/doc++/osg/Timer.html
index edccb0367..bc785909c 100644
--- a/doc/doc++/osg/Timer.html
+++ b/doc/doc++/osg/Timer.html
@@ -13,21 +13,21 @@
Public Methods
-
-
Timer()
+
Timer()
-
-
~Timer()
+
~Timer()
-
-
inline double delta_s( Timer_t t1, Timer_t t2 ) const
+
inline double delta_s( Timer_t t1, Timer_t t2 ) const
-
-
inline double delta_m( Timer_t t1, Timer_t t2 ) const
+
inline double delta_m( Timer_t t1, Timer_t t2 ) const
-
-
inline double delta_u( Timer_t t1, Timer_t t2 ) const
+
inline double delta_u( Timer_t t1, Timer_t t2 ) const
-
-
inline double delta_n( Timer_t t1, Timer_t t2 ) const
+
inline double delta_n( Timer_t t1, Timer_t t2 ) const
-
-
inline Timer_t tick() const
+
inline Timer_t tick() const
-
-
inline Timer_t tick( void ) const
+
inline Timer_t tick( void ) const
@@ -39,35 +39,35 @@
-
+
Timer()
-
+
~Timer()
-
+
inline double delta_s( Timer_t t1, Timer_t t2 ) const
-
+
inline double delta_m( Timer_t t1, Timer_t t2 ) const
-
+
inline double delta_u( Timer_t t1, Timer_t t2 ) const
-
+
inline double delta_n( Timer_t t1, Timer_t t2 ) const
-
+
inline Timer_t tick() const
-
+
inline Timer_t tick( void ) const
diff --git a/doc/doc++/osg/Transform.html b/doc/doc++/osg/Transform.html
index 890313546..f6ae92ea4 100644
--- a/doc/doc++/osg/Transform.html
+++ b/doc/doc++/osg/Transform.html
@@ -11,11 +11,11 @@
Inheritance:
-
-
-
-
-
+
+
+
+
+
@@ -23,97 +23,81 @@
Public Methods
-
-
Transform()
+
Transform()
-
-
Transform(const Transform&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
Transform(const Transform&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
- Copy constructor using CopyOp to manage deep vs shallow copy
-
-
Transform(const Matrix& matix)
+
Transform(const Matrix& matix)
-
-
META_Node(Transform)
+
META_Node(Transform)
-
-
inline void setType(Type type)
- - Set the Transform Type, which can be DYNAMIC - the Matrix value is updated during the main loop, or STATIC - the Matrix is constant throughout the life of the main loop.
+
void setReferenceFrame(ReferenceFrame rf)
+- Set the transform's ReferenceFrame, either to be realtive to its parent reference frame, or relative to an absolute coordinate frame.
-
-
inline const Type getType() const
- - Get the Transform Type
+
const ReferenceFrame getReferenceFrame() const
-
-
inline void setMatrixMode(MatrixMode mode)
- - Set the matrix mode which tells traversers them how to treat this Transform - as Projection, View or Model transformation
-
-
-
inline const MatrixMode getMatrixMode() const
- - Get the transform mode
-
-
-
inline const bool isProjectionTransform() const
- - Does the tranform set up the projection matrix
-
-
-
inline const bool isModelViewTransform() const
- - Does the tranform set up the modelview matrix
-
-
-
void setComputeTransformCallback(ComputeTransformCallback* ctc)
+
void setComputeTransformCallback(ComputeTransformCallback* ctc)
- Set the ComputerTransfromCallback which allows users to attach custom computation of the local transformation as seen by cull traversers and alike
-
-
ComputeTransformCallback* getComputeTransformCallback()
+
ComputeTransformCallback* getComputeTransformCallback()
- Get the non const ComputerTransfromCallback
-
-
const ComputeTransformCallback* getComputeTransformCallback() const
+
const ComputeTransformCallback* getComputeTransformCallback() const
- Get the const ComputerTransfromCallback
-
-
inline const bool getLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const
+
inline const bool getLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const
- Get the transformation matrix which moves from local coords to world coords.
-
-
inline const bool getWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const
+
inline const bool getWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const
- Get the transformation matrix which moves from world coords to local coords.
-
-
void setMatrix(const Matrix& mat)
+
void setMatrix(const Matrix& mat)
- Set the transform's matrix
-
-
inline const Matrix& getMatrix() const
+
inline const Matrix& getMatrix() const
- Get the transform's matrix.
-
-
void preMult(const Matrix& mat)
+
void preMult(const Matrix& mat)
- preMult transform
-
-
void postMult(const Matrix& mat)
+
void postMult(const Matrix& mat)
- postMult transform
Public Members
-
-
enum Type
- - Range of types that the Transform can be
+
enum ReferenceFrame
-
-
struct ComputeTransformCallback: public osg::Referenced
- - Callback attached to an Transform to specifiy how to compute the modelview or projection transformation for the transform below the Transform node
+
struct ComputeTransformCallback: public osg::Referenced
+- Callback attached to an Transform to specifiy how to compute the modelview transformation for the transform below the Transform node
Protected Fields
-
-
Type _type
+
ref_ptr<ComputeTransformCallback> _computeTransformCallback
-
-
MatrixMode _mode
+
ReferenceFrame _referenceFrame
-
-
ref_ptr<ComputeTransformCallback> _computeTransformCallback
+
ref_ptr<Matrix> _matrix
-
-
ref_ptr<Matrix> _matrix
+
mutable ref_ptr<Matrix> _inverse
-
-
mutable ref_ptr<Matrix> _inverse
--
-
mutable bool _inverseDirty
+
mutable bool _inverseDirty
Protected Methods
-
-
virtual ~Transform()
+
virtual ~Transform()
-
-
virtual const bool computeBound() const
+
virtual const bool computeBound() const
- Override's Group's computeBound.
-
-
virtual const bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor*) const
+
virtual const bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor*) const
-
-
virtual const bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor*) const
+
virtual const bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor*) const
-
-
inline void computeInverse() const
+
inline void computeInverse() const
@@ -123,23 +107,23 @@
Public Methods
virtual void traverse(NodeVisitor& nv)
-
virtual bool addChild( Node* child )
+
virtual bool addChild( Node* child )
-
virtual bool removeChild( Node* child )
+
virtual bool removeChild( Node* child )
-
virtual bool replaceChild( Node* origChild, Node* newChild )
+
virtual bool replaceChild( Node* origChild, Node* newChild )
inline const int getNumChildren() const
-
inline Node* getChild( const int i )
+
inline Node* getChild( const int i )
-
inline const Node* getChild( const int i ) const
+
inline const Node* getChild( const int i ) const
-
inline bool containsNode( const Node* node ) const
+
inline bool containsNode( const Node* node ) const
-
inline ChildList::iterator findNode( const Node* node )
+
inline ChildList::iterator findNode( const Node* node )
-
inline ChildList::const_iterator findNode( const Node* node ) const
+
inline ChildList::const_iterator findNode( const Node* node ) const
@@ -147,153 +131,6 @@
ChildList _children
-
-
Inherited from Node:
-
-
-Public Methods
-
-
virtual Object* cloneType() const
--
-
virtual Object* clone(const CopyOp& copyop) const
--
-
virtual bool isSameKindAs(const Object* obj) const
--
-
virtual const char* className() const
--
-
virtual void accept(NodeVisitor& nv)
--
-
virtual void ascend(NodeVisitor& nv)
--
-
inline void setName( const std::string& name )
--
-
inline void setName( const char* name )
--
-
inline const std::string& getName() const
--
-
inline const ParentList& getParents() const
--
-
inline ParentList getParents()
--
-
inline Group* getParent(const int i)
--
-
inline const Group* getParent(const int i) const
--
-
inline const int getNumParents() const
--
-
void setAppCallback(NodeCallback* nc)
--
-
inline NodeCallback* getAppCallback()
--
-
inline const NodeCallback* getAppCallback() const
--
-
inline const int getNumChildrenRequiringAppTraversal() const
--
-
void setCullingActive(const bool active)
--
-
inline const bool getCullingActive() const
--
-
inline const int getNumChildrenWithCullingDisabled() const
--
-
inline void setUserData(osg::Referenced* obj)
--
-
inline Referenced* getUserData()
--
-
inline const Referenced* getUserData() const
--
-
inline void setNodeMask(const NodeMask nm)
--
-
inline const NodeMask getNodeMask() const
--
-
inline const DescriptionList& getDescriptions() const
--
-
inline DescriptionList& getDescriptions()
--
-
inline const std::string& getDescription(const int i) const
--
-
inline std::string& getDescription(const int i)
--
-
inline const int getNumDescriptions() const
--
-
void addDescription(const std::string& desc)
--
-
inline void setStateSet(osg::StateSet* dstate)
--
-
inline osg::StateSet* getStateSet()
--
-
inline const osg::StateSet* getStateSet() const
--
-
inline const BoundingSphere& getBound() const
--
-
void dirtyBound()
-
-
-
-Public Members
-
-
typedef std::vector<Group*> ParentList
--
-
typedef std::vector<std::string> DescriptionList
-
-
-
-Protected Fields
-
-
mutable BoundingSphere _bsphere
--
-
mutable bool _bsphere_computed
--
-
std::string _name
--
-
ParentList _parents
--
-
ref_ptr<NodeCallback> _appCallback
--
-
int _numChildrenRequiringAppTraversal
--
-
bool _cullingActive
--
-
int _numChildrenWithCullingDisabled
--
-
osg::ref_ptr<Referenced> _userData
--
-
NodeMask _nodeMask
--
-
DescriptionList _descriptions
--
-
ref_ptr<StateSet> _dstate
-
-
-
-Protected Methods
-
-
void addParent(osg::Group* node)
--
-
void removeParent(osg::Group* node)
--
-
void setNumChildrenRequiringAppTraversal(const int num)
--
-
void setNumChildrenWithCullingDisabled(const int num)
-
-
-
-
Inherited from Object:
-
-
-
-
-
-Public Methods
-
-
inline Referenced& operator = (Referenced&)
--
-
inline void ref() const
--
-
inline void unref() const
--
-
inline const int referenceCount() const
-
-
-
-Protected Fields
-
-
mutable int _refCount
-
-
@@ -317,184 +154,159 @@ mode to on via stateset->setMode(GL_NORMALIZE,osg::StateAttribute::ON);.
-
+
Transform()
-
-
Transform(const Transform&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
+
+
Transform(const Transform&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
Copy constructor using CopyOp to manage deep vs shallow copy
-
+
Transform(const Matrix& matix)
-
+
META_Node(Transform)
-
-
-
enum Type
-Range of types that the Transform can be
+
+
+
enum ReferenceFrame
-
-
-
DYNAMIC
+
+
+
RELATIVE_TO_PARENTS
-
-
-
STATIC
+
+
+
RELATIVE_TO_ABSOLUTE
-
-
-
inline void setType(Type type)
-Set the Transform Type, which can be DYNAMIC - the Matrix
-value is updated during the main loop, or STATIC - the Matrix
-is constant throughout the life of the main loop. STATIC
-Transforms can be optimized away is some instances, which
-can improve performance so unless you plan to modify the
-Matrix explicitly set the Matrix to STATIC. The default
-value is DYNAMIC.
+
+
+
void setReferenceFrame(ReferenceFrame rf)
+Set the transform's ReferenceFrame, either to be realtive to its parent reference frame,
+or relative to an absolute coordinate frame. RELATIVE_TO_PARENTS is the default.
+Note, setting the RefrenceFrame to be RELATIVE_TO_ABSOLUTE will also set the CullingActive flag on the
+transform, and hence all its parents, to false, therby disabling culling of it and all its
+parents. This is neccessary to prevent inappropriate culling, but may impact of cull times
+if the absolute transform is deep in the scene graph, it is therefore recommend to only use
+abolsoute Transforms at the top of the scene, for such things as headlight LightSource's or
+Head up displays.
-
-
-
inline const Type getType() const
-Get the Transform Type
-
-
-
-
inline void setMatrixMode(MatrixMode mode)
-Set the matrix mode which tells traversers them how to treat this Transform - as Projection, View or Model transformation
-
-
-
-
inline const MatrixMode getMatrixMode() const
-Get the transform mode
-
-
-
-
inline const bool isProjectionTransform() const
-Does the tranform set up the projection matrix
-
-
-
-
inline const bool isModelViewTransform() const
-Does the tranform set up the modelview matrix
+
+
+
const ReferenceFrame getReferenceFrame() const
-
+
struct ComputeTransformCallback: public osg::Referenced
-Callback attached to an Transform to specifiy how to compute the modelview or projection transformation
+Callback attached to an Transform to specifiy how to compute the modelview transformation
for the transform below the Transform node
-
-
virtual const bool computeLocalToWorldMatrix(Matrix& matrix, const Transform* transform, NodeVisitor* nv) const = 0
+
+
virtual const bool computeLocalToWorldMatrix(Matrix& matrix, const Transform* transform, NodeVisitor* nv) const = 0
- Get the transformation matrix which moves from local coords to world coords
-
-
virtual const bool computeWorldToLocalMatrix(Matrix& matrix, const Transform* transform, NodeVisitor* nv) const = 0
+
+
virtual const bool computeWorldToLocalMatrix(Matrix& matrix, const Transform* transform, NodeVisitor* nv) const = 0
- Get the transformation matrix which moves from world coords to local coords
-
-
void setComputeTransformCallback(ComputeTransformCallback* ctc)
+
+
void setComputeTransformCallback(ComputeTransformCallback* ctc)
Set the ComputerTransfromCallback which allows users to attach custom computation of the local transformation as
seen by cull traversers and alike
-
-
ComputeTransformCallback* getComputeTransformCallback()
+
+
ComputeTransformCallback* getComputeTransformCallback()
Get the non const ComputerTransfromCallback
-
-
const ComputeTransformCallback* getComputeTransformCallback() const
+
+
const ComputeTransformCallback* getComputeTransformCallback() const
Get the const ComputerTransfromCallback
-
+
inline const bool getLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const
Get the transformation matrix which moves from local coords to world coords.
Return true if Matrix passed in has been modified and
-
+
inline const bool getWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const
Get the transformation matrix which moves from world coords to local coords.
Return true if Matrix passed in has been modified and
-
+
void setMatrix(const Matrix& mat)
Set the transform's matrix
-
+
inline const Matrix& getMatrix() const
Get the transform's matrix.
-
+
void preMult(const Matrix& mat)
preMult transform
-
+
void postMult(const Matrix& mat)
postMult transform
-
+
virtual ~Transform()
-
+
virtual const bool computeBound() const
Override's Group's computeBound.
There is no need to override in subclasses from osg::Transform since this computeBound() uses
the underlying matrix (calling computeMatrix if required.)
-
+
virtual const bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor*) const
-
+
virtual const bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor*) const
-
+
inline void computeInverse() const
-
-
-
Type _type
-
-
-
-
MatrixMode _mode
-
-
-
ref_ptr<ComputeTransformCallback> _computeTransformCallback
+
+
ref_ptr<ComputeTransformCallback> _computeTransformCallback
+
+
+
+
ReferenceFrame _referenceFrame
-
+
ref_ptr<Matrix> _matrix
-
+
mutable ref_ptr<Matrix> _inverse
-
+
mutable bool _inverseDirty
@@ -502,7 +314,7 @@ the underlying matrix (calling computeMatrix if required.)
PositionAttitudeTransform
-- Friends:
- struct osg::Transform::ComputeTransformCallback
Alphabetic index HTML hierarchy of classes or Java
+- Friends:
- struct osg::Transform::ComputeTransformCallback
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.