From 4649537b4bde2da54969fc044c052e1ce11fb849 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Thu, 29 Aug 2002 14:39:41 +0000 Subject: [PATCH] Added new autogenerated .html files --- doc/doc++/osg/AnimationPathCallback.2.html | 115 ++++ doc/doc++/osg/AnimationPathCallback.html | 114 ++++ doc/doc++/osg/ClearNode.html | 160 +++++ doc/doc++/osg/ConvexPlanarOccluder.html | 192 ++++++ doc/doc++/osg/ConvexPlanarPolygon.html | 66 ++ doc/doc++/osg/DOFTransform.html | 492 ++++++++++++++ doc/doc++/osg/OSGUTX_ADD_TESTCASE.html | 22 + doc/doc++/osg/OSGUTX_ADD_TESTSUITE.html | 22 + .../osg/OSGUTX_AUTOREGISTER_TESTSUITE.html | 20 + .../osg/OSGUTX_AUTOREGISTER_TESTSUITE_AT.html | 20 + doc/doc++/osg/OSGUTX_BEGIN_TESTSUITE.html | 22 + doc/doc++/osg/OSGUTX_END_TESTSUITE.html | 22 + doc/doc++/osg/OSGUTX_TESTSUITE.html | 20 + doc/doc++/osg/OSGUTX_TEST_E.html | 27 + doc/doc++/osg/OSGUTX_TEST_F.html | 27 + doc/doc++/osg/QualifiedTestPrinter.html | 65 ++ doc/doc++/osg/Sequence.html | 306 +++++++++ doc/doc++/osg/SubloadCallback.2.html | 73 ++ doc/doc++/osg/SubloadCallback.3.html | 73 ++ doc/doc++/osg/SubloadCallback.4.html | 73 ++ doc/doc++/osg/SubloadCallback.html | 73 ++ doc/doc++/osg/Test.html | 88 +++ doc/doc++/osg/TestCase.html | 93 +++ doc/doc++/osg/TestCase_.html | 97 +++ doc/doc++/osg/TestContext.html | 98 +++ doc/doc++/osg/TestErrorX.html | 60 ++ doc/doc++/osg/TestFailureX.html | 57 ++ doc/doc++/osg/TestGraph.html | 77 +++ doc/doc++/osg/TestQualifier.html | 79 +++ doc/doc++/osg/TestRecord.html | 87 +++ doc/doc++/osg/TestReport.html | 43 ++ doc/doc++/osg/TestRunner.html | 103 +++ doc/doc++/osg/TestSuite.html | 102 +++ .../osg/TestSuiteAutoRegistrationAgent.html | 37 + doc/doc++/osg/TestVisitor.html | 85 +++ doc/doc++/osg/TestX.html | 65 ++ doc/doc++/osg/TexEnvCombine.html | 633 ++++++++++++++++++ doc/doc++/osg/Texture1D.html | 433 ++++++++++++ doc/doc++/osg/Texture2D.html | 433 ++++++++++++ doc/doc++/osg/Texture3D.html | 433 ++++++++++++ doc/doc++/osg/TraceStream.html | 60 ++ doc/doc++/osg/isGLUExtensionSupported.html | 22 + doc/doc++/osg/osgUtx.html | 73 ++ doc/doc++/osgGA/CmdLineArgs.html | 97 +++ doc/doc++/osgUtil/MergeGeometryVisitor.html | 102 +++ 45 files changed, 5461 insertions(+) create mode 100644 doc/doc++/osg/AnimationPathCallback.2.html create mode 100644 doc/doc++/osg/AnimationPathCallback.html create mode 100644 doc/doc++/osg/ClearNode.html create mode 100644 doc/doc++/osg/ConvexPlanarOccluder.html create mode 100644 doc/doc++/osg/ConvexPlanarPolygon.html create mode 100644 doc/doc++/osg/DOFTransform.html create mode 100644 doc/doc++/osg/OSGUTX_ADD_TESTCASE.html create mode 100644 doc/doc++/osg/OSGUTX_ADD_TESTSUITE.html create mode 100644 doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE.html create mode 100644 doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE_AT.html create mode 100644 doc/doc++/osg/OSGUTX_BEGIN_TESTSUITE.html create mode 100644 doc/doc++/osg/OSGUTX_END_TESTSUITE.html create mode 100644 doc/doc++/osg/OSGUTX_TESTSUITE.html create mode 100644 doc/doc++/osg/OSGUTX_TEST_E.html create mode 100644 doc/doc++/osg/OSGUTX_TEST_F.html create mode 100644 doc/doc++/osg/QualifiedTestPrinter.html create mode 100644 doc/doc++/osg/Sequence.html create mode 100644 doc/doc++/osg/SubloadCallback.2.html create mode 100644 doc/doc++/osg/SubloadCallback.3.html create mode 100644 doc/doc++/osg/SubloadCallback.4.html create mode 100644 doc/doc++/osg/SubloadCallback.html create mode 100644 doc/doc++/osg/Test.html create mode 100644 doc/doc++/osg/TestCase.html create mode 100644 doc/doc++/osg/TestCase_.html create mode 100644 doc/doc++/osg/TestContext.html create mode 100644 doc/doc++/osg/TestErrorX.html create mode 100644 doc/doc++/osg/TestFailureX.html create mode 100644 doc/doc++/osg/TestGraph.html create mode 100644 doc/doc++/osg/TestQualifier.html create mode 100644 doc/doc++/osg/TestRecord.html create mode 100644 doc/doc++/osg/TestReport.html create mode 100644 doc/doc++/osg/TestRunner.html create mode 100644 doc/doc++/osg/TestSuite.html create mode 100644 doc/doc++/osg/TestSuiteAutoRegistrationAgent.html create mode 100644 doc/doc++/osg/TestVisitor.html create mode 100644 doc/doc++/osg/TestX.html create mode 100644 doc/doc++/osg/TexEnvCombine.html create mode 100644 doc/doc++/osg/Texture1D.html create mode 100644 doc/doc++/osg/Texture2D.html create mode 100644 doc/doc++/osg/Texture3D.html create mode 100644 doc/doc++/osg/TraceStream.html create mode 100644 doc/doc++/osg/isGLUExtensionSupported.html create mode 100644 doc/doc++/osg/osgUtx.html create mode 100644 doc/doc++/osgGA/CmdLineArgs.html create mode 100644 doc/doc++/osgUtil/MergeGeometryVisitor.html diff --git a/doc/doc++/osg/AnimationPathCallback.2.html b/doc/doc++/osg/AnimationPathCallback.2.html new file mode 100644 index 000000000..ee8f77c10 --- /dev/null +++ b/doc/doc++/osg/AnimationPathCallback.2.html @@ -0,0 +1,115 @@ + + + + + class SG_EXPORT osg::PositionAttitudeTransform::AnimationPathCallback + + + + +

class SG_EXPORT AnimationPathCallback

Callback which can be attached to a PositionAttitudeTransform as an app callback to allow it to follow the path defined by a AnimationPath
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]ref_ptr<AnimationPath> _animationPath +
+[more]double _firstTime +

+ +

+

Public Methods

+[more] AnimationPathCallback(AnimationPath* ap) +
+[more]virtual void operator()(Node* node, NodeVisitor* nv) +
implements the callback +

+ +
+

Inherited from NodeCallback:

+
+

+

Public Fields

+oref_ptr<NodeCallback> _nestedCallback +

+ +

+

Public Methods

+ovoid traverse(Node* node, NodeVisitor* nv) +
+ovoid setNestedCallback(NodeCallback* nc) +
+oNodeCallback* getNestedCallback() +
+oinline void addNestedCallback(NodeCallback* nc) +
+oinline void removeNestedCallback(NodeCallback* nc) +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Callback which can be attached to a PositionAttitudeTransform +as an app callback to allow it to follow the path defined by a +AnimationPath
+
+ + + +
o AnimationPathCallback(AnimationPath* ap) +

+ + +

ovirtual void operator()(Node* node, NodeVisitor* nv) +
implements the callback +

+ + +

oref_ptr<AnimationPath> _animationPath +

+ + +

odouble _firstTime +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/AnimationPathCallback.html b/doc/doc++/osg/AnimationPathCallback.html new file mode 100644 index 000000000..2fb863c76 --- /dev/null +++ b/doc/doc++/osg/AnimationPathCallback.html @@ -0,0 +1,114 @@ + + + + + class SG_EXPORT osg::MatrixTransform::AnimationPathCallback + + + + +

class SG_EXPORT AnimationPathCallback

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

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]ref_ptr<AnimationPath> _animationPath +
+[more]double _firstTime +

+ +

+

Public Methods

+[more] AnimationPathCallback(AnimationPath* ap) +
+[more]virtual void operator()(Node* node, NodeVisitor* nv) +
implements the callback +

+ +
+

Inherited from NodeCallback:

+
+

+

Public Fields

+oref_ptr<NodeCallback> _nestedCallback +

+ +

+

Public Methods

+ovoid traverse(Node* node, NodeVisitor* nv) +
+ovoid setNestedCallback(NodeCallback* nc) +
+oNodeCallback* getNestedCallback() +
+oinline void addNestedCallback(NodeCallback* nc) +
+oinline void removeNestedCallback(NodeCallback* nc) +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Callback which can be attached to a MatrixTransform as an app +callback to allow it to follow the path defined by a AnimationPath
+
+ + + +
o AnimationPathCallback(AnimationPath* ap) +

+ + +

ovirtual void operator()(Node* node, NodeVisitor* nv) +
implements the callback +

+ + +

oref_ptr<AnimationPath> _animationPath +

+ + +

odouble _firstTime +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ClearNode.html b/doc/doc++/osg/ClearNode.html new file mode 100644 index 000000000..5a4c0d34d --- /dev/null +++ b/doc/doc++/osg/ClearNode.html @@ -0,0 +1,160 @@ + + + + + class SG_EXPORT osg::ClearNode + + + + +

class SG_EXPORT osg::ClearNode

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

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ClearNode() +
+[more] ClearNode(const ClearNode& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] META_Node(osg, ClearNode) +
+[more]inline void setRequiresClear(const bool requiresClear) +
Sets the flag which control whether a glClear is required at the beginning of each frame. +
+[more]inline const bool getRequiresClear() const +
Gets the flag which control whether a glClear is required at the beginning of each frame. +
+[more]inline void setClearColor(const Vec4& color) +
Sets the clear color. +
+[more]inline const Vec4& getClearColor() const +
Returns the clear color. +

+ +

+

Protected Fields

+[more]bool _requiresClear +
+[more]Vec4 _clearColor +

+ +

+

Protected Methods

+[more]virtual ~ClearNode() +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual void traverse(NodeVisitor& nv) +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline const unsigned int getNumChildren() const +
+oinline Node* getChild( const unsigned int i ) +
+oinline const Node* getChild( const unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline ChildList::iterator findNode( const Node* node ) +
+oinline ChildList::const_iterator findNode( const Node* node ) const +

+ +

+

Protected Fields

+oChildList _children +

+ +

+

Protected Methods

+ovirtual const bool computeBound() const +

+ +
+ + +
+

Documentation

+
ClearNode is a Group node which controls the clearing of the color and depth +buffers at the start of each frame. +The earth sky by default is empty and simply holds the clear color of +the background. However, if the uses wants to add their own clearing of +the color and depth buffers then the children can be added, and the +background clear turned off. The ClearNode by default has StateSet attached +to it which sets the default ClearNode bin number to -1, so that all drawables +below it are placed in a separate bin from the rest of the scene graph, and +are rendered prior to standard opaque and transparent drawables.
+
+ + + +
o ClearNode() +

+ + +

o ClearNode(const ClearNode& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o META_Node(osg, ClearNode) +

+ + +

oinline void setRequiresClear(const bool requiresClear) +
Sets the flag which control whether a glClear is required at the beginning of each frame. +

+ + +

oinline const bool getRequiresClear() const +
Gets the flag which control whether a glClear is required at the beginning of each frame. +

+ + +

oinline void setClearColor(const Vec4& color) +
Sets the clear color. +

+ + +

oinline const Vec4& getClearColor() const +
Returns the clear color. +

+ + +

ovirtual ~ClearNode() +

+ + +

obool _requiresClear +

+ + +

oVec4 _clearColor +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ConvexPlanarOccluder.html b/doc/doc++/osg/ConvexPlanarOccluder.html new file mode 100644 index 000000000..99d85f03b --- /dev/null +++ b/doc/doc++/osg/ConvexPlanarOccluder.html @@ -0,0 +1,192 @@ + + + + + class SG_EXPORT osg::ConvexPlanarOccluder + + + + +

class SG_EXPORT osg::ConvexPlanarOccluder

A class for representing convex clipping volumes made up.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ConvexPlanarOccluder() +
+[more] ConvexPlanarOccluder(const ConvexPlanarOccluder& cpo, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]META_Object (osg, ConvexPlanarOccluder)(const ConvexPlanarPolygon& cpp) +
+[more]ConvexPlanarPolygon& getOccluder() +
+[more]const ConvexPlanarPolygon& getOccluder() const +
+[more]typedef std::vector<ConvexPlanarPolygon> HoleList void addHole(const ConvexPlanarPolygon& cpp) +
+[more]HoleList& getHoleList() +
+[more]const HoleList& getHoleList() const +
+[more]void computeAttributes() +
+[more]void computeBound(BoundingBox& bb) const +
+[more]void computeBound(BoundingSphere& bs) const +

+ +

+

Protected Fields

+[more]ConvexPlanarPolygon _occluder +
+[more]HoleList _holeList +

+ +

+

Protected Methods

+[more] ~ConvexPlanarOccluder() +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object*) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+oinline void setDataVariance(const DataVariance dv) +
+oinline const DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
A class for representing convex clipping volumes made up. +When adding planes, their normals should point inwards (into the volume)
+
+ + + +
o ConvexPlanarOccluder() +

+ + +

o ConvexPlanarOccluder(const ConvexPlanarOccluder& cpo, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

oMETA_Object (osg, ConvexPlanarOccluder)(const ConvexPlanarPolygon& cpp) +

+ + +

oConvexPlanarPolygon& getOccluder() +

+ + +

oconst ConvexPlanarPolygon& getOccluder() const +

+ + +

otypedef std::vector<ConvexPlanarPolygon> HoleList void addHole(const ConvexPlanarPolygon& cpp) +

+ + +

oHoleList& getHoleList() +

+ + +

oconst HoleList& getHoleList() const +

+ + +

ovoid computeAttributes() +

+ + +

ovoid computeBound(BoundingBox& bb) const +

+ + +

ovoid computeBound(BoundingSphere& bs) const +

+ + +

o ~ConvexPlanarOccluder() +

+ + +

oConvexPlanarPolygon _occluder +

+ + +

oHoleList _holeList +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ConvexPlanarPolygon.html b/doc/doc++/osg/ConvexPlanarPolygon.html new file mode 100644 index 000000000..2f0ef2e92 --- /dev/null +++ b/doc/doc++/osg/ConvexPlanarPolygon.html @@ -0,0 +1,66 @@ + + + + + class SG_EXPORT osg::ConvexPlanarPolygon + + + + +

class SG_EXPORT osg::ConvexPlanarPolygon

A class for representing convex clipping volumes made up.
+
+ +
+

+

Public Methods

+[more] ConvexPlanarPolygon() +
+[more]typedef std::vector<osg::Vec3> VertexList void add(const Vec3& v) +
+[more]VertexList& getVertexList() +
+[more]const VertexList& getVertexList() const +

+ +

+

Protected Fields

+[more]VertexList _vertexList +

+ +
+ + +
+

Documentation

+
A class for representing convex clipping volumes made up. +When adding planes, their normals should point inwards (into the volume)
+
+ + + +
o ConvexPlanarPolygon() +

+ + +

otypedef std::vector<osg::Vec3> VertexList void add(const Vec3& v) +

+ + +

oVertexList& getVertexList() +

+ + +

oconst VertexList& getVertexList() const +

+ + +

oVertexList _vertexList +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/DOFTransform.html b/doc/doc++/osg/DOFTransform.html new file mode 100644 index 000000000..166fdc502 --- /dev/null +++ b/doc/doc++/osg/DOFTransform.html @@ -0,0 +1,492 @@ + + + + + class SG_EXPORT osg::DOFTransform + + + + +

class SG_EXPORT osg::DOFTransform

DOFTransform - encapsulates Multigen DOF behavior
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DOFTransform() +
constructor +
+[more] DOFTransform(const DOFTransform& dof, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
copy constructor +
+[more] META_Node(osg, DOFTransform) +
+[more]virtual void traverse(NodeVisitor& nv) +
+[more]void setMinHPR(const Vec3& hpr) +
+[more]const Vec3& getMinHPR() const +
+[more]void setMaxHPR(const Vec3& hpr) +
+[more]const Vec3& getMaxHPR() const +
+[more]void setIncrementHPR(const Vec3& hpr) +
+[more]const Vec3& getIncrementHPR() const +
+[more]void setCurrentHPR(const Vec3& hpr) +
+[more]const Vec3& getCurrentHPR() const +
+[more]void updateCurrentHPR(const Vec3& hpr) +
+[more]void setMinTranslate(const Vec3& translate) +
+[more]const Vec3& getMinTranslate() const +
+[more]void setMaxTranslate(const Vec3& translate) +
+[more]const Vec3& getMaxTranslate() const +
+[more]void setIncrementTranslate(const Vec3& translate) +
+[more]const Vec3& getIncrementTranslate() const +
+[more]void setCurrentTranslate(const Vec3& translate) +
+[more]inline const Vec3& getCurrentTranslate() const +
+[more]void updateCurrentTranslate(const Vec3& translate) +
+[more]void setMinScale(const Vec3& scale) +
+[more]const Vec3& getMinScale() const +
+[more]void setMaxScale(const Vec3& scale) +
+[more]const Vec3& getMaxScale() const +
+[more]void setIncrementScale(const Vec3& scale) +
+[more]const Vec3& getIncrementScale() const +
+[more]void setCurrentScale(const Vec3& scale) +
+[more]inline const Vec3& getCurrentScale() const +
+[more]void updateCurrentScale(const Vec3& scale) +
+[more]void setPutMatrix(const Matrix& put) +
+[more]inline const Matrix& getPutMatrix() const +
+[more]void setInversePutMatrix(const Matrix& inversePut) +
+[more]inline const Matrix& getInversePutMatrix() const +
+[more]void setLimitationFlags(unsigned long flags) +
+[more]inline unsigned long getLimitationFlags() const +
+[more]inline void setAnimationOn(bool do_animate) +
+[more]inline bool getAnimationOn() const +
+[more]void animate() +
+[more]virtual const bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +
+[more]virtual const bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ +

+

Protected Fields

+[more]Vec3 _minHPR +
+[more]Vec3 _maxHPR +
+[more]Vec3 _currentHPR +
+[more]Vec3 _incrementHPR +
+[more]Vec3 _minTranslate +
+[more]Vec3 _maxTranslate +
+[more]Vec3 _currentTranslate +
+[more]Vec3 _incrementTranslate +
+[more]Vec3 _minScale +
+[more]Vec3 _maxScale +
+[more]Vec3 _currentScale +
+[more]Vec3 _incrementScale +
+[more]Matrix _Put +
+[more]Matrix _inversePut +
+[more]unsigned long _limitationFlags +
+[more]bool _animationOn +
+[more]unsigned short _increasingFlags +
flags indicating whether value is incerasing or decreasing in animation bits form right to left, 1 means increasing while 0 is decreasing 0 = x translation 1 = y translation 2 = z translation 3 = pitch 4 = roll 5 = yaw 6 = x scale 7 = y scale 8 = z scale +

+ +

+

Protected Methods

+[more]virtual ~DOFTransform() +

+ +
+

Inherited from Transform:

+
+

+

Public Methods

+ovoid setReferenceFrame(ReferenceFrame rf) +
+oconst ReferenceFrame getReferenceFrame() const +
+ovoid setComputeTransformCallback(ComputeTransformCallback* ctc) +
+oComputeTransformCallback* getComputeTransformCallback() +
+oconst ComputeTransformCallback* getComputeTransformCallback() const +
+oinline const bool getLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +
+oinline const bool getWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ +

+

Public Members

+oenum ReferenceFrame +
+ostruct ComputeTransformCallback: public osg::Referenced +

+ +

+

Protected Fields

+oref_ptr<ComputeTransformCallback> _computeTransformCallback +
+oReferenceFrame _referenceFrame +

+ +

+

Protected Methods

+ovirtual const bool computeBound() const +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline const unsigned int getNumChildren() const +
+oinline Node* getChild( const unsigned int i ) +
+oinline const Node* getChild( const unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline ChildList::iterator findNode( const Node* node ) +
+oinline ChildList::const_iterator findNode( const Node* node ) const +

+ +

+

Protected Fields

+oChildList _children +

+ +
+ + +
+

Documentation

+
DOFTransform - encapsulates Multigen DOF behavior
+
+ + + +
o DOFTransform() +
constructor +

+ + +

o DOFTransform(const DOFTransform& dof, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
copy constructor +

+ + +

o META_Node(osg, DOFTransform) +

+ + +

ovirtual void traverse(NodeVisitor& nv) +

+ + +

ovoid setMinHPR(const Vec3& hpr) +

+ + +

oconst Vec3& getMinHPR() const +

+ + +

ovoid setMaxHPR(const Vec3& hpr) +

+ + +

oconst Vec3& getMaxHPR() const +

+ + +

ovoid setIncrementHPR(const Vec3& hpr) +

+ + +

oconst Vec3& getIncrementHPR() const +

+ + +

ovoid setCurrentHPR(const Vec3& hpr) +

+ + +

oconst Vec3& getCurrentHPR() const +

+ + +

ovoid updateCurrentHPR(const Vec3& hpr) +

+ + +

ovoid setMinTranslate(const Vec3& translate) +

+ + +

oconst Vec3& getMinTranslate() const +

+ + +

ovoid setMaxTranslate(const Vec3& translate) +

+ + +

oconst Vec3& getMaxTranslate() const +

+ + +

ovoid setIncrementTranslate(const Vec3& translate) +

+ + +

oconst Vec3& getIncrementTranslate() const +

+ + +

ovoid setCurrentTranslate(const Vec3& translate) +

+ + +

oinline const Vec3& getCurrentTranslate() const +

+ + +

ovoid updateCurrentTranslate(const Vec3& translate) +

+ + +

ovoid setMinScale(const Vec3& scale) +

+ + +

oconst Vec3& getMinScale() const +

+ + +

ovoid setMaxScale(const Vec3& scale) +

+ + +

oconst Vec3& getMaxScale() const +

+ + +

ovoid setIncrementScale(const Vec3& scale) +

+ + +

oconst Vec3& getIncrementScale() const +

+ + +

ovoid setCurrentScale(const Vec3& scale) +

+ + +

oinline const Vec3& getCurrentScale() const +

+ + +

ovoid updateCurrentScale(const Vec3& scale) +

+ + +

ovoid setPutMatrix(const Matrix& put) +

+ + +

oinline const Matrix& getPutMatrix() const +

+ + +

ovoid setInversePutMatrix(const Matrix& inversePut) +

+ + +

oinline const Matrix& getInversePutMatrix() const +

+ + +

ovoid setLimitationFlags(unsigned long flags) +

+ + +

oinline unsigned long getLimitationFlags() const +

+ + +

oinline void setAnimationOn(bool do_animate) +

+ + +

oinline bool getAnimationOn() const +

+ + +

ovoid animate() +

+ + +

ovirtual const bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ + +

ovirtual const bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ + +

ovirtual ~DOFTransform() +

+ + +

oVec3 _minHPR +

+ + +

oVec3 _maxHPR +

+ + +

oVec3 _currentHPR +

+ + +

oVec3 _incrementHPR +

+ + +

oVec3 _minTranslate +

+ + +

oVec3 _maxTranslate +

+ + +

oVec3 _currentTranslate +

+ + +

oVec3 _incrementTranslate +

+ + +

oVec3 _minScale +

+ + +

oVec3 _maxScale +

+ + +

oVec3 _currentScale +

+ + +

oVec3 _incrementScale +

+ + +

oMatrix _Put +

+ + +

oMatrix _inversePut +

+ + +

ounsigned long _limitationFlags +

+ + +

obool _animationOn +

+ + +

ounsigned short _increasingFlags +
flags indicating whether value is incerasing or decreasing in animation +bits form right to left, 1 means increasing while 0 is decreasing +0 = x translation +1 = y translation +2 = z translation +3 = pitch +4 = roll +5 = yaw +6 = x scale +7 = y scale +8 = z scale +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_ADD_TESTCASE.html b/doc/doc++/osg/OSGUTX_ADD_TESTCASE.html new file mode 100644 index 000000000..9cc661df9 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_ADD_TESTCASE.html @@ -0,0 +1,22 @@ + + + + + #define OSGUTX_ADD_TESTCASE + + + + +

#define OSGUTX_ADD_TESTCASE

( tfixture, tmethod )

Adds a test case to a suite object being created in a TestSuite singleton function.
+ + +
+

Documentation

+
+Adds a test case to a suite object being created in a TestSuite singleton function. +
+
See Also:
OSGUTX_BEGIN_TESTSUITE, OSGUTX_END_TESTSUITE

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_ADD_TESTSUITE.html b/doc/doc++/osg/OSGUTX_ADD_TESTSUITE.html new file mode 100644 index 000000000..38e3e04b8 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_ADD_TESTSUITE.html @@ -0,0 +1,22 @@ + + + + + #define OSGUTX_ADD_TESTSUITE + + + + +

#define OSGUTX_ADD_TESTSUITE

( childSuite )

Adds a suite to a suite - allows composition of test suites.
+ + +
+

Documentation

+
+Adds a suite to a suite - allows composition of test suites. +
+
See Also:
OSGUTX_BEGIN_TESTSUITE, OSGUTX_END_TESTSUITE

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE.html b/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE.html new file mode 100644 index 000000000..d87af0fd7 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE.html @@ -0,0 +1,20 @@ + + + + + #define OSGUTX_AUTOREGISTER_TESTSUITE + + + + +

#define OSGUTX_AUTOREGISTER_TESTSUITE

( tsuite )

Autoregister a testsuite with the root suite at startup
+ + +
+

Documentation

+
Autoregister a testsuite with the root suite at startup
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE_AT.html b/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE_AT.html new file mode 100644 index 000000000..c9dea2859 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE_AT.html @@ -0,0 +1,20 @@ + + + + + #define OSGUTX_AUTOREGISTER_TESTSUITE_AT + + + + +

#define OSGUTX_AUTOREGISTER_TESTSUITE_AT

( tsuite , path )

Auto register a testsuite with at designated point in the suite graph at startup
+ + +
+

Documentation

+
Auto register a testsuite with at designated point in the suite graph at startup
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_BEGIN_TESTSUITE.html b/doc/doc++/osg/OSGUTX_BEGIN_TESTSUITE.html new file mode 100644 index 000000000..aea23f523 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_BEGIN_TESTSUITE.html @@ -0,0 +1,22 @@ + + + + + #define OSGUTX_BEGIN_TESTSUITE + + + + +

#define OSGUTX_BEGIN_TESTSUITE

( tsuite )

Starts a TestSuite singleton function
+ + +
+

Documentation

+
+Starts a TestSuite singleton function +
+
See Also:
OSGUTX_ADD_TESTCASE, OSGUTX_END_TESTSUITE

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_END_TESTSUITE.html b/doc/doc++/osg/OSGUTX_END_TESTSUITE.html new file mode 100644 index 000000000..6df20c99b --- /dev/null +++ b/doc/doc++/osg/OSGUTX_END_TESTSUITE.html @@ -0,0 +1,22 @@ + + + + + #define OSGUTX_END_TESTSUITE + + + + +

#define OSGUTX_END_TESTSUITE

()

Ends a TestSuite singleton function
+ + +
+

Documentation

+
+Ends a TestSuite singleton function +
+
See Also:
OSGUTX_BEGIN_TESTSUITE, OSGUTX_ADD_TESTCASE

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_TESTSUITE.html b/doc/doc++/osg/OSGUTX_TESTSUITE.html new file mode 100644 index 000000000..45b7ce9ff --- /dev/null +++ b/doc/doc++/osg/OSGUTX_TESTSUITE.html @@ -0,0 +1,20 @@ + + + + + #define OSGUTX_TESTSUITE + + + + +

#define OSGUTX_TESTSUITE

( tsuite )

Define a TestSuite accessor
+ + +
+

Documentation

+
Define a TestSuite accessor
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_TEST_E.html b/doc/doc++/osg/OSGUTX_TEST_E.html new file mode 100644 index 000000000..c1303681a --- /dev/null +++ b/doc/doc++/osg/OSGUTX_TEST_E.html @@ -0,0 +1,27 @@ + + + + + #define OSGUTX_TEST_E + + + + +

#define OSGUTX_TEST_E

( expr )

OSGUTX_TEST_E is a convenience macro, analogous to assert(), which will throw an osgUtx::TestErrorX if \em expr evaluates to false; this should be used to test for an error in a given test, as opposed to a failure in the tested code.
+ + +
+

Documentation

+
+OSGUTX_TEST_E is a convenience macro, analogous to assert(), which will +throw an osgUtx::TestErrorX if \em expr evaluates to false; this should be +used to test for an error in a given test, as opposed to a failure +in the tested code. + +

The exception will indicate the file and line number of the failed expression, +along with expression itself.

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_TEST_F.html b/doc/doc++/osg/OSGUTX_TEST_F.html new file mode 100644 index 000000000..d5569116c --- /dev/null +++ b/doc/doc++/osg/OSGUTX_TEST_F.html @@ -0,0 +1,27 @@ + + + + + #define OSGUTX_TEST_F + + + + +

#define OSGUTX_TEST_F

( expr )

OSGUTX_TEST_F is a convenience macro, analogous to assert(), which will throw an osgUtx::TestFailureX if \em expr evaluates to false; this should be used to test for failure in a given test, as opposed to an actual error in the test owing to some other reason than the tested code being faulty.
+ + +
+

Documentation

+
+OSGUTX_TEST_F is a convenience macro, analogous to assert(), which will +throw an osgUtx::TestFailureX if \em expr evaluates to false; this should be +used to test for failure in a given test, as opposed to an actual error +in the test owing to some other reason than the tested code being faulty. + +

The exception will indicate the file and line number of the failed expression, +along with expression itself.

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/QualifiedTestPrinter.html b/doc/doc++/osg/QualifiedTestPrinter.html new file mode 100644 index 000000000..ba1f7c2a9 --- /dev/null +++ b/doc/doc++/osg/QualifiedTestPrinter.html @@ -0,0 +1,65 @@ + + + + + class SG_EXPORT osgUtx::QualifiedTestPrinter + + + + +

class SG_EXPORT osgUtx::QualifiedTestPrinter

QualifiedTestPrinter prints to standard output a list of fully qualified tests
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual bool visit( TestCase* pTest ) +

+ +
+

Inherited from TestQualifier:

+
+

+

Public Methods

+ovirtual bool visitEnter( TestSuite* pSuite ) +
+ovirtual bool visitLeave( TestSuite* pSuite ) +
+oconst std::string& currentPath() const +

+ +
+

Inherited from TestVisitor:

+
+
+ + +
+

Documentation

+
+QualifiedTestPrinter prints to standard output a list of fully +qualified tests
+
+ + + +
ovirtual bool visit( TestCase* pTest ) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Sequence.html b/doc/doc++/osg/Sequence.html new file mode 100644 index 000000000..c94ee94b3 --- /dev/null +++ b/doc/doc++/osg/Sequence.html @@ -0,0 +1,306 @@ + + + + + class SG_EXPORT osg::Sequence + + + + +

class SG_EXPORT osg::Sequence

Sequence is a Group node which allows automatic, time based switching between children
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Sequence() +
+[more] Sequence(const Sequence&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_Node(osg, Sequence) +
+[more]virtual void traverse(NodeVisitor& nv) +
+[more]void setTime(int frame, float t) +
Set time in seconds for child +
+[more]const float getTime(int frame) const +
Get time for child +
+[more]void setInterval(LoopMode mode, int begin, int end) +
Set sequence mode & interval. +
+[more]inline void getInterval(LoopMode& mode, int& begin, int& end) const +
Get sequence mode & interval. +
+[more]void setDuration(float speed, int nreps = -1) +
Set duration: speed-up & number of repeats +
+[more]inline void getDuration(float& speed, int& nreps) const +
Get duration +
+[more]void setMode(SequenceMode mode) +
Set sequence mode. +
+[more]inline SequenceMode getMode() const +
Get sequence mode. +

+ +

+

Public Members

+[more]enum LoopMode +
Interval modes +
+[more]enum SequenceMode +
Sequence modes +

+ +

+

Protected Fields

+[more]float _last +
+[more]std::vector<float> _frameTime +
+[more]int _step +
+[more]LoopMode _loopMode +
+[more]int _begin +
+[more]int _end +
+[more]float _speed +
+[more]int _nreps +
+[more]int _nrepsremain +
+[more]SequenceMode _mode +

+ +

+

Protected Methods

+[more]virtual ~Sequence() +

+ +
+

Inherited from Switch:

+
+

+

Public Methods

+oinline void setValue(const int value) +
+oinline const int getValue() const +

+ +

+

Public Members

+oenum SwitchType +

+ +

+

Protected Fields

+oint _value +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline const unsigned int getNumChildren() const +
+oinline Node* getChild( const unsigned int i ) +
+oinline const Node* getChild( const unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline ChildList::iterator findNode( const Node* node ) +
+oinline ChildList::const_iterator findNode( const Node* node ) const +

+ +

+

Protected Fields

+oChildList _children +

+ +

+

Protected Methods

+ovirtual const bool computeBound() const +

+ +
+ + +
+

Documentation

+
Sequence is a Group node which allows automatic, time based +switching between children
+
+ + + +
o Sequence() +

+ + +

o Sequence(const Sequence&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_Node(osg, Sequence) +

+ + +

ovirtual void traverse(NodeVisitor& nv) +

+ + +

ovoid setTime(int frame, float t) +
Set time in seconds for child +

+ + +

oconst float getTime(int frame) const +
Get time for child +

+ + +

oenum LoopMode +
Interval modes +

+ + + +
o LOOP +

+ + +

o SWING +

+ + + +
ovoid setInterval(LoopMode mode, int begin, int end) +
Set sequence mode & interval. +

+ + +

oinline void getInterval(LoopMode& mode, int& begin, int& end) const +
Get sequence mode & interval. +

+ + +

ovoid setDuration(float speed, int nreps = -1) +
Set duration: speed-up & number of repeats +

+ + +

oinline void getDuration(float& speed, int& nreps) const +
Get duration +

+ + +

oenum SequenceMode +
Sequence modes +

+ + + +
o START +

+ + +

o STOP +

+ + +

o PAUSE +

+ + +

o RESUME +

+ + + +
ovoid setMode(SequenceMode mode) +
Set sequence mode. Start/stop & pause/resume. +

+ + +

oinline SequenceMode getMode() const +
Get sequence mode. +

+ + +

ovirtual ~Sequence() +

+ + +

ofloat _last +

+ + +

ostd::vector<float> _frameTime +

+ + +

oint _step +

+ + +

oLoopMode _loopMode +

+ + +

oint _begin +

+ + +

oint _end +

+ + +

ofloat _speed +

+ + +

oint _nreps +

+ + +

oint _nrepsremain +

+ + +

oSequenceMode _mode +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/SubloadCallback.2.html b/doc/doc++/osg/SubloadCallback.2.html new file mode 100644 index 000000000..b3dab3f26 --- /dev/null +++ b/doc/doc++/osg/SubloadCallback.2.html @@ -0,0 +1,73 @@ + + + + + class osg::Texture2D::SubloadCallback + + + + +

class SubloadCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void load(const Texture2D& texture, State& state) const = 0 +
+[more]virtual void subload(const Texture2D& texture, State& state) const = 0 +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual void load(const Texture2D& texture, State& state) const = 0 +

+ + +

ovirtual void subload(const Texture2D& texture, State& state) const = 0 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/SubloadCallback.3.html b/doc/doc++/osg/SubloadCallback.3.html new file mode 100644 index 000000000..32e0fbf75 --- /dev/null +++ b/doc/doc++/osg/SubloadCallback.3.html @@ -0,0 +1,73 @@ + + + + + class osg::Texture3D::SubloadCallback + + + + +

class SubloadCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void load(const Texture3D& texture, State& state) const = 0 +
+[more]virtual void subload(const Texture3D& texture, State& state) const = 0 +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual void load(const Texture3D& texture, State& state) const = 0 +

+ + +

ovirtual void subload(const Texture3D& texture, State& state) const = 0 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/SubloadCallback.4.html b/doc/doc++/osg/SubloadCallback.4.html new file mode 100644 index 000000000..b417b02b9 --- /dev/null +++ b/doc/doc++/osg/SubloadCallback.4.html @@ -0,0 +1,73 @@ + + + + + class osg::TextureCubeMap::SubloadCallback + + + + +

class SubloadCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void load(const TextureCubeMap& texture, State& state) const = 0 +
+[more]virtual void subload(const TextureCubeMap& texture, State& state) const = 0 +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual void load(const TextureCubeMap& texture, State& state) const = 0 +

+ + +

ovirtual void subload(const TextureCubeMap& texture, State& state) const = 0 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/SubloadCallback.html b/doc/doc++/osg/SubloadCallback.html new file mode 100644 index 000000000..3421d3b9a --- /dev/null +++ b/doc/doc++/osg/SubloadCallback.html @@ -0,0 +1,73 @@ + + + + + class osg::Texture1D::SubloadCallback + + + + +

class SubloadCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void load(const Texture1D& texture, State& state) const = 0 +
+[more]virtual void subload(const Texture1D& texture, State& state) const = 0 +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual void load(const Texture1D& texture, State& state) const = 0 +

+ + +

ovirtual void subload(const Texture1D& texture, State& state) const = 0 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Test.html b/doc/doc++/osg/Test.html new file mode 100644 index 000000000..0652a1cf3 --- /dev/null +++ b/doc/doc++/osg/Test.html @@ -0,0 +1,88 @@ + + + + + class SG_EXPORT osgUtx::Test + + + + +

class SG_EXPORT osgUtx::Test

Test, an abstract base class, is the Composite pattern's \em component class for our graph of test cases, and defines the basic interface for all Test components.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]typedef TestVisitor Visitor Test( const std::string& sName ) +
+[more]const std::string& name() const +
+[more]virtual bool accept( Visitor& ) = 0 +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+Test, an abstract base class, is the Composite pattern's \em component +class for our graph of test cases, and defines the basic interface +for all Test components. It is a referent, and may be pointed +to by an osg::ref_ptr.
+
+ + + +
otypedef TestVisitor Visitor Test( const std::string& sName ) +

+ + +

oconst std::string& name() const +

+ + +

ovirtual bool accept( Visitor& ) = 0 +

+
+
Direct child classes: +
TestSuite
+TestCase
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestCase.html b/doc/doc++/osg/TestCase.html new file mode 100644 index 000000000..2d94ca176 --- /dev/null +++ b/doc/doc++/osg/TestCase.html @@ -0,0 +1,93 @@ + + + + + class osgUtx::TestCase + + + + +

class osgUtx::TestCase

TestCase, is the supplies the interface for a Composite pattern's \em leaf class, though it is not a leaf in itself
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]typedef TestContext Context TestCase( const std::string& sName ) +
+[more]virtual bool accept( Visitor& v ) +
+[more]virtual void run( const Context& ) = 0 +

+ +
+

Inherited from Test:

+
+

+

Public Methods

+oconst std::string& name() const +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+TestCase, is the supplies the interface for a Composite pattern's +\em leaf class, though it is not a leaf in itself
+
+ + + +
otypedef TestContext Context TestCase( const std::string& sName ) +

+ + +

ovirtual bool accept( Visitor& v ) +

+ + +

ovirtual void run( const Context& ) = 0 +

+
+
Direct child classes: +
TestCase_
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestCase_.html b/doc/doc++/osg/TestCase_.html new file mode 100644 index 000000000..bfd0b8f76 --- /dev/null +++ b/doc/doc++/osg/TestCase_.html @@ -0,0 +1,97 @@ + + + + + template< typename FixtureT > class osgUtx::TestCase_ + + + + +

template< typename FixtureT > class osgUtx::TestCase_

TestCase_ is a class template for a leaf TestCase, which allows TestFixture classes to be easily collected into the tree of tests, and have their public test methods called.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestCase_( const std::string& sName, TestMethodPtr pTestMethod ) +
+[more]virtual void run( const Context& ctx ) +

+ +
+

Inherited from TestCase:

+
+

+

Public Methods

+ovirtual bool accept( Visitor& v ) +

+ +
+

Inherited from Test:

+
+

+

Public Methods

+oconst std::string& name() const +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+TestCase_ is a class template for a leaf TestCase, which allows TestFixture +classes to be easily collected into the tree of tests, and have their public +test methods called. It is worth noting that, for a given TestCase_, an +instance of the test fixture class will be constructed pior to the +test method being called, and destructed afterwards. This prevents 'leakage' +of information from one test case to the next.
+
+ + + +
o TestCase_( const std::string& sName, TestMethodPtr pTestMethod ) +

+ + +

ovirtual void run( const Context& ctx ) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestContext.html b/doc/doc++/osg/TestContext.html new file mode 100644 index 000000000..8aaf85e76 --- /dev/null +++ b/doc/doc++/osg/TestContext.html @@ -0,0 +1,98 @@ + + + + + class SG_EXPORT osgUtx::TestContext + + + + +

class SG_EXPORT osgUtx::TestContext

TestContext wraps up information which is passed to tests as they are run, and may contain test-specific information or 'global' test objects, such as an output stream for verbose output during the running of tests.
+
+ +
+

+

Public Methods

+[more] TestContext() +
+[more]bool shouldStop() +
+[more]bool isVerbose() +
+[more]void setTraceLevel(TraceLevel tl) +
+[more]TraceLevel getTraceLevel() const +
+[more]std::ostream& tout(TraceLevel tl=Full) const +

+ +

+

Public Members

+[more]enum TraceLevel +

+ +
+ + +
+

Documentation

+
+TestContext wraps up information which is passed to tests as they are run, +and may contain test-specific information or 'global' test objects, such +as an output stream for verbose output during the running of tests. + +

\todo Improve the output stream code by providing a filtering stream.

+
+ + + +
o TestContext() +

+ + +

obool shouldStop() +

+ + +

obool isVerbose() +

+ + +

oenum TraceLevel +

+ + + +
o Off +

+ + +

o Results +
< All tracing turned off +

+ + +

o Full +
< Output results only +

+ + + +
ovoid setTraceLevel(TraceLevel tl) +

+ + +

oTraceLevel getTraceLevel() const +

+ + +

ostd::ostream& tout(TraceLevel tl=Full) const +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestErrorX.html b/doc/doc++/osg/TestErrorX.html new file mode 100644 index 000000000..60362fb1a --- /dev/null +++ b/doc/doc++/osg/TestErrorX.html @@ -0,0 +1,60 @@ + + + + + class osgUtx::TestErrorX + + + + +

class osgUtx::TestErrorX

A TestErrorX indicates an error while testing a component, which prevents the test from being run; it does not indicate a problem with the component, but rather a problem during the run which prevents the component from being tested
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestErrorX(const std::string& s) +

+ +
+

Inherited from TestX:

+
+

+

Public Methods

+oconst std::string& what() const +

+ +
+ + +
+

Documentation

+
+A TestErrorX indicates an error while testing a component, +which prevents the test from being run; it does not indicate +a problem with the component, but rather a problem during the +run which prevents the component from being tested
+
+ + + +
o TestErrorX(const std::string& s) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestFailureX.html b/doc/doc++/osg/TestFailureX.html new file mode 100644 index 000000000..7f6fde8a3 --- /dev/null +++ b/doc/doc++/osg/TestFailureX.html @@ -0,0 +1,57 @@ + + + + + class osgUtx::TestFailureX + + + + +

class osgUtx::TestFailureX

A TestFailureX indicates a failure in the tested component
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestFailureX(const std::string& s) +

+ +
+

Inherited from TestX:

+
+

+

Public Methods

+oconst std::string& what() const +

+ +
+ + +
+

Documentation

+
+A TestFailureX indicates a failure in the tested component
+
+ + + +
o TestFailureX(const std::string& s) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestGraph.html b/doc/doc++/osg/TestGraph.html new file mode 100644 index 000000000..97d0795d4 --- /dev/null +++ b/doc/doc++/osg/TestGraph.html @@ -0,0 +1,77 @@ + + + + + class SG_EXPORT osgUtx::TestGraph + + + + +

class SG_EXPORT osgUtx::TestGraph

TestGraph is a singleton providing central access to the tree of tests; primarily, it provides access to the root suite
+
+ +
+

+

Public Methods

+[more]static TestGraph& instance() +
+[more]TestSuite* root() +
+
+[more]TestSuite* suite(const std::string& path, TestSuite* tsuite = 0, bool createIfNecessary = false) +
A utility function for accessing an arbitrary quite by pathname, relative to the suite 'tsuite' (defaults to root if null), and with the option of creating the \em TestSuite designated by \em path, if it does not already exist. +

+ +
+ + +
+

Documentation

+
+TestGraph is a singleton providing central access to the tree of tests; +primarily, it provides access to the root suite
+
+ + + +
ostatic TestGraph& instance() +

+ + +

oTestSuite* root() +
+ +
Returns:
a pointer to the root TestSuite.

+ + +

oTestSuite* suite(const std::string& path, TestSuite* tsuite = 0, bool createIfNecessary = false) +
+A utility function for accessing an arbitrary quite by pathname, relative to +the suite 'tsuite' (defaults to root if null), and with the option of creating +the \em TestSuite designated by \em path, if it does not already exist. + +

This method may return 0 if the suite either cannot be found (and createIfNecssary +is 0), or the first component of \em path is not the same as the name of the +TestSuite \em tsuite. + +

This was written to aid the auto-registration of tests at specific points in +the test tree, where the tests' AutoRegistrationAgents may be distributed across +several files, and cannot be guaranteed to run in a given order. E.g. You cannot +register a test "root.osg.MyTest" unless you know that the the suite "root.osg" +already exists. + +

+ +

Parameters:
path - The name of the TestSuite to return. +
tsuite - The suite to 'start from'. Path is relative to this +suite (defaults to root suite). +
createIfNecessary - Optionally create the TestSuite(s) denoted by path if +they do not exist.

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestQualifier.html b/doc/doc++/osg/TestQualifier.html new file mode 100644 index 000000000..326a31f43 --- /dev/null +++ b/doc/doc++/osg/TestQualifier.html @@ -0,0 +1,79 @@ + + + + + class SG_EXPORT osgUtx::TestQualifier + + + + +

class SG_EXPORT osgUtx::TestQualifier

Maintains a string that when accessed in the "visit" member, returns the current qualified TestSuite path
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual bool visitEnter( TestSuite* pSuite ) +
+[more]virtual bool visitLeave( TestSuite* pSuite ) +
+[more]const std::string& currentPath() const +

+ +
+

Inherited from TestVisitor:

+
+

+

Public Methods

+ovirtual bool visit( TestCase* ) +

+ +
+ + +
+

Documentation

+
+Maintains a string that when accessed in the "visit" member, returns the +current qualified TestSuite path
+
+
+ + + +
o SEPCHAR +

+ + + +
ovirtual bool visitEnter( TestSuite* pSuite ) +

+ + +

ovirtual bool visitLeave( TestSuite* pSuite ) +

+ + +

oconst std::string& currentPath() const +

+
+
Direct child classes: +
TestRunner
+QualifiedTestPrinter
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestRecord.html b/doc/doc++/osg/TestRecord.html new file mode 100644 index 000000000..4cc18a42d --- /dev/null +++ b/doc/doc++/osg/TestRecord.html @@ -0,0 +1,87 @@ + + + + + class SG_EXPORT osgUtx::TestRecord + + + + +

class SG_EXPORT osgUtx::TestRecord

A TestRecord records the output of a given test case, ie.
+
+ +
+

+

Public Methods

+[more]void start() +
+[more]void stop() +
+[more]void log(const TestFailureX& e) +
+[more]void log(const TestErrorX& e) +
+[more]void log(const std::exception& e) +
+[more]void log(const std::string& s) +

+ +
+ + +
+

Documentation

+
+A TestRecord records the output of a given test case, ie. its start/stop time, +its result, and a textual description of any problems. + +

\todo Consider adding accessor methods if necessary, to get the details +stored in the TestRecord.

+
+ + + +
ovoid start() +

+ + +

ovoid stop() +

+ + +

ovoid log(const TestFailureX& e) +

+ + +

ovoid log(const TestErrorX& e) +

+ + +

ovoid log(const std::exception& e) +

+ + +

ovoid log(const std::string& s) +

+ + + +
o Success +

+ + +

o Failure +

+ + +

o Error +

+
+ +
This class has no child classes.
+ +
Friends:
class TestReport
std::ostream& operator<<(std::ostream& o,const TestRecord& tr)

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestReport.html b/doc/doc++/osg/TestReport.html new file mode 100644 index 000000000..fc72920c5 --- /dev/null +++ b/doc/doc++/osg/TestReport.html @@ -0,0 +1,43 @@ + + + + + class SG_EXPORT osgUtx::TestReport + + + + +

class SG_EXPORT osgUtx::TestReport

A TestReport represents the complete set of results (TestRecords) for a given test run.
+
+ +
+

+

Public Methods

+[more]TestRecord& createRecord(const std::string& s) +

+ +
+ + +
+

Documentation

+
+A TestReport represents the complete set of results (TestRecords) for a +given test run. + +

\todo Add support for printing the test report in various formats: +e.g. text, XML, CSV

+
+ + + +
oTestRecord& createRecord(const std::string& s) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestRunner.html b/doc/doc++/osg/TestRunner.html new file mode 100644 index 000000000..acda9bb60 --- /dev/null +++ b/doc/doc++/osg/TestRunner.html @@ -0,0 +1,103 @@ + + + + + class SG_EXPORT osgUtx::TestRunner + + + + +

class SG_EXPORT osgUtx::TestRunner

A TestRunner is a visitor which will run specified tests as it traverses the test graph.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestRunner( TestContext& ctx ) +
+[more]void specify( const std::string& sQualifiedName ) +
Tests may be specified by partial names. +
+[more]bool visitEnter( TestSuite* pSuite ) +
+[more]bool visit( TestCase* pTest ) +
+[more]bool visitLeave( TestSuite* pSuite ) +

+ +

+

Protected Methods

+[more]void perform( TestCase* pTest ) +

+ +
+

Inherited from TestQualifier:

+
+

+

Public Methods

+oconst std::string& currentPath() const +

+ +
+

Inherited from TestVisitor:

+
+
+ + +
+

Documentation

+
+A TestRunner is a visitor which will run specified tests as it traverses the +test graph. + +

\todo Consider an accessor method to get at the TestReport if necessary.

+
+ + + +
o TestRunner( TestContext& ctx ) +

+ + +

ovoid specify( const std::string& sQualifiedName ) +
+Tests may be specified by partial names. E.g. specifiying "root" +will run all tests below root, i.e. all tests. +Specifiying "root.osg" will run all tests below \em root.osg. +Specifying "root.osg.de" will run all tests (and suites) below +\em root.osg with names beginning with the \em de. +

+ + +

obool visitEnter( TestSuite* pSuite ) +

+ + +

obool visit( TestCase* pTest ) +

+ + +

obool visitLeave( TestSuite* pSuite ) +

+ + +

ovoid perform( TestCase* pTest ) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestSuite.html b/doc/doc++/osg/TestSuite.html new file mode 100644 index 000000000..4555e5e5c --- /dev/null +++ b/doc/doc++/osg/TestSuite.html @@ -0,0 +1,102 @@ + + + + + class SG_EXPORT osgUtx::TestSuite + + + + +

class SG_EXPORT osgUtx::TestSuite

A TestSuite is the \em composite component of the Composite pattern, and allows aggregation of Tests into hierarchies
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestSuite( const std::string& name ) +
+[more]void add( Test* pTest ) +
Adds a Test to the suite. +
+[more]Test* findChild(const std::string& name) +
+
+[more]virtual bool accept( Test::Visitor& v ) +

+ +
+

Inherited from Test:

+
+

+

Public Methods

+oconst std::string& name() const +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+A TestSuite is the \em composite component of the Composite pattern, +and allows aggregation of Tests into hierarchies
+
+ + + +
o TestSuite( const std::string& name ) +

+ + +

ovoid add( Test* pTest ) +
Adds a Test to the suite. +

+ + +

oTest* findChild(const std::string& name) +
+ +
Returns:
s The immediate child denoted by name, or 0 if not found.

+ + +

ovirtual bool accept( Test::Visitor& v ) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestSuiteAutoRegistrationAgent.html b/doc/doc++/osg/TestSuiteAutoRegistrationAgent.html new file mode 100644 index 000000000..5d88aeaf1 --- /dev/null +++ b/doc/doc++/osg/TestSuiteAutoRegistrationAgent.html @@ -0,0 +1,37 @@ + + + + + struct osgUtx::TestSuiteAutoRegistrationAgent + + + + +

struct osgUtx::TestSuiteAutoRegistrationAgent

A helper struct to perform automatic registration at program startup; not for direct use, it should be used via the following macros.
+ +
+

+
+[more] TestSuiteAutoRegistrationAgent(TestSuite* tsuite, const char* path = 0) +

+ + + +
+

Documentation

+
+A helper struct to perform automatic registration at program startup; not for +direct use, it should be used via the following macros. (It's a secret agent :-) + +

+
+ + + +
o TestSuiteAutoRegistrationAgent(TestSuite* tsuite, const char* path = 0) +

+
See Also:
OSGUTX_AUTOREGISTER_TESTSUITE, OSGUTX_AUTOREGISTER_TESTSUITE_AT

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestVisitor.html b/doc/doc++/osg/TestVisitor.html new file mode 100644 index 000000000..1b9b55df0 --- /dev/null +++ b/doc/doc++/osg/TestVisitor.html @@ -0,0 +1,85 @@ + + + + + class osgUtx::TestVisitor + + + + +

class osgUtx::TestVisitor

Visits while maintaining the current hierarchical context.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual bool visitEnter( TestSuite* ) +
+[more]virtual bool visit( TestCase* ) = 0 +
+[more]virtual bool visitLeave( TestSuite* ) +

+ +

+

Protected Methods

+[more] TestVisitor() +
+[more] TestVisitor( const TestVisitor& ) +
+[more]virtual ~TestVisitor() +

+ +
+ + +
+

Documentation

+
+Visits while maintaining the current hierarchical context. Also allows +the traversal to be short-cicuited at any point during the visitation.
+
+ + + +
ovirtual bool visitEnter( TestSuite* ) +

+ + +

ovirtual bool visit( TestCase* ) = 0 +

+ + +

ovirtual bool visitLeave( TestSuite* ) +

+ + +

o TestVisitor() +

+ + +

o TestVisitor( const TestVisitor& ) +

+ + +

ovirtual ~TestVisitor() +

+
+
Direct child classes: +
TestQualifier
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestX.html b/doc/doc++/osg/TestX.html new file mode 100644 index 000000000..d2b60e955 --- /dev/null +++ b/doc/doc++/osg/TestX.html @@ -0,0 +1,65 @@ + + + + + class osgUtx::TestX + + + + +

class osgUtx::TestX

Base class catchable for the exception's which may be thrown to indicate problems during the run of a TestCase
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestX(const std::string& s) +
+[more]virtual ~TestX() +
+[more]const std::string& what() const +

+ +
+ + +
+

Documentation

+
+Base class catchable for the exception's which may be thrown to +indicate problems during the run of a TestCase
+
+ + + +
o TestX(const std::string& s) +

+ + +

ovirtual ~TestX() +

+ + +

oconst std::string& what() const +

+
+
Direct child classes: +
TestFailureX
+TestErrorX
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TexEnvCombine.html b/doc/doc++/osg/TexEnvCombine.html new file mode 100644 index 000000000..3f5c3824e --- /dev/null +++ b/doc/doc++/osg/TexEnvCombine.html @@ -0,0 +1,633 @@ + + + + + class SG_EXPORT osg::TexEnvCombine + + + + +

class SG_EXPORT osg::TexEnvCombine

TexEnvCombine - encapsulates the OpenGL glTexEnvCombine (texture environment) state
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TexEnvCombine() +
+[more] TexEnvCombine(const TexEnvCombine& texenv, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, TexEnvCombine, TEXENV) +
+[more]virtual bool isTextureAttribute() const +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]void setCombine_RGB(GLint cm) +
+[more]void setCombine_Alpha(GLint cm) +
+[more]GLint getCombine_RGB() const +
+[more]GLint getCombine_Alpha() const +
+[more]void setSource0_RGB(GLint sp) +
+[more]void setSource1_RGB(GLint sp) +
+[more]void setSource2_RGB(GLint sp) +
+[more]void setSource0_Alpha(GLint sp) +
+[more]void setSource1_Alpha(GLint sp) +
+[more]void setSource2_Alpha(GLint sp) +
+[more]GLint getSource0_RGB() const +
+[more]GLint getSource1_RGB() const +
+[more]GLint getSource2_RGB() const +
+[more]GLint getSource0_Alpha() const +
+[more]GLint getSource1_Alpha() const +
+[more]GLint getSource2_Alpha() const +
+[more]void setOperand0_RGB(GLint op) +
+[more]void setOperand1_RGB(GLint op) +
+[more]void setOperand2_RGB(GLint op) +
+[more]void setOperand0_Alpha(GLint op) +
+[more]void setOperand1_Alpha(GLint op) +
+[more]void setOperand2_Alpha(GLint op) +
+[more]GLint getOperand0_RGB() const +
+[more]GLint getOperand1_RGB() const +
+[more]GLint getOperand2_RGB() const +
+[more]GLint getOperand0_Alpha() const +
+[more]GLint getOperand1_Alpha() const +
+[more]GLint getOperand2_Alpha() const +
+[more]void setScale_RGB(float scale) +
+[more]void setScale_Alpha(float scale) +
+[more]float getScale_RGB() const +
+[more]float getScale_Alpha() const +
+[more]void setConstantColor( const Vec4& color ) +
+[more]const Vec4& getConstantColor() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum CombineParam +
+[more]enum SourceParam +
+[more]enum OperandParam +

+ +

+

Protected Fields

+[more]bool _needsTexEnvCrossbar +
+[more]GLint _combine_RGB +
+[more]GLint _combine_Alpha +
+[more]GLint _source0_RGB +
+[more]GLint _source1_RGB +
+[more]GLint _source2_RGB +
+[more]GLint _source0_Alpha +
+[more]GLint _source1_Alpha +
+[more]GLint _source2_Alpha +
+[more]GLint _operand0_RGB +
+[more]GLint _operand1_RGB +
+[more]GLint _operand2_RGB +
+[more]GLint _operand0_Alpha +
+[more]GLint _operand1_Alpha +
+[more]GLint _operand2_Alpha +
+[more]float _scale_RGB +
+[more]float _scale_Alpha +
+[more]osg::Vec4 _constantColor +

+ +

+

Protected Methods

+[more]virtual ~TexEnvCombine() +
+[more]inline bool needsTexEnvCombiner(GLint value) const +
+[more]void computeNeedoForTexEnvCombiners() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual const Type getType() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(const DataVariance dv) +
+oinline const DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
TexEnvCombine - encapsulates the OpenGL glTexEnvCombine (texture environment) state
+
+ + + +
o TexEnvCombine() +

+ + +

o TexEnvCombine(const TexEnvCombine& texenv, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, TexEnvCombine, TEXENV) +

+ + +

ovirtual bool isTextureAttribute() const +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

oenum CombineParam +

+ + + +
o REPLACE +

+ + +

o MODULATE +

+ + +

o ADD +

+ + +

o ADD_SIGNED +

+ + +

o INTERPOLATE +

+ + +

o SUBTRACT +

+ + +

o DOT3_RGB +

+ + +

o DOT3_RGBA +

+ + + +
ovoid setCombine_RGB(GLint cm) +

+ + +

ovoid setCombine_Alpha(GLint cm) +

+ + +

oGLint getCombine_RGB() const +

+ + +

oGLint getCombine_Alpha() const +

+ + +

oenum SourceParam +

+ + + +
o CONSTANT +

+ + +

o PRIMARY_COLOR +

+ + +

o PREVIOUS +

+ + +

o TEXTURE +

+ + +

o TEXTURE0 +

+ + +

o TEXTURE1 +

+ + +

o TEXTURE2 +

+ + +

o TEXTURE3 +

+ + +

o TEXTURE4 +

+ + +

o TEXTURE5 +

+ + +

o TEXTURE6 +

+ + +

o TEXTURE7 +

+ + + +
ovoid setSource0_RGB(GLint sp) +

+ + +

ovoid setSource1_RGB(GLint sp) +

+ + +

ovoid setSource2_RGB(GLint sp) +

+ + +

ovoid setSource0_Alpha(GLint sp) +

+ + +

ovoid setSource1_Alpha(GLint sp) +

+ + +

ovoid setSource2_Alpha(GLint sp) +

+ + +

oGLint getSource0_RGB() const +

+ + +

oGLint getSource1_RGB() const +

+ + +

oGLint getSource2_RGB() const +

+ + +

oGLint getSource0_Alpha() const +

+ + +

oGLint getSource1_Alpha() const +

+ + +

oGLint getSource2_Alpha() const +

+ + +

oenum OperandParam +

+ + + +
o SRC_COLOR +

+ + +

o ONE_MINUS_SRC_COLOR +

+ + +

o SRC_ALPHA +

+ + +

o ONE_MINUS_SRC_ALPHA +

+ + + +
ovoid setOperand0_RGB(GLint op) +

+ + +

ovoid setOperand1_RGB(GLint op) +

+ + +

ovoid setOperand2_RGB(GLint op) +

+ + +

ovoid setOperand0_Alpha(GLint op) +

+ + +

ovoid setOperand1_Alpha(GLint op) +

+ + +

ovoid setOperand2_Alpha(GLint op) +

+ + +

oGLint getOperand0_RGB() const +

+ + +

oGLint getOperand1_RGB() const +

+ + +

oGLint getOperand2_RGB() const +

+ + +

oGLint getOperand0_Alpha() const +

+ + +

oGLint getOperand1_Alpha() const +

+ + +

oGLint getOperand2_Alpha() const +

+ + +

ovoid setScale_RGB(float scale) +

+ + +

ovoid setScale_Alpha(float scale) +

+ + +

ofloat getScale_RGB() const +

+ + +

ofloat getScale_Alpha() const +

+ + +

ovoid setConstantColor( const Vec4& color ) +

+ + +

oconst Vec4& getConstantColor() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~TexEnvCombine() +

+ + +

oinline bool needsTexEnvCombiner(GLint value) const +

+ + +

ovoid computeNeedoForTexEnvCombiners() +

+ + +

obool _needsTexEnvCrossbar +

+ + +

oGLint _combine_RGB +

+ + +

oGLint _combine_Alpha +

+ + +

oGLint _source0_RGB +

+ + +

oGLint _source1_RGB +

+ + +

oGLint _source2_RGB +

+ + +

oGLint _source0_Alpha +

+ + +

oGLint _source1_Alpha +

+ + +

oGLint _source2_Alpha +

+ + +

oGLint _operand0_RGB +

+ + +

oGLint _operand1_RGB +

+ + +

oGLint _operand2_RGB +

+ + +

oGLint _operand0_Alpha +

+ + +

oGLint _operand1_Alpha +

+ + +

oGLint _operand2_Alpha +

+ + +

ofloat _scale_RGB +

+ + +

ofloat _scale_Alpha +

+ + +

oosg::Vec4 _constantColor +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Texture1D.html b/doc/doc++/osg/Texture1D.html new file mode 100644 index 000000000..332834038 --- /dev/null +++ b/doc/doc++/osg/Texture1D.html @@ -0,0 +1,433 @@ + + + + + class SG_EXPORT osg::Texture1D + + + + +

class SG_EXPORT osg::Texture1D

Texture state class which encapsulates OpenGl 1D texture functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Texture1D() +
+[more] Texture1D(const Texture1D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Texture1D, TEXTURE) +
+[more]virtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setImage(Image* image) +
Set the texture image. +
+[more]Image* getImage() +
Get the texture image. +
+[more]inline const Image* getImage() const +
Get the const texture image. +
+[more]inline void setTextureSize(const int width) const +
Set the texture width and height. +
+[more]inline void getTextureSize(int& width) const +
Get the texture subload width. +
+[more]void setSubloadCallback(SubloadCallback* cb) +
+[more]SubloadCallback* getSubloadCallback() +
+[more]const SubloadCallback* getSubloadCallback() const +
+[more]void setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, should only be called within an osg::Texuture::apply() and custom OpenGL texture load +
+[more]unsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +
+[more]void copyTexImage1D(State& state, int x, int y, int width) +
Copy pixels into a 1D texture imageAs per glCopyTexImage1D. +
+[more]void copyTexSubImage1D(State& state, int xoffset, int x, int y, int width) +
Copy a one-dimensional texture subimage. +
+[more]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 +

+ +

+

Public Members

+class SubloadCallback: public Referenced +

+ +

+

Protected Fields

+[more]mutable ref_ptr<Image> _image +
+[more]mutable GLsizei _textureWidth +
+[more]mutable GLsizei _numMimpmapLevels +
+[more]ref_ptr<SubloadCallback> _subloadCallback +

+ +

+

Protected Methods

+[more]virtual ~Texture1D() +
+[more]virtual void computeInternalFormat() const +
+[more]void applyTexImage1D(GLenum target, Image* image, State& state, GLsizei& width, GLsizei& numMimpmapLevels) const +
Helper method which does the creation of the texture itself, and does not set or use texture binding. +

+ +
+

Inherited from Texture:

+
+

+

Public Methods

+ovirtual osg::Object* cloneType() const +
+ovirtual osg::Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual const Type getType() const +
+ovirtual bool isTextureAttribute() const +
+ovoid setWrap(const WrapParameter which, const WrapMode wrap) +
+oconst WrapMode getWrap(const WrapParameter which) const +
+ovoid setBorderColor(const Vec4& color) +
+oconst Vec4& borderColor(void) const +
+ovoid setFilter(const FilterParameter which, const FilterMode filter) +
+oconst FilterMode getFilter(const FilterParameter which) const +
+ovoid setMaxAnisotropy(float anis) +
+oinline float getMaxAnisotropy() const +
+oinline void setInternalFormatMode(const InternalFormatMode mode) +
+oinline const InternalFormatMode getInternalFormatMode() const +
+oinline void setInternalFormat(const int internalFormat) +
+oinline const int getInternalFormat() const +
+obool isCompressedInternalFormat() const +
+oinline GLuint& getTextureObject(const uint contextID) const +
+oinline uint& getModifiedTag(const uint contextID) const +
+ovoid dirtyTextureObject() +
+ostatic void deleteTextureObject(uint contextID, GLuint handle) +
+ostatic void flushDeletedTextureObjects(uint contextID) +
+ostatic GLint getMaxTextureSize() +
+ovirtual void compile(State& state) const +

+ +

+

Public Members

+oenum WrapParameter +
+oenum WrapMode +
+oenum FilterParameter +
+oenum FilterMode +
+oenum InternalFormatMode +
+o Get the handle to the texture object for the current context +

+ +

+

Protected Fields

+oWrapMode _wrap_s +
+oWrapMode _wrap_t +
+oWrapMode _wrap_r +
+oFilterMode _min_filter +
+oFilterMode _mag_filter +
+ofloat _maxAnisotropy +
+oVec4 _borderColor +
+omutable bool _texParametersDirty +
+oInternalFormatMode _internalFormatMode +
+omutable GLint _internalFormat +

+ +

+

Protected Methods

+ovoid computeInternalFormatWithImage(osg::Image& image) const +
+obool isCompressedInternalFormat(GLint internalFormat) const +
+ovoid applyTexParameters(GLenum target, State& state) const +
+ovoid applyTexImage2D(GLenum target, Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
+oint compareTexture(const Texture& rhs) const +

+ +

+

Protected Members

+otypedef std::vector<GLuint> TextureNameList mutable TextureNameList _handleList +
+otypedef std::vector<uint> ImageModifiedTag mutable ImageModifiedTag _modifiedTag +
+otypedef std::map<uint,std::set<uint> >static DeletedTextureObjectCache DeletedTextureObjectCache s_deletedTextureObjectCache +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(const DataVariance dv) +
+oinline const DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Texture state class which encapsulates OpenGl 1D texture functionality
+
+ + + +
o Texture1D() +

+ + +

o Texture1D(const Texture1D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Texture1D, TEXTURE) +

+ + +

ovirtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setImage(Image* image) +
Set the texture image. +

+ + +

oImage* getImage() +
Get the texture image. +

+ + +

oinline const Image* getImage() const +
Get the const texture image. +

+ + +

oinline void setTextureSize(const int width) const +
Set the texture width and height. If width or height are zero then +the repsective size value is calculated from the source image sizes. +

+ + +

oinline void getTextureSize(int& width) const +
Get the texture subload width. +

+ + +

ovoid setSubloadCallback(SubloadCallback* cb) +

+ + +

oSubloadCallback* getSubloadCallback() +

+ + +

oconst SubloadCallback* getSubloadCallback() const +

+ + +

ovoid setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, +should only be called within an osg::Texuture::apply() and custom OpenGL texture load +

+ + +

ounsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +

+ + +

ovoid copyTexImage1D(State& state, int x, int y, int width) +
Copy pixels into a 1D texture imageAs per glCopyTexImage1D. +Creates an OpenGL texture object from the current OpenGL background +framebuffer contents at pos \a x, \a y with width \a width. \a width must be a power of two. +

+ + +

ovoid copyTexSubImage1D(State& state, int xoffset, int x, int y, int width) +
Copy a one-dimensional texture subimage. As per glCopyTexSubImage1D. +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. +

+ + +

ovirtual 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 +

+ + +

ovirtual ~Texture1D() +

+ + +

ovirtual void computeInternalFormat() const +

+ + +

ovoid applyTexImage1D(GLenum target, Image* image, State& state, GLsizei& width, GLsizei& numMimpmapLevels) const +
Helper method which does the creation of the texture itself, and +does not set or use texture binding. +

+ + +

omutable ref_ptr<Image> _image +

+ + +

omutable GLsizei _textureWidth +

+ + +

omutable GLsizei _numMimpmapLevels +

+ + +

oref_ptr<SubloadCallback> _subloadCallback +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Texture2D.html b/doc/doc++/osg/Texture2D.html new file mode 100644 index 000000000..f4db45426 --- /dev/null +++ b/doc/doc++/osg/Texture2D.html @@ -0,0 +1,433 @@ + + + + + class SG_EXPORT osg::Texture2D + + + + +

class SG_EXPORT osg::Texture2D

Texture state class which encapsulates OpenGl texture functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Texture2D() +
+[more] Texture2D(const Texture2D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Texture2D, TEXTURE) +
+[more]virtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setImage(Image* image) +
Set the texture image. +
+[more]Image* getImage() +
Get the texture image. +
+[more]inline const Image* getImage() const +
Get the const texture image. +
+[more]inline void setTextureSize(const int width, const int height) const +
Set the texture width and height. +
+[more]inline void getTextureSize(int& width, int& height) const +
Get the texture subload width. +
+[more]void setSubloadCallback(SubloadCallback* cb) +
+[more]SubloadCallback* getSubloadCallback() +
+[more]const SubloadCallback* getSubloadCallback() const +
+[more]void setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, should only be called within an osg::Texuture::apply() and custom OpenGL texture load +
+[more]unsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +
+[more]void copyTexImage2D(State& state, int x, int y, int width, int height ) +
Copy pixels into a 2D texture imageAs per glCopyTexImage2D. +
+[more]void copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height ) +
Copy a two-dimensional texture subimage. +
+[more]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 +

+ +

+

Public Members

+class SubloadCallback: public Referenced +

+ +

+

Protected Fields

+[more]mutable ref_ptr<Image> _image +
+[more]mutable GLsizei _textureWidth +
+[more]mutable GLsizei _textureHeight +
+[more]mutable GLsizei _numMimpmapLevels +
+[more]ref_ptr<SubloadCallback> _subloadCallback +

+ +

+

Protected Methods

+[more]virtual ~Texture2D() +
+[more]virtual void computeInternalFormat() const +

+ +
+

Inherited from Texture:

+
+

+

Public Methods

+ovirtual osg::Object* cloneType() const +
+ovirtual osg::Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual const Type getType() const +
+ovirtual bool isTextureAttribute() const +
+ovoid setWrap(const WrapParameter which, const WrapMode wrap) +
+oconst WrapMode getWrap(const WrapParameter which) const +
+ovoid setBorderColor(const Vec4& color) +
+oconst Vec4& borderColor(void) const +
+ovoid setFilter(const FilterParameter which, const FilterMode filter) +
+oconst FilterMode getFilter(const FilterParameter which) const +
+ovoid setMaxAnisotropy(float anis) +
+oinline float getMaxAnisotropy() const +
+oinline void setInternalFormatMode(const InternalFormatMode mode) +
+oinline const InternalFormatMode getInternalFormatMode() const +
+oinline void setInternalFormat(const int internalFormat) +
+oinline const int getInternalFormat() const +
+obool isCompressedInternalFormat() const +
+oinline GLuint& getTextureObject(const uint contextID) const +
+oinline uint& getModifiedTag(const uint contextID) const +
+ovoid dirtyTextureObject() +
+ostatic void deleteTextureObject(uint contextID, GLuint handle) +
+ostatic void flushDeletedTextureObjects(uint contextID) +
+ostatic GLint getMaxTextureSize() +
+ovirtual void compile(State& state) const +

+ +

+

Public Members

+oenum WrapParameter +
+oenum WrapMode +
+oenum FilterParameter +
+oenum FilterMode +
+oenum InternalFormatMode +
+o Get the handle to the texture object for the current context +

+ +

+

Protected Fields

+oWrapMode _wrap_s +
+oWrapMode _wrap_t +
+oWrapMode _wrap_r +
+oFilterMode _min_filter +
+oFilterMode _mag_filter +
+ofloat _maxAnisotropy +
+oVec4 _borderColor +
+omutable bool _texParametersDirty +
+oInternalFormatMode _internalFormatMode +
+omutable GLint _internalFormat +

+ +

+

Protected Methods

+ovoid computeInternalFormatWithImage(osg::Image& image) const +
+obool isCompressedInternalFormat(GLint internalFormat) const +
+ovoid applyTexParameters(GLenum target, State& state) const +
+ovoid applyTexImage2D(GLenum target, Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
+oint compareTexture(const Texture& rhs) const +

+ +

+

Protected Members

+otypedef std::vector<GLuint> TextureNameList mutable TextureNameList _handleList +
+otypedef std::vector<uint> ImageModifiedTag mutable ImageModifiedTag _modifiedTag +
+otypedef std::map<uint,std::set<uint> >static DeletedTextureObjectCache DeletedTextureObjectCache s_deletedTextureObjectCache +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(const DataVariance dv) +
+oinline const DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Texture state class which encapsulates OpenGl texture functionality
+
+ + + +
o Texture2D() +

+ + +

o Texture2D(const Texture2D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Texture2D, TEXTURE) +

+ + +

ovirtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setImage(Image* image) +
Set the texture image. +

+ + +

oImage* getImage() +
Get the texture image. +

+ + +

oinline const Image* getImage() const +
Get the const texture image. +

+ + +

oinline void setTextureSize(const int width, const int height) const +
Set the texture width and height. If width or height are zero then +the repsective size value is calculated from the source image sizes. +

+ + +

oinline void getTextureSize(int& width, int& height) const +
Get the texture subload width. +

+ + +

ovoid setSubloadCallback(SubloadCallback* cb) +

+ + +

oSubloadCallback* getSubloadCallback() +

+ + +

oconst SubloadCallback* getSubloadCallback() const +

+ + +

ovoid setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, +should only be called within an osg::Texuture::apply() and custom OpenGL texture load +

+ + +

ounsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +

+ + +

ovoid 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. +

+ + +

ovoid 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 +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. +

+ + +

ovirtual 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 +

+ + +

ovirtual ~Texture2D() +

+ + +

ovirtual void computeInternalFormat() const +

+ + +

omutable ref_ptr<Image> _image +

+ + +

omutable GLsizei _textureWidth +

+ + +

omutable GLsizei _textureHeight +

+ + +

omutable GLsizei _numMimpmapLevels +

+ + +

oref_ptr<SubloadCallback> _subloadCallback +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Texture3D.html b/doc/doc++/osg/Texture3D.html new file mode 100644 index 000000000..3248bc13b --- /dev/null +++ b/doc/doc++/osg/Texture3D.html @@ -0,0 +1,433 @@ + + + + + class SG_EXPORT osg::Texture3D + + + + +

class SG_EXPORT osg::Texture3D

Texture state class which encapsulates OpenGl 3D texture functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Texture3D() +
+[more] Texture3D(const Texture3D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Texture3D, TEXTURE) +
+[more]virtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setImage(Image* image) +
Set the texture image. +
+[more]Image* getImage() +
Get the texture image. +
+[more]inline const Image* getImage() const +
Get the const texture image. +
+[more]inline void setTextureSize(const int width, const int height, const int depth) const +
Set the texture width and height. +
+[more]inline void getTextureSize(int& width, int& height, int& depth) const +
Get the texture subload width. +
+[more]void setSubloadCallback(SubloadCallback* cb) +
+[more]SubloadCallback* getSubloadCallback() +
+[more]const SubloadCallback* getSubloadCallback() const +
+[more]void setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, should only be called within an osg::Texuture::apply() and custom OpenGL texture load +
+[more]unsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +
+[more]void copyTexSubImage3D(State& state, int xoffset, int yoffset, int zoffset, int x, int y, int width, int height) +
Copy a two-dimensional texture subimage. +
+[more]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 +

+ +

+

Public Members

+class SubloadCallback: public Referenced +

+ +

+

Protected Fields

+[more]mutable ref_ptr<Image> _image +
+[more]mutable GLsizei _textureWidth +
+[more]mutable GLsizei _textureHeight +
+[more]mutable GLsizei _textureDepth +
+[more]mutable GLsizei _numMimpmapLevels +
+[more]ref_ptr<SubloadCallback> _subloadCallback +

+ +

+

Protected Methods

+[more]virtual ~Texture3D() +
+[more]virtual void computeInternalFormat() const +
+[more]void applyTexImage3D(GLenum target, Image* image, State& state, GLsizei& inwidth, GLsizei& inheight, GLsizei& indepth, GLsizei& numMimpmapLevels) const +

+ +
+

Inherited from Texture:

+
+

+

Public Methods

+ovirtual osg::Object* cloneType() const +
+ovirtual osg::Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual const Type getType() const +
+ovirtual bool isTextureAttribute() const +
+ovoid setWrap(const WrapParameter which, const WrapMode wrap) +
+oconst WrapMode getWrap(const WrapParameter which) const +
+ovoid setBorderColor(const Vec4& color) +
+oconst Vec4& borderColor(void) const +
+ovoid setFilter(const FilterParameter which, const FilterMode filter) +
+oconst FilterMode getFilter(const FilterParameter which) const +
+ovoid setMaxAnisotropy(float anis) +
+oinline float getMaxAnisotropy() const +
+oinline void setInternalFormatMode(const InternalFormatMode mode) +
+oinline const InternalFormatMode getInternalFormatMode() const +
+oinline void setInternalFormat(const int internalFormat) +
+oinline const int getInternalFormat() const +
+obool isCompressedInternalFormat() const +
+oinline GLuint& getTextureObject(const uint contextID) const +
+oinline uint& getModifiedTag(const uint contextID) const +
+ovoid dirtyTextureObject() +
+ostatic void deleteTextureObject(uint contextID, GLuint handle) +
+ostatic void flushDeletedTextureObjects(uint contextID) +
+ostatic GLint getMaxTextureSize() +
+ovirtual void compile(State& state) const +

+ +

+

Public Members

+oenum WrapParameter +
+oenum WrapMode +
+oenum FilterParameter +
+oenum FilterMode +
+oenum InternalFormatMode +
+o Get the handle to the texture object for the current context +

+ +

+

Protected Fields

+oWrapMode _wrap_s +
+oWrapMode _wrap_t +
+oWrapMode _wrap_r +
+oFilterMode _min_filter +
+oFilterMode _mag_filter +
+ofloat _maxAnisotropy +
+oVec4 _borderColor +
+omutable bool _texParametersDirty +
+oInternalFormatMode _internalFormatMode +
+omutable GLint _internalFormat +

+ +

+

Protected Methods

+ovoid computeInternalFormatWithImage(osg::Image& image) const +
+obool isCompressedInternalFormat(GLint internalFormat) const +
+ovoid applyTexParameters(GLenum target, State& state) const +
+ovoid applyTexImage2D(GLenum target, Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
+oint compareTexture(const Texture& rhs) const +

+ +

+

Protected Members

+otypedef std::vector<GLuint> TextureNameList mutable TextureNameList _handleList +
+otypedef std::vector<uint> ImageModifiedTag mutable ImageModifiedTag _modifiedTag +
+otypedef std::map<uint,std::set<uint> >static DeletedTextureObjectCache DeletedTextureObjectCache s_deletedTextureObjectCache +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(const DataVariance dv) +
+oinline const DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+oinline void ref() const +
+oinline void unref() const +
+oinline void unref_nodelete() const +
+oinline const int referenceCount() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Texture state class which encapsulates OpenGl 3D texture functionality
+
+ + + +
o Texture3D() +

+ + +

o Texture3D(const Texture3D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Texture3D, TEXTURE) +

+ + +

ovirtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setImage(Image* image) +
Set the texture image. +

+ + +

oImage* getImage() +
Get the texture image. +

+ + +

oinline const Image* getImage() const +
Get the const texture image. +

+ + +

oinline void setTextureSize(const int width, const int height, const int depth) const +
Set the texture width and height. If width or height are zero then +the repsective size value is calculated from the source image sizes. +

+ + +

oinline void getTextureSize(int& width, int& height, int& depth) const +
Get the texture subload width. +

+ + +

ovoid setSubloadCallback(SubloadCallback* cb) +

+ + +

oSubloadCallback* getSubloadCallback() +

+ + +

oconst SubloadCallback* getSubloadCallback() const +

+ + +

ovoid setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, +should only be called within an osg::Texuture::apply() and custom OpenGL texture load +

+ + +

ounsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +

+ + +

ovoid copyTexSubImage3D(State& state, int xoffset, int yoffset, int zoffset, 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 +height \a height. +

+ + +

ovirtual 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 +

+ + +

ovirtual ~Texture3D() +

+ + +

ovirtual void computeInternalFormat() const +

+ + +

ovoid applyTexImage3D(GLenum target, Image* image, State& state, GLsizei& inwidth, GLsizei& inheight, GLsizei& indepth, GLsizei& numMimpmapLevels) const +

+ + +

omutable ref_ptr<Image> _image +

+ + +

omutable GLsizei _textureWidth +

+ + +

omutable GLsizei _textureHeight +

+ + +

omutable GLsizei _textureDepth +

+ + +

omutable GLsizei _numMimpmapLevels +

+ + +

oref_ptr<SubloadCallback> _subloadCallback +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TraceStream.html b/doc/doc++/osg/TraceStream.html new file mode 100644 index 000000000..863c99443 --- /dev/null +++ b/doc/doc++/osg/TraceStream.html @@ -0,0 +1,60 @@ + + + + + class SG_EXPORT osgUtx::TestContext::TraceStream + + + + +

class SG_EXPORT TraceStream

+ +
+

+

Public Methods

+[more] TraceStream(std::ostream& o=std::cout, TraceLevel tl=Results) +
+[more] ~TraceStream() +
+[more]void setTraceLevel(TraceLevel tl) +
+[more]TraceLevel getTraceLevel() const +
+[more]std::ostream& stream(TraceLevel tl) +

+ +
+ + +
+

Documentation

+
+ + + +
o TraceStream(std::ostream& o=std::cout, TraceLevel tl=Results) +

+ + +

o ~TraceStream() +

+ + +

ovoid setTraceLevel(TraceLevel tl) +

+ + +

oTraceLevel getTraceLevel() const +

+ + +

ostd::ostream& stream(TraceLevel tl) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/isGLUExtensionSupported.html b/doc/doc++/osg/isGLUExtensionSupported.html new file mode 100644 index 000000000..cf44eb53a --- /dev/null +++ b/doc/doc++/osg/isGLUExtensionSupported.html @@ -0,0 +1,22 @@ + + + + + SG_EXPORT extern const bool osg::isGLUExtensionSupported + + + + +

SG_EXPORT extern const bool osg::isGLUExtensionSupported

(const char* extension)

return true if OpenGL "extension" is supported.
+ + +
+

Documentation

+
return true if OpenGL "extension" is supported. +note: Must only called within a valid OpenGL context, +undefined behavior may occur otherwise.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/osgUtx.html b/doc/doc++/osg/osgUtx.html new file mode 100644 index 000000000..7cb6994bf --- /dev/null +++ b/doc/doc++/osg/osgUtx.html @@ -0,0 +1,73 @@ + + + + + namespace osgUtx + + + + +

namespace osgUtx

+
+

+
+class SG_EXPORT Test: public osg::Referenced +
Test, an abstract base class, is the Composite pattern's \em component class for our graph of test cases, and defines the basic interface for all Test components. +
+class SG_EXPORT TestContext +
TestContext wraps up information which is passed to tests as they are run, and may contain test-specific information or 'global' test objects, such as an output stream for verbose output during the running of tests. +
+class TestVisitor +
Visits while maintaining the current hierarchical context. +
+class TestCase: public Test +
TestCase, is the supplies the interface for a Composite pattern's \em leaf class, though it is not a leaf in itself +
+class TestX +
Base class catchable for the exception's which may be thrown to indicate problems during the run of a TestCase +
+class TestFailureX: public TestX +
A TestFailureX indicates a failure in the tested component +
+class TestErrorX: public TestX +
A TestErrorX indicates an error while testing a component, which prevents the test from being run; it does not indicate a problem with the component, but rather a problem during the run which prevents the component from being tested +
+template< typename FixtureT > class TestCase_: public TestCase +
TestCase_ is a class template for a leaf TestCase, which allows TestFixture classes to be easily collected into the tree of tests, and have their public test methods called. +
+class SG_EXPORT TestSuite: public Test +
A TestSuite is the \em composite component of the Composite pattern, and allows aggregation of Tests into hierarchies +
+class SG_EXPORT TestGraph +
TestGraph is a singleton providing central access to the tree of tests; primarily, it provides access to the root suite +
+class SG_EXPORT TestQualifier: public TestVisitor +
Maintains a string that when accessed in the "visit" member, returns the current qualified TestSuite path +
+class SG_EXPORT QualifiedTestPrinter: public TestQualifier +
QualifiedTestPrinter prints to standard output a list of fully qualified tests +
+class SG_EXPORT TestRecord +
A TestRecord records the output of a given test case, ie. +
+class SG_EXPORT TestReport +
A TestReport represents the complete set of results (TestRecords) for a given test run. +
+class SG_EXPORT TestRunner: public TestQualifier +
A TestRunner is a visitor which will run specified tests as it traverses the test graph. +
+struct TestSuiteAutoRegistrationAgent +
A helper struct to perform automatic registration at program startup; not for direct use, it should be used via the following macros. +

+ + + +
+

Documentation

+
+
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/CmdLineArgs.html b/doc/doc++/osgGA/CmdLineArgs.html new file mode 100644 index 000000000..2bd47e772 --- /dev/null +++ b/doc/doc++/osgGA/CmdLineArgs.html @@ -0,0 +1,97 @@ + + + + + #define CmdLineArgs + + + + +

#define CmdLineArgs

+
+ +

+A collection of utilities for processing command line arguments. + +

An osgGA::CmdLineArgs::Processor class is provided, which implements a chain +of responsibilty for handline command line arguments. Each item in the chain +is a subclass of the abstract osgGA::CmdLineArgs::ArgHandler. A number +of ArgHandlers are provided, though the user if free to implement their +own subclasses for specific needs (e.g. to validate an argument which +takes an integer which must be in a specific range). + +

Let's look at an example... + +

Example

+ +

\code + +

#include + +

int main(int argc, char* argv[]) +{ +using namespace osg; +using namespace osgGA::CmdLineArgs; + +

// Create some handlers +ref_ptr helpSwitch(new BoolHandler("[-h]","\t\tPrint this help and exit","-h")); +ref_ptr verboseSwitch(new BoolHandler("[-v]","\t\tActivate verbose output","-v")); +ref_ptr configFile( +new SwitchStringHandler("[-config ", +"\t\tSpecify a config file to load"), "-config"); + +

Processor clp; +clp.push_back(helpSwitch.get()); +clp.push_back(verboseSwitch.get()); +clp.push_back(configFile.get()); + +

try{ +clp.process(argc,argv); +} +catch(ArgHandlerX& e){ +cerr<if(helpSwitch->wasSpecified()){ +clp.printHelp(cerr); +exit(0); +} + +

if(verboseSwitch->wasSpecified()){ +// Activate verbosity... +} + +

if(configFile->wasSpecified()){ +loadConfigFile(configFile->getString()); +} + +

} + +

\endcode + +

The processor takes each argument on the command line in turn, and passes it +to the ArgHandler chain. Each ArgHandler is given the opportunity to handle +an argument and - if it requires - any subsequent arguments until the +end of the argument list (it can do this by incrementing the ArgIterator +passed to it. If an ArgHandler handles an argument (e.g. it's looking for +and recognises the argument '-h'), it returns true and further processing of +the argument stops. If an argument is not handled it is passed to the next +handler in the chain, and so on, until it is either handled, or it drops off +the end of the chain. + +

A number of pre-written ArgHandlers are supplied. User's may use these +directly, may write their own, or may extend a pre-written ArgHandler to +customise it for their specific needs. +

+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/MergeGeometryVisitor.html b/doc/doc++/osgUtil/MergeGeometryVisitor.html new file mode 100644 index 000000000..3fdead264 --- /dev/null +++ b/doc/doc++/osgUtil/MergeGeometryVisitor.html @@ -0,0 +1,102 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Optimizer::MergeGeometryVisitor + + + + +

class OSGUTIL_EXPORT MergeGeometryVisitor

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] MergeGeometryVisitor() +
default to traversing all children +
+[more]virtual void apply(osg::Geode& geode) +
+[more]virtual void apply(osg::Billboard&) +
+[more]static bool mergeGeode(osg::Geode& geode) +
+[more]static bool mergeGeometry(osg::Geometry& lhs, osg::Geometry& rhs) +
+[more]static bool mergePrimitive(osg::DrawArrays& lhs, osg::DrawArrays& rhs) +
+[more]static bool mergePrimitive(osg::DrawArrayLengths& lhs, osg::DrawArrayLengths& rhs) +
+[more]static bool mergePrimitive(osg::DrawElementsUByte& lhs, osg::DrawElementsUByte& rhs) +
+[more]static bool mergePrimitive(osg::DrawElementsUShort& lhs, osg::DrawElementsUShort& rhs) +
+[more]static bool mergePrimitive(osg::DrawElementsUInt& lhs, osg::DrawElementsUInt& rhs) +

+ +
+ + +
+

Documentation

+
+ + + +
o MergeGeometryVisitor() +
default to traversing all children +

+ + +

ovirtual void apply(osg::Geode& geode) +

+ + +

ovirtual void apply(osg::Billboard&) +

+ + +

ostatic bool mergeGeode(osg::Geode& geode) +

+ + +

ostatic bool mergeGeometry(osg::Geometry& lhs, osg::Geometry& rhs) +

+ + +

ostatic bool mergePrimitive(osg::DrawArrays& lhs, osg::DrawArrays& rhs) +

+ + +

ostatic bool mergePrimitive(osg::DrawArrayLengths& lhs, osg::DrawArrayLengths& rhs) +

+ + +

ostatic bool mergePrimitive(osg::DrawElementsUByte& lhs, osg::DrawElementsUByte& rhs) +

+ + +

ostatic bool mergePrimitive(osg::DrawElementsUShort& lhs, osg::DrawElementsUShort& rhs) +

+ + +

ostatic bool mergePrimitive(osg::DrawElementsUInt& lhs, osg::DrawElementsUInt& rhs) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + +