From 217621401e96747e0e19caaa8a6c98484f453402 Mon Sep 17 00:00:00 2001
From: Robert Osfield
Date: Mon, 24 Dec 2001 21:56:22 +0000
Subject: [PATCH] Did a make docs.
---
doc/doc++/osg/AlphaFunc.html | 18 +-
doc/doc++/osg/Billboard.html | 41 +-
doc/doc++/osg/BoundingBox.html | 138 ++--
doc/doc++/osg/BoundingSphere.html | 78 +-
doc/doc++/osg/Camera.html | 636 +++++++++------
doc/doc++/osg/ClipPlane.html | 10 +-
doc/doc++/osg/ClippingVolume.html | 8 +-
doc/doc++/osg/ColorMask.html | 12 +-
doc/doc++/osg/CullFace.html | 58 +-
doc/doc++/osg/Depth.html | 106 +--
doc/doc++/osg/Drawable.html | 245 ++++--
doc/doc++/osg/Fog.html | 110 +--
doc/doc++/osg/FrameStamp.html | 86 +--
doc/doc++/osg/FrontFace.html | 52 +-
doc/doc++/osg/General.html | 100 ++-
doc/doc++/osg/GeoSet.html | 721 ++++++++++--------
doc/doc++/osg/Geode.html | 102 +--
doc/doc++/osg/Group.html | 113 +--
doc/doc++/osg/HIER.html | 9 +-
doc/doc++/osg/HIERjava.html | 12 +-
doc/doc++/osg/Image.html | 146 ++--
doc/doc++/osg/Impostor.html | 92 +--
doc/doc++/osg/ImpostorSprite.html | 195 ++---
doc/doc++/osg/ImpostorSpriteManager.html | 50 +-
doc/doc++/osg/LOD.html | 88 ++-
doc/doc++/osg/Light.html | 212 +++--
doc/doc++/osg/LightSource.html | 62 +-
doc/doc++/osg/LineSegment.html | 100 +--
doc/doc++/osg/Material.html | 246 +++---
doc/doc++/osg/Matrix.html | 438 +++++------
doc/doc++/osg/MemoryAdapter.html | 22 +-
doc/doc++/osg/Node.html | 287 +++----
doc/doc++/osg/NodeAcceptOp.html | 20 +-
doc/doc++/osg/NodeCallback.html | 84 +-
doc/doc++/osg/NodeVisitor.html | 178 +++--
doc/doc++/osg/NotifySeverity.html | 28 +-
doc/doc++/osg/Object.html | 37 +-
doc/doc++/osg/Plane.html | 120 +--
doc/doc++/osg/Point.html | 74 +-
doc/doc++/osg/PolygonMode.html | 78 +-
doc/doc++/osg/PolygonOffset.html | 54 +-
doc/doc++/osg/Quat.html | 164 ++--
doc/doc++/osg/Referenced.html | 49 +-
doc/doc++/osg/State.html | 131 ++--
doc/doc++/osg/StateAttribute.html | 380 ++++-----
doc/doc++/osg/StateSet.html | 264 ++++---
doc/doc++/osg/Stencil.html | 164 ++--
doc/doc++/osg/Switch.html | 68 +-
doc/doc++/osg/TexEnv.html | 56 +-
doc/doc++/osg/TexGen.html | 98 +--
doc/doc++/osg/TexMat.html | 42 +-
doc/doc++/osg/Texture.html | 330 ++++----
doc/doc++/osg/Timer.html | 32 +-
doc/doc++/osg/Transform.html | 149 ++--
doc/doc++/osg/Transparency.html | 88 +--
doc/doc++/osg/Vec2.html | 150 ++--
doc/doc++/osg/Vec3.html | 158 ++--
doc/doc++/osg/Vec4.html | 162 ++--
doc/doc++/osg/Viewport.html | 85 ++-
doc/doc++/osg/clampArray3BetweenRange.html | 4 +-
doc/doc++/osg/clampArray3GEQUAL.html | 4 +-
doc/doc++/osg/clampArray3LEQUAL.html | 4 +-
doc/doc++/osg/clampArray4BetweenRange.html | 4 +-
doc/doc++/osg/clampArray4GEQUAL.html | 4 +-
doc/doc++/osg/clampArray4LEQUAL.html | 4 +-
.../osg/clampArrayElementBetweenRange.html | 4 +-
doc/doc++/osg/clampArrayElementGEQUAL.html | 4 +-
doc/doc++/osg/clampArrayElementLEQUAL.html | 4 +-
.../osg/clampArrayElementsBetweenRange.html | 6 +-
doc/doc++/osg/clampArrayElementsGEQUAL.html | 4 +-
doc/doc++/osg/clampArrayElementsLEQUAL.html | 4 +-
doc/doc++/osg/clampBetweenRange.html | 4 +-
doc/doc++/osg/clampGEQUAL.html | 4 +-
doc/doc++/osg/clampLEQUAL.html | 4 +-
doc/doc++/osg/createGeodeForImage.2.html | 2 +-
doc/doc++/osg/for_each_triangle.html | 2 +-
doc/doc++/osg/index.html | 35 +
doc/doc++/osg/isGLExtensionSupported.html | 2 +-
doc/doc++/osg/mem_ptr.html | 96 +--
doc/doc++/osg/notify.html | 4 +-
doc/doc++/osg/osg.html | 289 ++++---
doc/doc++/osg/osgGetVersion.html | 4 +-
doc/doc++/osg/ref_ptr.html | 106 +--
doc/doc++/osgDB/DotOsgWrapper.html | 4 +-
doc/doc++/osgDB/FieldReader.html | 8 +-
doc/doc++/osgDB/FieldReaderIterator.html | 8 +-
doc/doc++/osgDB/HIER.html | 5 +-
doc/doc++/osgDB/HIERjava.html | 23 +-
doc/doc++/osgDB/Input.html | 54 +-
doc/doc++/osgDB/Output.html | 144 ++--
doc/doc++/osgDB/ReaderWriter.html | 57 +-
.../osgDB/RegisterDotOsgWrapperProxy.html | 12 +-
.../osgDB/RegisterReaderWriterProxy.html | 12 +-
doc/doc++/osgDB/Registry.html | 152 ++--
doc/doc++/osgDB/findFileInDirectory.html | 2 +-
doc/doc++/osgDB/osgDB.html | 19 +-
doc/doc++/osgDB/osgDBGetVersion.html | 4 +-
doc/doc++/osgDB/readImageFile.html | 2 +-
doc/doc++/osgDB/readNodeFile.html | 2 +-
doc/doc++/osgDB/readObjectFile.html | 2 +-
doc/doc++/osgDB/writeImageFile.html | 2 +-
doc/doc++/osgDB/writeNodeFile.html | 2 +-
doc/doc++/osgDB/writeObjectFile.html | 2 +-
doc/doc++/osgGLUT/GLUTEventAdapter.html | 166 ++--
doc/doc++/osgGLUT/General.html | 8 +-
doc/doc++/osgGLUT/HIER.html | 3 +
doc/doc++/osgGLUT/HIERjava.html | 8 +-
doc/doc++/osgGLUT/Viewer.html | 490 ++++++------
doc/doc++/osgGLUT/index.html | 2 +
doc/doc++/osgGLUT/osgGLUT.html | 5 +-
doc/doc++/osgGLUT/osgGLUTGetVersion.html | 4 +-
doc/doc++/osgUtil/CullVisitor.html | 390 ++++++----
doc/doc++/osgUtil/DepthSortedBin.html | 6 +-
doc/doc++/osgUtil/DisplayListVisitor.html | 100 +--
doc/doc++/osgUtil/DriveManipulator.html | 32 +-
doc/doc++/osgUtil/FlightManipulator.html | 42 +-
doc/doc++/osgUtil/GUIActionAdapter.html | 12 +-
doc/doc++/osgUtil/GUIEventAdapter.html | 84 +-
doc/doc++/osgUtil/GUIEventHandler.html | 4 +-
doc/doc++/osgUtil/General.html | 18 +-
doc/doc++/osgUtil/HIER.html | 12 +-
doc/doc++/osgUtil/HIERjava.html | 48 +-
doc/doc++/osgUtil/Hit.html | 66 +-
doc/doc++/osgUtil/InsertImpostorsVisitor.html | 64 +-
doc/doc++/osgUtil/IntersectState.html | 32 +-
doc/doc++/osgUtil/IntersectVisitor.html | 116 +--
doc/doc++/osgUtil/RegisterRenderBinProxy.html | 12 +-
doc/doc++/osgUtil/RenderBin.html | 104 +--
doc/doc++/osgUtil/RenderGraph.html | 74 +-
doc/doc++/osgUtil/RenderLeaf.html | 32 +-
doc/doc++/osgUtil/RenderStage.html | 206 ++---
doc/doc++/osgUtil/RenderStageLighting.html | 80 +-
doc/doc++/osgUtil/RenderToTextureStage.html | 54 +-
doc/doc++/osgUtil/SceneView.html | 426 ++++++-----
doc/doc++/osgUtil/SceneViewManipulator.html | 60 +-
doc/doc++/osgUtil/SmoothingVisitor.html | 12 +-
doc/doc++/osgUtil/StateSetManipulator.html | 40 +-
doc/doc++/osgUtil/Tesselator.html | 8 +-
doc/doc++/osgUtil/TriStripVisitor.html | 14 +-
doc/doc++/osgUtil/index.html | 6 +-
doc/doc++/osgUtil/osgUtil.html | 19 +-
doc/doc++/osgUtil/osgUtilGetVersion.html | 4 +-
142 files changed, 6419 insertions(+), 5398 deletions(-)
diff --git a/doc/doc++/osg/AlphaFunc.html b/doc/doc++/osg/AlphaFunc.html
index 1ee547237..7e183602d 100644
--- a/doc/doc++/osg/AlphaFunc.html
+++ b/doc/doc++/osg/AlphaFunc.html
@@ -7,7 +7,7 @@
-Encapsulte OpenGL glAlphaFunc
+Encapsulate OpenGL glAlphaFunc
Inheritance:
@@ -25,14 +25,14 @@
Public Methods
AlphaFunc()
-
META_StateAttribute(AlphaFunc, ALPHAFUNC)
+
META_StateAttribute(AlphaFunc, ALPHAFUNC)
virtual int compare(const StateAttribute& sa) const
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
inline void setFunction(const ComparisonFunction func, const float ref)
+
inline void setFunction(const ComparisonFunction func, const float ref)
inline const ComparisonFunction getFunction() const
@@ -69,7 +69,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -122,7 +122,7 @@
Documentation
-Encapsulte OpenGL glAlphaFunc
+Encapsulate OpenGL glAlphaFunc
@@ -131,7 +131,7 @@
-
META_StateAttribute(AlphaFunc, ALPHAFUNC)
+
META_StateAttribute(AlphaFunc, ALPHAFUNC)
@@ -140,7 +140,7 @@
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
@@ -182,7 +182,7 @@
-
inline void setFunction(const ComparisonFunction func, const float ref)
+
inline void setFunction(const ComparisonFunction func, const float ref)
diff --git a/doc/doc++/osg/Billboard.html b/doc/doc++/osg/Billboard.html
index 03f2f32a4..edcee50b4 100644
--- a/doc/doc++/osg/Billboard.html
+++ b/doc/doc++/osg/Billboard.html
@@ -46,10 +46,10 @@
- Get the position of specified drawable.
-
inline PositionList& getPositionList()
- - Get the PostionList from the billboard
+
- Get the PositionList from the billboard
-
inline const PositionList& getPositionList() const
- - Get a const PostionList from the billboard
+
- Get a const PositionList from the billboard
-
virtual const bool addDrawable( Drawable* gset )
- Add Drawable to Billboard with default position(0,0,0); If gset not NULL and is not contained in Billboard then increment its reference count, and dirty the bounding box to cause it to recompute on next getBound() and return true for success.
@@ -139,7 +139,7 @@
-
inline const std::string& getName() const
-
-
inline const ParentList& getParents() const
+
inline const ParentList& getParents() const
-
inline Group* getParent(const int i)
-
@@ -155,23 +155,25 @@
-
inline const int getNumChildrenRequiringAppTraversal() const
-
-
inline void setUserData(void* data, MemoryAdapter* ma=0L)
+
void setCullingActive(const bool active)
-
-
inline void* getUserData()
+
inline const bool getCullingActive() const
-
-
inline const void* getUserData() const
+
inline const int getNumChildrenWithCullingDisabled() const
-
-
inline MemoryAdapter* getMemoryAdapter()
+
inline void setUserData(osg::Referenced* obj)
-
-
inline const MemoryAdapter* getMemoryAdapter() const
+
inline Referenced* getUserData()
+-
+
inline const Referenced* getUserData() const
-
inline void setNodeMask(const NodeMask nm)
-
inline const NodeMask getNodeMask() const
-
-
inline const DescriptionList& getDescriptions() const
+
inline const DescriptionList& getDescriptions() const
-
-
inline DescriptionList& getDescriptions()
+
inline DescriptionList& getDescriptions()
-
inline const std::string& getDescription(const int i) const
-
@@ -207,19 +209,21 @@
-
std::string _name
-
-
ParentList _parents
+
ParentList _parents
-
ref_ptr<NodeCallback> _appCallback
-
int _numChildrenRequiringAppTraversal
-
-
void* _userData
+
bool _cullingActive
-
-
ref_ptr<MemoryAdapter> _memoryAdapter
+
int _numChildrenWithCullingDisabled
+-
+
osg::ref_ptr<Referenced> _userData
-
NodeMask _nodeMask
-
-
DescriptionList _descriptions
+
DescriptionList _descriptions
-
ref_ptr<StateSet> _dstate
@@ -227,6 +231,8 @@
Protected Methods
-
void setNumChildrenRequiringAppTraversal(const int num)
+-
+
void setNumChildrenWithCullingDisabled(const int num)
@@ -257,8 +263,7 @@
Documentation
Billboard - a Geode which orientates its child osg::Drawable's to face
-the eye point.
-Typical uses are for trees, or particle explosions.
+the eye point. Typical uses are for trees, or particle explosions.
@@ -325,12 +330,12 @@ Typical uses are for trees, or particle explosions.
inline PositionList& getPositionList()
-- Get the PostionList from the billboard
+
- Get the PositionList from the billboard
inline const PositionList& getPositionList() const
-- Get a const PostionList from the billboard
+
- Get a const PositionList from the billboard
diff --git a/doc/doc++/osg/BoundingBox.html b/doc/doc++/osg/BoundingBox.html
index 836956615..777d740cd 100644
--- a/doc/doc++/osg/BoundingBox.html
+++ b/doc/doc++/osg/BoundingBox.html
@@ -22,61 +22,72 @@
Public Methods
-
-
BoundingBox()
+
inline BoundingBox()
- construct to invalid values to represent an unset bounding box
-
-
inline void init()
+
inline BoundingBox(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax)
+ - construct to with specified min and max values
+
-
+
inline BoundingBox(const Vec3& min, const Vec3& max)
+ - construct to with specified min and max values
+
-
+
inline void init()
- initialize to invalid values to represent an unset bounding box
-
-
inline const bool isValid() const
+
inline const bool isValid() const
- return true if the bounding box contains valid values, false if the bounding box is effectively unset/empty
-
-
inline float& xMin()
+
inline void set(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax)
-
-
inline const float xMin() const
+
inline void set(const Vec3& min, const Vec3& max)
+ - construct to with specified min and max values
-
-
inline float& yMin()
+
inline float& xMin()
-
-
inline const float yMin() const
+
inline const float xMin() const
-
-
inline float& zMin()
+
inline float& yMin()
-
-
inline const float zMin() const
+
inline const float yMin() const
-
-
inline float& xMax()
+
inline float& zMin()
-
-
inline const float xMax() const
+
inline const float zMin() const
-
-
inline float& yMax()
+
inline float& xMax()
-
-
inline const float yMax() const
+
inline const float xMax() const
-
-
inline float& zMax()
+
inline float& yMax()
-
-
inline const float zMax() const
+
inline const float yMax() const
-
-
inline const Vec3 center() const
+
inline float& zMax()
+-
+
inline const float zMax() const
+-
+
inline const Vec3 center() const
- Calculate and return the center of the bounding box
-
-
inline const float radius() const
+
inline const float radius() const
- Calculate and return the radius of the bounding box
-
-
inline const float radius2() const
+
inline const float radius2() const
- Calculate and return the radius squared of the bounding box.
-
-
inline const Vec3 corner(unsigned int pos) const
+
inline const Vec3 corner(unsigned int pos) const
- return the corner of the bounding box.
-
-
void expandBy(const Vec3& v)
- - If the vertex is outwith the box expand to ecompass vertex.
+
void expandBy(const Vec3& v)
+- If the vertex is out-with the box expand to encompass vertex.
-
-
void expandBy(const BoundingBox& bb)
- - If incomming box is outwith the box expand to ecompass incomming box.
+
void expandBy(const BoundingBox& bb)
+- If incoming box is out-with the box expand to encompass incoming box.
-
-
void expandBy(const BoundingSphere& sh)
- - If incomming sphere is outwith the box expand to ecompass incomming sphere.
+
void expandBy(const BoundingSphere& sh)
+- If incoming sphere is out-with the box expand to encompass incoming sphere.
-
-
inline const bool contains(const Vec3& v) const
+
inline const bool contains(const Vec3& v) const
- return true is vertex v is within the box
@@ -104,113 +115,132 @@ bounding box
-
BoundingBox()
+
inline BoundingBox()
- construct to invalid values to represent an unset bounding box
-
+
+
inline BoundingBox(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax)
+- construct to with specified min and max values
+
+
+
+
inline BoundingBox(const Vec3& min, const Vec3& max)
+- construct to with specified min and max values
+
+
+
inline void init()
- initialize to invalid values to represent an unset bounding box
-
+
inline const bool isValid() const
- return true if the bounding box contains valid values,
false if the bounding box is effectively unset/empty
+
+
+
inline void set(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax)
+
+
+
+
inline void set(const Vec3& min, const Vec3& max)
+- construct to with specified min and max values
+
-
+
inline float& xMin()
-
+
inline const float xMin() const
-
+
inline float& yMin()
-
+
inline const float yMin() const
-
+
inline float& zMin()
-
+
inline const float zMin() const
-
+
inline float& xMax()
-
+
inline const float xMax() const
-
+
inline float& yMax()
-
+
inline const float yMax() const
-
+
inline float& zMax()
-
+
inline const float zMax() const
-
+
inline const Vec3 center() const
- Calculate and return the center of the bounding box
-
+
inline const float radius() const
- Calculate and return the radius of the bounding box
-
+
inline const float radius2() const
- Calculate and return the radius squared of the bounding box.
Note, radius2() is faster to calculate than radius().
-
+
inline const Vec3 corner(unsigned int pos) const
- return the corner of the bounding box.
-Position (pos) is specfied by a number between 0 and 7,
+Position (pos) is specified by a number between 0 and 7,
the first bit toggles between x min and x max, second
bit toggles between y min and y max, third bit toggles
between z min and z max.
-
+
void expandBy(const Vec3& v)
-- If the vertex is outwith the box expand to ecompass vertex.
+
- If the vertex is out-with the box expand to encompass vertex.
If this box is empty then move set this box's min max to vertex.
-
+
void expandBy(const BoundingBox& bb)
-- If incomming box is outwith the box expand to ecompass incomming box.
-If this box is empty then move set this box to incomming box.
+
- If incoming box is out-with the box expand to encompass incoming box.
+If this box is empty then move set this box to incoming box.
-
+
void expandBy(const BoundingSphere& sh)
-- If incomming sphere is outwith the box expand to ecompass incomming sphere.
+
- If incoming sphere is out-with the box expand to encompass incoming sphere.
If this box is empty then move set this box to encompass the sphere.
-
+
inline const bool contains(const Vec3& v) const
- return true is vertex v is within the box
diff --git a/doc/doc++/osg/BoundingSphere.html b/doc/doc++/osg/BoundingSphere.html
index b120caac2..36f0e76d2 100644
--- a/doc/doc++/osg/BoundingSphere.html
+++ b/doc/doc++/osg/BoundingSphere.html
@@ -23,43 +23,49 @@
BoundingSphere()
construct to invalid values to represent an unset bounding sphere
-
inline void init()
+
BoundingSphere(const Vec3& center, float radius)
+construct to specified bounding sphere
+
+
inline void init()
initialize to invalid values to represent an unset bounding sphere
-
inline const bool isValid() const
+
inline const bool isValid() const
return true if the bounding sphere contains valid values, false if the bounding sphere is effectively unset
-
inline Vec3& center()
+
inline void set(const Vec3& center, float radius)
+set bounding sphere
+
+
inline Vec3& center()
return the center of the bounding sphere
-
inline const Vec3& center() const
+
inline const Vec3& center() const
return the const center of the bounding sphere
-
inline float& radius()
+
inline float& radius()
return the radius of the bounding sphere
-
inline const float radius() const
+
inline const float radius() const
return the const radius of the bounding sphere
-
inline const float radius2() const
+
inline const float radius2() const
return the radius squared.
-
void expandBy(const Vec3& v)
-If the vertex is outwith the sphere expand to ecompass vertex.
+
void expandBy(const Vec3& v)
+If the vertex is out-with the sphere expand to encompass vertex.
-
void expandRadiusBy(const Vec3& v)
+
void expandRadiusBy(const Vec3& v)
If the vertex is outwith the sphere expand radius to ecompass vertex.
-
void expandBy(const BoundingSphere& sh)
+
void expandBy(const BoundingSphere& sh)
If incomming sphere is outwith the sphere expand to ecompass incomming sphere.
-
void expandRadiusBy(const BoundingSphere& sh)
+
void expandRadiusBy(const BoundingSphere& sh)
If incomming sphere is outwith the sphere expand radius to ecompass incomming sphere.
-
inline const bool contains(const Vec3& v) const
+
inline const bool contains(const Vec3& v) const
return true is vertex v is within the sphere
-
inline const bool intersects( const BoundingSphere& bs ) const
+
inline const bool intersects( const BoundingSphere& bs ) const
return true if bounding sphere's intersect each other
@@ -70,7 +76,7 @@
Documentation
General purpose bounding sphere class for enclosing nodes/objects/vertices.
Used to bound internal osg::Node's in the scene,
-to assist in view frustrum culling etc. Similar in function to BoundingBox
+to assist in view frustum culling etc. Similar in function to BoundingBox
but is quicker for evaluating culling, but generally encloses a greater volume
than a BoundingBox so will not cull so aggressively.
@@ -88,62 +94,72 @@ than a BoundingBox so will not cull so aggressively.
BoundingSphere()
- construct to invalid values to represent an unset bounding sphere
-
+
+
BoundingSphere(const Vec3& center, float radius)
+- construct to specified bounding sphere
+
+
+
inline void init()
- initialize to invalid values to represent an unset bounding sphere
-
+
inline const bool isValid() const
- return true if the bounding sphere contains valid values,
false if the bounding sphere is effectively unset
+
+
+
inline void set(const Vec3& center, float radius)
+- set bounding sphere
+
-
+
inline Vec3& center()
- return the center of the bounding sphere
-
+
inline const Vec3& center() const
- return the const center of the bounding sphere
-
+
inline float& radius()
- return the radius of the bounding sphere
-
+
inline const float radius() const
- return the const radius of the bounding sphere
-
+
inline const float radius2() const
- return the radius squared.
Note, for performance reasons, assumes the calling method has ensured
that the sphere is valid before calling radius2(), i.e. has _radius>=0.0,
-as it does not check th validity of sphere and will eroneously return a positive value.
+as it does not check th validity of sphere and will erroneously return a positive value.
-
+
void expandBy(const Vec3& v)
-- If the vertex is outwith the sphere expand to ecompass vertex.
+
- If the vertex is out-with the sphere expand to encompass vertex.
Calculates the combination of movement of center and radius which
minimizes the radius increase. If this sphere is empty then
-move the centrer to v and set radius to 0.
+move the center to v and set radius to 0.
-
+
void expandRadiusBy(const Vec3& v)
- If the vertex is outwith the sphere expand radius to ecompass vertex.
Unlike update, does not move the center, just increasing the radius.
If this sphere is empty then move the centrer to v and set radius to 0
-
+
void expandBy(const BoundingSphere& sh)
- If incomming sphere is outwith the sphere expand to ecompass incomming sphere.
calculates the combination of movement of center and radius which
@@ -151,19 +167,19 @@ minimizes the radius increase. If this sphere is empty then
move the centrer to v and set radius to 0.
-
+
void expandRadiusBy(const BoundingSphere& sh)
- If incomming sphere is outwith the sphere expand radius to ecompass incomming sphere.
Unlike update, does not move the center, just increasing the radius.
If this sphere is empty then move the centrer to v and set radius to 0.
-
+
inline const bool contains(const Vec3& v) const
- return true is vertex v is within the sphere
-
+
inline const bool intersects( const BoundingSphere& bs ) const
- return true if bounding sphere's intersect each other
diff --git a/doc/doc++/osg/Camera.html b/doc/doc++/osg/Camera.html
index 1de788180..7c82477f6 100644
--- a/doc/doc++/osg/Camera.html
+++ b/doc/doc++/osg/Camera.html
@@ -23,215 +23,258 @@
Public Methods
-
-
Camera()
+
Camera(DisplaySettings* ds=NULL)
-
-
virtual ~Camera()
+
Camera(const Camera&)
-
-
const ProjectionType getProjectionType() const
+
Camera& operator=(const Camera&)
+-
+
virtual ~Camera()
+-
+
const ProjectionType getProjectionType() const
- Get the projection type set by setOtho,setOtho2D,setFrustum, and set perspective methods
-
-
void setOrtho(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
- - Set a orthographics projection.
+
void setOrtho(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+- Set a orthographic projection.
-
-
void setOrtho2D(const double left, const double right, const double bottom, const double top)
- - Set a 2D orthographics projection.
+
void setOrtho2D(const double left, const double right, const double bottom, const double top)
+- Set a 2D orthographic projection.
-
-
void setFrustum(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+
void setFrustum(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
- Set a perspective projection.
-
-
void setPerspective(const double fovy, const double aspectRatio, const double zNear, const double zFar)
- - Set a sysmetical perspective projection, See gluPerspective for further details.
+
void setPerspective(const double fovy, const double aspectRatio, const double zNear, const double zFar)
+- Set a symmetrical perspective projection, See gluPerspective for further details.
-
-
void setFOV(const double fovx, const double fovy, const double zNear, const double zFar)
- - Set a sysmetical perspective projection using field of view
+
void setFOV(const double fovx, const double fovy, const double zNear, const double zFar)
+- Set a sysmmetical perspective projection using field of view
-
-
void setNearFar(const double zNear, const double zFar)
+
void setNearFar(const double zNear, const double zFar)
- Set the near and far clipping planes
-
-
void setAdjustAspectRatioMode(const AdjustAspectRatioMode aam)
+
void setAdjustAspectRatioMode(const AdjustAspectRatioMode aam)
- Set the way that the vertical or horizontal dimensions of the window are adjusted on a resize.
-
-
const AdjustAspectRatioMode getAdjustAspectRatioMode() const
+
const AdjustAspectRatioMode getAdjustAspectRatioMode() const
- Get the way that the vertical or horizontal dimensions of the window are adjusted on a resize.
-
-
void adjustAspectRatio(const double newAspectRatio)
- - Adjust the clipping planes to account for a new window aspcect ratio.
+
void adjustAspectRatio(const double newAspectRatio)
+- Adjust the clipping planes to account for a new window aspect ratio.
-
-
void adjustAspectRatio(const double newAspectRatio, const AdjustAspectRatioMode aa)
- - Adjust the clipping planes to account for a new window aspcect ratio.
+
void adjustAspectRatio(const double newAspectRatio, const AdjustAspectRatioMode aa)
+- Adjust the clipping planes to account for a new window aspect ratio.
-
-
const double left() const
+
const double left() const
-
-
const double right() const
+
const double right() const
-
-
const double top() const
+
const double top() const
-
-
const double bottom() const
+
const double bottom() const
-
-
const double zNear() const
+
const double zNear() const
-
-
const double zFar() const
+
const double zFar() const
-
-
const double calc_fovy() const
- - Calculate and return the equivilant fovx for the current project setting.
+
const double calc_fovy() const
+- Calculate and return the equivalent fovx for the current project setting.
-
-
const double calc_fovx() const
- - Calculate and return the equivilant fovy for the current project setting.
+
const double calc_fovx() const
+- Calculate and return the equivalent fovy for the current project setting.
-
-
const double calc_aspectRatio() const
+
const double calc_aspectRatio() const
- Calculate and return the projection aspect ratio.
-
-
const Matrix& getProjectionMatrix() const
+
const Matrix& getProjectionMatrix() const
-
-
const LookAtType getLookAtType() const
+
const LookAtType getLookAtType() const
-
-
void home()
+
void home()
- hardwired home view for now, looking straight down the Z axis at the origin, with 'up' being the y axis
-
-
void setView(const Vec3& eyePoint, const Vec3& lookPoint, const Vec3& upVector)
+
void setView(const Vec3& eyePoint, const Vec3& lookPoint, const Vec3& upVector)
- Set the View, the up vector should be orthogonal to the look vector.
-
-
void setLookAt(const Vec3& eye, const Vec3& center, const Vec3& up)
- - set the position and orientaion of the camera, using the same convention as gluLookAt
+
void setLookAt(const Vec3& eye, const Vec3& center, const Vec3& up)
+- set the position and orientation of the camera, using the same convention as gluLookAt
-
-
void setLookAt(const double eyeX, const double eyeY, const double eyeZ, const double centerX, const double centerY, const double centerZ, const double upX, const double upY, const double upZ)
- - set the position and orientaion of the camera, using the same convention as gluLookAt
+
void setLookAt(const double eyeX, const double eyeY, const double eyeZ, const double centerX, const double centerY, const double centerZ, const double upX, const double upY, const double upZ)
+- set the position and orientation of the camera, using the same convention as gluLookAt
-
-
void transformLookAt(const Matrix& matrix)
+
void transformLookAt(const Matrix& matrix)
- post multiple the existing eye point and orientation by matrix.
-
-
void ensureOrthogonalUpVector()
+
void ensureOrthogonalUpVector()
-
-
inline const Vec3& getEyePoint() const
+
inline const Vec3& getEyePoint() const
- get the eye point.
-
-
inline const Vec3& getCenterPoint() const
+
inline const Vec3& getCenterPoint() const
- get the center point.
-
-
inline const Vec3& getUpVector() const
+
inline const Vec3& getUpVector() const
- get the up vector
-
-
const Vec3 getLookVector() const
+
const Vec3 getLookVector() const
- calculate look vector
-
-
const Vec3 getSideVector() const
+
const Vec3 getSideVector() const
- calculate side vector
-
-
inline const float getFocalLength() const
- - get focal distance
+
inline float getLookDistance() const
+- calculate the look distance which is the distance between the eye and the center
-
-
void attachTransform(const TransformMode mode, Matrix* modelTransform=0)
+
void attachTransform(const TransformMode mode, Matrix* modelTransform=0)
- Attach a transform matrix which is applied after the camera look at.
-
-
void dirtyTransform()
+
void dirtyTransform()
- must be called after you modify an attachedTransform.
-
-
Matrix* getTransform(const TransformMode mode)
+
Matrix* getTransform(const TransformMode mode)
-
-
const Matrix* getTransform(const TransformMode mode) const
+
const Matrix* getTransform(const TransformMode mode) const
-
-
const Vec3 getEyePoint_Model() const
+
const Vec3 getEyePoint_Model() const
-
-
const Vec3 getCenterPoint_Model() const
+
const Vec3 getCenterPoint_Model() const
-
-
const Vec3 getLookVector_Model() const
+
const Vec3 getLookVector_Model() const
-
-
const Vec3 getUpVector_Model() const
+
const Vec3 getUpVector_Model() const
-
-
const Vec3 getSideVector_Model() const
+
const Vec3 getSideVector_Model() const
-
-
const Matrix& getModelViewMatrix() const
+
const Matrix& getModelViewMatrix() const
- Get the ModelView matrix.
-
-
void setUseNearClippingPlane(const bool use)
+
void setUseNearClippingPlane(const bool use)
+ - Switch on/off the use of the near clipping plane which creating the getClippingVolume(), uses the camera _znear value for the position of the near clipping plane.
-
-
const bool getUseNearClippingPlane() const
+
const bool getUseNearClippingPlane() const
+ - get whether the ClippingVolume uses a near clipping plane
-
-
void setUseFarClippingPlane(const bool use)
+
void setUseFarClippingPlane(const bool use)
+ - Switch on/off the use of the far clipping plane which creating the getClippingVolume(), uses the camera _zfar value for the position of the far clipping plane.
-
-
const bool getUseFarClippingPlane() const
+
const bool getUseFarClippingPlane() const
+ - Get whether the ClippingVolume uses a far clipping plane
-
-
const ClippingVolume& getClippingVolume() const
+
const ClippingVolume& getClippingVolume() const
- get the view frustum clipping in model coordinates
-
-
const bool project(const Vec3& obj, const Viewport& viewport, Vec3& win) const
+
const bool project(const Vec3& obj, const Viewport& viewport, Vec3& win) const
- Map object coordinates into windows coordinates.
-
-
const bool unproject(const Vec3& win, const Viewport& viewport, Vec3& obj) const
+
const bool unproject(const Vec3& win, const Viewport& viewport, Vec3& obj) const
- Map window coordinates into object coordinates.
+
-
+
void setFusionDistanceMode(FusionDistanceMode mode)
+ - Set the mode of the fusion distance function which in use to calculate the fusion distance used in stereo rendering.
+
-
+
FusionDistanceMode getFusionDistanceMode() const
+ - Get the mode of the fusion distance function
+
-
+
void setFusionDistanceRatio(float ratio)
+ - Set the ratio of the fusion distance function which in use to calculate the fusion distance used in stereo rendering.
+
-
+
float getFusionDistanceRatio() const
+ - Get the ratio of the fusion distance function
+
-
+
const float getFusionDistance() const
+ - Calculate and return the fusion distance, using the FusionDistanceFunction
+
-
+
void setScreenDistance(float screenDistance)
+ - Set the physical distance between the viewers eyes and the display system.
+
-
+
const float getScreenDistance() const
+ - Get the physical distance between the viewers eyes and the display system
+
-
+
void adjustEyeOffsetForStereo(const osg::Vec3& offset)
+ - Convinience method for adjusting the project and model view to account for and eye offset, as used in stereo work, assumes that the users will use a seperate camera for each eye, adjustEyePointForStereo() being used to specialize the camera for each eye view
+
-
+
virtual void apply(State& state)
+ - Set up the OpenGL projection and model view matrices
Public Members
-
-
enum ProjectionType
+
enum ProjectionType
- Range of projection types.
-
-
enum AdjustAspectRatioMode
+
enum AdjustAspectRatioMode
- Use in combination with adjustAspectRatio, to control the change in frustum clipping planes to account for changes in windows aspect ratio,
-
-
enum LookAtType
+
enum LookAtType
-
-
enum TransformMode
+
enum TransformMode
+-
+
enum FusionDistanceMode
Protected Fields
-
-
ProjectionType _projectionType
+
ProjectionType _projectionType
-
-
AdjustAspectRatioMode _adjustAspectRatioMode
+
AdjustAspectRatioMode _adjustAspectRatioMode
-
-
double _left
+
double _left
-
-
double _right
+
double _right
-
-
double _bottom
+
double _bottom
-
-
double _top
+
double _top
-
-
double _zNear
+
double _zNear
-
-
double _zFar
+
double _zFar
-
-
LookAtType _lookAtType
+
LookAtType _lookAtType
-
-
Vec3 _eye
+
Vec3 _eye
-
-
Vec3 _center
+
Vec3 _center
-
-
Vec3 _up
+
Vec3 _up
-
-
double _focalLength
+
TransformMode _attachedTransformMode
-
-
TransformMode _attachedTransformMode
+
ref_ptr<Matrix> _eyeToModelTransform
-
-
ref_ptr<Matrix> _eyeToModelTransform
+
ref_ptr<Matrix> _modelToEyeTransform
-
-
ref_ptr<Matrix> _modelToEyeTransform
+
bool _useNearClippingPlane
-
-
bool _useNearClippingPlane
+
bool _useFarClippingPlane
-
-
bool _useFarClippingPlane
+
mutable bool _dirty
-
-
mutable bool _dirty
+
mutable ref_ptr<Matrix> _projectionMatrix
-
-
mutable ref_ptr<Matrix> _projectionMatrix
+
mutable ref_ptr<Matrix> _modelViewMatrix
-
-
mutable ref_ptr<Matrix> _modelViewMatrix
+
mutable ClippingVolume _clippingVolume
-
-
mutable ClippingVolume _clippingVolume
+
mutable ref_ptr<Matrix> _mp
-
-
mutable ref_ptr<Matrix> _MP
+
mutable ref_ptr<Matrix> _inversemp
-
-
mutable ref_ptr<Matrix> _inverseMP
+
bool _useEyeOffset
+-
+
osg::Vec3 _eyeOffset
+-
+
float _screenDistance
+-
+
FusionDistanceMode _fusionDistanceMode
+-
+
float _fusionDistanceRatio
Protected Methods
-
-
Camera(const Camera&)
+
void copy(const Camera&)
-
-
Camera& operator=(const Camera&)
--
-
void calculateMatricesAndClippingVolume() const
+
void calculateMatricesAndClippingVolume() const
@@ -261,83 +304,91 @@
Camera class for encapsulating the view position and orientation and
projection (lens) used. Creates a projection and modelview matrices
which can be used to set OpenGL's PROJECTION and MODELVIEW matrices
-represectively.
+respectively.
-
Camera()
+
Camera(DisplaySettings* ds=NULL)
+
+
+
+
Camera(const Camera&)
+
+
+
+
Camera& operator=(const Camera&)
-
+
virtual ~Camera()
-
+
enum ProjectionType
- Range of projection types.
-OTHO2D is a special case of OTHO where the near and far planes
+ORTHO2D is a special case of ORTHO where the near and far planes
are equal to -1 and 1 respectively.
-PRESPECTIVE is a special case of FRUSTUM where the left & right
-and bottom and top and symetrical.
+PERSPECTIVE is a special case of FRUSTUM where the left & right
+and bottom and top and symmetrical.
-
+
ORTHO
-
+
ORTHO2D
-
+
FRUSTUM
-
+
PERSPECTIVE
-
-
const ProjectionType getProjectionType() const
+
+
const ProjectionType getProjectionType() const
- Get the projection type set by setOtho,setOtho2D,setFrustum,
and set perspective methods
-
-
void setOrtho(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
-- Set a orthographics projection. See glOrtho for further details.
+
+
void setOrtho(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+- Set a orthographic projection. See glOrtho for further details.
-
-
void setOrtho2D(const double left, const double right, const double bottom, const double top)
-- Set a 2D orthographics projection. See gluOrtho2D for further details.
+
+
void setOrtho2D(const double left, const double right, const double bottom, const double top)
+- Set a 2D orthographic projection. See gluOrtho2D for further details.
-
-
void setFrustum(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
+
+
void setFrustum(const double left, const double right, const double bottom, const double top, const double zNear, const double zFar)
- Set a perspective projection. See glFrustum for further details.
-
-
void setPerspective(const double fovy, const double aspectRatio, const double zNear, const double zFar)
-- Set a sysmetical perspective projection, See gluPerspective for further details.
+
+
void setPerspective(const double fovy, const double aspectRatio, const double zNear, const double zFar)
+- Set a symmetrical perspective projection, See gluPerspective for further details.
Aspect ratio is defined as width/height.
-
-
void setFOV(const double fovx, const double fovy, const double zNear, const double zFar)
-- Set a sysmetical perspective projection using field of view
+
+
void setFOV(const double fovx, const double fovy, const double zNear, const double zFar)
+- Set a sysmmetical perspective projection using field of view
-
-
void setNearFar(const double zNear, const double zFar)
+
+
void setNearFar(const double zNear, const double zFar)
- Set the near and far clipping planes
-
+
enum AdjustAspectRatioMode
- Use in combination with adjustAspectRatio, to control
the change in frustum clipping planes to account for
@@ -345,119 +396,119 @@ changes in windows aspect ratio,
-
+
ADJUST_VERTICAL
-
+
ADJUST_HORIZONTAL
-
-
void setAdjustAspectRatioMode(const AdjustAspectRatioMode aam)
+
+
void setAdjustAspectRatioMode(const AdjustAspectRatioMode aam)
- Set the way that the vertical or horizontal dimensions of the window
are adjusted on a resize.
-
-
const AdjustAspectRatioMode getAdjustAspectRatioMode() const
+
+
const AdjustAspectRatioMode getAdjustAspectRatioMode() const
- Get the way that the vertical or horizontal dimensions of the window
are adjusted on a resize.
-
+
void adjustAspectRatio(const double newAspectRatio)
-- Adjust the clipping planes to account for a new window aspcect ratio.
-Typicall used after resizeing a window. Aspect ratio is defined as
+
- Adjust the clipping planes to account for a new window aspect ratio.
+Typically used after resizing a window. Aspect ratio is defined as
width/height.
-
-
void adjustAspectRatio(const double newAspectRatio, const AdjustAspectRatioMode aa)
-- Adjust the clipping planes to account for a new window aspcect ratio.
+
+
void adjustAspectRatio(const double newAspectRatio, const AdjustAspectRatioMode aa)
+- Adjust the clipping planes to account for a new window aspect ratio.
Typicall used after resizeing a window. Aspect ratio is defined as
width/height.
-
+
const double left() const
-
+
const double right() const
-
+
const double top() const
-
+
const double bottom() const
-
+
const double zNear() const
-
+
const double zFar() const
-
+
const double calc_fovy() const
-- Calculate and return the equivilant fovx for the current project setting.
-This value is only valid for when a symetric persepctive projection exists.
+
- Calculate and return the equivalent fovx for the current project setting.
+This value is only valid for when a symmetric perspective projection exists.
i.e. getProjectionType()==PERSPECTIVE.
-
+
const double calc_fovx() const
-- Calculate and return the equivilant fovy for the current project setting.
-This value is only valid for when a symetric persepctive projection exists.
+
- Calculate and return the equivalent fovy for the current project setting.
+This value is only valid for when a symmetric perspective projection exists.
i.e. getProjectionType()==PERSPECTIVE.
-
+
const double calc_aspectRatio() const
- Calculate and return the projection aspect ratio.
Aspect ratio is defined as width/height.
-
+
const Matrix& getProjectionMatrix() const
-
+
enum LookAtType
-
+
USE_HOME_POSITON
-
+
USE_EYE_AND_QUATERNION
-
+
USE_EYE_CENTER_AND_UP
-
-
const LookAtType getLookAtType() const
+
+
const LookAtType getLookAtType() const
-
+
void home()
-
hardwired home view for now, looking straight down the
Z axis at the origin, with 'up' being the y axis
-
+
void setView(const Vec3& eyePoint, const Vec3& lookPoint, const Vec3& upVector)
-
Set the View, the up vector should be orthogonal to the look vector.
@@ -465,87 +516,87 @@ setView is now mapped to setLookAt(eye,center,up), and is only
kept for backwards compatibility.
-
-
void setLookAt(const Vec3& eye, const Vec3& center, const Vec3& up)
-- set the position and orientaion of the camera, using the same convention as
+
+
void setLookAt(const Vec3& eye, const Vec3& center, const Vec3& up)
+- set the position and orientation of the camera, using the same convention as
gluLookAt
-
+
void setLookAt(const double eyeX, const double eyeY, const double eyeZ, const double centerX, const double centerY, const double centerZ, const double upX, const double upY, const double upZ)
-- set the position and orientaion of the camera, using the same convention as
+
- set the position and orientation of the camera, using the same convention as
gluLookAt
-
+
void transformLookAt(const Matrix& matrix)
- post multiple the existing eye point and orientation by matrix.
note, does not affect any ModelTransforms that are applied.
-
+
void ensureOrthogonalUpVector()
-
+
inline const Vec3& getEyePoint() const
- get the eye point.
-
+
inline const Vec3& getCenterPoint() const
- get the center point.
-
+
inline const Vec3& getUpVector() const
- get the up vector
-
+
const Vec3 getLookVector() const
- calculate look vector
-
+
const Vec3 getSideVector() const
- calculate side vector
-
-
-
inline const float getFocalLength() const
-- get focal distance
+
+
+
inline float getLookDistance() const
+- calculate the look distance which is the distance between the eye and the center
-
+
enum TransformMode
-
+
EYE_TO_MODEL
-
+
MODEL_TO_EYE
-
+
NO_ATTACHED_TRANSFORM
-
-
void attachTransform(const TransformMode mode, Matrix* modelTransform=0)
+
+
void attachTransform(const TransformMode mode, Matrix* modelTransform=0)
- Attach a transform matrix which is applied after the camera look at.
The attached matrix can work in two ways, either as transform of the eye
into the model coordinates - EYE_TO_MODEL, or as a transform of the
-model to the eye - MODEL_TO_EYE. The former is equivilant to attaching
-a camera internal to the scene graph. The later is equivilant to adding
+model to the eye - MODEL_TO_EYE. The former is equivalent to attaching
+a camera internal to the scene graph. The later is equivalent to adding
a osg::Transform at root of the scene to move the scene to the eye point.
Typical used in conjunction with the LookAt position set to home,
in which case it is simply treated as a model view matrix.
-If the same behaviour as IRIS Performer's setViewMat is desired
+If the same behavior as IRIS Performer's setViewMat is desired
then set the LookAt to be (0,0,0),(0,1,0),(0,0,1) since Performer's
default direction is along the y axis, unlike OpenGL and the default OSG.
If modelTransfor is NULL then do not use any model transform - just use the
@@ -556,187 +607,274 @@ if you modify the attached transform then you must call dirtyTransform, to
allow the OSG to update matrices accordingly.
-
+
void dirtyTransform()
- must be called after you modify an attachedTransform.
-
-
Matrix* getTransform(const TransformMode mode)
+
+
Matrix* getTransform(const TransformMode mode)
-
-
const Matrix* getTransform(const TransformMode mode) const
+
+
const Matrix* getTransform(const TransformMode mode) const
-
+
const Vec3 getEyePoint_Model() const
-
+
const Vec3 getCenterPoint_Model() const
-
+
const Vec3 getLookVector_Model() const
-
+
const Vec3 getUpVector_Model() const
-
+
const Vec3 getSideVector_Model() const
-
+
const Matrix& getModelViewMatrix() const
- Get the ModelView matrix.
If a ModelTransform is supplied then the ModelView matrix is
-created by multipling the current LookAt by ModelTransform.
+created by multiplying the current LookAt by ModelTransform.
Otherwise it is simply created by using the current LookAt,
-equivialent to using gluLookAt.
+equivalent to using gluLookAt.
-
+
void setUseNearClippingPlane(const bool use)
+- Switch on/off the use of the near clipping plane which creating the
+getClippingVolume(), uses the camera _znear value for the position of the
+near clipping plane. By default this value is off.
-
+
const bool getUseNearClippingPlane() const
+- get whether the ClippingVolume uses a near clipping plane
-
+
void setUseFarClippingPlane(const bool use)
+- Switch on/off the use of the far clipping plane which creating the
+getClippingVolume(), uses the camera _zfar value for the position
+of the far clipping plane. By default this value is off.
-
+
const bool getUseFarClippingPlane() const
+- Get whether the ClippingVolume uses a far clipping plane
-
+
const ClippingVolume& getClippingVolume() const
- get the view frustum clipping in model coordinates
-
+
const bool project(const Vec3& obj, const Viewport& viewport, Vec3& win) const
- Map object coordinates into windows coordinates.
-Equivilant to gluProject(...).
+Equivalent to gluProject(...).
-
+
const bool unproject(const Vec3& win, const Viewport& viewport, Vec3& obj) const
- Map window coordinates into object coordinates.
-Equivilant to gluUnProject(...).
+Equivalent to gluUnProject(...).
-
-
-
Camera(const Camera&)
+
+
+
enum FusionDistanceMode
+
+
+
+
+
PROPORTIONAL_TO_LOOK_DISTANCE
-
-
-
Camera& operator=(const Camera&)
+
+
+
PROPORTIONAL_TO_SCREEN_DISTANCE
+
+
+
+
+
void setFusionDistanceMode(FusionDistanceMode mode)
+- Set the mode of the fusion distance function which in use to calculate the
+fusion distance used in stereo rendering. Default value is
+PROPORTIONAL_TO_LOOK_DISTANCE. Use in conjunction with setFusionDistanceRatio(float).
+
+
+
+
FusionDistanceMode getFusionDistanceMode() const
+- Get the mode of the fusion distance function
+
+
+
+
void setFusionDistanceRatio(float ratio)
+- Set the ratio of the fusion distance function which in use to calculate the
+fusion distance used in stereo rendering. Default value is 1.0f
+Use in conjunction with setFusionDistanceMode(..).
+
+
+
+
float getFusionDistanceRatio() const
+- Get the ratio of the fusion distance function
+
+
+
+
const float getFusionDistance() const
+- Calculate and return the fusion distance, using the FusionDistanceFunction
+
+
+
+
void setScreenDistance(float screenDistance)
+- Set the physical distance between the viewers eyes and the display system.
+Note, only used when rendering in stereo.
+
+
+
+
const float getScreenDistance() const
+- Get the physical distance between the viewers eyes and the display system
+
+
+
+
void adjustEyeOffsetForStereo(const osg::Vec3& offset)
+- Convinience method for adjusting the project and model view to account for
+and eye offset, as used in stereo work, assumes that the users will use
+a seperate camera for each eye, adjustEyePointForStereo() being used to
+specialize the camera for each eye view
+
+
+
+
virtual void apply(State& state)
+- Set up the OpenGL projection and model view matrices
+
+
+
+
void copy(const Camera&)
-
-
ProjectionType _projectionType
+
+
ProjectionType _projectionType
-
-
AdjustAspectRatioMode _adjustAspectRatioMode
+
+
AdjustAspectRatioMode _adjustAspectRatioMode
-
+
double _left
-
+
double _right
-
+
double _bottom
-
+
double _top
-
+
double _zNear
-
+
double _zFar
-
-
LookAtType _lookAtType
+
+
LookAtType _lookAtType
-
+
Vec3 _eye
-
+
Vec3 _center
-
+
Vec3 _up
-
-
-
double _focalLength
-
-
-
TransformMode _attachedTransformMode
+
+
TransformMode _attachedTransformMode
-
+
ref_ptr<Matrix> _eyeToModelTransform
-
+
ref_ptr<Matrix> _modelToEyeTransform
-
+
bool _useNearClippingPlane
-
+
bool _useFarClippingPlane
-
+
mutable bool _dirty
-
+
mutable ref_ptr<Matrix> _projectionMatrix
-
+
mutable ref_ptr<Matrix> _modelViewMatrix
-
+
mutable ClippingVolume _clippingVolume
-
-
-
mutable ref_ptr<Matrix> _MP
+
+
+
mutable ref_ptr<Matrix> _mp
-
-
-
mutable ref_ptr<Matrix> _inverseMP
+
+
+
mutable ref_ptr<Matrix> _inversemp
-
+
void calculateMatricesAndClippingVolume() const
+
+
+
+
bool _useEyeOffset
+
+
+
+
osg::Vec3 _eyeOffset
+
+
+
+
float _screenDistance
+
+
+
+
FusionDistanceMode _fusionDistanceMode
+
+
+
+
float _fusionDistanceRatio
- This class has no child classes.
diff --git a/doc/doc++/osg/ClipPlane.html b/doc/doc++/osg/ClipPlane.html
index 4fc5e2f87..e2b771cda 100644
--- a/doc/doc++/osg/ClipPlane.html
+++ b/doc/doc++/osg/ClipPlane.html
@@ -25,12 +25,12 @@
Public Methods
ClipPlane()
-
META_StateAttribute(ClipPlane, (Type)(CLIPPLANE+_clipPlaneNum))
+
META_StateAttribute(ClipPlane, (Type)(CLIPPLANE+_clipPlaneNum))
virtual int compare(const StateAttribute& sa) const
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
void setClipPlane(const Vec4& plane)
Set the clip plane, using a Vec4 to define plane.
@@ -83,7 +83,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -145,7 +145,7 @@
-
META_StateAttribute(ClipPlane, (Type)(CLIPPLANE+_clipPlaneNum))
+
META_StateAttribute(ClipPlane, (Type)(CLIPPLANE+_clipPlaneNum))
@@ -154,7 +154,7 @@
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
diff --git a/doc/doc++/osg/ClippingVolume.html b/doc/doc++/osg/ClippingVolume.html
index 4ab30379d..3bec1c9fa 100644
--- a/doc/doc++/osg/ClippingVolume.html
+++ b/doc/doc++/osg/ClippingVolume.html
@@ -7,7 +7,7 @@
-A ClippingVolume class for represecting convex clipping volumes made up
+A ClippingVolume class for representing convex clipping volumes made up
@@ -71,7 +71,7 @@
Documentation
-A ClippingVolume class for represecting convex clipping volumes made up
+A ClippingVolume class for representing convex clipping volumes made up
@@ -134,7 +134,7 @@
Using a mask to determine which planes should be used for the check, and
modifying the mask to turn off planes which wouldn't contribute to clipping
of any internal objects. This feature is used in osgUtil::CullVisitor
-to prevent redundent plane checking.
+to prevent redundant plane checking.
@@ -148,7 +148,7 @@ to prevent redundent plane checking.
Using a mask to determine which planes should be used for the check, and
modifying the mask to turn off planes which wouldn't contribute to clipping
of any internal objects. This feature is used in osgUtil::CullVisitor
-to prevent redundent plane checking.
+to prevent redundant plane checking.
diff --git a/doc/doc++/osg/ColorMask.html b/doc/doc++/osg/ColorMask.html
index c54438e4d..df105f820 100644
--- a/doc/doc++/osg/ColorMask.html
+++ b/doc/doc++/osg/ColorMask.html
@@ -7,7 +7,7 @@
-Encapsulte OpenGL glColorMaskFunc/Op/Mask functions
+Encapsulate OpenGL glColorMaskFunc/Op/Mask functions
Inheritance:
@@ -25,7 +25,7 @@
Public Methods
-
ColorMask()
-
-
META_StateAttribute(ColorMask, COLORMASK)
+
META_StateAttribute(ColorMask, COLORMASK)
-
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
@@ -70,7 +70,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -78,7 +78,7 @@
-
bool operator != (const StateAttribute& rhs) const
-
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
-
virtual void compile(State&) const
@@ -125,7 +125,7 @@
Documentation
-Encapsulte OpenGL glColorMaskFunc/Op/Mask functions
+Encapsulate OpenGL glColorMaskFunc/Op/Mask functions
@@ -134,7 +134,7 @@
-
META_StateAttribute(ColorMask, COLORMASK)
+
META_StateAttribute(ColorMask, COLORMASK)
diff --git a/doc/doc++/osg/CullFace.html b/doc/doc++/osg/CullFace.html
index 35688b273..8a683b4da 100644
--- a/doc/doc++/osg/CullFace.html
+++ b/doc/doc++/osg/CullFace.html
@@ -23,35 +23,35 @@
Public Methods
-
-
CullFace()
+
CullFace()
-
-
META_StateAttribute(CullFace, CULLFACE)
+
META_StateAttribute(CullFace, CULLFACE)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
inline void setMode(const Mode mode)
+
inline void setMode(const Mode mode)
-
-
inline const Mode getMode() const
+
inline const Mode getMode() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Mode
+
enum Mode
Protected Fields
-
-
Mode _mode
+
Mode _mode
Protected Methods
-
-
virtual ~CullFace()
+
virtual ~CullFace()
@@ -65,7 +65,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -122,59 +122,59 @@
-
+
CullFace()
-
-
META_StateAttribute(CullFace, CULLFACE)
+
+
META_StateAttribute(CullFace, CULLFACE)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
enum Mode
-
+
FRONT
-
+
BACK
-
+
FRONT_AND_BACK
-
-
inline void setMode(const Mode mode)
+
+
inline void setMode(const Mode mode)
-
-
inline const Mode getMode() const
+
+
inline const Mode getMode() const
-
+
virtual void apply(State& state) const
-
+
virtual ~CullFace()
-
-
Mode _mode
+
+
Mode _mode
- This class has no child classes.
diff --git a/doc/doc++/osg/Depth.html b/doc/doc++/osg/Depth.html
index ee3461b38..fb117c901 100644
--- a/doc/doc++/osg/Depth.html
+++ b/doc/doc++/osg/Depth.html
@@ -7,7 +7,7 @@
-Encapsulte OpenGL glDepthFunc/Mask/Range functions
+Encapsulate OpenGL glDepthFunc/Mask/Range functions
Inheritance:
@@ -23,51 +23,51 @@
Public Methods
-
-
Depth()
+
Depth()
-
-
META_StateAttribute(Depth, DEPTH)
+
META_StateAttribute(Depth, DEPTH)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
inline void setFunction(const Function func)
+
inline void setFunction(const Function func)
-
-
inline const Function getFunction() const
+
inline const Function getFunction() const
-
-
inline void setWriteMask(const bool mask)
+
inline void setWriteMask(const bool mask)
-
-
inline const bool getWriteMask() const
+
inline const bool getWriteMask() const
-
-
inline void setRange(const double zNear, const double zFar)
+
inline void setRange(const double zNear, const double zFar)
-
-
inline const double getZNear() const
+
inline const double getZNear() const
-
-
inline const double getZFar() const
+
inline const double getZFar() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Function
+
enum Function
Protected Fields
-
-
Function _func
+
Function _func
-
-
bool _depthWriteMask
+
bool _depthWriteMask
-
-
double _zNear
+
double _zNear
-
-
double _zFar
+
double _zFar
Protected Methods
-
-
virtual ~Depth()
+
virtual ~Depth()
@@ -81,7 +81,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -134,114 +134,114 @@
Documentation
-Encapsulte OpenGL glDepthFunc/Mask/Range functions
+Encapsulate OpenGL glDepthFunc/Mask/Range functions
-
+
Depth()
-
-
META_StateAttribute(Depth, DEPTH)
+
+
META_StateAttribute(Depth, DEPTH)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
enum Function
-
+
NEVER
-
+
LESS
-
+
EQUAL
-
+
LEQUAL
-
+
GREATER
-
+
NOTEQUAL
-
+
GEQUAL
-
+
ALWAYS
-
-
inline void setFunction(const Function func)
+
+
inline void setFunction(const Function func)
-
-
inline const Function getFunction() const
+
+
inline const Function getFunction() const
-
+
inline void setWriteMask(const bool mask)
-
+
inline const bool getWriteMask() const
-
-
inline void setRange(const double zNear, const double zFar)
+
+
inline void setRange(const double zNear, const double zFar)
-
+
inline const double getZNear() const
-
+
inline const double getZFar() const
-
+
virtual void apply(State& state) const
-
+
virtual ~Depth()
-
-
Function _func
+
+
Function _func
-
+
bool _depthWriteMask
-
+
double _zNear
-
+
double _zFar
diff --git a/doc/doc++/osg/Drawable.html b/doc/doc++/osg/Drawable.html
index 58d49f657..0e8b2da45 100644
--- a/doc/doc++/osg/Drawable.html
+++ b/doc/doc++/osg/Drawable.html
@@ -7,7 +7,7 @@
-Pure virtual base class for drawable Geomtery.
+Pure virtual base class for drawable Geometry.
Inheritance:
@@ -23,87 +23,104 @@
Public Methods
-
-
Drawable()
+
Drawable()
-
-
virtual bool isSameKindAs(const Object* obj) const
+
virtual bool isSameKindAs(const Object* obj) const
-
-
virtual const char* className() const
+
virtual const char* className() const
-
-
inline void setStateSet(StateSet* state)
+
inline void setStateSet(StateSet* state)
- Set the StateSet attached to the Drawable.
-
-
inline StateSet* getStateSet()
+
inline StateSet* getStateSet()
- Get the attached StateSet
-
-
inline const StateSet* getStateSet() const
+
inline const StateSet* getStateSet() const
- Get the attached const StateSet
-
-
void setSupportsDisplayList(const bool flag)
- - Set the drawable to it can or cannot be used inconjunction with OpenGL display lists.
+
void setSupportsDisplayList(const bool flag)
+- Set the drawable to it can or cannot be used in conjunction with OpenGL display lists.
-
-
inline const bool getSupportsDisplayList() const
- - Get whether display lists are supportd for this drawable instance
+
inline const bool getSupportsDisplayList() const
+- Get whether display lists are supported for this drawable instance
-
-
void setUseDisplayList(const bool flag)
+
void setUseDisplayList(const bool flag)
- When set to true, force the draw method to use OpenGL Display List for rendering.
-
-
inline const bool getUseDisplayList() const
+
inline const bool getUseDisplayList() const
- Return whether OpenGL display lists are being used for rendering
-
-
void dirtyDisplayList()
+
void dirtyDisplayList()
- Force a recompile on next draw() of any OpenGL display list associated with this geoset
-
-
inline void dirtyBound()
+
inline void dirtyBound()
+ - Dirty the bounding box, forcing a computeBound() on the next call to getBound().
-
-
inline const BoundingBox& getBound() const
+
inline const BoundingBox& getBound() const
- get bounding box of geoset.
-
-
inline void draw(State& state)
- - draw OpenGL primitives.
-
-
-
void compile(State& state)
+
void compile(State& state)
- Immediately compile this drawable into an OpenGL Display List.
-
-
virtual void drawImmediateMode(State& state) = 0
+
virtual void drawImmediateMode(State& state) = 0
- draw directly ignoring an OpenGL display list which could be attached.
-
-
static void deleteDisplayList(uint contextID, uint globj)
+
static void deleteDisplayList(uint contextID, uint globj)
- use deleteDisplayList instead of glDeleteList to allow OpenGL display list to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID
-
-
static void flushDeletedDisplayLists(uint contextID)
+
static void flushDeletedDisplayLists(uint contextID)
- flush all the cached display list which need to be deleted in the OpenGL context related to contextID
+
-
+
virtual bool getStats(Statistics&)
+ - Collect Stistics count from Drawable
+
-
+
virtual AttributeBitMask suppportsAttributeOperation() const
+ - return the attributes supported by applyAttrbuteOperation() as an AttributeBitMask
+
-
+
virtual AttributeBitMask applyAttributeOperation(AttributeFunctor&)
+ - return the attributes successully applied in applyAttributeUpdate
+
-
+
inline void draw(State& state)
+ - draw OpenGL primitives.
+
+
+
+Public Members
-
+
typedef uint AttributeBitMaskenum AttributeBitMaskValues
+-
+class AttributeFunctor
Protected Fields
-
-
ref_ptr<StateSet> _dstate
+
ref_ptr<StateSet> _dstate
-
-
bool _supportsDisplayList
+
bool _supportsDisplayList
-
-
bool _useDisplayList
+
bool _useDisplayList
-
-
mutable BoundingBox _bbox
+
mutable BoundingBox _bbox
-
-
mutable bool _bbox_computed
+
mutable bool _bbox_computed
Protected Methods
-
-
Drawable(const Drawable&)
+
Drawable(const Drawable&)
-
-
Drawable& operator = (const Drawable&)
+
Drawable& operator = (const Drawable&)
-
-
virtual ~Drawable()
+
virtual ~Drawable()
-
-
virtual const bool computeBound() const = 0
+
virtual const bool computeBound() const = 0
- compute the bounding box of the drawable.
Protected Members
-
-
typedef std::vector<uint> GLObjectList mutable GLObjectList _globjList
+
typedef std::vector<uint> GLObjectList mutable GLObjectList _globjList
-
-
typedef std::map<uint,std::set<uint> >static DeletedDisplayListCache DeletedDisplayListCache s_deletedDisplayListCache
+
typedef std::map<uint,std::set<uint> >static DeletedDisplayListCache DeletedDisplayListCache s_deletedDisplayListCache
@@ -136,46 +153,59 @@
Documentation
-Pure virtual base class for drawable Geomtery. Contains no drawing primitives
+Pure virtual base class for drawable Geometry. Contains no drawing primitives
directly, these are provided by subclasses such as GeoSet. State attributes
for a Drawable are maintained in StateSet which the Drawable maintains
a referenced counted pointer to. Both Drawable's and StateSet's can
-be shared for optimal memory usage and graphics performance.
+be shared for optimal memory usage and graphics performance.
+
+Subclasses should provide an instance of getStats(Statistics *st) if the subclass
+contains drawing primitives. This member function should add the primitives it
+draws into the Statistics class; for example add the number of quads, triangles etc
+created. For an example see GeoSet.cpp:
+getStats(osgUtil::Statistics *stat).
+Failure to implement this routine will only result in the stats displayed for
+your drawable being wrong.
+Another example is in the InfinitePlane class- this draws a normal geoset AND
+its own special set of quads, so this case of getPrims calls:
+the normal geoset stats gs->getStats(..), and then adds the number of quads
+rendered directly (it is rendered in a display list, but we do know how many
+quads are in the display list).
-
+
Drawable()
-
+
virtual bool isSameKindAs(const Object* obj) const
-
+
virtual const char* className() const
-
+
inline void setStateSet(StateSet* state)
- Set the StateSet attached to the Drawable.
Previously attached StateSet are automatically unreferenced on
assignment of a new drawstate.
-
+
inline StateSet* getStateSet()
- Get the attached StateSet
-
+
inline const StateSet* getStateSet() const
- Get the attached const StateSet
-
+
void setSupportsDisplayList(const bool flag)
-- Set the drawable to it can or cannot be used inconjunction with OpenGL
+
- Set the drawable to it can or cannot be used in conjunction with OpenGL
display lists. With set to true, calls to Drawable::setUseDisplayList,
whereas when set to false, no display lists can be created and calls
to setUseDisplayList are ignored, and a warning is produced. The later
@@ -184,63 +214,57 @@ on objects with dynamic internal data such as continuous Level of Detail
algorithms.
-
+
inline const bool getSupportsDisplayList() const
-- Get whether display lists are supportd for this drawable instance
+
- Get whether display lists are supported for this drawable instance
-
+
void setUseDisplayList(const bool flag)
- When set to true, force the draw method to use OpenGL Display List for rendering.
If false rendering directly. If the display list has not been already
compile the next call to draw will automatically create the display list.
-
+
inline const bool getUseDisplayList() const
- Return whether OpenGL display lists are being used for rendering
-
+
void dirtyDisplayList()
- Force a recompile on next draw() of any OpenGL display list associated with this geoset
-
+
inline void dirtyBound()
+- Dirty the bounding box, forcing a computeBound() on the next call
+to getBound(). Should be called in the internal geometry of the Drawable
+is modified.
-
+
inline const BoundingBox& getBound() const
- get bounding box of geoset.
Note, now made virtual to make it possible to implement user-drawn
objects albeit so what crudely, to be improved later.
-
-
-
inline void draw(State& state)
-- draw OpenGL primitives.
-If the drawable has _useDisplayList set to true then use an OpenGL display
-list, automatically compiling one if required.
-Otherwise call drawImmediateMode().
-Note, draw method should not be overriden in subclasses as it
-manages the optional display list.
-
-
+
void compile(State& state)
- Immediately compile this drawable into an OpenGL Display List.
-Note, operation is ignored if _useDisplayList to false.
+Note I, operation is ignored if _useDisplayList to false.
+Note II, compile is not intended to be overridden in subclasses.
-
+
virtual void drawImmediateMode(State& state) = 0
- draw directly ignoring an OpenGL display list which could be attached.
This is the internal draw method which does the drawing itself,
and is the method to override when deriving from Drawable.
-
+
static void deleteDisplayList(uint contextID, uint globj)
- use deleteDisplayList instead of glDeleteList to allow
OpenGL display list to cached until they can be deleted
@@ -248,56 +272,119 @@ by the OpenGL context in which they were created, specified
by contextID
-
+
static void flushDeletedDisplayLists(uint contextID)
- flush all the cached display list which need to be deleted
in the OpenGL context related to contextID
+
+
+
virtual bool getStats(Statistics&)
+- Collect Stistics count from Drawable
+
+
+
+
typedef uint AttributeBitMaskenum AttributeBitMaskValues
+
+
+
+
+
COORDS
+
+
+
+
NORMALS
+
+
+
+
COLORS
+
+
+
+
TEXTURE_COORDS
+
+
+
+
TEXTURE_COORDS_0
+
+
+
+
TEXTURE_COORDS_1
+
+
+
+
TEXTURE_COORDS_2
+
+
+
+
TEXTURE_COORDS_3
+
+
+
+
+
virtual AttributeBitMask suppportsAttributeOperation() const
+- return the attributes supported by applyAttrbuteOperation() as an AttributeBitMask
+
+
+
+
virtual AttributeBitMask applyAttributeOperation(AttributeFunctor&)
+- return the attributes successully applied in applyAttributeUpdate
+
-
-
Drawable(const Drawable&)
+
+
Drawable(const Drawable&)
-
+
Drawable& operator = (const Drawable&)
-
+
virtual ~Drawable()
-
+
virtual const bool computeBound() const = 0
- compute the bounding box of the drawable. Method must be
-implementated by subclasses.
+implemented by subclasses.
-
+
ref_ptr<StateSet> _dstate
-
+
bool _supportsDisplayList
-
+
bool _useDisplayList
-
+
typedef std::vector<uint> GLObjectList mutable GLObjectList _globjList
-
+
mutable BoundingBox _bbox
-
+
mutable bool _bbox_computed
-
+
typedef std::map<uint,std::set<uint> >static DeletedDisplayListCache DeletedDisplayListCache s_deletedDisplayListCache
+
+
+
+
inline void draw(State& state)
+- draw OpenGL primitives.
+If the drawable has _useDisplayList set to true then use an OpenGL display
+list, automatically compiling one if required.
+Otherwise call drawImmediateMode().
+Note, draw method should *not* be overridden in subclasses as it
+manages the optional display list.
- Direct child classes:
diff --git a/doc/doc++/osg/Fog.html b/doc/doc++/osg/Fog.html
index daeabad0a..1fa3bdbbc 100644
--- a/doc/doc++/osg/Fog.html
+++ b/doc/doc++/osg/Fog.html
@@ -23,59 +23,59 @@
Public Methods
-
-
Fog()
+
Fog()
-
-
META_StateAttribute(Fog, FOG)
+
META_StateAttribute(Fog, FOG)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
inline void setMode( const Mode mode )
+
inline void setMode( const Mode mode )
-
-
inline Mode getMode() const
+
inline Mode getMode() const
-
-
inline void setDensity( const float density )
+
inline void setDensity( const float density )
-
-
inline const float getDensity() const
+
inline const float getDensity() const
-
-
inline void setStart( const float start )
+
inline void setStart( const float start )
-
-
inline const float getStart() const
+
inline const float getStart() const
-
-
inline void setEnd( const float end )
+
inline void setEnd( const float end )
-
-
inline const float getEnd() const
+
inline const float getEnd() const
-
-
inline void setColor( const Vec4 &color )
+
inline void setColor( const Vec4 &color )
-
-
inline const Vec4& getColor() const
+
inline const Vec4& getColor() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Mode
+
enum Mode
Protected Fields
-
-
Mode _mode
+
Mode _mode
-
-
float _density
+
float _density
-
-
float _start
+
float _start
-
-
float _end
+
float _end
-
-
Vec4 _color
+
Vec4 _color
Protected Methods
-
-
virtual ~Fog()
+
virtual ~Fog()
@@ -89,7 +89,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -146,106 +146,106 @@
-
+
Fog()
-
-
META_StateAttribute(Fog, FOG)
+
+
META_StateAttribute(Fog, FOG)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
enum Mode
-
+
LINEAR
-
+
EXP
-
+
EXP2
-
-
inline void setMode( const Mode mode )
+
+
inline void setMode( const Mode mode )
-
-
inline Mode getMode() const
+
+
inline Mode getMode() const
-
+
inline void setDensity( const float density )
-
+
inline const float getDensity() const
-
-
inline void setStart( const float start )
+
+
inline void setStart( const float start )
-
+
inline const float getStart() const
-
-
inline void setEnd( const float end )
+
+
inline void setEnd( const float end )
-
+
inline const float getEnd() const
-
+
inline void setColor( const Vec4 &color )
-
+
inline const Vec4& getColor() const
-
+
virtual void apply(State& state) const
-
+
virtual ~Fog()
-
-
Mode _mode
+
+
Mode _mode
-
+
float _density
-
+
float _start
-
+
float _end
-
+
Vec4 _color
diff --git a/doc/doc++/osg/FrameStamp.html b/doc/doc++/osg/FrameStamp.html
index e24f4ec49..764aa7269 100644
--- a/doc/doc++/osg/FrameStamp.html
+++ b/doc/doc++/osg/FrameStamp.html
@@ -23,50 +23,50 @@
Public Methods
-
-
FrameStamp()
+
FrameStamp()
-
-
FrameStamp(const FrameStamp& fs)
+
FrameStamp(const FrameStamp& fs)
-
-
~FrameStamp()
+
~FrameStamp()
-
-
FrameStamp& operator = (const FrameStamp& fs)
+
FrameStamp& operator = (const FrameStamp& fs)
-
-
void setFrameNumber(int fnum)
+
void setFrameNumber(int fnum)
-
-
int getFrameNumber() const
+
int getFrameNumber() const
-
-
void setReferenceTime(double refTime)
+
void setReferenceTime(double refTime)
-
-
double getReferenceTime() const
+
double getReferenceTime() const
-
-
void setCalanderTime(const tm& calanderTime)
+
void setCalanderTime(const tm& calanderTime)
-
-
void getCalanderTime(tm& calanderTime) const
+
void getCalanderTime(tm& calanderTime) const
Protected Fields
-
-
int _frameNumber
+
int _frameNumber
-
-
double _referenceTime
+
double _referenceTime
-
-
int tm_sec
+
int tm_sec
-
-
int tm_min
+
int tm_min
-
-
int tm_hour
+
int tm_hour
-
-
int tm_mday
+
int tm_mday
-
-
int tm_mon
+
int tm_mon
-
-
int tm_year
+
int tm_year
-
-
int tm_wday
+
int tm_wday
-
-
int tm_yday
+
int tm_yday
-
-
int tm_isdst
+
int tm_isdst
@@ -99,87 +99,87 @@ of day etc.
-
+
FrameStamp()
-
-
FrameStamp(const FrameStamp& fs)
+
+
FrameStamp(const FrameStamp& fs)
-
+
~FrameStamp()
-
+
FrameStamp& operator = (const FrameStamp& fs)
-
+
void setFrameNumber(int fnum)
-
+
int getFrameNumber() const
-
+
void setReferenceTime(double refTime)
-
+
double getReferenceTime() const
-
+
void setCalanderTime(const tm& calanderTime)
-
+
void getCalanderTime(tm& calanderTime) const
-
+
int _frameNumber
-
+
double _referenceTime
-
+
int tm_sec
-
+
int tm_min
-
+
int tm_hour
-
+
int tm_mday
-
+
int tm_mon
-
+
int tm_year
-
+
int tm_wday
-
+
int tm_yday
-
+
int tm_isdst
diff --git a/doc/doc++/osg/FrontFace.html b/doc/doc++/osg/FrontFace.html
index 6132eeda4..2ca9568e8 100644
--- a/doc/doc++/osg/FrontFace.html
+++ b/doc/doc++/osg/FrontFace.html
@@ -23,33 +23,33 @@
Public Methods
-
-
FrontFace()
+
FrontFace()
-
-
META_StateAttribute(FrontFace, FRONTFACE)
+
META_StateAttribute(FrontFace, FRONTFACE)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
inline void setMode(const Mode mode)
+
inline void setMode(const Mode mode)
-
-
inline const Mode getMode() const
+
inline const Mode getMode() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Mode
+
enum Mode
Protected Fields
-
-
Mode _mode
+
Mode _mode
Protected Methods
-
-
virtual ~FrontFace()
+
virtual ~FrontFace()
@@ -63,7 +63,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -71,7 +71,7 @@
-
bool operator != (const StateAttribute& rhs) const
-
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
-
virtual void compile(State&) const
@@ -122,51 +122,51 @@
-
+
FrontFace()
-
-
META_StateAttribute(FrontFace, FRONTFACE)
+
+
META_StateAttribute(FrontFace, FRONTFACE)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
enum Mode
-
+
CLOCKWISE
-
+
COUNTER_CLOCKWISE
-
-
inline void setMode(const Mode mode)
+
+
inline void setMode(const Mode mode)
-
-
inline const Mode getMode() const
+
+
inline const Mode getMode() const
-
+
virtual void apply(State& state) const
-
+
virtual ~FrontFace()
-
-
Mode _mode
+
+
Mode _mode
- This class has no child classes.
diff --git a/doc/doc++/osg/General.html b/doc/doc++/osg/General.html
index cdd8f0eef..b9743f3c5 100644
--- a/doc/doc++/osg/General.html
+++ b/doc/doc++/osg/General.html
@@ -37,15 +37,24 @@
#define
OSG_COLORMASK-
+
#define
+OSG_COLORMATRIX-
+
#define
OSG_CULLFACE-
#define
OSG_DEPTH-
+
#define
+OSG_DisplaySettings-
+
#define
OSG_DRAWABLE-
+
#define
+OSG_EARTHSKY-
+
#define
OSG_EXPORT-
@@ -70,6 +79,9 @@
#define
OSG_FRAMESTAMP-
+
using
+std::tm-
+
#define
OSG_FRONTFACE-
@@ -103,6 +115,9 @@
#define
OSG_GLEXTENSIONS-
+
#define
+OSG_GLU-
+
#define
OSG_GROUP-
@@ -124,12 +139,81 @@
#define
OSG_LINESEGMENT-
+
#define
+OSG_LineWidth-
+
#define
OSG_LOD-
#define
OSG_MATERIAL-
+
#define
+__OSG_MATH-
+
+
#define
+M_E-
+
+
#define
+M_LOG2E-
+
+
#define
+M_LOG10E-
+
+
#define
+M_LN2-
+
+
#define
+M_LN10-
+
+
#define
+M_PI-
+
+
#define
+M_PI_2-
+
+
#define
+M_PI_4-
+
+
#define
+M_1_PI-
+
+
#define
+M_2_PI-
+
+
#define
+M_2_SQRTPI-
+
+
#define
+M_SQRT2-
+
+
#define
+M_SQRT1_2-
+
+
#define
+acosf(float)-
+
+
#define
+asinf(float)-
+
+
#define
+cosf(float)-
+
+
#define
+sinf(float)-
+
+
#define
+logf(float)-
+
+
#define
+floorf(float)-
+
+
#define
+powf(float)-
+
+
#define
+sqrtf(float)-
+
#define
OSG_MATRIX-
@@ -184,6 +268,9 @@
#define
OSG_STATESET-
+
#define
+OSGUTIL_STATISTICS-
+
#define
OSG_STENCIL-
@@ -203,7 +290,7 @@
OSG_TEXTURE
-
#define
-GL_TEXTURE_MAX_ANISOTROPY_EXT(GLenum)-
+GL_TEXTURE_MAX_ANISOTROPY_EXT
-
#define
GL_COMPRESSED_ALPHA_ARB-
@@ -253,8 +340,11 @@
#define
GL_MIRRORED_REPEAT_IBM-
+
#define
+GL_CLAMP_TO_EDGE-
+
#define
-GL_GENERATE_MIPMAP_SGIS(GLenum)-
+GL_GENERATE_MIPMAP_SGIS
-
#define
GL_GENERATE_MIPMAP_HINT_SGIS-
@@ -262,6 +352,9 @@
#define
OSG_TIMER-
+
pragmaoptimize("", on)
+(x)(".byte 0x0f, 0x31" : "=A" (x))-
+
#define
OSG_TRANSFORM-
@@ -271,6 +364,9 @@
#define
OSG_TYPES-
+
typedef uchar
+ubyte-
+
#define
OSG_VEC2-
diff --git a/doc/doc++/osg/GeoSet.html b/doc/doc++/osg/GeoSet.html
index a278ba7cd..790368bb7 100644
--- a/doc/doc++/osg/GeoSet.html
+++ b/doc/doc++/osg/GeoSet.html
@@ -23,284 +23,307 @@
Public Methods
-
-
GeoSet()
+
GeoSet()
-
-
virtual Object* clone() const
+
virtual Object* clone() const
-
-
virtual bool isSameKindAs(const Object* obj) const
+
virtual bool isSameKindAs(const Object* obj) const
-
-
virtual const char* className() const
+
virtual const char* className() const
-
-
inline void setNumPrims( const int n )
+
inline void setNumPrims( const int n )
-
-
inline const int getNumPrims() const
+
inline const int getNumPrims() const
-
-
void setPrimType( const PrimitiveType type )
+
void setPrimType( const PrimitiveType type )
-
-
inline const PrimitiveType getPrimType() const
+
inline const PrimitiveType getPrimType() const
-
-
inline void setPrimLengths( int* lens )
+
inline void setPrimLengths( int* lens )
-
-
inline int* getPrimLengths()
+
inline int* getPrimLengths()
-
-
inline const int* getPrimLengths() const
+
inline const int* getPrimLengths() const
-
-
void computeNumVerts()
+
void computeNumVerts() const
-
-
inline const int getNumCoords() const
+
inline const int getNumCoords() const
- get the number of coords required by the defined primitives.
-
-
inline Vec3* getCoords()
+
inline Vec3* getCoords()
- get a pointer to Vec3 coord array.
-
-
inline const Vec3* getCoords() const
+
inline const Vec3* getCoords() const
- get a const pointer to Vec3 coord array.
-
-
inline const int getNumCoordIndices() const
+
inline const int getNumCoordIndices() const
- get the number of indices required by the defined primitives.
-
-
inline IndexPointer& getCoordIndices()
+
inline IndexPointer& getCoordIndices()
- get the coord index array.
-
-
inline const IndexPointer& getCoordIndices() const
+
inline const IndexPointer& getCoordIndices() const
- get the const coord index array.
-
-
void setCoords( Vec3* cp )
+
void setCoords( Vec3* cp )
- set the coords (ie the geometry) of the geoset
-
-
void setCoords( Vec3* cp, ushort* ci )
+
void setCoords( Vec3* cp, ushort* ci )
- set the coords (ie the geometry) and ushort indices of the geoset.
-
-
void setCoords( Vec3* cp, uint* ci )
+
void setCoords( Vec3* cp, uint* ci )
- set the coords (ie the geometry) and uint indices of the geoset.
-
-
void setCoords( Vec3* cp, IndexPointer& ip )
+
void setCoords( Vec3* cp, IndexPointer& ip )
- set the coords (ie the geometry) and indices of the geoset
-
-
inline const int getNumNormals() const
+
inline const int getNumNormals() const
- get the number of normals required by the defined primitives and normals binding
-
-
inline Vec3* getNormals()
+
inline Vec3* getNormals()
- get a pointer to Vec3 normal array.
-
-
inline const Vec3* getNormals() const
+
inline const Vec3* getNormals() const
- get a const pointer to Vec3 normal array.
-
-
inline int getNumNormalIndices() const
+
inline int getNumNormalIndices() const
- get the number of normal indices required by the defined primitives and normals binding
-
-
inline IndexPointer& getNormalIndices()
+
inline IndexPointer& getNormalIndices()
- get the normal index array.
-
-
inline const IndexPointer& getNormalIndices() const
+
inline const IndexPointer& getNormalIndices() const
- get the const normal index array.
-
-
void setNormals( Vec3* np )
+
void setNormals( Vec3* np )
- set the normals of the geoset
-
-
void setNormals( Vec3* np, ushort* ni )
+
void setNormals( Vec3* np, ushort* ni )
- set the normals and normal indices of the geoset
-
-
void setNormals( Vec3* np, uint* ni )
+
void setNormals( Vec3* np, uint* ni )
- set the normals and normal indices of the geoset
-
-
void setNormals( Vec3* np, IndexPointer& ip )
+
void setNormals( Vec3* np, IndexPointer& ip )
- set the normals and normal indices of the geoset
-
-
void setNormalBinding( const BindingType binding )
+
void setNormalBinding( const BindingType binding )
- set the normals binding to the vertices/primitives/overall
-
-
inline const BindingType getNormalBinding() const
+
inline const BindingType getNormalBinding() const
-
-
inline const int getNumColors() const
+
inline const int getNumColors() const
- get the number of colors required by the defined primitives and color binding
-
-
inline Vec4* getColors()
+
inline Vec4* getColors()
- get a pointer to Vec4 color array.
-
-
inline const Vec4* getColors() const
+
inline const Vec4* getColors() const
- get a pointer to Vec4 color array.
-
-
inline int getNumColorIndices() const
+
inline int getNumColorIndices() const
- get the number of colors indices required by the defined primitives and color binding
-
-
inline IndexPointer& getColorIndices()
+
inline IndexPointer& getColorIndices()
- get the color index array.
-
-
inline const IndexPointer& getColorIndices() const
+
inline const IndexPointer& getColorIndices() const
- get the const color index array.
-
-
void setColors( Vec4* cp )
+
void setColors( Vec4* cp )
- set the colors of the geoset
-
-
void setColors( Vec4* cp, ushort* li )
+
void setColors( Vec4* cp, ushort* li )
- set the colors and color indices of the geoset
-
-
void setColors( Vec4* cp, uint* li )
+
void setColors( Vec4* cp, uint* li )
- set the colors and color indices of the geoset
-
-
void setColors( Vec4* cp, IndexPointer& ip )
+
void setColors( Vec4* cp, IndexPointer& ip )
- set the colors and color indices of the geoset
-
-
void setColorBinding( BindingType binding )
+
void setColorBinding( BindingType binding )
- set the color binding to the vertices/primitives/overall
-
-
inline BindingType getColorBinding() const
+
inline BindingType getColorBinding() const
-
-
inline const int getNumTextureCoords() const
+
inline const int getNumTextureCoords() const
- get the number of texture coords required by the defined primitives and textures binding
-
-
inline Vec2* getTextureCoords()
+
inline Vec2* getTextureCoords()
- get a pointer to Vec4 color array.
-
-
inline const Vec2* getTextureCoords() const
+
inline const Vec2* getTextureCoords() const
- get a pointer to Vec4 color array.
-
-
inline const int getNumTextureIndices() const
+
inline const int getNumTextureIndices() const
- get the number of texture coord indices required by the defined primitives and texture binding
-
-
inline IndexPointer& getTextureIndices()
+
inline IndexPointer& getTextureIndices()
- get the texture index array.
-
-
inline const IndexPointer& getTextureIndices() const
+
inline const IndexPointer& getTextureIndices() const
- get the texture index array.
-
-
void setTextureCoords( Vec2* tc )
+
void setTextureCoords( Vec2* tc )
- set the texture coords of the geoset
-
-
void setTextureCoords( Vec2* tc, ushort* ti )
+
void setTextureCoords( Vec2* tc, ushort* ti )
- set the texture coords and texture coord indices of the geoset
-
-
void setTextureCoords( Vec2* tc, uint* ti )
+
void setTextureCoords( Vec2* tc, uint* ti )
- set the texture coords and texture coord indices of the geoset
-
-
void setTextureCoords( Vec2* tc, IndexPointer& ip )
+
void setTextureCoords( Vec2* tc, IndexPointer& ip )
- set the texture coords and texture indices of the geoset
-
-
void setTextureBinding( const BindingType binding )
+
void setTextureBinding( const BindingType binding )
- set the texture coord binding to the vertices/primitives/overall
-
-
inline const BindingType getTextureBinding() const
+
inline const BindingType getTextureBinding() const
-
-
inline const int getNumInterleavedCoords() const
+
inline const int getNumInterleavedCoords() const
- get the number of texture coords required by the defined primitives and textures binding
-
-
inline void* getInterleavedArray()
+
inline void* getInterleavedArray()
- get a pointer to interleaved float array.
-
-
inline const void* getInterleavedArray() const
+
inline const void* getInterleavedArray() const
- get a const pointer to interleaved float array.
-
-
inline const int getNumIterleavedIndices() const
+
inline const int getNumInterleavedIndices() const
- get the number of texture coord indices required by the defined primitives and texture binding
-
-
inline IndexPointer& getInterleavedIndices()
+
inline IndexPointer& getInterleavedIndices()
- get the texture index array.
-
-
inline const IndexPointer& getInterleavedIndices() const
+
inline const IndexPointer& getInterleavedIndices() const
- get the interleaved index array.
-
-
inline const InterleaveArrayType getInterleavedFromat() const
+
inline const InterleaveArrayType getInterleavedFormat() const
- get the interleaved array storage format.
-
-
void setInterleavedArray( const InterleaveArrayType format, float* ia )
+
void setInterleavedArray( const InterleaveArrayType format, float* ia )
- set the interleaved arrays of the geoset
-
-
void setInterleavedArray( const InterleaveArrayType format, float* ia, ushort* iai )
+
void setInterleavedArray( const InterleaveArrayType format, float* ia, ushort* iai )
-
-
void setInterleavedArray( const InterleaveArrayType format, float* ia, uint* iai )
+
void setInterleavedArray( const InterleaveArrayType format, float* ia, uint* iai )
-
-
void setInterleavedArray( const InterleaveArrayType format, float* ia, IndexPointer& iai )
+
void setInterleavedArray( const InterleaveArrayType format, float* ia, IndexPointer& iai )
-
-
virtual void drawImmediateMode(State& state)
+
virtual void drawImmediateMode(State& state)
- draw geoset directly ignoring an OpenGL display list which could be attached.
-
-
const bool check() const
+
const bool check() const
+-
+
void setAttributeDeleteFunctor(AttributeDeleteFunctor* adf)
+ - set an alternative AttributeDeleteFunction to handle attribute arrays attached to this Geoset
+
-
+
AttributeDeleteFunctor* getAttributeDeleteFunctor()
+ - get the current AttributeDeleteFunction to handle attribute arrays attached to this Geoset
+
-
+
const AttributeDeleteFunctor* getAttributeDeleteFunctor() const
+ - get the current AttributeDeleteFunction to handle attribute arrays attached to this Geoset
+
-
+
bool getStats(Statistics &)
+ - Statistics collection for each drawable- 260901
+
-
+
virtual AttributeBitMask suppportsAttributeOperation() const
+ - return the attributes supported by applyAttrbuteUpdate() as an AttributeBitMask
+
-
+
virtual AttributeBitMask applyAttributeOperation(AttributeFunctor& auf)
+ - return the attributes successully applied in applyAttributeUpdate
Public Members
-
-
enum PrimitiveType
+
enum PrimitiveType
-
-
enum BindingType
+
enum BindingType
-
-
enum InterleaveArrayType
+
enum InterleaveArrayType
-
-
struct IndexPointer
+
struct IndexPointer
+-
+
struct AttributeDeleteFunctor: public osg::Referenced
+ - function object which is used to handling the clean up of attribute arrays associated with GeoSet's.
Protected Fields
-
-
int _numprims
+
ref_ptr<AttributeDeleteFunctor> _adf
-
-
PrimitiveType _primtype
+
int _numprims
-
-
int _needprimlen
+
PrimitiveType _primtype
-
-
unsigned int _oglprimtype
+
int _needprimlen
-
-
int* _primLengths
+
unsigned int _oglprimtype
-
-
unsigned char _primlength
+
int* _primLengths
-
-
unsigned char _flat_shaded_skip
+
mutable unsigned char _primlength
-
-
int _numcoords
+
unsigned char _flat_shaded_skip
-
-
Vec3* _coords
+
mutable int _numcoords
-
-
IndexPointer _cindex
+
Vec3* _coords
-
-
BindingType _normal_binding
+
IndexPointer _cindex
-
-
int _numnormals
+
BindingType _normal_binding
-
-
Vec3* _normals
+
mutable int _numnormals
-
-
IndexPointer _nindex
+
Vec3* _normals
-
-
BindingType _color_binding
+
IndexPointer _nindex
-
-
int _numcolors
+
BindingType _color_binding
-
-
Vec4* _colors
+
mutable int _numcolors
-
-
IndexPointer _colindex
+
Vec4* _colors
-
-
BindingType _texture_binding
+
IndexPointer _colindex
-
-
int _numtcoords
+
BindingType _texture_binding
-
-
Vec2* _tcoords
+
mutable int _numtcoords
-
-
IndexPointer _tindex
+
Vec2* _tcoords
-
-
void* _iarray
+
IndexPointer _tindex
-
-
IndexPointer _iaindex
+
void* _iarray
-
-
InterleaveArrayType _iaformat
+
IndexPointer _iaindex
-
-
unsigned int _ogliaformat
+
InterleaveArrayType _iaformat
-
-
int _fast_path
+
unsigned int _ogliaformat
+-
+
int _fast_path
Protected Methods
-
-
GeoSet(const GeoSet&)
+
GeoSet(const GeoSet&)
-
-
GeoSet& operator = (const GeoSet&)
+
GeoSet& operator = (const GeoSet&)
-
-
virtual ~GeoSet()
+
virtual ~GeoSet()
-
-
virtual const bool computeBound() const
+
virtual const bool computeBound() const
-
-
void set_fast_path( void )
+
void set_fast_path( void )
-
-
void draw_fast_path( void )
+
void draw_fast_path( void )
-
-
void draw_alternate_path( void )
+
void draw_alternate_path( void )
@@ -328,13 +351,20 @@
-
inline const BoundingBox& getBound() const
-
-
inline void draw(State& state)
--
void compile(State& state)
-
static void deleteDisplayList(uint contextID, uint globj)
-
static void flushDeletedDisplayLists(uint contextID)
+-
+
inline void draw(State& state)
+
+
+
+Public Members
-
+
typedef uint AttributeBitMaskenum AttributeBitMaskValues
+-
+class AttributeFunctor
@@ -391,699 +421,748 @@ be shared for optimal memory usage and graphics performance.
-
+
enum PrimitiveType
-
+
NO_TYPE
-
+
POINTS
-
+
LINES
-
+
LINE_STRIP
-
+
FLAT_LINE_STRIP
-
+
LINE_LOOP
-
+
TRIANGLES
-
+
TRIANGLE_STRIP
-
+
FLAT_TRIANGLE_STRIP
-
+
TRIANGLE_FAN
-
+
FLAT_TRIANGLE_FAN
-
+
QUADS
-
+
QUAD_STRIP
-
+
POLYGON
-
+
enum BindingType
-
+
BIND_OFF
-
+
BIND_OVERALL
-
+
BIND_PERPRIM
-
+
BIND_PERVERTEX
-
+
BIND_DEFAULT
-
+
enum InterleaveArrayType
-
+
IA_OFF
-
+
IA_V2F
-
+
IA_V3F
-
+
IA_C4UB_V2F
-
+
IA_C4UB_V3F
-
+
IA_C3F_V3F
-
+
IA_N3F_V3F
-
+
IA_C4F_N3F_V3F
-
+
IA_T2F_V3F
-
+
IA_T4F_V4F
-
+
IA_T2F_C4UB_V3F
-
+
IA_T2F_C3F_V3F
-
+
IA_T2F_N3F_V3F
-
+
IA_T2F_C4F_N3F_V3F
-
+
IA_T4F_C4F_N3F_V4F
-
+
struct IndexPointer
-
-
uint _size
+
+
mutable uint _size
-
+
bool _is_ushort
-
+
union
-
+
ushort* _ushort
-
+
uint* _uint
-
+
IndexPointer()
-
-
inline const bool operator == (const IndexPointer& ip) const
+
+
inline const bool operator == (const IndexPointer& ip) const
-
+
inline const bool valid() const
-
+
inline const bool null() const
-
+
inline void setToNull()
-
-
inline void set(uint size, ushort* data)
+
+
inline void set(uint size, ushort* data)
-
-
void set(const uint size, uint* data)
+
+
void set(const uint size, uint* data)
-
+
inline const uint maxIndex() const
-
+
inline const uint operator [] (const uint pos) const
-
+
GeoSet()
-
+
virtual Object* clone() const
-
+
virtual bool isSameKindAs(const Object* obj) const
-
+
virtual const char* className() const
-
+
inline void setNumPrims( const int n )
-
+
inline const int getNumPrims() const
-
-
void setPrimType( const PrimitiveType type )
+
+
void setPrimType( const PrimitiveType type )
-
-
inline const PrimitiveType getPrimType() const
+
+
inline const PrimitiveType getPrimType() const
-
+
inline void setPrimLengths( int* lens )
-
+
inline int* getPrimLengths()
-
+
inline const int* getPrimLengths() const
-
-
void computeNumVerts()
+
+
void computeNumVerts() const
-
+
inline const int getNumCoords() const
- get the number of coords required by the defined primitives.
-
+
inline Vec3* getCoords()
- get a pointer to Vec3 coord array.
-
+
inline const Vec3* getCoords() const
- get a const pointer to Vec3 coord array.
-
+
inline const int getNumCoordIndices() const
- get the number of indices required by the defined primitives.
-
-
inline IndexPointer& getCoordIndices()
+
+
inline IndexPointer& getCoordIndices()
- get the coord index array.
-
-
inline const IndexPointer& getCoordIndices() const
+
+
inline const IndexPointer& getCoordIndices() const
- get the const coord index array.
-
+
void setCoords( Vec3* cp )
- set the coords (ie the geometry) of the geoset
-
+
void setCoords( Vec3* cp, ushort* ci )
- set the coords (ie the geometry) and ushort indices of the geoset.
To reduce memory footprint and bandwidth for small datasets it is
-recommended the ushort undices are used instead of unit indices.
+recommended the ushort indices are used instead of unit indices.
-
+
void setCoords( Vec3* cp, uint* ci )
- set the coords (ie the geometry) and uint indices of the geoset.
Unless your data set exceeds 65536 indices prefer ushort indices
-over uint indices, only use this unit indices version if neccessary.
+over uint indices, only use this unit indices version if necessary.
-
-
void setCoords( Vec3* cp, IndexPointer& ip )
+
+
void setCoords( Vec3* cp, IndexPointer& ip )
- set the coords (ie the geometry) and indices of the geoset
-
+
inline const int getNumNormals() const
- get the number of normals required by the defined primitives and normals binding
-
+
inline Vec3* getNormals()
- get a pointer to Vec3 normal array.
-
+
inline const Vec3* getNormals() const
- get a const pointer to Vec3 normal array.
-
+
inline int getNumNormalIndices() const
- get the number of normal indices required by the defined primitives and normals binding
-
-
inline IndexPointer& getNormalIndices()
+
+
inline IndexPointer& getNormalIndices()
- get the normal index array.
-
-
inline const IndexPointer& getNormalIndices() const
+
+
inline const IndexPointer& getNormalIndices() const
- get the const normal index array.
-
+
void setNormals( Vec3* np )
- set the normals of the geoset
-
+
void setNormals( Vec3* np, ushort* ni )
- set the normals and normal indices of the geoset
-
+
void setNormals( Vec3* np, uint* ni )
- set the normals and normal indices of the geoset
-
-
void setNormals( Vec3* np, IndexPointer& ip )
+
+
void setNormals( Vec3* np, IndexPointer& ip )
- set the normals and normal indices of the geoset
-
-
void setNormalBinding( const BindingType binding )
+
+
void setNormalBinding( const BindingType binding )
- set the normals binding to the vertices/primitives/overall
-
-
inline const BindingType getNormalBinding() const
+
+
inline const BindingType getNormalBinding() const
-
+
inline const int getNumColors() const
- get the number of colors required by the defined primitives and color binding
-
+
inline Vec4* getColors()
- get a pointer to Vec4 color array.
-
+
inline const Vec4* getColors() const
- get a pointer to Vec4 color array.
-
+
inline int getNumColorIndices() const
- get the number of colors indices required by the defined primitives and color binding
-
-
inline IndexPointer& getColorIndices()
+
+
inline IndexPointer& getColorIndices()
- get the color index array.
-
-
inline const IndexPointer& getColorIndices() const
+
+
inline const IndexPointer& getColorIndices() const
- get the const color index array.
-
+
void setColors( Vec4* cp )
- set the colors of the geoset
-
+
void setColors( Vec4* cp, ushort* li )
- set the colors and color indices of the geoset
-
+
void setColors( Vec4* cp, uint* li )
- set the colors and color indices of the geoset
-
-
void setColors( Vec4* cp, IndexPointer& ip )
+
+
void setColors( Vec4* cp, IndexPointer& ip )
- set the colors and color indices of the geoset
-
-
void setColorBinding( BindingType binding )
+
+
void setColorBinding( BindingType binding )
- set the color binding to the vertices/primitives/overall
-
-
inline BindingType getColorBinding() const
+
+
inline BindingType getColorBinding() const
-
+
inline const int getNumTextureCoords() const
- get the number of texture coords required by the defined primitives and textures binding
-
+
inline Vec2* getTextureCoords()
- get a pointer to Vec4 color array.
-
+
inline const Vec2* getTextureCoords() const
- get a pointer to Vec4 color array.
-
+
inline const int getNumTextureIndices() const
- get the number of texture coord indices required by the defined primitives and texture binding
-
-
inline IndexPointer& getTextureIndices()
+
+
inline IndexPointer& getTextureIndices()
- get the texture index array.
-
-
inline const IndexPointer& getTextureIndices() const
+
+
inline const IndexPointer& getTextureIndices() const
- get the texture index array.
-
+
void setTextureCoords( Vec2* tc )
- set the texture coords of the geoset
-
+
void setTextureCoords( Vec2* tc, ushort* ti )
- set the texture coords and texture coord indices of the geoset
-
+
void setTextureCoords( Vec2* tc, uint* ti )
- set the texture coords and texture coord indices of the geoset
-
-
void setTextureCoords( Vec2* tc, IndexPointer& ip )
+
+
void setTextureCoords( Vec2* tc, IndexPointer& ip )
- set the texture coords and texture indices of the geoset
-
-
void setTextureBinding( const BindingType binding )
+
+
void setTextureBinding( const BindingType binding )
- set the texture coord binding to the vertices/primitives/overall
-
-
inline const BindingType getTextureBinding() const
+
+
inline const BindingType getTextureBinding() const
-
+
inline const int getNumInterleavedCoords() const
- get the number of texture coords required by the defined primitives and textures binding
-
+
inline void* getInterleavedArray()
- get a pointer to interleaved float array.
-
+
inline const void* getInterleavedArray() const
- get a const pointer to interleaved float array.
-
-
-
inline const int getNumIterleavedIndices() const
+
+
+
inline const int getNumInterleavedIndices() const
- get the number of texture coord indices required by the defined primitives and texture binding
-
-
inline IndexPointer& getInterleavedIndices()
+
+
inline IndexPointer& getInterleavedIndices()
- get the texture index array.
-
-
inline const IndexPointer& getInterleavedIndices() const
+
+
inline const IndexPointer& getInterleavedIndices() const
- get the interleaved index array.
-
-
-
inline const InterleaveArrayType getInterleavedFromat() const
+
+
+
inline const InterleaveArrayType getInterleavedFormat() const
- get the interleaved array storage format.
-
-
void setInterleavedArray( const InterleaveArrayType format, float* ia )
+
+
void setInterleavedArray( const InterleaveArrayType format, float* ia )
- set the interleaved arrays of the geoset
-
-
void setInterleavedArray( const InterleaveArrayType format, float* ia, ushort* iai )
+
+
void setInterleavedArray( const InterleaveArrayType format, float* ia, ushort* iai )
-
-
void setInterleavedArray( const InterleaveArrayType format, float* ia, uint* iai )
+
+
void setInterleavedArray( const InterleaveArrayType format, float* ia, uint* iai )
-
-
void setInterleavedArray( const InterleaveArrayType format, float* ia, IndexPointer& iai )
+
+
void setInterleavedArray( const InterleaveArrayType format, float* ia, IndexPointer& iai )
-
+
virtual void drawImmediateMode(State& state)
- draw geoset directly ignoring an OpenGL display list which could be attached.
This is the internal draw method which does the drawing itself,
and is the method to override when deriving from GeoSet for user-drawn objects.
-
+
const bool check() const
+
+
+
struct AttributeDeleteFunctor: public osg::Referenced
+- function object which is used to handling the clean up of attribute arrays
+associated with GeoSet's. A default is provided which assumes that all
+momory attached to the GeoSet is owned by this GeoSet and can be deleted
+using delete []. If this is not the cause derive your own AttributeDeleteFunctor
+a specify your own memory deletion operation.
+
+
+
+
+
virtual void operator() (GeoSet* gset)
+
+
+
+
+
void setAttributeDeleteFunctor(AttributeDeleteFunctor* adf)
+- set an alternative AttributeDeleteFunction to handle attribute arrays attached to this Geoset
+
+
+
+
AttributeDeleteFunctor* getAttributeDeleteFunctor()
+- get the current AttributeDeleteFunction to handle attribute arrays attached to this Geoset
+
+
+
+
const AttributeDeleteFunctor* getAttributeDeleteFunctor() const
+- get the current AttributeDeleteFunction to handle attribute arrays attached to this Geoset
+
+
+
+
bool getStats(Statistics &)
+- Statistics collection for each drawable- 260901
+
+
+
+
virtual AttributeBitMask suppportsAttributeOperation() const
+- return the attributes supported by applyAttrbuteUpdate() as an AttributeBitMask
+
+
+
+
virtual AttributeBitMask applyAttributeOperation(AttributeFunctor& auf)
+- return the attributes successully applied in applyAttributeUpdate
+
-
-
GeoSet(const GeoSet&)
+
+
GeoSet(const GeoSet&)
-
+
GeoSet& operator = (const GeoSet&)
-
+
virtual ~GeoSet()
-
+
virtual const bool computeBound() const
+
+
+
ref_ptr<AttributeDeleteFunctor> _adf
+
-
+
int _numprims
-
-
PrimitiveType _primtype
+
+
PrimitiveType _primtype
-
+
int _needprimlen
-
+
unsigned int _oglprimtype
-
+
int* _primLengths
-
-
unsigned char _primlength
+
+
mutable unsigned char _primlength
-
+
unsigned char _flat_shaded_skip
-
-
int _numcoords
+
+
mutable int _numcoords
-
+
Vec3* _coords
-
-
IndexPointer _cindex
+
+
IndexPointer _cindex
-
-
BindingType _normal_binding
+
+
BindingType _normal_binding
-
-
int _numnormals
+
+
mutable int _numnormals
-
+
Vec3* _normals
-
-
IndexPointer _nindex
+
+
IndexPointer _nindex
-
-
BindingType _color_binding
+
+
BindingType _color_binding
-
-
int _numcolors
+
+
mutable int _numcolors
-
+
Vec4* _colors
-
-
IndexPointer _colindex
+
+
IndexPointer _colindex
-
-
BindingType _texture_binding
+
+
BindingType _texture_binding
-
-
int _numtcoords
+
+
mutable int _numtcoords
-
+
Vec2* _tcoords
-
-
IndexPointer _tindex
+
+
IndexPointer _tindex
-
+
void* _iarray
-
-
IndexPointer _iaindex
+
+
IndexPointer _iaindex
-
-
InterleaveArrayType _iaformat
+
+
InterleaveArrayType _iaformat
-
+
unsigned int _ogliaformat
-
+
int _fast_path
-
+
void set_fast_path( void )
-
+
void draw_fast_path( void )
-
+
void draw_alternate_path( void )
diff --git a/doc/doc++/osg/Geode.html b/doc/doc++/osg/Geode.html
index aad6f7886..dc670d677 100644
--- a/doc/doc++/osg/Geode.html
+++ b/doc/doc++/osg/Geode.html
@@ -23,51 +23,51 @@
Public Methods
-
-
typedef std::vector< ref_ptr<Drawable> > DrawableList Geode()
+
typedef std::vector< ref_ptr<Drawable> > DrawableList Geode()
-
-
META_Node(Geode)
+
META_Node(Geode)
-
-
virtual const bool addDrawable( Drawable* drawable )
+
virtual const bool addDrawable( Drawable* drawable )
- Add Drawable to Geode.
-
-
virtual const bool removeDrawable( Drawable* drawable )
+
virtual const bool removeDrawable( Drawable* drawable )
- Remove Drawable from Geode.
-
-
virtual const bool replaceDrawable( Drawable* origDraw, Drawable* newDraw )
+
virtual const bool replaceDrawable( Drawable* origDraw, Drawable* newDraw )
- Replace specified Drawable with another Drawable.
-
-
inline const int getNumDrawables() const
+
inline const int getNumDrawables() const
- return the number of geoset's
-
-
inline Drawable* getDrawable( const int i )
+
inline Drawable* getDrawable( const int i )
- return geoset at position i
-
-
inline const Drawable* getDrawable( const int i ) const
+
inline const Drawable* getDrawable( const int i ) const
- return geoset at position i
-
-
inline const bool containsDrawable(const Drawable* gset) const
+
inline const bool containsDrawable(const Drawable* gset) const
- return true if geoset is contained within Geode
-
-
inline DrawableList::iterator findDrawable(const Drawable* gset)
- - return the iterator postion for specified Drawable.
+
inline DrawableList::iterator findDrawable(const Drawable* gset)
+- return the iterator position for specified Drawable.
-
-
inline DrawableList::const_iterator findDrawable(const Drawable* gset) const
- - return the const_iterator postion for specified Drawable.
+
inline DrawableList::const_iterator findDrawable(const Drawable* gset) const
+- return the const_iterator position for specified Drawable.
-
-
void compileDrawables(State& state)
- - complile OpenGL Display List for each geoset
+
void compileDrawables(State& state)
+- compile OpenGL Display List for each geoset
Protected Fields
-
-
DrawableList _drawables
+
DrawableList _drawables
Protected Methods
-
-
virtual ~Geode()
+
virtual ~Geode()
-
-
virtual const bool computeBound() const
+
virtual const bool computeBound() const
@@ -93,7 +93,7 @@
-
inline const std::string& getName() const
-
-
inline const ParentList& getParents() const
+
inline const ParentList& getParents() const
-
inline Group* getParent(const int i)
-
@@ -109,23 +109,25 @@
-
inline const int getNumChildrenRequiringAppTraversal() const
-
-
inline void setUserData(void* data, MemoryAdapter* ma=0L)
+
void setCullingActive(const bool active)
-
-
inline void* getUserData()
+
inline const bool getCullingActive() const
-
-
inline const void* getUserData() const
+
inline const int getNumChildrenWithCullingDisabled() const
-
-
inline MemoryAdapter* getMemoryAdapter()
+
inline void setUserData(osg::Referenced* obj)
-
-
inline const MemoryAdapter* getMemoryAdapter() const
+
inline Referenced* getUserData()
+-
+
inline const Referenced* getUserData() const
-
inline void setNodeMask(const NodeMask nm)
-
inline const NodeMask getNodeMask() const
-
-
inline const DescriptionList& getDescriptions() const
+
inline const DescriptionList& getDescriptions() const
-
-
inline DescriptionList& getDescriptions()
+
inline DescriptionList& getDescriptions()
-
inline const std::string& getDescription(const int i) const
-
@@ -161,19 +163,21 @@
-
std::string _name
-
-
ParentList _parents
+
ParentList _parents
-
ref_ptr<NodeCallback> _appCallback
-
int _numChildrenRequiringAppTraversal
-
-
void* _userData
+
bool _cullingActive
-
-
ref_ptr<MemoryAdapter> _memoryAdapter
+
int _numChildrenWithCullingDisabled
+-
+
osg::ref_ptr<Referenced> _userData
-
NodeMask _nodeMask
-
-
DescriptionList _descriptions
+
DescriptionList _descriptions
-
ref_ptr<StateSet> _dstate
@@ -181,6 +185,8 @@
Protected Methods
-
void setNumChildrenRequiringAppTraversal(const int num)
+-
+
void setNumChildrenWithCullingDisabled(const int num)
@@ -214,15 +220,15 @@
-
+
typedef std::vector< ref_ptr<Drawable> > DrawableList Geode()
-
+
META_Node(Geode)
-
+
virtual const bool addDrawable( Drawable* drawable )
- Add Drawable to Geode.
If gset is not NULL and is not contained in Geode then increment its
@@ -231,7 +237,7 @@ sphere to force it to recompute on next getBound() and return true for success.
Otherwise return false.
-
+
virtual const bool removeDrawable( Drawable* drawable )
- Remove Drawable from Geode.
If gset is contained in Geode then remove it from the geoset
@@ -241,7 +247,7 @@ return true for success. If gset is not found then return false
and do not change the reference count of gset.
-
+
virtual const bool replaceDrawable( Drawable* origDraw, Drawable* newDraw )
- Replace specified Drawable with another Drawable.
Decrement the reference count origGSet and increments the
@@ -252,52 +258,52 @@ add newGset. If newGset is NULL then return false and do
not remove origGset.
-
+
inline const int getNumDrawables() const
- return the number of geoset's
-
+
inline Drawable* getDrawable( const int i )
- return geoset at position i
-
+
inline const Drawable* getDrawable( const int i ) const
- return geoset at position i
-
+
inline const bool containsDrawable(const Drawable* gset) const
- return true if geoset is contained within Geode
-
+
inline DrawableList::iterator findDrawable(const Drawable* gset)
-- return the iterator postion for specified Drawable.
+
- return the iterator position for specified Drawable.
return _geoset.end() if gset not is contained in Geode.
-
+
inline DrawableList::const_iterator findDrawable(const Drawable* gset) const
-- return the const_iterator postion for specified Drawable.
+
- return the const_iterator position for specified Drawable.
return _geoset.end() if gset not is contained in Geode.
-
+
void compileDrawables(State& state)
-- complile OpenGL Display List for each geoset
+
- compile OpenGL Display List for each geoset
-
+
virtual ~Geode()
-
+
virtual const bool computeBound() const
-
+
DrawableList _drawables
diff --git a/doc/doc++/osg/Group.html b/doc/doc++/osg/Group.html
index c4fb29099..6645d744a 100644
--- a/doc/doc++/osg/Group.html
+++ b/doc/doc++/osg/Group.html
@@ -11,11 +11,11 @@
Inheritance:
-
-
+
@@ -50,11 +50,11 @@
-
-
-
-
-
+
+
+
+
+
diff --git a/doc/doc++/osg/Image.html b/doc/doc++/osg/Image.html
index c91c90c8c..c631c0cc7 100644
--- a/doc/doc++/osg/Image.html
+++ b/doc/doc++/osg/Image.html
@@ -23,80 +23,86 @@
Public Methods
-
-
Image()
+
Image()
-
-
virtual Object* clone() const
+
virtual Object* clone() const
-
-
virtual bool isSameKindAs(const Object* obj) const
+
virtual bool isSameKindAs(const Object* obj) const
-
-
virtual const char* className() const
+
virtual const char* className() const
-
-
inline const std::string& getFileName() const
+
inline const std::string& getFileName() const
-
-
void setFileName(const std::string& fileName)
+
void setFileName(const std::string& fileName)
-
-
void setImage(const int s, const int t, const int r, const int internalFormat, const unsigned int pixelFormat, const unsigned int dataType, unsigned char* data, const int packing=-1)
+
void setImage(const int s, const int t, const int r, const int internalFormat, const unsigned int pixelFormat, const unsigned int dataType, unsigned char* data, const int packing=-1)
- set the image data and format.
-
-
inline const int s() const
+
inline const int s() const
- Width of image
-
-
inline const int t() const
+
inline const int t() const
- Height of image
-
-
inline const int r() const
+
inline const int r() const
- Depth of image
-
-
inline const int internalFormat() const
+
inline const int internalFormat() const
-
-
inline const unsigned int pixelFormat() const
+
inline const unsigned int pixelFormat() const
-
-
inline const unsigned int dataType() const
+
inline const unsigned int dataType() const
-
-
inline const unsigned int packing() const
+
inline const unsigned int packing() const
-
-
inline unsigned char* data()
+
inline unsigned char* data()
- raw image data
-
-
inline const unsigned char* data() const
+
inline const unsigned char* data() const
- raw const image data
-
-
void scaleImage(const int s, const int t, const int r)
+
void scaleImage(const int s, const int t, const int r)
- Scale image to specified size.
-
-
void ensureDimensionsArePowerOfTwo()
+
void ensureDimensionsArePowerOfTwo()
- Ensure image dimensions are a power of two.
-
-
inline const unsigned int getModifiedTag() const
- - Get modified tag value.
+
inline void dirty()
+- Dirty the image, which increments the modified flag, to force osg::Texture to reload the image
+
-
+
inline void setModifiedTag(const unsigned int value)
+ - Set the modified tag value, only used by osg::Texture when using texture subloading.
+
-
+
inline const unsigned int getModifiedTag() const
+ - Get modified tag value, only used by osg::Texture when using texture subloading.
Protected Fields
-
-
std::string _fileName
+
std::string _fileName
-
-
int _s
+
int _s
-
-
int _t
+
int _t
-
-
int _r
+
int _r
-
-
int _internalFormat
+
int _internalFormat
-
-
unsigned int _pixelFormat
+
unsigned int _pixelFormat
-
-
unsigned int _dataType
+
unsigned int _dataType
-
-
unsigned int _packing
+
unsigned int _packing
-
-
unsigned char* _data
+
unsigned char* _data
-
-
unsigned int _modifiedTag
+
unsigned int _modifiedTag
Protected Methods
-
-
virtual ~Image()
+
virtual ~Image()
@@ -130,138 +136,148 @@
-
+
Image()
-
+
virtual Object* clone() const
-
+
virtual bool isSameKindAs(const Object* obj) const
-
+
virtual const char* className() const
-
+
inline const std::string& getFileName() const
-
+
void setFileName(const std::string& fileName)
-
-
void setImage(const int s, const int t, const int r, const int internalFormat, const unsigned int pixelFormat, const unsigned int dataType, unsigned char* data, const int packing=-1)
+
+
void setImage(const int s, const int t, const int r, const int internalFormat, const unsigned int pixelFormat, const unsigned int dataType, unsigned char* data, const int packing=-1)
- set the image data and format.
note, when the packing value is negative (the default is -1) this method assumes
a _packing width of 1 if the width is not a multiple of 4,
-otherwise automatically sets to _packing to 4. If a postive
+otherwise automatically sets to _packing to 4. If a positive
value of packing is supplied than _packing is simply set to that value.
-
+
inline const int s() const
- Width of image
-
+
inline const int t() const
- Height of image
-
+
inline const int r() const
- Depth of image
-
+
inline const int internalFormat() const
-
+
inline const unsigned int pixelFormat() const
-
+
inline const unsigned int dataType() const
-
+
inline const unsigned int packing() const
-
+
inline unsigned char* data()
- raw image data
-
+
inline const unsigned char* data() const
- raw const image data
-
-
void scaleImage(const int s, const int t, const int r)
+
+
void scaleImage(const int s, const int t, const int r)
- Scale image to specified size.
-
+
void ensureDimensionsArePowerOfTwo()
- Ensure image dimensions are a power of two.
Mip Mapped texture require the image dimensions to be
power of two.
+
+
+
inline void dirty()
+- Dirty the image, which increments the modified flag, to force osg::Texture to reload the image
+
+
+
+
inline void setModifiedTag(const unsigned int value)
+- Set the modified tag value, only used by osg::Texture when using texture subloading.
+
-
+
inline const unsigned int getModifiedTag() const
-- Get modified tag value.
+
- Get modified tag value, only used by osg::Texture when using texture subloading.
-
+
virtual ~Image()
-
+
std::string _fileName
-
+
int _s
-
+
int _t
-
+
int _r
-
+
int _internalFormat
-
+
unsigned int _pixelFormat
-
+
unsigned int _dataType
-
+
unsigned int _packing
-
+
unsigned char* _data
-
+
unsigned int _modifiedTag
diff --git a/doc/doc++/osg/Impostor.html b/doc/doc++/osg/Impostor.html
index fdfb33be8..64404314d 100644
--- a/doc/doc++/osg/Impostor.html
+++ b/doc/doc++/osg/Impostor.html
@@ -23,45 +23,45 @@
Public Methods
-
-
Impostor()
+
Impostor()
-
-
META_Node(Impostor)
+
META_Node(Impostor)
-
-
inline void setImpostorThreshold(float distance)
+
inline void setImpostorThreshold(float distance)
- Set the Impostor threshold distance.
-
-
inline void setImpostorThresholdToBound(float ratio=1.0f)
+
inline void setImpostorThresholdToBound(float ratio=1.0f)
- Set the Impostor threshold distance relative to the node's bounding sphere's radius
-
-
inline const float getImpostorThreshold() const
+
inline const float getImpostorThreshold() const
-
-
inline const float getImpostorThreshold2() const
+
inline const float getImpostorThreshold2() const
-
-
ImpostorSprite* findBestImpostorSprite(const osg::Vec3& currLocalEyePoint)
+
ImpostorSprite* findBestImpostorSprite(const osg::Vec3& currLocalEyePoint)
- Find the ImposterSprite which fits the current eye point best
-
-
void addImpostorSprite(ImpostorSprite* is)
+
void addImpostorSprite(ImpostorSprite* is)
- Add an ImpostorSprite to the Impostor
-
-
inline ImpostorSpriteList& getImpostorSpriteList()
+
inline ImpostorSpriteList& getImpostorSpriteList()
- Get the list of ImpostorSprites attached to this Impostor
-
-
inline const ImpostorSpriteList& getImpostorSpriteList() const
+
inline const ImpostorSpriteList& getImpostorSpriteList() const
- Get a const list of ImpostorSprites attached to this const Impostor
Protected Fields
-
-
ImpostorSpriteList _impostorSpriteList
+
ImpostorSpriteList _impostorSpriteList
-
-
float _impostorThreshold
+
float _impostorThreshold
Protected Methods
-
-
virtual ~Impostor()
+
virtual ~Impostor()
-
-
virtual const bool computeBound() const
+
virtual const bool computeBound() const
@@ -77,7 +77,7 @@
inline const int getNumRanges() const
-
inline void setCenter(const Vec3 ¢er)
+
inline void setCenter(const Vec3 ¢er)
inline const Vec3& getCenter() const
@@ -146,7 +146,7 @@
inline const std::string& getName() const
-
inline const ParentList& getParents() const
+
inline const ParentList& getParents() const
inline Group* getParent(const int i)
@@ -162,23 +162,25 @@
inline const int getNumChildrenRequiringAppTraversal() const
-
inline void setUserData(void* data, MemoryAdapter* ma=0L)
+
void setCullingActive(const bool active)
-
inline void* getUserData()
+
inline const bool getCullingActive() const
-
inline const void* getUserData() const
+
inline const int getNumChildrenWithCullingDisabled() const
-
inline MemoryAdapter* getMemoryAdapter()
+
inline void setUserData(osg::Referenced* obj)
-
inline const MemoryAdapter* getMemoryAdapter() const
+
inline Referenced* getUserData()
+
+
inline const Referenced* getUserData() const
inline void setNodeMask(const NodeMask nm)
inline const NodeMask getNodeMask() const
-
inline const DescriptionList& getDescriptions() const
+
inline const DescriptionList& getDescriptions() const
-
inline DescriptionList& getDescriptions()
+
inline DescriptionList& getDescriptions()
inline const std::string& getDescription(const int i) const
@@ -214,19 +216,21 @@
std::string _name
-
ParentList _parents
+
ParentList _parents
ref_ptr<NodeCallback> _appCallback
int _numChildrenRequiringAppTraversal
-
void* _userData
+
bool _cullingActive
-
ref_ptr<MemoryAdapter> _memoryAdapter
+
int _numChildrenWithCullingDisabled
+
+
osg::ref_ptr<Referenced> _userData
NodeMask _nodeMask
-
DescriptionList _descriptions
+
DescriptionList _descriptions
ref_ptr<StateSet> _dstate
@@ -234,6 +238,8 @@
Protected Methods
-
void setNumChildrenRequiringAppTraversal(const int num)
+-
+
void setNumChildrenWithCullingDisabled(const int num)
@@ -284,7 +290,7 @@ them.
All you need to do to use Impostors is to set up the visible
range values for each LOD child of the Impostor, as per osg::LOD,
and set an Impostor threshold to tell the renderer at what distance
-the Impsotor's image caching should cut in. The osg::CullVisitor
+the Impostor's image caching should cut in. The osg::CullVisitor
automatically handles all the setting of pre-rendering stages to
calculate the required ImpostorSprites (which encapsulates the image
cache and quad), and updates them as the view point changes. If you
@@ -303,68 +309,68 @@ geometry.
-
+
Impostor()
-
+
META_Node(Impostor)
-
-
inline void setImpostorThreshold(float distance)
+
+
inline void setImpostorThreshold(float distance)
- Set the Impostor threshold distance.
For eye points further than this threshold the Imposter is used if appropriate,
otherwise the LOD children as chosen as per a standard LOD node.
-
+
inline void setImpostorThresholdToBound(float ratio=1.0f)
- Set the Impostor threshold distance relative to the node's bounding
sphere's radius
-
+
inline const float getImpostorThreshold() const
-
+
inline const float getImpostorThreshold2() const
-
+
ImpostorSprite* findBestImpostorSprite(const osg::Vec3& currLocalEyePoint)
- Find the ImposterSprite which fits the current eye point best
-
+
void addImpostorSprite(ImpostorSprite* is)
- Add an ImpostorSprite to the Impostor
-
+
inline ImpostorSpriteList& getImpostorSpriteList()
- Get the list of ImpostorSprites attached to this Impostor
-
+
inline const ImpostorSpriteList& getImpostorSpriteList() const
- Get a const list of ImpostorSprites attached to this const Impostor
-
+
virtual ~Impostor()
-
+
virtual const bool computeBound() const
-
+
ImpostorSpriteList _impostorSpriteList
-
+
float _impostorThreshold
diff --git a/doc/doc++/osg/ImpostorSprite.html b/doc/doc++/osg/ImpostorSprite.html
index 5d5b2681f..badaf045d 100644
--- a/doc/doc++/osg/ImpostorSprite.html
+++ b/doc/doc++/osg/ImpostorSprite.html
@@ -23,106 +23,108 @@
Public Methods
-
-
ImpostorSprite()
+
ImpostorSprite()
-
-
virtual Object* clone() const
+
virtual Object* clone() const
-
-
virtual bool isSameKindAs(const Object* obj) const
+
virtual bool isSameKindAs(const Object* obj) const
-
-
virtual const char* className() const
+
virtual const char* className() const
-
-
void setParent(Impostor* parent)
+
void setParent(Impostor* parent)
- Set the parent, which must be an Impostor.
-
-
Impostor* getParent()
+
Impostor* getParent()
- Get the parent, which is an Impostor.
-
-
const Impostor* getParent() const
+
const Impostor* getParent() const
- Get the const parent, which is an Impostor.
-
-
inline void setStoredLocalEyePoint(const Vec3& v)
+
inline void setStoredLocalEyePoint(const Vec3& v)
- Set the eye point for when the ImpsotorSprite was snapped
-
-
inline const Vec3& getStoredLocalEyePoint() const
+
inline const Vec3& getStoredLocalEyePoint() const
- Get the eye point for when the ImpsotorSprite was snapped
-
-
inline void setLastFrameUsed(const int frameNumber)
+
inline void setLastFrameUsed(const int frameNumber)
- Set the frame number for when the ImpostorSprite was last used in rendering
-
-
inline int getLastFrameUsed() const
+
inline int getLastFrameUsed() const
- Get the frame number for when the ImpostorSprite was last used in rendering
-
-
inline Vec3* getCoords()
+
inline Vec3* getCoords()
- Get the coordinates of the corners of the quad.
-
-
inline const Vec3* getCoords() const
+
inline const Vec3* getCoords() const
- Get the const coordinates of the corners of the quad
-
-
inline Vec2* getTexCoords()
+
inline Vec2* getTexCoords()
- Get the texture coordinates of the corners of the quad.
-
-
inline const Vec2* getTexCoords() const
+
inline const Vec2* getTexCoords() const
- Get the const texture coordinates of the corners of the quad
-
-
inline Vec3* getControlCoords()
+
inline Vec3* getControlCoords()
- Get the control coordinates of the corners of the quad.
-
-
inline const Vec3* getControlCoords() const
+
inline const Vec3* getControlCoords() const
- Get the const control coordinates of the corners of the quad
-
-
const float calcPixelError(const Camera& camera, const Viewport& viewport, const osg::Matrix* matrix) const
+
const float calcPixelError(const Camera& camera, const Viewport& viewport, const osg::Matrix* matrix) const
- calculate the pixel error value for current camera position and object position
-
-
void setTexture(Texture* tex, int s, int t)
+
void setTexture(Texture* tex, int s, int t)
-
-
Texture* getTexture()
+
Texture* getTexture()
-
-
const Texture* getTexture() const
+
const Texture* getTexture() const
-
-
const int s() const
+
const int s() const
-
-
const int t() const
+
const int t() const
-
-
virtual void drawImmediateMode(State& state)
+
virtual void drawImmediateMode(State& state)
- draw ImpostorSprite directly.
+
-
+
bool getStats(Statistics &stat)
Protected Fields
-
-
Impostor* _parent
+
Impostor* _parent
-
-
ImpostorSpriteManager* _ism
+
ImpostorSpriteManager* _ism
-
-
ImpostorSprite* _previous
+
ImpostorSprite* _previous
-
-
ImpostorSprite* _next
+
ImpostorSprite* _next
-
-
int _lastFrameUsed
+
int _lastFrameUsed
-
-
Vec3 _storedLocalEyePoint
+
Vec3 _storedLocalEyePoint
-
-
Vec3 _coords[4]
+
Vec3 _coords[4]
-
-
Vec2 _texcoords[4]
+
Vec2 _texcoords[4]
-
-
Vec3 _controlcoords[4]
+
Vec3 _controlcoords[4]
-
-
Texture* _texture
+
Texture* _texture
-
-
int _s
+
int _s
-
-
int _t
+
int _t
Protected Methods
-
-
ImpostorSprite(const ImpostorSprite&)
+
ImpostorSprite(const ImpostorSprite&)
-
-
ImpostorSprite& operator = (const ImpostorSprite&)
+
ImpostorSprite& operator = (const ImpostorSprite&)
-
-
virtual ~ImpostorSprite()
+
virtual ~ImpostorSprite()
-
-
virtual const bool computeBound() const
+
virtual const bool computeBound() const
@@ -150,13 +152,24 @@
inline const BoundingBox& getBound() const
-
inline void draw(State& state)
-
void compile(State& state)
static void deleteDisplayList(uint contextID, uint globj)
static void flushDeletedDisplayLists(uint contextID)
+
+
virtual AttributeBitMask suppportsAttributeOperation() const
+
+
virtual AttributeBitMask applyAttributeOperation(AttributeFunctor&)
+
+
inline void draw(State& state)
+
+
+
+Public Members
-
+
typedef uint AttributeBitMaskenum AttributeBitMaskValues
+-
+class AttributeFunctor
@@ -207,197 +220,201 @@
An ImposterSprite is a textured quad which is rendered in place a
3D geometry. The ImposterSprite is generated by rendering the original
3D geometry to a texture as an image cache. The ImpostorSprite is
-automatiacally generatated by the osgUtil::CullVisitor so it not
+automatically generated by the osgUtil::CullVisitor so it not
necessary to deal with it directly.
-
+
ImpostorSprite()
-
+
virtual Object* clone() const
-
+
virtual bool isSameKindAs(const Object* obj) const
-
+
virtual const char* className() const
-
+
void setParent(Impostor* parent)
- Set the parent, which must be an Impostor.
Unlike conventional Drawables, ImpostorSprite's can only ever have
one parent.
-
+
Impostor* getParent()
- Get the parent, which is an Impostor.
-
+
const Impostor* getParent() const
- Get the const parent, which is an Impostor.
-
+
inline void setStoredLocalEyePoint(const Vec3& v)
- Set the eye point for when the ImpsotorSprite was snapped
-
+
inline const Vec3& getStoredLocalEyePoint() const
- Get the eye point for when the ImpsotorSprite was snapped
-
+
inline void setLastFrameUsed(const int frameNumber)
- Set the frame number for when the ImpostorSprite was last used in rendering
-
+
inline int getLastFrameUsed() const
- Get the frame number for when the ImpostorSprite was last used in rendering
-
+
inline Vec3* getCoords()
- Get the coordinates of the corners of the quad.
Stored in the order, [0] - top_left, [1] - bottom_left, [2] - bottom_right, [3] - top_left.
-
+
inline const Vec3* getCoords() const
- Get the const coordinates of the corners of the quad
-
+
inline Vec2* getTexCoords()
- Get the texture coordinates of the corners of the quad.
Stored in the order, [0] - top_left, [1] - bottom_left, [2] - bottom_right, [3] - top_left.
-
+
inline const Vec2* getTexCoords() const
- Get the const texture coordinates of the corners of the quad
-
+
inline Vec3* getControlCoords()
- Get the control coordinates of the corners of the quad.
-The control coordinates are the cornders of the quad projected
+The control coordinates are the corners of the quad projected
out onto the front face of bounding box which enclosed the impostor
geometry when it was pre-rendered into the impostor sprite's texture.
At the point of creation/or update of the impostor sprite the control
-coords will lie ontop of the coorners of the quad in screen space - with a pixel error
+coords will lie on top of the corners of the quad in screen space - with a pixel error
or zero. Once the camera moves relative to the impostor sprite the
-control coords will nolonger lie ontop of the corners of the quad in
+control coords will no longer lie on top of the corners of the quad in
screen space - a pixel error will have accumulated. This pixel error
-can then be used to dertermine whether the impostor needs to be updated.
+can then be used to determine whether the impostor needs to be updated.
Stored in the order, [0] - top_left, [1] - bottom_left, [2] - bottom_right, [3] - top_left.
-
+
inline const Vec3* getControlCoords() const
- Get the const control coordinates of the corners of the quad
-
+
const float calcPixelError(const Camera& camera, const Viewport& viewport, const osg::Matrix* matrix) const
- calculate the pixel error value for current camera position and object position
-
-
void setTexture(Texture* tex, int s, int t)
+
+
void setTexture(Texture* tex, int s, int t)
-
+
Texture* getTexture()
-
+
const Texture* getTexture() const
-
+
const int s() const
-
+
const int t() const
-
+
virtual void drawImmediateMode(State& state)
- draw ImpostorSprite directly.
+
+
+
bool getStats(Statistics &stat)
+
-
-
ImpostorSprite(const ImpostorSprite&)
+
+
ImpostorSprite(const ImpostorSprite&)
-
+
ImpostorSprite& operator = (const ImpostorSprite&)
-
+
virtual ~ImpostorSprite()
-
+
virtual const bool computeBound() const
-
+
Impostor* _parent
-
+
ImpostorSpriteManager* _ism
-
+
ImpostorSprite* _previous
-
+
ImpostorSprite* _next
-
+
int _lastFrameUsed
-
+
Vec3 _storedLocalEyePoint
-
+
Vec3 _coords[4]
-
+
Vec2 _texcoords[4]
-
+
Vec3 _controlcoords[4]
-
+
Texture* _texture
-
+
int _s
-
+
int _t
diff --git a/doc/doc++/osg/ImpostorSpriteManager.html b/doc/doc++/osg/ImpostorSpriteManager.html
index 4f75a54b3..b26d32496 100644
--- a/doc/doc++/osg/ImpostorSpriteManager.html
+++ b/doc/doc++/osg/ImpostorSpriteManager.html
@@ -23,35 +23,35 @@
Public Methods
-
-
ImpostorSpriteManager()
+
ImpostorSpriteManager()
-
-
const bool empty() const
+
const bool empty() const
-
-
ImpostorSprite* first()
+
ImpostorSprite* first()
-
-
ImpostorSprite* last()
+
ImpostorSprite* last()
-
-
void push_back(ImpostorSprite* is)
+
void push_back(ImpostorSprite* is)
-
-
void remove(ImpostorSprite* is)
+
void remove(ImpostorSprite* is)
-
-
ImpostorSprite* createOrReuseImpostorSprite(int s, int t, int frameNumber)
+
ImpostorSprite* createOrReuseImpostorSprite(int s, int t, int frameNumber)
Protected Fields
-
-
ref_ptr<TexEnv> _texenv
+
ref_ptr<TexEnv> _texenv
-
-
ref_ptr<AlphaFunc> _alphafunc
+
ref_ptr<AlphaFunc> _alphafunc
-
-
ImpostorSprite* _first
+
ImpostorSprite* _first
-
-
ImpostorSprite* _last
+
ImpostorSprite* _last
Protected Methods
-
-
~ImpostorSpriteManager()
+
~ImpostorSpriteManager()
@@ -82,51 +82,51 @@
-
+
ImpostorSpriteManager()
-
+
const bool empty() const
-
+
ImpostorSprite* first()
-
+
ImpostorSprite* last()
-
+
void push_back(ImpostorSprite* is)
-
+
void remove(ImpostorSprite* is)
-
-
ImpostorSprite* createOrReuseImpostorSprite(int s, int t, int frameNumber)
+
+
ImpostorSprite* createOrReuseImpostorSprite(int s, int t, int frameNumber)
-
+
~ImpostorSpriteManager()
-
+
ref_ptr<TexEnv> _texenv
-
+
ref_ptr<AlphaFunc> _alphafunc
-
+
ImpostorSprite* _first
-
+
ImpostorSprite* _last
diff --git a/doc/doc++/osg/LOD.html b/doc/doc++/osg/LOD.html
index d685cac29..60e56fd53 100644
--- a/doc/doc++/osg/LOD.html
+++ b/doc/doc++/osg/LOD.html
@@ -23,46 +23,46 @@
Public Methods
-
-
LOD()
+
LOD()
-
-
META_Node(LOD)
+
META_Node(LOD)
-
-
virtual void traverse(NodeVisitor& nv)
+
virtual void traverse(NodeVisitor& nv)
-
-
void setRange(const unsigned int index, const float range)
+
void setRange(const unsigned int index, const float range)
- Sets the value of range list element index to range which is a floating point distance specified in world coordinates.
-
-
inline const float getRange(const unsigned int index) const
+
inline const float getRange(const unsigned int index) const
- returns the range for specified index
-
-
inline const int getNumRanges() const
+
inline const int getNumRanges() const
- returns the number of ranges currently set
-
-
inline void setCenter(const Vec3 ¢er)
+
inline void setCenter(const Vec3 ¢er)
- Sets the object-space point which defines the center of the osg::LOD.
-
-
inline const Vec3& getCenter() const
+
inline const Vec3& getCenter() const
- return the LOD center point.
-
-
const int evaluate(const Vec3& eye_local, const float bias=1.0f) const
+
const int evaluate(const Vec3& eye_local, const float bias=1.0f) const
- return the child to traverse.
Protected Fields
-
-
RangeList _rangeList2
+
RangeList _rangeList2
-
-
Vec3 _center
+
Vec3 _center
Protected Methods
-
-
virtual ~LOD()
+
virtual ~LOD()
Protected Members
-
-
typedef std::vector<float> RangeList RangeList _rangeList
+
typedef std::vector<float> RangeList RangeList _rangeList
@@ -120,7 +120,7 @@
-
inline const std::string& getName() const
-
-
inline const ParentList& getParents() const
+
inline const ParentList& getParents() const
-
inline Group* getParent(const int i)
-
@@ -136,23 +136,25 @@
-
inline const int getNumChildrenRequiringAppTraversal() const
-
-
inline void setUserData(void* data, MemoryAdapter* ma=0L)
+
void setCullingActive(const bool active)
-
-
inline void* getUserData()
+
inline const bool getCullingActive() const
-
-
inline const void* getUserData() const
+
inline const int getNumChildrenWithCullingDisabled() const
-
-
inline MemoryAdapter* getMemoryAdapter()
+
inline void setUserData(osg::Referenced* obj)
-
-
inline const MemoryAdapter* getMemoryAdapter() const
+
inline Referenced* getUserData()
+-
+
inline const Referenced* getUserData() const
-
inline void setNodeMask(const NodeMask nm)
-
inline const NodeMask getNodeMask() const
-
-
inline const DescriptionList& getDescriptions() const
+
inline const DescriptionList& getDescriptions() const
-
-
inline DescriptionList& getDescriptions()
+
inline DescriptionList& getDescriptions()
-
inline const std::string& getDescription(const int i) const
-
@@ -188,19 +190,21 @@
-
std::string _name
-
-
ParentList _parents
+
ParentList _parents
-
ref_ptr<NodeCallback> _appCallback
-
int _numChildrenRequiringAppTraversal
-
-
void* _userData
+
bool _cullingActive
-
-
ref_ptr<MemoryAdapter> _memoryAdapter
+
int _numChildrenWithCullingDisabled
+-
+
osg::ref_ptr<Referenced> _userData
-
NodeMask _nodeMask
-
-
DescriptionList _descriptions
+
DescriptionList _descriptions
-
ref_ptr<StateSet> _dstate
@@ -208,6 +212,8 @@
Protected Methods
-
void setNumChildrenRequiringAppTraversal(const int num)
+-
+
void setNumChildrenWithCullingDisabled(const int num)
@@ -246,67 +252,67 @@ also be chosen.
-
+
LOD()
-
+
META_Node(LOD)
-
+
virtual void traverse(NodeVisitor& nv)
-
+
void setRange(const unsigned int index, const float range)
- Sets the value of range list element index to range which
is a floating point distance specified in world coordinates.
-Range list automatically expands to accomodate values beyond
+Range list automatically expands to accommodate values beyond
the current getNumRanges().
-
+
inline const float getRange(const unsigned int index) const
- returns the range for specified index
-
+
inline const int getNumRanges() const
- returns the number of ranges currently set
-
-
inline void setCenter(const Vec3 ¢er)
+
+
inline void setCenter(const Vec3 ¢er)
- Sets the object-space point which defines the center of the osg::LOD.
center is affected by any transforms in the hierarchy above the osg::LOD.
-
+
inline const Vec3& getCenter() const
- return the LOD center point.
-
+
const int evaluate(const Vec3& eye_local, const float bias=1.0f) const
- return the child to traverse.
Selected by the distance between the eye point in local
-coordinates and the LOD center, mutliplied by the bias.
+coordinates and the LOD center, multiplied by the bias.
-
+
virtual ~LOD()
-
+
typedef std::vector<float> RangeList RangeList _rangeList
-
+
RangeList _rangeList2
-
+
Vec3 _center
diff --git a/doc/doc++/osg/Light.html b/doc/doc++/osg/Light.html
index 6c12724c0..93014e0be 100644
--- a/doc/doc++/osg/Light.html
+++ b/doc/doc++/osg/Light.html
@@ -23,120 +23,118 @@
Public Methods
-
-
Light()
+
Light()
-
-
META_StateAttribute(Light, (Type)(LIGHT_0+_lightnum))
+
META_StateAttribute(Light, (Type)(LIGHT_0+_lightnum))
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
inline void on()
- - Turn the light on.
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
inline void off()
- - Turn the light off.
+
void setLightNum(const int num)
+- Set which OpenGL light to operate on
-
-
virtual void apply(State& state) const
- - Apply the light's state to the OpenGL state machine.
+
const int getLightNum() const
+- Get which OpenGL light this osg::Light operates on
-
-
inline void setAmbient( const Vec4& ambient )
+
inline void setAmbient( const Vec4& ambient )
- Set the ambient component of the light.
-
-
inline const Vec4& getAmbient() const
+
inline const Vec4& getAmbient() const
- Get the ambient component of the light.
-
-
inline void setDiffuse( const Vec4& diffuse )
+
inline void setDiffuse( const Vec4& diffuse )
- Set the diffuse component of the light.
-
-
inline const Vec4& getDiffuse() const
+
inline const Vec4& getDiffuse() const
- Get the diffuse component of the light.
-
-
inline void setSpecular( const Vec4& specular )
+
inline void setSpecular( const Vec4& specular )
- Set the specular component of the light.
-
-
inline const Vec4& getSpecular() const
+
inline const Vec4& getSpecular() const
- Get the specular component of the light.
-
-
inline void setPosition( const Vec4& position )
+
inline void setPosition( const Vec4& position )
- Set the position of the light.
-
-
inline const Vec4& getPosition() const
+
inline const Vec4& getPosition() const
- Get the position of the light.
-
-
inline void setDirection( const Vec3& direction )
+
inline void setDirection( const Vec3& direction )
- Set the direction of the light.
-
-
inline const Vec3& getDirection() const
+
inline const Vec3& getDirection() const
- Get the direction of the light.
-
-
inline void setConstantAttenuation( const float constant_attenuation )
+
inline void setConstantAttenuation( const float constant_attenuation )
- Set the constant attenuation of the light.
-
-
inline const float getConstantAttenuation() const
+
inline const float getConstantAttenuation() const
- Get the constant attenuation of the light.
-
-
inline void setLinearAttenuation( const float linear_attenuation )
+
inline void setLinearAttenuation( const float linear_attenuation )
- Set the linear attenuation of the light.
-
-
inline const float getLinearAttenuation() const
+
inline const float getLinearAttenuation() const
- Get the linear attenuation of the light.
-
-
inline void setQuadraticAttenuation( const float quadratic_attenuation )
+
inline void setQuadraticAttenuation( const float quadratic_attenuation )
- Set the quadratic attenuation of the light.
-
-
inline const float getQuadraticAttenuation() const
+
inline const float getQuadraticAttenuation() const
- Get the quadratic attenuation of the light.
-
-
inline void setSpotExponent( const float spot_exponent )
+
inline void setSpotExponent( const float spot_exponent )
- Set the spot exponent of the light.
-
-
inline const float getSpotExponent() const
+
inline const float getSpotExponent() const
- Get the spot exponent of the light.
-
-
inline void setSpotCutoff( const float spot_cutoff )
+
inline void setSpotCutoff( const float spot_cutoff )
- Set the spot cutoff of the light.
-
-
inline const float getSpotCutoff() const
+
inline const float getSpotCutoff() const
- Get the spot cutoff of the light.
-
-
void captureLightState()
+
void captureLightState()
- Capture the lighting settings of the current OpenGL state and store them in this object
+
-
+
virtual void apply(State& state) const
+ - Apply the light's state to the OpenGL state machine.
Protected Fields
-
-
int _lightnum
+
int _lightnum
-
-
bool _on
+
Vec4 _ambient
-
-
Vec4 _ambient
+
Vec4 _diffuse
-
-
Vec4 _diffuse
+
Vec4 _specular
-
-
Vec4 _specular
+
Vec4 _position
-
-
Vec4 _position
+
Vec3 _direction
-
-
Vec3 _direction
+
float _constant_attenuation
-
-
float _constant_attenuation
+
float _linear_attenuation
-
-
float _linear_attenuation
+
float _quadratic_attenuation
-
-
float _quadratic_attenuation
+
float _spot_exponent
-
-
float _spot_exponent
--
-
float _spot_cutoff
--
-
static int _currentLightNum
+
float _spot_cutoff
Protected Methods
-
-
virtual ~Light()
+
virtual ~Light()
-
-
void init()
+
void init()
- Initialize the light's settings with some decent defaults.
@@ -151,7 +149,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -159,8 +157,6 @@
-
bool operator != (const StateAttribute& rhs) const
-
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
--
virtual void compile(State&) const
@@ -210,204 +206,196 @@
-
+
Light()
-
-
META_StateAttribute(Light, (Type)(LIGHT_0+_lightnum))
+
+
META_StateAttribute(Light, (Type)(LIGHT_0+_lightnum))
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
-
inline void on()
--
-Turn the light on.
-Calling this method doesn't directly affect OpenGL's lighting mode.
+
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
-
inline void off()
--
-Turn the light off.
-Calling this method doesn't directly affect OpenGL's lighting mode.
+
+
+
void setLightNum(const int num)
+- Set which OpenGL light to operate on
-
-
-
virtual void apply(State& state) const
-- Apply the light's state to the OpenGL state machine.
+
+
+
const int getLightNum() const
+- Get which OpenGL light this osg::Light operates on
-
+
inline void setAmbient( const Vec4& ambient )
- Set the ambient component of the light.
-
+
inline const Vec4& getAmbient() const
- Get the ambient component of the light.
-
+
inline void setDiffuse( const Vec4& diffuse )
- Set the diffuse component of the light.
-
+
inline const Vec4& getDiffuse() const
- Get the diffuse component of the light.
-
+
inline void setSpecular( const Vec4& specular )
- Set the specular component of the light.
-
+
inline const Vec4& getSpecular() const
- Get the specular component of the light.
-
+
inline void setPosition( const Vec4& position )
- Set the position of the light.
-
+
inline const Vec4& getPosition() const
- Get the position of the light.
-
+
inline void setDirection( const Vec3& direction )
- Set the direction of the light.
-
+
inline const Vec3& getDirection() const
- Get the direction of the light.
-
+
inline void setConstantAttenuation( const float constant_attenuation )
- Set the constant attenuation of the light.
-
+
inline const float getConstantAttenuation() const
- Get the constant attenuation of the light.
-
+
inline void setLinearAttenuation( const float linear_attenuation )
- Set the linear attenuation of the light.
-
+
inline const float getLinearAttenuation() const
- Get the linear attenuation of the light.
-
+
inline void setQuadraticAttenuation( const float quadratic_attenuation )
- Set the quadratic attenuation of the light.
-
+
inline const float getQuadraticAttenuation() const
- Get the quadratic attenuation of the light.
-
+
inline void setSpotExponent( const float spot_exponent )
- Set the spot exponent of the light.
-
+
inline const float getSpotExponent() const
- Get the spot exponent of the light.
-
+
inline void setSpotCutoff( const float spot_cutoff )
- Set the spot cutoff of the light.
-
+
inline const float getSpotCutoff() const
- Get the spot cutoff of the light.
-
+
void captureLightState()
-
Capture the lighting settings of the current OpenGL state
and store them in this object
+
+
+
virtual void apply(State& state) const
+- Apply the light's state to the OpenGL state machine.
+
-
+
virtual ~Light()
-
+
void init()
- Initialize the light's settings with some decent defaults.
-
+
int _lightnum
-
-
-
bool _on
-
-
+
Vec4 _ambient
-
+
Vec4 _diffuse
-
+
Vec4 _specular
-
+
Vec4 _position
-
+
Vec3 _direction
-
+
float _constant_attenuation
-
+
float _linear_attenuation
-
+
float _quadratic_attenuation
-
+
float _spot_exponent
-
+
float _spot_cutoff
-
-
-
-
static int _currentLightNum
- This class has no child classes.
diff --git a/doc/doc++/osg/LightSource.html b/doc/doc++/osg/LightSource.html
index 2c08bf6bc..11be2fc8d 100644
--- a/doc/doc++/osg/LightSource.html
+++ b/doc/doc++/osg/LightSource.html
@@ -23,30 +23,30 @@
Public Methods
-
-
LightSource()
+
LightSource()
-
-
META_Node(LightSource)
+
META_Node(LightSource)
-
-
inline void setLight(Light* light)
+
inline void setLight(Light* light)
- Set the attached light
-
-
inline Light* getLight()
+
inline Light* getLight()
- Get the attached light
-
-
inline const Light* getLight() const
+
inline const Light* getLight() const
- Get the const attached light
Protected Fields
-
-
ref_ptr<Light> _light
+
ref_ptr<Light> _light
Protected Methods
-
-
virtual ~LightSource()
+
virtual ~LightSource()
-
-
virtual const bool computeBound() const
+
virtual const bool computeBound() const
@@ -72,7 +72,7 @@
inline const std::string& getName() const
-
inline const ParentList& getParents() const
+
inline const ParentList& getParents() const
inline Group* getParent(const int i)
@@ -88,23 +88,25 @@
inline const int getNumChildrenRequiringAppTraversal() const
-
inline void setUserData(void* data, MemoryAdapter* ma=0L)
+
void setCullingActive(const bool active)
-
inline void* getUserData()
+
inline const bool getCullingActive() const
-
inline const void* getUserData() const
+
inline const int getNumChildrenWithCullingDisabled() const
-
inline MemoryAdapter* getMemoryAdapter()
+
inline void setUserData(osg::Referenced* obj)
-
inline const MemoryAdapter* getMemoryAdapter() const
+
inline Referenced* getUserData()
+
+
inline const Referenced* getUserData() const
inline void setNodeMask(const NodeMask nm)
inline const NodeMask getNodeMask() const
-
inline const DescriptionList& getDescriptions() const
+
inline const DescriptionList& getDescriptions() const
-
inline DescriptionList& getDescriptions()
+
inline DescriptionList& getDescriptions()
inline const std::string& getDescription(const int i) const
@@ -140,19 +142,21 @@
std::string _name
-
ParentList _parents
+
ParentList _parents
ref_ptr<NodeCallback> _appCallback
int _numChildrenRequiringAppTraversal
-
void* _userData
+
bool _cullingActive
-
ref_ptr<MemoryAdapter> _memoryAdapter
+
int _numChildrenWithCullingDisabled
+
+
osg::ref_ptr<Referenced> _userData
NodeMask _nodeMask
-
DescriptionList _descriptions
+
DescriptionList _descriptions
ref_ptr<StateSet> _dstate
@@ -160,6 +164,8 @@
Protected Methods
-
void setNumChildrenRequiringAppTraversal(const int num)
+-
+
void setNumChildrenWithCullingDisabled(const int num)
@@ -193,38 +199,38 @@
-
+
LightSource()
-
+
META_Node(LightSource)
-
+
inline void setLight(Light* light)
- Set the attached light
-
+
inline Light* getLight()
- Get the attached light
-
+
inline const Light* getLight() const
- Get the const attached light
-
+
virtual ~LightSource()
-
+
virtual const bool computeBound() const
-
+
ref_ptr<Light> _light
diff --git a/doc/doc++/osg/LineSegment.html b/doc/doc++/osg/LineSegment.html
index 2f6c28483..fa3898415 100644
--- a/doc/doc++/osg/LineSegment.html
+++ b/doc/doc++/osg/LineSegment.html
@@ -7,7 +7,7 @@
-LineSegmentment class for representing a line segment
+LineSegment class for representing a line segment
Inheritance:
@@ -23,58 +23,60 @@
Public Methods
-
-
LineSegment()
+
LineSegment()
-
-
LineSegment(const LineSegment& seg)
+
LineSegment(const LineSegment& seg)
-
-
LineSegment(const Vec3& s, const Vec3& e)
+
LineSegment(const Vec3& s, const Vec3& e)
-
-
virtual ~LineSegment()
+
virtual ~LineSegment()
-
-
LineSegment& operator = (const LineSegment& seg)
+
LineSegment& operator = (const LineSegment& seg)
-
-
inline void set(const Vec3& s, const Vec3& e)
+
inline void set(const Vec3& s, const Vec3& e)
-
-
inline Vec3& start()
+
inline Vec3& start()
-
-
inline const Vec3& start() const
+
inline const Vec3& start() const
-
-
inline Vec3& end()
+
inline Vec3& end()
-
-
inline const Vec3& end() const
+
inline const Vec3& end() const
-
-
const bool intersect(const BoundingBox& bb) const
+
inline const bool valid() const
+-
+
const bool intersect(const BoundingBox& bb) const
- return true if segment intersects BoundingBox
-
-
const bool intersect(const BoundingBox& bb, float& r1, float& r2) const
+
const bool intersect(const BoundingBox& bb, float& r1, float& r2) const
- return true if segment intersects BoundingSphere and return the intersection ratio's
-
-
const bool intersect(const BoundingSphere& bs) const
+
const bool intersect(const BoundingSphere& bs) const
- return true if segment intersects BoundingSphere
-
-
const bool intersect(const BoundingSphere& bs, float& r1, float& r2) const
+
const bool intersect(const BoundingSphere& bs, float& r1, float& r2) const
- return true if segment intersects BoundingSphere and return the intersection ratio's
-
-
const bool intersect(const Vec3& v1, const Vec3& v2, const Vec3& v3, float& r)
+
const bool intersect(const Vec3& v1, const Vec3& v2, const Vec3& v3, float& r)
- return true if segment intersects triangle and set ratio long segment.
-
-
inline void mult(const LineSegment& seg, const Matrix& m)
+
inline void mult(const LineSegment& seg, const Matrix& m)
- post multiply a segment by matrix
-
-
inline void mult(const Matrix& m, const LineSegment& seg)
+
inline void mult(const Matrix& m, const LineSegment& seg)
- pre multiply a segment by matrix
Protected Fields
-
-
Vec3 _s
+
Vec3 _s
-
-
Vec3 _e
+
Vec3 _e
Protected Methods
-
-
static const bool intersectAndClip(Vec3& s, Vec3& e, const BoundingBox& bb)
+
static const bool intersectAndClip(Vec3& s, Vec3& e, const BoundingBox& bb)
@@ -99,94 +101,98 @@
Documentation
-LineSegmentment class for representing a line segment
+LineSegment class for representing a line segment
-
+
LineSegment()
-
-
LineSegment(const LineSegment& seg)
+
+
LineSegment(const LineSegment& seg)
-
-
LineSegment(const Vec3& s, const Vec3& e)
+
+
LineSegment(const Vec3& s, const Vec3& e)
-
+
virtual ~LineSegment()
-
+
LineSegment& operator = (const LineSegment& seg)
-
-
inline void set(const Vec3& s, const Vec3& e)
+
+
inline void set(const Vec3& s, const Vec3& e)
-
+
inline Vec3& start()
-
+
inline const Vec3& start() const
-
+
inline Vec3& end()
-
+
inline const Vec3& end() const
+
+
+
inline const bool valid() const
+
-
+
const bool intersect(const BoundingBox& bb) const
- return true if segment intersects BoundingBox
-
+
const bool intersect(const BoundingBox& bb, float& r1, float& r2) const
- return true if segment intersects BoundingSphere and return the intersection ratio's
-
+
const bool intersect(const BoundingSphere& bs) const
- return true if segment intersects BoundingSphere
-
+
const bool intersect(const BoundingSphere& bs, float& r1, float& r2) const
- return true if segment intersects BoundingSphere and return the intersection ratio's
-
-
const bool intersect(const Vec3& v1, const Vec3& v2, const Vec3& v3, float& r)
+
+
const bool intersect(const Vec3& v1, const Vec3& v2, const Vec3& v3, float& r)
- return true if segment intersects triangle and set ratio long segment.
-
+
inline void mult(const LineSegment& seg, const Matrix& m)
- post multiply a segment by matrix
-
+
inline void mult(const Matrix& m, const LineSegment& seg)
- pre multiply a segment by matrix
-
-
static const bool intersectAndClip(Vec3& s, Vec3& e, const BoundingBox& bb)
+
+
static const bool intersectAndClip(Vec3& s, Vec3& e, const BoundingBox& bb)
-
+
Vec3 _s
-
+
Vec3 _e
diff --git a/doc/doc++/osg/Material.html b/doc/doc++/osg/Material.html
index 5c44dc164..c09191628 100644
--- a/doc/doc++/osg/Material.html
+++ b/doc/doc++/osg/Material.html
@@ -23,112 +23,112 @@
Public Methods
-
-
Material()
+
Material()
-
-
META_StateAttribute(Material, MATERIAL)
+
META_StateAttribute(Material, MATERIAL)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
-
-
inline void setColorMode(const ColorMode mode)
+
inline void setColorMode(const ColorMode mode)
-
-
inline const ColorMode getColorMode() const
+
inline const ColorMode getColorMode() const
-
-
void setAmbient( const Face face, const Vec4& ambient )
+
void setAmbient( const Face face, const Vec4& ambient )
-
-
const Vec4& getAmbient(const Face face) const
+
const Vec4& getAmbient(const Face face) const
-
-
inline const bool getAmbientFrontAndBack() const
+
inline const bool getAmbientFrontAndBack() const
-
-
void setDiffuse( const Face face, const Vec4& diffuse )
+
void setDiffuse( const Face face, const Vec4& diffuse )
-
-
const Vec4& getDiffuse(const Face face) const
+
const Vec4& getDiffuse(const Face face) const
-
-
inline const bool getDiffuseFrontAndBack() const
+
inline const bool getDiffuseFrontAndBack() const
-
-
void setSpecular( const Face face, const Vec4& specular )
+
void setSpecular( const Face face, const Vec4& specular )
- Set specular value of specified face(s) of the material, valid specular[03] range is 00 to 10
-
-
const Vec4& getSpecular(const Face face) const
+
const Vec4& getSpecular(const Face face) const
- Get the specular value for specified face
-
-
inline const bool getSpecularFrontAndBack() const
+
inline const bool getSpecularFrontAndBack() const
- Get the whether specular values are equal for front and back faces
-
-
void setEmission( const Face face, const Vec4& emission )
- - Set emmision value of specified face(s) of the material, valid emmison[03] range is 00 to 10
+
void setEmission( const Face face, const Vec4& emission )
+- Set emission value of specified face(s) of the material, valid emmison[03] range is 00 to 10
-
-
const Vec4& getEmission(const Face face) const
+
const Vec4& getEmission(const Face face) const
- Get the emmsion value for specified face
-
-
inline const bool getEmissionFrontAndBack() const
- - Get the whether emmision values are equal for front and back faces
+
inline const bool getEmissionFrontAndBack() const
+- Get the whether emission values are equal for front and back faces
-
-
void setShininess( const Face face, float shininess )
+
void setShininess( const Face face, float shininess )
- Set shininess of specified face(s) of the material, valid shininess range is 00 to 10
-
-
const float getShininess(const Face face) const
+
const float getShininess(const Face face) const
- Get the shininess value for specified face
-
-
inline const bool getShininessFrontAndBack() const
+
inline const bool getShininessFrontAndBack() const
- Get the whether shininess values are equal for front and back faces
-
-
void setTransparency(const Face face, float trans)
- - Set the alpha value of ambient,diffuse,specular and emmission colors, of specified face, to 1-transparancy.
+
void setTransparency(const Face face, float trans)
+- Set the alpha value of ambient,diffuse,specular and emission colors, of specified face, to 1-transparency.
-
-
void setAlpha(const Face face, float alpha)
- - Set the alpha value of ambient,diffuse,specular and emmission colors.
+
void setAlpha(const Face face, float alpha)
+- Set the alpha value of ambient,diffuse,specular and emission colors.
Public Members
-
-
enum Face
+
enum Face
-
-
enum ColorMode
+
enum ColorMode
Protected Fields
-
-
ColorMode _colorMode
+
ColorMode _colorMode
-
-
bool _ambientFrontAndBack
+
bool _ambientFrontAndBack
-
-
Vec4 _ambientFront
+
Vec4 _ambientFront
-
-
Vec4 _ambientBack
+
Vec4 _ambientBack
-
-
bool _diffuseFrontAndBack
+
bool _diffuseFrontAndBack
-
-
Vec4 _diffuseFront
+
Vec4 _diffuseFront
-
-
Vec4 _diffuseBack
+
Vec4 _diffuseBack
-
-
bool _specularFrontAndBack
+
bool _specularFrontAndBack
-
-
Vec4 _specularFront
+
Vec4 _specularFront
-
-
Vec4 _specularBack
+
Vec4 _specularBack
-
-
bool _emissionFrontAndBack
+
bool _emissionFrontAndBack
-
-
Vec4 _emissionFront
+
Vec4 _emissionFront
-
-
Vec4 _emissionBack
+
Vec4 _emissionBack
-
-
bool _shininessFrontAndBack
+
bool _shininessFrontAndBack
-
-
float _shininessFront
+
float _shininessFront
-
-
float _shininessBack
+
float _shininessBack
Protected Methods
-
-
virtual ~Material()
+
virtual ~Material()
@@ -142,7 +142,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -199,231 +199,231 @@
-
+
Material()
-
-
META_StateAttribute(Material, MATERIAL)
+
+
META_StateAttribute(Material, MATERIAL)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
virtual void apply(State& state) const
-
+
enum Face
-
+
FRONT
-
+
BACK
-
+
FRONT_AND_BACK
-
+
enum ColorMode
-
+
AMBIENT
-
+
DIFFUSE
-
+
SPECULAR
-
+
EMISSION
-
+
AMBIENT_AND_DIFFUSE
-
+
OFF
-
-
inline void setColorMode(const ColorMode mode)
+
+
inline void setColorMode(const ColorMode mode)
-
-
inline const ColorMode getColorMode() const
+
+
inline const ColorMode getColorMode() const
-
-
void setAmbient( const Face face, const Vec4& ambient )
+
+
void setAmbient( const Face face, const Vec4& ambient )
-
-
const Vec4& getAmbient(const Face face) const
+
+
const Vec4& getAmbient(const Face face) const
-
+
inline const bool getAmbientFrontAndBack() const
-
-
void setDiffuse( const Face face, const Vec4& diffuse )
+
+
void setDiffuse( const Face face, const Vec4& diffuse )
-
-
const Vec4& getDiffuse(const Face face) const
+
+
const Vec4& getDiffuse(const Face face) const
-
+
inline const bool getDiffuseFrontAndBack() const
-
-
void setSpecular( const Face face, const Vec4& specular )
+
+
void setSpecular( const Face face, const Vec4& specular )
- Set specular value of specified face(s) of the material,
valid specular[03] range is 00 to 10
-
-
const Vec4& getSpecular(const Face face) const
+
+
const Vec4& getSpecular(const Face face) const
- Get the specular value for specified face
-
+
inline const bool getSpecularFrontAndBack() const
- Get the whether specular values are equal for front and back faces
-
-
void setEmission( const Face face, const Vec4& emission )
-- Set emmision value of specified face(s) of the material,
+
+
void setEmission( const Face face, const Vec4& emission )
+- Set emission value of specified face(s) of the material,
valid emmison[03] range is 00 to 10
-
-
const Vec4& getEmission(const Face face) const
+
+
const Vec4& getEmission(const Face face) const
- Get the emmsion value for specified face
-
+
inline const bool getEmissionFrontAndBack() const
-- Get the whether emmision values are equal for front and back faces
+
- Get the whether emission values are equal for front and back faces
-
-
void setShininess( const Face face, float shininess )
+
+
void setShininess( const Face face, float shininess )
- Set shininess of specified face(s) of the material, valid shininess range is 00 to 10
-
-
const float getShininess(const Face face) const
+
+
const float getShininess(const Face face) const
- Get the shininess value for specified face
-
+
inline const bool getShininessFrontAndBack() const
- Get the whether shininess values are equal for front and back faces
-
-
void setTransparency(const Face face, float trans)
-- Set the alpha value of ambient,diffuse,specular and emmission colors,
-of specified face, to 1-transparancy. Valid transparancy range is 0.0 to 1.0.
+
+
void setTransparency(const Face face, float trans)
+- Set the alpha value of ambient,diffuse,specular and emission colors,
+of specified face, to 1-transparency. Valid transparency range is 0.0 to 1.0.
-
-
void setAlpha(const Face face, float alpha)
-- Set the alpha value of ambient,diffuse,specular and emmission colors.
-Valid transparancy range is 0.0 to 1.0.
+
+
void setAlpha(const Face face, float alpha)
+- Set the alpha value of ambient,diffuse,specular and emission colors.
+Valid transparency range is 0.0 to 1.0.
-
+
virtual ~Material()
-
-
ColorMode _colorMode
+
+
ColorMode _colorMode
-
+
bool _ambientFrontAndBack
-
+
Vec4 _ambientFront
-
+
Vec4 _ambientBack
-
+
bool _diffuseFrontAndBack
-
+
Vec4 _diffuseFront
-
+
Vec4 _diffuseBack
-
+
bool _specularFrontAndBack
-
+
Vec4 _specularFront
-
+
Vec4 _specularBack
-
+
bool _emissionFrontAndBack
-
+
Vec4 _emissionFront
-
+
Vec4 _emissionBack
-
+
bool _shininessFrontAndBack
-
+
float _shininessFront
-
+
float _shininessBack
diff --git a/doc/doc++/osg/Matrix.html b/doc/doc++/osg/Matrix.html
index 714b83510..82e36d77e 100644
--- a/doc/doc++/osg/Matrix.html
+++ b/doc/doc++/osg/Matrix.html
@@ -20,172 +20,141 @@
-
-Public Fields
-
-
float _mat[4][4]
--
-
bool fully_realized
-
-
Public Methods
-
-
META_Object(Matrix)
+
META_Object(Matrix)
-
-
Matrix()
+
Matrix()
-
-
Matrix( const Matrix& other )
+
Matrix( const Matrix& other )
-
-
explicit Matrix( float const* const def )
+
explicit Matrix( float const* const def )
-
-
Matrix( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
+
Matrix( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
-
-
virtual ~Matrix()
+
virtual ~Matrix()
-
-
Matrix& operator = (const Matrix& )
+
Matrix& operator = (const Matrix& )
-
-
int compare(const Matrix& m) const
+
int compare(const Matrix& m) const
-
-
bool operator < (const Matrix& m) const
+
bool operator < (const Matrix& m) const
-
-
bool operator == (const Matrix& m) const
+
bool operator == (const Matrix& m) const
-
-
bool operator != (const Matrix& m) const
+
bool operator != (const Matrix& m) const
-
-
inline float& operator()(int col, int row)
+
inline float& operator()(int row, int col)
-
-
inline float operator()(int col, int row) const
+
inline float operator()(int row, int col) const
-
-
void set( float const* const )
+
void set( float const* const )
-
-
void set( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
+
void set( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
-
-
const float* values()
+
float* ptr()
-
-
void makeIdent()
+
const float* ptr() const
-
-
void makeScale( const Vec3& )
+
inline void ensureRealized() const
-
-
void makeScale( float, float, float )
+
void makeIdentity()
-
-
void makeTrans( const Vec3& )
+
void makeScale( const Vec3& )
-
-
void makeTrans( float, float, float )
+
void makeScale( float, float, float )
-
-
void makeRot( const Vec3& from, const Vec3& to )
+
void makeTranslate( const Vec3& )
-
-
void makeRot( float angle, const Vec3& orientation )
+
void makeTranslate( float, float, float )
-
-
void makeRot( float angle, float x, float y, float z )
+
void makeRotate( const Vec3& from, const Vec3& to )
-
-
void makeRot( const Quat& )
+
void makeRotate( float angle, const Vec3& axis )
-
-
void makeRot( float, float, float )
+
void makeRotate( float angle, float x, float y, float z )
-
-
bool invert( const Matrix& )
+
void makeRotate( const Quat& )
-
-
bool invertAffine( const Matrix& )
+
void makeRotate( float, float, float )
-
-
inline static Matrix scale( const Vec3& )
+
bool invert( const Matrix& )
-
-
inline static Matrix scale( float, float, float )
+
bool invertAffine( const Matrix& )
-
-
inline static Matrix trans( const Vec3& )
+
inline static Matrix identity( void )
-
-
inline static Matrix trans( float, float, float )
+
inline static Matrix scale( const Vec3& )
-
-
inline static Matrix rotate( const Vec3&, const Vec3& )
+
inline static Matrix scale( float, float, float )
-
-
inline static Matrix rotate( float, float, float, float )
+
inline static Matrix translate( const Vec3& )
-
-
inline static Matrix rotate( const Quat& )
+
inline static Matrix translate( float, float, float )
-
-
void setTrans( float tx, float ty, float tz )
+
inline static Matrix rotate( const Vec3&, const Vec3& )
-
-
void setTrans( const Vec3& v )
+
inline static Matrix rotate( float, float, float, float )
-
-
Vec3 getTrans() const
+
inline static Matrix rotate( float angle, const Vec3& axis)
-
-
void copy( const Matrix& )
+
inline static Matrix rotate( const Quat& )
-
-
void preScale( float sx, float sy, float sz, const Matrix& m )
+
void setTrans( float tx, float ty, float tz )
-
-
void postScale( const Matrix& m, float sx, float sy, float sz )
+
void setTrans( const Vec3& v )
-
-
void preScale( float sx, float sy, float sz )
+
Vec3 getTrans() const
-
-
void postScale( float sx, float sy, float sz )
--
-
void preTrans( float tx, float ty, float tz, const Matrix& m )
--
-
void postTrans( const Matrix& m, float tx, float ty, float tz )
--
-
void preTrans( float tx, float ty, float tz)
--
-
void postTrans( float tx, float ty, float tz )
--
-
void preRot( float deg, float x, float y, float z, const Matrix& m )
--
-
void postRot( const Matrix& m, float deg, float x, float y, float z )
--
-
void preRot( float deg, float x, float y, float z )
--
-
void postRot( float deg, float x, float y, float z )
--
-
inline static Vec3 transform3x3(const Vec3& v, const Matrix& m)
+
inline static Vec3 transform3x3(const Vec3& v, const Matrix& m)
- apply apply an 3x3 transform of v*M[02,02]
-
-
inline static Vec3 transform3x3(const Matrix& m, const Vec3& v)
+
inline static Vec3 transform3x3(const Matrix& m, const Vec3& v)
- apply apply an 3x3 transform of M[02,02]*v
-
-
void mult( const Matrix&, const Matrix& )
- - nd of Deprecated methods
+
void mult( const Matrix&, const Matrix& )
-
-
void preMult( const Matrix& )
+
void preMult( const Matrix& )
-
-
void postMult( const Matrix& )
+
void postMult( const Matrix& )
-
-
inline MatrixProduct operator * ( const Matrix& other ) const
+
inline void operator *= ( const Matrix& other )
-
-
inline void operator *= ( const Matrix& other )
+
inline Matrix operator * ( const Matrix &m ) const
-
-
inline void operator = ( const MatrixProduct& p )
+
inline Matrix identity(void)
-
-
Matrix( const MatrixProduct& p )
+
inline Matrix scale(float sx, float sy, float sz)
-
-
inline Matrix scale(float sx, float sy, float sz)
+
inline Matrix scale(const Vec3& v )
-
-
inline Matrix scale(const Vec3& v )
+
inline Matrix translate(float tx, float ty, float tz)
-
-
inline Matrix trans(float tx, float ty, float tz)
+
inline Matrix translate(const Vec3& v )
-
-
inline Matrix trans(const Vec3& v )
+
inline Matrix rotate( const Quat& q )
-
-
inline Matrix rotate( const Quat& q )
+
inline Matrix rotate(float angle, float x, float y, float z )
-
-
inline Matrix rotate(float angle, float x, float y, float z )
+
inline Matrix rotate(float angle, const Vec3& axis )
-
-
inline Matrix rotate(const Vec3& from, const Vec3& to )
+
inline Matrix rotate(const Vec3& from, const Vec3& to )
-
-
inline Vec3 postMult( const Vec3& v ) const
+
inline Vec3 postMult( const Vec3& v ) const
-
-
inline Vec3 preMult( const Vec3& v ) const
+
inline Vec3 preMult( const Vec3& v ) const
-
-
inline Vec4 postMult( const Vec4& v ) const
+
inline Vec4 postMult( const Vec4& v ) const
-
-
inline Vec4 preMult( const Vec4& v ) const
+
inline Vec4 preMult( const Vec4& v ) const
-
-
inline Vec3 transform3x3(const Vec3& v, const Matrix& m)
+
inline Vec3 transform3x3(const Vec3& v, const Matrix& m)
-
-
inline Vec3 transform3x3(const Matrix& m, const Vec3& v)
+
inline Vec3 transform3x3(const Matrix& m, const Vec3& v)
-
-
inline Vec3 operator* (const Vec3& v) const
+
inline Vec3 operator* (const Vec3& v) const
-
-
inline Vec4 operator* (const Vec4& v) const
-
-
-
-Public Members
-
-class MatrixProduct
+
inline Vec4 operator* (const Vec4& v) const
@@ -224,315 +193,270 @@ class MatrixProduct
Documentation
-
-
-
float _mat[4][4]
-
-
-
-
bool fully_realized
-
-
+
META_Object(Matrix)
-
+
Matrix()
-
-
Matrix( const Matrix& other )
+
+
Matrix( const Matrix& other )
-
+
explicit Matrix( float const* const def )
-
+
Matrix( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
-
+
virtual ~Matrix()
-
+
Matrix& operator = (const Matrix& )
-
+
int compare(const Matrix& m) const
-
+
bool operator < (const Matrix& m) const
-
+
bool operator == (const Matrix& m) const
-
+
bool operator != (const Matrix& m) const
-
-
inline float& operator()(int col, int row)
+
+
inline float& operator()(int row, int col)
-
-
inline float operator()(int col, int row) const
+
+
inline float operator()(int row, int col) const
-
+
void set( float const* const )
-
+
void set( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33)
-
-
-
const float* values()
+
+
+
float* ptr()
-
-
-
void makeIdent()
+
+
+
const float* ptr() const
+
+
+
+
inline void ensureRealized() const
+
+
+
+
void makeIdentity()
-
+
void makeScale( const Vec3& )
-
+
void makeScale( float, float, float )
-
-
-
void makeTrans( const Vec3& )
+
+
+
void makeTranslate( const Vec3& )
-
-
-
void makeTrans( float, float, float )
+
+
+
void makeTranslate( float, float, float )
-
-
-
void makeRot( const Vec3& from, const Vec3& to )
+
+
+
void makeRotate( const Vec3& from, const Vec3& to )
-
-
-
void makeRot( float angle, const Vec3& orientation )
+
+
+
void makeRotate( float angle, const Vec3& axis )
-
-
-
void makeRot( float angle, float x, float y, float z )
+
+
+
void makeRotate( float angle, float x, float y, float z )
-
-
-
void makeRot( const Quat& )
+
+
+
void makeRotate( const Quat& )
-
-
-
void makeRot( float, float, float )
+
+
+
void makeRotate( float, float, float )
-
+
bool invert( const Matrix& )
-
+
bool invertAffine( const Matrix& )
+
+
+
inline static Matrix identity( void )
+
-
+
inline static Matrix scale( const Vec3& )
-
+
inline static Matrix scale( float, float, float )
-
-
-
inline static Matrix trans( const Vec3& )
+
+
+
inline static Matrix translate( const Vec3& )
-
-
-
inline static Matrix trans( float, float, float )
+
+
+
inline static Matrix translate( float, float, float )
-
+
inline static Matrix rotate( const Vec3&, const Vec3& )
-
+
inline static Matrix rotate( float, float, float, float )
-
+
+
inline static Matrix rotate( float angle, const Vec3& axis)
+
+
+
inline static Matrix rotate( const Quat& )
-
+
void setTrans( float tx, float ty, float tz )
-
+
void setTrans( const Vec3& v )
-
+
Vec3 getTrans() const
-
-
-
void copy( const Matrix& )
-
-
-
-
void preScale( float sx, float sy, float sz, const Matrix& m )
-
-
-
-
void postScale( const Matrix& m, float sx, float sy, float sz )
-
-
-
-
void preScale( float sx, float sy, float sz )
-
-
-
-
void postScale( float sx, float sy, float sz )
-
-
-
-
void preTrans( float tx, float ty, float tz, const Matrix& m )
-
-
-
-
void postTrans( const Matrix& m, float tx, float ty, float tz )
-
-
-
-
void preTrans( float tx, float ty, float tz)
-
-
-
-
void postTrans( float tx, float ty, float tz )
-
-
-
-
void preRot( float deg, float x, float y, float z, const Matrix& m )
-
-
-
-
void postRot( const Matrix& m, float deg, float x, float y, float z )
-
-
-
-
void preRot( float deg, float x, float y, float z )
-
-
-
-
void postRot( float deg, float x, float y, float z )
-
-
+
inline static Vec3 transform3x3(const Vec3& v, const Matrix& m)
- apply apply an 3x3 transform of v*M[02,02]
-
+
inline static Vec3 transform3x3(const Matrix& m, const Vec3& v)
- apply apply an 3x3 transform of M[02,02]*v
-
+
void mult( const Matrix&, const Matrix& )
-- nd of Deprecated methods
-
+
void preMult( const Matrix& )
-
+
void postMult( const Matrix& )
-
-
-
inline MatrixProduct operator * ( const Matrix& other ) const
-
-
+
inline void operator *= ( const Matrix& other )
-
-
-
inline void operator = ( const MatrixProduct& p )
+
+
+
inline Matrix operator * ( const Matrix &m ) const
-
-
-
Matrix( const MatrixProduct& p )
+
+
+
inline Matrix identity(void)
-
+
inline Matrix scale(float sx, float sy, float sz)
-
+
inline Matrix scale(const Vec3& v )
-
-
-
inline Matrix trans(float tx, float ty, float tz)
+
+
+
inline Matrix translate(float tx, float ty, float tz)
-
-
-
inline Matrix trans(const Vec3& v )
+
+
+
inline Matrix translate(const Vec3& v )
-
+
inline Matrix rotate( const Quat& q )
-
-
inline Matrix rotate(float angle, float x, float y, float z )
+
+
inline Matrix rotate(float angle, float x, float y, float z )
-
+
+
inline Matrix rotate(float angle, const Vec3& axis )
+
+
+
inline Matrix rotate(const Vec3& from, const Vec3& to )
-
+
inline Vec3 postMult( const Vec3& v ) const
-
+
inline Vec3 preMult( const Vec3& v ) const
-
+
inline Vec4 postMult( const Vec4& v ) const
-
+
inline Vec4 preMult( const Vec4& v ) const
-
+
inline Vec3 transform3x3(const Vec3& v, const Matrix& m)
-
+
inline Vec3 transform3x3(const Matrix& m, const Vec3& v)
-
+
inline Vec3 operator* (const Vec3& v) const
-
+
inline Vec4 operator* (const Vec4& v) const
diff --git a/doc/doc++/osg/MemoryAdapter.html b/doc/doc++/osg/MemoryAdapter.html
index 9f5bce2eb..6141725a1 100644
--- a/doc/doc++/osg/MemoryAdapter.html
+++ b/doc/doc++/osg/MemoryAdapter.html
@@ -23,21 +23,21 @@
Public Methods
-
-
MemoryAdapter()
+
MemoryAdapter()
-
-
virtual void ref_data(void* ) = 0
+
virtual void ref_data(void* ) = 0
- Increment the reference count of the userData
-
-
virtual void unref_data(void* ) = 0
+
virtual void unref_data(void* ) = 0
- Decrement the reference count of the userData.
-
-
virtual void* clone_data(void* )
+
virtual void* clone_data(void* )
- not current used, but will be used in future
Protected Methods
-
-
virtual ~MemoryAdapter()
+
virtual ~MemoryAdapter()
@@ -70,30 +70,30 @@ which can be attached to osg::Node.
-
+
MemoryAdapter()
-
+
virtual void ref_data(void* ) = 0
- Increment the reference count of the userData
-
+
virtual void unref_data(void* ) = 0
- Decrement the reference count of the userData.
Is usually implemented such that if reference count
is decremented to zero the userData should be
deleted. However, this is entirely up to the
-discression of the user who is extending this base class.
+discretion of the user who is extending this base class.
-
+
virtual void* clone_data(void* )
- not current used, but will be used in future
-
+
virtual ~MemoryAdapter()
diff --git a/doc/doc++/osg/Node.html b/doc/doc++/osg/Node.html
index 95ba3ac84..fdf390646 100644
--- a/doc/doc++/osg/Node.html
+++ b/doc/doc++/osg/Node.html
@@ -23,158 +23,165 @@
Public Methods
-
-
Node()
+
Node()
- Construct a node.
-
-
virtual Object* clone() const
+
virtual Object* clone() const
- return a shallow copy of a node, with Object* return type
-
-
virtual bool isSameKindAs(const Object* obj) const
+
virtual bool isSameKindAs(const Object* obj) const
- return true if this and obj are of the same kind of object
-
-
virtual const char* className() const
+
virtual const char* className() const
- return the name of the node's class type
-
-
virtual void accept(NodeVisitor& nv)
+
virtual void accept(NodeVisitor& nv)
- Visitor Pattern : calls the apply method of a NodeVisitor with this node's type
-
-
virtual void ascend(NodeVisitor& nv)
+
virtual void ascend(NodeVisitor& nv)
- Traverse upwards : calls parents' accept method with NodeVisitor
-
-
virtual void traverse(NodeVisitor& )
+
virtual void traverse(NodeVisitor& )
- Traverse downwards : calls children's accept method with NodeVisitor
-
-
inline void setName( const std::string& name )
+
inline void setName( const std::string& name )
- Set the name of node using C++ style string
-
-
inline void setName( const char* name )
+
inline void setName( const char* name )
- Set the name of node using a C style string
-
-
inline const std::string& getName() const
+
inline const std::string& getName() const
- Get the name of node
-
-
inline const ParentList& getParents() const
+
inline const ParentList& getParents() const
- Get the parent list of node.
-
-
inline Group* getParent(const int i)
+
inline Group* getParent(const int i)
- Get the a copy of parent list of node.
-
-
inline const Group* getParent(const int i) const
+
inline const Group* getParent(const int i) const
- Get a single const parent of node.
-
-
inline const int getNumParents() const
+
inline const int getNumParents() const
- Get the number of parents of node.
-
-
void setAppCallback(NodeCallback* nc)
+
void setAppCallback(NodeCallback* nc)
- Set app node callback, called during app traversal.
-
-
inline NodeCallback* getAppCallback()
+
inline NodeCallback* getAppCallback()
- Get app node callback, called during app traversal.
-
-
inline const NodeCallback* getAppCallback() const
+
inline const NodeCallback* getAppCallback() const
- Get const app node callback, called during app traversal.
-
-
inline const int getNumChildrenRequiringAppTraversal() const
+
inline const int getNumChildrenRequiringAppTraversal() const
- Get the number of Children of this node which require App traversal, since they have an AppCallback attached to them or their children
-
-
inline void setUserData(void* data, MemoryAdapter* ma=0L)
- - Set user data.
+
void setCullingActive(const bool active)
+- Set the view frustum/small feature culling of this node to be active or inactive.
-
-
inline void* getUserData()
+
inline const bool getCullingActive() const
+ - Get the view frustum/small feature _cullingActive flag.
+
-
+
inline const int getNumChildrenWithCullingDisabled() const
+ - Get the number of Children of this node which have culling disabled
+
-
+
inline void setUserData(osg::Referenced* obj)
+ - Set user data, data must be subclased from Referenced to allow automatic memory handling.
+
-
+
inline Referenced* getUserData()
- Get user data
-
-
inline const void* getUserData() const
+
inline const Referenced* getUserData() const
- Get const user data
-
-
inline MemoryAdapter* getMemoryAdapter()
- - Get the memory adapter associated with _userData
-
-
-
inline const MemoryAdapter* getMemoryAdapter() const
- - Get the const memory adapter associated with _userData
-
-
-
inline void setNodeMask(const NodeMask nm)
+
inline void setNodeMask(const NodeMask nm)
- Set the node mask.
-
-
inline const NodeMask getNodeMask() const
+
inline const NodeMask getNodeMask() const
- Get the node Mask.
-
-
inline const DescriptionList& getDescriptions() const
+
inline const DescriptionList& getDescriptions() const
- Get the description list of the const node
-
-
inline DescriptionList& getDescriptions()
+
inline DescriptionList& getDescriptions()
- Get the description list of the const node
-
-
inline const std::string& getDescription(const int i) const
+
inline const std::string& getDescription(const int i) const
- Get a single const description of the const node
-
-
inline std::string& getDescription(const int i)
+
inline std::string& getDescription(const int i)
- Get a single description of the node
-
-
inline const int getNumDescriptions() const
+
inline const int getNumDescriptions() const
- Get the number of descriptions of the node
-
-
void addDescription(const std::string& desc)
+
void addDescription(const std::string& desc)
- Add a description string to the node
-
-
inline void setStateSet(osg::StateSet* dstate)
+
inline void setStateSet(osg::StateSet* dstate)
- set the node's StateSet
-
-
inline osg::StateSet* getStateSet()
+
inline osg::StateSet* getStateSet()
- return the node's StateSet
-
-
inline const osg::StateSet* getStateSet() const
+
inline const osg::StateSet* getStateSet() const
- return the node's const StateSet
-
-
inline const BoundingSphere& getBound() const
+
inline const BoundingSphere& getBound() const
- get the bounding sphere of node.
-
-
void dirtyBound()
+
void dirtyBound()
- Mark this node's bounding sphere dirty.
Public Members
-
-
typedef std::vector<Group*> ParentList
+
typedef std::vector<Group*> ParentList
- A vector of osg::Group pointers which is used to store the parent(s) of node
-
-
typedef std::vector<std::string> DescriptionList
+
typedef std::vector<std::string> DescriptionList
- A vector of std::string's which are used to describe the object
Protected Fields
-
-
mutable BoundingSphere _bsphere
+
mutable BoundingSphere _bsphere
-
-
mutable bool _bsphere_computed
+
mutable bool _bsphere_computed
-
-
std::string _name
+
std::string _name
-
-
ParentList _parents
+
ParentList _parents
-
-
ref_ptr<NodeCallback> _appCallback
+
ref_ptr<NodeCallback> _appCallback
-
-
int _numChildrenRequiringAppTraversal
+
int _numChildrenRequiringAppTraversal
-
-
void* _userData
+
bool _cullingActive
-
-
ref_ptr<MemoryAdapter> _memoryAdapter
+
int _numChildrenWithCullingDisabled
-
-
NodeMask _nodeMask
+
osg::ref_ptr<Referenced> _userData
-
-
DescriptionList _descriptions
+
NodeMask _nodeMask
-
-
ref_ptr<StateSet> _dstate
+
DescriptionList _descriptions
+-
+
ref_ptr<StateSet> _dstate
Protected Methods
-
-
virtual ~Node()
+
virtual ~Node()
- Node destructor.
-
-
virtual const bool computeBound() const
+
virtual const bool computeBound() const
- Compute the bounding sphere around Node's geometry or children.
-
-
void setNumChildrenRequiringAppTraversal(const int num)
+
void setNumChildrenRequiringAppTraversal(const int num)
+-
+
void setNumChildrenWithCullingDisabled(const int num)
@@ -209,75 +216,75 @@ Provides interface for most common node operations (Composite Pattern).
-
+
Node()
Construct a node.
Initialize the parent list to empty, node name to "" and
bounding sphere dirty flag to true.
-
+
virtual Object* clone() const
return a shallow copy of a node, with Object* return type
-
+
virtual bool isSameKindAs(const Object* obj) const
return true if this and obj are of the same kind of object
-
+
virtual const char* className() const
return the name of the node's class type
-
+
virtual void accept(NodeVisitor& nv)
Visitor Pattern : calls the apply method of a NodeVisitor with this node's type
-
+
virtual void ascend(NodeVisitor& nv)
Traverse upwards : calls parents' accept method with NodeVisitor
-
+
virtual void traverse(NodeVisitor& )
Traverse downwards : calls children's accept method with NodeVisitor
-
+
inline void setName( const std::string& name )
Set the name of node using C++ style string
-
+
inline void setName( const char* name )
Set the name of node using a C style string
-
+
inline const std::string& getName() const
Get the name of node
-
+
typedef std::vector<Group*> ParentList
A vector of osg::Group pointers which is used to store the parent(s) of node
-
-
inline const ParentList& getParents() const
+
+
inline const ParentList& getParents() const
Get the parent list of node.
-
+
inline Group* getParent(const int i)
Get the a copy of parent list of node. A copy is returned to
prevent modification of the parent list.
-
+
inline const Group* getParent(const int i) const
Get a single const parent of node.
@@ -285,134 +292,144 @@ Get a single const parent of node.
- Parameters:
- i - index of the parent to get.
- Returns:
- the parent i.
-
+
inline const int getNumParents() const
Get the number of parents of node.
- Returns:
- the number of parents of this node.
-
+
void setAppCallback(NodeCallback* nc)
Set app node callback, called during app traversal.
-
+
inline NodeCallback* getAppCallback()
Get app node callback, called during app traversal.
-
+
inline const NodeCallback* getAppCallback() const
Get const app node callback, called during app traversal.
-
+
inline const int getNumChildrenRequiringAppTraversal() const
Get the number of Children of this node which require App traversal,
since they have an AppCallback attached to them or their children
+
+
+
void setCullingActive(const bool active)
+Set the view frustum/small feature culling of this node to be active or inactive.
+The default value to true for _cullingActive. Used a guide
+to the cull traversal.
+
+
+
+
inline const bool getCullingActive() const
+Get the view frustum/small feature _cullingActive flag. Used a guide
+to the cull traversal.
+
+
+
+
inline const int getNumChildrenWithCullingDisabled() const
+Get the number of Children of this node which have culling disabled
+
-
-
inline void setUserData(void* data, MemoryAdapter* ma=0L)
+
+
inline void setUserData(osg::Referenced* obj)
-Set user data. See MemoryAdapter documention for details
-of how to specify memory management of _userData.
+Set user data, data must be subclased from Referenced to allow
+automatic memory handling. If you own data isn't directly
+subclassed from Referenced then create and adapter object
+which points to your own objects and handles the memory addressing.
-
-
inline void* getUserData()
+
+
inline Referenced* getUserData()
Get user data
-
-
inline const void* getUserData() const
+
+
inline const Referenced* getUserData() const
Get const user data
-
-
-
inline MemoryAdapter* getMemoryAdapter()
-Get the memory adapter associated with _userData
-
-
-
-
inline const MemoryAdapter* getMemoryAdapter() const
-Get the const memory adapter associated with _userData
-
-
+
inline void setNodeMask(const NodeMask nm)
Set the node mask. Note, node mask is will be replaced by TraversalMask.
-
+
inline const NodeMask getNodeMask() const
Get the node Mask. Note, node mask is will be replaced by TraversalMask.
-
+
typedef std::vector<std::string> DescriptionList
A vector of std::string's which are used to describe the object
-
-
inline const DescriptionList& getDescriptions() const
+
+
inline const DescriptionList& getDescriptions() const
Get the description list of the const node
-
-
inline DescriptionList& getDescriptions()
+
+
inline DescriptionList& getDescriptions()
Get the description list of the const node
-
+
inline const std::string& getDescription(const int i) const
Get a single const description of the const node
-
+
inline std::string& getDescription(const int i)
Get a single description of the node
-
+
inline const int getNumDescriptions() const
Get the number of descriptions of the node
-
+
void addDescription(const std::string& desc)
Add a description string to the node
-
+
inline void setStateSet(osg::StateSet* dstate)
set the node's StateSet
-
+
inline osg::StateSet* getStateSet()
return the node's StateSet
-
+
inline const osg::StateSet* getStateSet() const
return the node's const StateSet
-
+
inline const BoundingSphere& getBound() const
get the bounding sphere of node.
Using lazy evaluation computes the bounding sphere if it is 'dirty'.
-
+
void dirtyBound()
Mark this node's bounding sphere dirty.
Forcing it to be computed on the next call to getBound().
-
+
virtual ~Node()
Node destructor. Note, is protected so that Nodes cannot
be deleted other than by being dereferenced and the reference
@@ -423,58 +440,66 @@ forcing all nodes to be created on the heap i.e Node* node
= new Node().
-
+
virtual const bool computeBound() const
Compute the bounding sphere around Node's geometry or children.
This method is automatically called by getBound() when the bounding
sphere has been marked dirty via dirtyBound().
-
+
mutable BoundingSphere _bsphere
-
+
mutable bool _bsphere_computed
-
+
std::string _name
-
-
ParentList _parents
+
+
ParentList _parents
-
+
ref_ptr<NodeCallback> _appCallback
-
+
int _numChildrenRequiringAppTraversal
-
+
void setNumChildrenRequiringAppTraversal(const int num)
-
-
-
void* _userData
+
+
+
bool _cullingActive
-
-
-
ref_ptr<MemoryAdapter> _memoryAdapter
+
+
+
int _numChildrenWithCullingDisabled
+
+
+
+
void setNumChildrenWithCullingDisabled(const int num)
+
+
+
+
osg::ref_ptr<Referenced> _userData
-
+
NodeMask _nodeMask
-
-
DescriptionList _descriptions
+
+
DescriptionList _descriptions
-
+
ref_ptr<StateSet> _dstate
diff --git a/doc/doc++/osg/NodeAcceptOp.html b/doc/doc++/osg/NodeAcceptOp.html
index b9edc013e..fa7dd7493 100644
--- a/doc/doc++/osg/NodeAcceptOp.html
+++ b/doc/doc++/osg/NodeAcceptOp.html
@@ -7,41 +7,41 @@
-Convinience functor for assisting visiting of arrays of osg::Node's
+Convenience functor for assisting visiting of arrays of osg::Node's
-
-
NodeVisitor& _nv
+
NodeVisitor& _nv
-
-
NodeAcceptOp(NodeVisitor& nv)
+
NodeAcceptOp(NodeVisitor& nv)
-
-
void operator () (Node* node)
+
void operator () (Node* node)
-
-
void operator () (ref_ptr<Node> node)
+
void operator () (ref_ptr<Node> node)
Documentation
-Convinience functor for assisting visiting of arrays of osg::Node's
+Convenience functor for assisting visiting of arrays of osg::Node's
-
+
NodeVisitor& _nv
-
+
NodeAcceptOp(NodeVisitor& nv)
-
+
void operator () (Node* node)
-
+
void operator () (ref_ptr<Node> node)
Alphabetic index HTML hierarchy of classes or Java
diff --git a/doc/doc++/osg/NodeCallback.html b/doc/doc++/osg/NodeCallback.html
index 4317447c3..a383b2f20 100644
--- a/doc/doc++/osg/NodeCallback.html
+++ b/doc/doc++/osg/NodeCallback.html
@@ -22,28 +22,41 @@
Public Fields
-
-
Requirements _requirements
+
Requirements _requirements
+-
+
ref_ptr<NodeCallback> _nestedCallback
Public Methods
-
-
NodeCallback(const Requirements ncr=NO_REQUIREMENTS)
+
NodeCallback(const Requirements ncr=NO_REQUIREMENTS)
-
-
virtual ~NodeCallback()
+
virtual ~NodeCallback()
-
-
inline void setRequirements(const Requirements ncr)
+
inline void setRequirements(const Requirements ncr)
- Set what values from traversal are required by this NodeCallback
-
-
inline const Requirements getRequirements() const
+
inline const Requirements getRequirements() const
- Get what values from traversal are required by this NodeCallback
-
-
virtual void operator()(Node*, NodeVisitor*)
+
virtual void operator()(Node*, NodeVisitor*)
- Callback method call by the NodeVisitor when visiting a node
+
-
+
void traverse(Node* node, NodeVisitor* nv)
+ - Call any nested callbacks and then traverse the scene graph.
+
-
+
void setNestedCallback(NodeCallback* nc)
+-
+
NodeCallback* getNestedCallback()
+-
+
inline void addNestedCallback(NodeCallback* nc)
+-
+
inline void removeNestedCallback(NodeCallback* nc)
Public Members
-
-
enum Requirements
+
enum Requirements
- The range of values which can be accumulated by the NodeVisitor.
@@ -74,58 +87,83 @@
-
+
enum Requirements
- The range of values which can be accumulated by the NodeVisitor.
-
+
NO_REQUIREMENTS
-
+
REQUIRES_TRAVERSAL
-
+
REQUIRES_PARENT_PATH
-
+
REQUIRES_ACCUMULATED_MATRIX
-
+
REQUIRES_ACCUMULATED_INVERSE
-
-
NodeCallback(const Requirements ncr=NO_REQUIREMENTS)
+
+
NodeCallback(const Requirements ncr=NO_REQUIREMENTS)
-
+
virtual ~NodeCallback()
-
-
inline void setRequirements(const Requirements ncr)
+
+
inline void setRequirements(const Requirements ncr)
- Set what values from traversal are required by this NodeCallback
-
-
inline const Requirements getRequirements() const
+
+
inline const Requirements getRequirements() const
- Get what values from traversal are required by this NodeCallback
-
+
virtual void operator()(Node*, NodeVisitor*)
- Callback method call by the NodeVisitor when visiting a node
+
+
+
void traverse(Node* node, NodeVisitor* nv)
+- Call any nested callbacks and then traverse the scene graph.
+
+
+
+
void setNestedCallback(NodeCallback* nc)
+
+
+
+
NodeCallback* getNestedCallback()
+
+
+
+
inline void addNestedCallback(NodeCallback* nc)
+
+
+
+
inline void removeNestedCallback(NodeCallback* nc)
+
-
-
Requirements _requirements
+
+
Requirements _requirements
+
+
+
+
ref_ptr<NodeCallback> _nestedCallback
- This class has no child classes.
diff --git a/doc/doc++/osg/NodeVisitor.html b/doc/doc++/osg/NodeVisitor.html
index 3d030beba..c5f5e39f5 100644
--- a/doc/doc++/osg/NodeVisitor.html
+++ b/doc/doc++/osg/NodeVisitor.html
@@ -23,94 +23,96 @@
Public Methods
-
-
NodeVisitor(TraversalMode tm=TRAVERSE_NONE)
+
NodeVisitor(TraversalMode tm=TRAVERSE_NONE)
-
-
virtual ~NodeVisitor()
+
virtual ~NodeVisitor()
-
-
virtual void reset()
+
virtual void reset()
- Method to call to reset visitor.
-
-
inline void setTraversalNumber(const int fn)
+
inline void setTraversalNumber(const int fn)
- Set the traversal number.
-
-
inline const int getTraversalNumber() const
+
inline const int getTraversalNumber() const
- Get the traversal number.
-
-
inline void setFrameStamp(FrameStamp* fs)
+
inline void setFrameStamp(FrameStamp* fs)
- Set the FrameStamp that this traversal is assoicated with
-
-
inline const FrameStamp* getFrameStamp() const
+
inline const FrameStamp* getFrameStamp() const
- Get the FrameStamp that this traversal is assoicated with
-
-
inline void setTraversalMask(const Node::NodeMask mask)
+
inline void setTraversalMask(const Node::NodeMask mask)
- Set the TraversalMask of this NodeVisitor.
-
-
inline const Node::NodeMask getTraversalMask() const
+
inline const Node::NodeMask getTraversalMask() const
- Get the TraversalMask
-
-
inline void setNodeMaskOverride(const Node::NodeMask mask)
+
inline void setNodeMaskOverride(const Node::NodeMask mask)
- Set the NodeMaskOverride mask.
-
-
inline const Node::NodeMask getNodeMaskOverride() const
+
inline const Node::NodeMask getNodeMaskOverride() const
- Get the NodeMaskOverride mask
-
-
inline const bool validNodeMask(const osg::Node& node) const
+
inline const bool validNodeMask(const osg::Node& node) const
- Method to called by Node and its subclass' Node::accept() method, if the result is true to be used to cull operations of nodes and their subgraphs.
-
-
void setTraversalMode(const TraversalMode mode)
+
void setTraversalMode(const TraversalMode mode)
- Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse.
-
-
inline const TraversalMode getTraversalMode() const
+
inline const TraversalMode getTraversalMode() const
- Get the traversal mode
-
-
void setTraversalVisitor(NodeVisitor* nv)
+
void setTraversalVisitor(NodeVisitor* nv)
- Set a visitor to handle traversal.
-
-
NodeVisitor* getTraversalVisitor()
+
NodeVisitor* getTraversalVisitor()
- Get the traversal visitor, returns NULL if none is attached
-
-
void traverse(Node& node)
+
void traverse(Node& node)
- Inline method for handling traversal of a nodes.
-
-
virtual void apply(Node& node)
+
virtual void apply(Node& node)
-
-
virtual void apply(Geode& node)
+
virtual void apply(Geode& node)
-
-
virtual void apply(Billboard& node)
+
virtual void apply(Billboard& node)
-
-
virtual void apply(LightSource& node)
+
virtual void apply(LightSource& node)
-
-
virtual void apply(Group& node)
+
virtual void apply(Group& node)
-
-
virtual void apply(Transform& node)
+
virtual void apply(Transform& node)
-
-
virtual void apply(Switch& node)
+
virtual void apply(Switch& node)
-
-
virtual void apply(Sequence& node)
+
virtual void apply(Sequence& node)
-
-
virtual void apply(LOD& node)
+
virtual void apply(LOD& node)
-
-
virtual void apply(Impostor& node)
+
virtual void apply(Impostor& node)
+-
+
virtual void apply(EarthSky& node)
Public Members
-
-
enum TraversalMode
+
enum TraversalMode
Protected Fields
-
-
int _traversalNumber
+
int _traversalNumber
-
-
ref_ptr<FrameStamp> _frameStamp
+
ref_ptr<FrameStamp> _frameStamp
-
-
ref_ptr<NodeVisitor> _traversalVisitor
+
ref_ptr<NodeVisitor> _traversalVisitor
-
-
TraversalMode _traversalMode
+
TraversalMode _traversalMode
-
-
Node::NodeMask _traversalMask
+
Node::NodeMask _traversalMask
-
-
Node::NodeMask _nodeMaskOverride
+
Node::NodeMask _nodeMaskOverride
@@ -138,73 +140,85 @@
Documentation
Visitor for type safe operations on osg::Node's.
-Based on GOF's Visitor pattern.
+Based on GOF's Visitor pattern. The NodeVisitor
+is useful for developing type safe operations to nodes
+in the scene graph (as per Visitor pattern), and adds to this
+support for optional scene graph traversal to allow
+operations to be applied to whole scenes at once. The Visitor
+pattern uses a technique of double dispatch as a mechanism to
+called the appropriate apply(..) method of the NodeVisitor. To
+use this feature one must use the Node::accept(NodeVisitor) which
+is extended in each Node subclass, rather than the NodeVisitor
+apply directly. So use root->accept(myVisitor); instead of
+myVisitor.apply(*root). The later method will bypass the double
+dispatch and the appropriate NodeVisitor::apply(..) method will
+not be called.
-
+
enum TraversalMode
-
+
TRAVERSE_NONE
-
+
TRAVERSE_PARENTS
-
+
TRAVERSE_ALL_CHILDREN
-
+
TRAVERSE_ACTIVE_CHILDREN
-
+
TRAVERSE_VISITOR
-
-
NodeVisitor(TraversalMode tm=TRAVERSE_NONE)
+
+
NodeVisitor(TraversalMode tm=TRAVERSE_NONE)
-
+
virtual ~NodeVisitor()
-
+
virtual void reset()
- Method to call to reset visitor. Useful for your visitor accumulates
-state during a traversal, and you plan to resuse the visitor.
+state during a traversal, and you plan to reuse the visitor.
To flush that state for the next traversal than call reset() prior
to each traversal.
-
+
inline void setTraversalNumber(const int fn)
- Set the traversal number. Typically used to denote the frame count.
-
+
inline const int getTraversalNumber() const
- Get the traversal number. Typically used to denote the frame count.
-
+
inline void setFrameStamp(FrameStamp* fs)
- Set the FrameStamp that this traversal is assoicated with
-
+
inline const FrameStamp* getFrameStamp() const
- Get the FrameStamp that this traversal is assoicated with
-
+
inline void setTraversalMask(const Node::NodeMask mask)
- Set the TraversalMask of this NodeVisitor.
The TraversalMask is used by the NodeVisitor::validNodeMask() method
@@ -217,12 +231,12 @@ _nodeMaskOverride to 0xffffffff will allow a visitor to work on all nodes
regardless of their own Node::_nodeMask state.
-
+
inline const Node::NodeMask getTraversalMask() const
- Get the TraversalMask
-
+
inline void setNodeMaskOverride(const Node::NodeMask mask)
- Set the NodeMaskOverride mask.
Used in validNodeMask() to determine whether to operate on a node or its
@@ -231,12 +245,12 @@ Typically used to force on nodes which may have
been switched off by their own Node::_nodeMask.
-
+
inline const Node::NodeMask getNodeMaskOverride() const
- Get the NodeMaskOverride mask
-
+
inline const bool validNodeMask(const osg::Node& node) const
- Method to called by Node and its subclass' Node::accept() method, if the result is true
to be used to cull operations of nodes and their subgraphs.
@@ -246,8 +260,8 @@ default values for _traversalMask is 0xffffffff, _nodeMaskOverride is 0x0,
and osg::Node::_nodeMask is 0xffffffff.
-
-
void setTraversalMode(const TraversalMode mode)
+
+
void setTraversalMode(const TraversalMode mode)
- Set the traversal mode for Node::traverse() to use when
deciding which children of a node to traverse. If a
NodeVisitor has been attached via setTraverseVisitor()
@@ -255,23 +269,23 @@ and the new mode is not TRAVERSE_VISITOR then the attached
visitor is detached. Default mode is TRAVERSE_NONE.
-
-
inline const TraversalMode getTraversalMode() const
+
+
inline const TraversalMode getTraversalMode() const
- Get the traversal mode
-
+
void setTraversalVisitor(NodeVisitor* nv)
- Set a visitor to handle traversal.
-Overides the traverse mode setting it to TRAVERSAL_VISITOR.
+Overrides the traverse mode setting it to TRAVERSAL_VISITOR.
-
+
NodeVisitor* getTraversalVisitor()
- Get the traversal visitor, returns NULL if none is attached
-
+
void traverse(Node& node)
- Inline method for handling traversal of a nodes.
If you intend to use the visitor for actively traversing
@@ -279,67 +293,71 @@ the scene graph then make sure the accept() methods call
this method unless they handle traversal directly.
-
+
virtual void apply(Node& node)
-
+
virtual void apply(Geode& node)
-
+
virtual void apply(Billboard& node)
-
+
virtual void apply(LightSource& node)
-
+
virtual void apply(Group& node)
-
+
virtual void apply(Transform& node)
-
+
virtual void apply(Switch& node)
-
+
virtual void apply(Sequence& node)
-
+
virtual void apply(LOD& node)
-
+
virtual void apply(Impostor& node)
+
+
+
virtual void apply(EarthSky& node)
+
-
+
int _traversalNumber
-
+
ref_ptr<FrameStamp> _frameStamp
-
+
ref_ptr<NodeVisitor> _traversalVisitor
-
-
TraversalMode _traversalMode
+
+
TraversalMode _traversalMode
-
+
Node::NodeMask _traversalMask
-
+
Node::NodeMask _nodeMaskOverride
diff --git a/doc/doc++/osg/NotifySeverity.html b/doc/doc++/osg/NotifySeverity.html
index a77410f84..cd5c46be9 100644
--- a/doc/doc++/osg/NotifySeverity.html
+++ b/doc/doc++/osg/NotifySeverity.html
@@ -12,19 +12,19 @@
-
-
ALWAYS
+
ALWAYS
-
-
FATAL
+
FATAL
-
-
WARN
+
WARN
-
-
NOTICE
+
NOTICE
-
-
INFO
+
INFO
-
-
DEBUG_INFO
+
DEBUG_INFO
-
-
DEBUG_FP
+
DEBUG_FP
@@ -39,31 +39,31 @@ further details.
-
+
ALWAYS
-
+
FATAL
-
+
WARN
-
+
NOTICE
-
+
INFO
-
+
DEBUG_INFO
-
+
DEBUG_FP
Alphabetic index HTML hierarchy of classes or Java
diff --git a/doc/doc++/osg/Object.html b/doc/doc++/osg/Object.html
index e05b8c093..75112fb7c 100644
--- a/doc/doc++/osg/Object.html
+++ b/doc/doc++/osg/Object.html
@@ -11,11 +11,11 @@
Inheritance:
-
-
-
-
-
+
+
+
+
+
@@ -23,21 +23,21 @@
Public Methods
-
-
Object()
+
Object()
- Construct an object.
-
-
virtual Object* clone() const = 0
+
virtual Object* clone() const = 0
- return a shallow copy of a node, with Object* return type.
-
-
virtual bool isSameKindAs(const Object*) const
+
virtual bool isSameKindAs(const Object*) const
-
-
virtual const char* className() const = 0
+
virtual const char* className() const = 0
- return the name of the object's class type.
Protected Methods
-
-
virtual ~Object()
+
virtual ~Object()
- Object destructor.
@@ -71,34 +71,34 @@ Based on GOF Composite, Prototype and Template Method patterns.
-
+
Object()
- Construct an object. Note Object is a pure virtual base class
and therefore cannot be constructed on its own, only derived
-classes which overide the clone and className methods are
+classes which override the clone and className methods are
concrete classes and can be constructed.
-
+
virtual Object* clone() const = 0
- return a shallow copy of a node, with Object* return type.
Must be defined by derived classes.
-
+
virtual bool isSameKindAs(const Object*) const
-
+
virtual const char* className() const = 0
- return the name of the object's class type. Must be defined
by derived classes.
-
+
virtual ~Object()
- Object destructor. Note, is protected so that Objects cannot
-be deleted other than by being derefernced and the reference
+be deleted other than by being dereferenced and the reference
count being zero (see osg::Referenced), preventing the deletion
of nodes which are still in use. This also means that
Node's cannot be created on stack i.e Node node will not compile,
@@ -107,7 +107,8 @@ forcing all nodes to be created on the heap i.e Node* node
- Direct child classes:
-
- StateSet
+- Statistics
+StateSet
StateAttribute
Node
Matrix
diff --git a/doc/doc++/osg/Plane.html b/doc/doc++/osg/Plane.html
index a783f6372..d7967e7e4 100644
--- a/doc/doc++/osg/Plane.html
+++ b/doc/doc++/osg/Plane.html
@@ -13,68 +13,68 @@
Public Methods
-
-
inline Plane()
+
inline Plane()
-
-
inline Plane(const Plane& pl)
+
inline Plane(const Plane& pl)
-
-
inline Plane(const float a, const float b, const float c, const float d)
+
inline Plane(const float a, const float b, const float c, const float d)
-
-
inline Plane(const Vec4& vec)
+
inline Plane(const Vec4& vec)
-
-
inline Plane(const Vec3& norm, const float d)
+
inline Plane(const Vec3& norm, const float d)
-
-
inline Plane(const Vec3& v1, const Vec3& v2, const Vec3& v3)
+
inline Plane(const Vec3& v1, const Vec3& v2, const Vec3& v3)
-
-
inline Plane& operator = (const Plane& pl)
+
inline Plane& operator = (const Plane& pl)
-
-
inline void set(const Plane& pl)
+
inline void set(const Plane& pl)
-
-
inline void set(const float a, const float b, const float c, const float d)
+
inline void set(const float a, const float b, const float c, const float d)
-
-
inline void set(const Vec4& vec)
+
inline void set(const Vec4& vec)
-
-
inline void set(const Vec3& norm, const float d)
+
inline void set(const Vec3& norm, const float d)
-
-
inline void set(const Vec3& v1, const Vec3& v2, const Vec3& v3)
+
inline void set(const Vec3& v1, const Vec3& v2, const Vec3& v3)
-
-
inline void makeUnitLength()
+
inline void makeUnitLength()
-
-
inline void calculateUpperLowerBBCorners()
+
inline void calculateUpperLowerBBCorners()
- calculate the upper and lower bounding box corners to be used in the intersect(BoundingBox&) method for speeding calculations
-
-
inline const bool valid() const
+
inline const bool valid() const
-
-
inline Vec4& asVec4()
+
inline Vec4& asVec4()
-
-
inline const Vec4& asVec4() const
+
inline const Vec4& asVec4() const
-
-
inline float& operator [] (const int i)
+
inline float& operator [] (const int i)
-
-
inline float operator [] (const int i) const
+
inline float operator [] (const int i) const
-
-
inline const float distance(const osg::Vec3& v) const
+
inline const float distance(const osg::Vec3& v) const
- calculate the distance between a point and the plane
-
-
inline const int intersect(const BoundingSphere& bs) const
- - interesection test between plane and bounding sphere.
+
inline const int intersect(const BoundingSphere& bs) const
+- intersection test between plane and bounding sphere.
-
-
inline const int intersect(const BoundingBox& bb) const
- - interesection test between plane and bounding sphere.
+
inline const int intersect(const BoundingBox& bb) const
+- intersection test between plane and bounding sphere.
-
-
inline void transform(const osg::Matrix& matrix)
+
inline void transform(const osg::Matrix& matrix)
- Transform the plane by matrix.
-
-
inline void transformProvidingInverse(const osg::Matrix& matrix)
+
inline void transformProvidingInverse(const osg::Matrix& matrix)
- Transform the plane by provide a pre inverted matrix.
Protected Fields
-
-
Vec4 _fv
+
Vec4 _fv
-
-
unsigned int _upperBBCorner
+
unsigned int _upperBBCorner
-
-
unsigned int _lowerBBCorner
+
unsigned int _lowerBBCorner
@@ -86,106 +86,106 @@
-
+
inline Plane()
-
-
inline Plane(const Plane& pl)
+
+
inline Plane(const Plane& pl)
-
+
inline Plane(const float a, const float b, const float c, const float d)
-
+
inline Plane(const Vec4& vec)
-
+
inline Plane(const Vec3& norm, const float d)
-
+
inline Plane(const Vec3& v1, const Vec3& v2, const Vec3& v3)
-
+
inline Plane& operator = (const Plane& pl)
-
+
inline void set(const Plane& pl)
-
+
inline void set(const float a, const float b, const float c, const float d)
-
+
inline void set(const Vec4& vec)
-
+
inline void set(const Vec3& norm, const float d)
-
+
inline void set(const Vec3& v1, const Vec3& v2, const Vec3& v3)
-
+
inline void makeUnitLength()
-
+
inline void calculateUpperLowerBBCorners()
- calculate the upper and lower bounding box corners to be used
in the intersect(BoundingBox&) method for speeding calculations
-
+
inline const bool valid() const
-
+
inline Vec4& asVec4()
-
+
inline const Vec4& asVec4() const
-
+
inline float& operator [] (const int i)
-
+
inline float operator [] (const int i) const
-
+
inline const float distance(const osg::Vec3& v) const
- calculate the distance between a point and the plane
-
+
inline const int intersect(const BoundingSphere& bs) const
-- interesection test between plane and bounding sphere.
+
- intersection test between plane and bounding sphere.
return 1 if the bs is completely above plane,
return 0 if the bs intersects the plane,
return -1 if the bs is completely below the plane.
-
+
inline const int intersect(const BoundingBox& bb) const
-- interesection test between plane and bounding sphere.
+
- intersection test between plane and bounding sphere.
return 1 if the bs is completely above plane,
return 0 if the bs intersects the plane,
return -1 if the bs is completely below the plane.
-
+
inline void transform(const osg::Matrix& matrix)
- Transform the plane by matrix. Note, this operations carries out
the calculation of the inverse of the matrix since to transforms
@@ -195,27 +195,27 @@ calculated elsewhere then use transformProvidingInverse() instead.
See http://www.worldserver.com/turk/computergraphics/NormalTransformations.pdf
-
+
inline void transformProvidingInverse(const osg::Matrix& matrix)
- Transform the plane by provide a pre inverted matrix.
see transform for details.
-
+
Vec4 _fv
-
+
unsigned int _upperBBCorner
-
+
unsigned int _lowerBBCorner
- This class has no child classes.
-- Friends:
- inline ostream& operator << (ostream& output, const Plane& pl)
Alphabetic index HTML hierarchy of classes or Java
+- Friends:
- inline std::ostream& operator << (std::ostream& output, const Plane& pl)
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.
diff --git a/doc/doc++/osg/Point.html b/doc/doc++/osg/Point.html
index 556f9dcdf..55472135d 100644
--- a/doc/doc++/osg/Point.html
+++ b/doc/doc++/osg/Point.html
@@ -7,7 +7,7 @@
-Point - encapsulates the OpenGL point smmothing and size state
+Point - encapsulates the OpenGL point smoothing and size state
Inheritance:
@@ -23,44 +23,44 @@
Public Methods
-
-
Point()
+
Point()
-
-
META_StateAttribute(Point, POINT)
+
META_StateAttribute(Point, POINT)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
void setSize(const float size)
+
void setSize(const float size)
-
-
inline const float getSize() const
+
inline const float getSize() const
-
-
void setFadeThresholdSize(const float fadeThresholdSize)
+
void setFadeThresholdSize(const float fadeThresholdSize)
-
-
inline const float getFadeThresholdSize() const
+
inline const float getFadeThresholdSize() const
-
-
void setDistanceAttenuation(const Vec3& distanceAttenuation)
+
void setDistanceAttenuation(const Vec3& distanceAttenuation)
-
-
inline const Vec3& getDistanceAttenuation() const
+
inline const Vec3& getDistanceAttenuation() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
-
-
static void init_GL_EXT()
+
static void init_GL_EXT()
Protected Fields
-
-
float _size
+
float _size
-
-
float _fadeThresholdSize
+
float _fadeThresholdSize
-
-
Vec3 _distanceAttenuation
+
Vec3 _distanceAttenuation
Protected Methods
-
-
virtual ~Point()
+
virtual ~Point()
@@ -74,7 +74,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -127,72 +127,72 @@
Documentation
-Point - encapsulates the OpenGL point smmothing and size state
+Point - encapsulates the OpenGL point smoothing and size state
-
+
Point()
-
-
META_StateAttribute(Point, POINT)
+
+
META_StateAttribute(Point, POINT)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
void setSize(const float size)
-
+
inline const float getSize() const
-
+
void setFadeThresholdSize(const float fadeThresholdSize)
-
+
inline const float getFadeThresholdSize() const
-
+
void setDistanceAttenuation(const Vec3& distanceAttenuation)
-
+
inline const Vec3& getDistanceAttenuation() const
-
+
virtual void apply(State& state) const
-
+
static void init_GL_EXT()
-
+
virtual ~Point()
-
+
float _size
-
+
float _fadeThresholdSize
-
+
Vec3 _distanceAttenuation
diff --git a/doc/doc++/osg/PolygonMode.html b/doc/doc++/osg/PolygonMode.html
index bb2406825..0bdb876e3 100644
--- a/doc/doc++/osg/PolygonMode.html
+++ b/doc/doc++/osg/PolygonMode.html
@@ -23,41 +23,41 @@
Public Methods
-
-
PolygonMode()
+
PolygonMode()
-
-
META_StateAttribute(PolygonMode, POLYGONMODE)
+
META_StateAttribute(PolygonMode, POLYGONMODE)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
void setMode(const Face face, const Mode mode)
+
void setMode(const Face face, const Mode mode)
-
-
const Mode getMode(const Face face) const
+
const Mode getMode(const Face face) const
-
-
inline const bool getFrontAndBack() const
+
inline const bool getFrontAndBack() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Face
+
enum Face
-
-
enum Mode
+
enum Mode
Protected Fields
-
-
bool _frontAndBack
+
bool _frontAndBack
-
-
Mode _modeFront
+
Mode _modeFront
-
-
Mode _modeBack
+
Mode _modeBack
Protected Methods
-
-
virtual ~PolygonMode()
+
virtual ~PolygonMode()
@@ -71,7 +71,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -79,7 +79,7 @@
-
bool operator != (const StateAttribute& rhs) const
-
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
-
virtual void compile(State&) const
@@ -130,85 +130,85 @@
-
+
PolygonMode()
-
-
META_StateAttribute(PolygonMode, POLYGONMODE)
+
+
META_StateAttribute(PolygonMode, POLYGONMODE)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
enum Face
-
+
FRONT
-
+
BACK
-
+
FRONT_AND_BACK
-
+
enum Mode
-
+
POINT
-
+
LINE
-
+
FILL
-
-
void setMode(const Face face, const Mode mode)
+
+
void setMode(const Face face, const Mode mode)
-
-
const Mode getMode(const Face face) const
+
+
const Mode getMode(const Face face) const
-
+
inline const bool getFrontAndBack() const
-
+
virtual void apply(State& state) const
-
+
virtual ~PolygonMode()
-
+
bool _frontAndBack
-
-
Mode _modeFront
+
+
Mode _modeFront
-
-
Mode _modeBack
+
+
Mode _modeBack
- This class has no child classes.
diff --git a/doc/doc++/osg/PolygonOffset.html b/doc/doc++/osg/PolygonOffset.html
index 09977a7c2..e381b4d22 100644
--- a/doc/doc++/osg/PolygonOffset.html
+++ b/doc/doc++/osg/PolygonOffset.html
@@ -23,36 +23,36 @@
Public Methods
-
-
PolygonOffset()
+
PolygonOffset()
-
-
META_StateAttribute(PolygonOffset, POLYGONOFFSET)
+
META_StateAttribute(PolygonOffset, POLYGONOFFSET)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
inline void setFactor(const float factor)
+
inline void setFactor(const float factor)
-
-
inline const float getFactor() const
+
inline const float getFactor() const
-
-
inline void setUnits(const float units)
+
inline void setUnits(const float units)
-
-
inline const float getUnits() const
+
inline const float getUnits() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Protected Fields
-
-
float _factor
+
float _factor
-
-
float _units
+
float _units
Protected Methods
-
-
virtual ~PolygonOffset()
+
virtual ~PolygonOffset()
@@ -66,7 +66,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -123,52 +123,52 @@
-
+
PolygonOffset()
-
-
META_StateAttribute(PolygonOffset, POLYGONOFFSET)
+
+
META_StateAttribute(PolygonOffset, POLYGONOFFSET)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
inline void setFactor(const float factor)
-
+
inline const float getFactor() const
-
+
inline void setUnits(const float units)
-
+
inline const float getUnits() const
-
+
virtual void apply(State& state) const
-
+
virtual ~PolygonOffset()
-
+
float _factor
-
+
float _units
diff --git a/doc/doc++/osg/Quat.html b/doc/doc++/osg/Quat.html
index 920d23731..f7534fb8f 100644
--- a/doc/doc++/osg/Quat.html
+++ b/doc/doc++/osg/Quat.html
@@ -13,98 +13,98 @@
Public Fields
-
-
Vec4 _fv
+
Vec4 _fv
Public Methods
-
-
Quat()
+
Quat()
-
-
Quat( float x, float y, float z, float w )
+
Quat( float x, float y, float z, float w )
-
-
Quat( const Vec4& v )
+
Quat( const Vec4& v )
-
-
inline Vec4& asVec4()
+
inline Vec4& asVec4()
-
-
inline const Vec4& asVec4() const
+
inline const Vec4& asVec4() const
-
-
inline const Vec3 asVec3() const
+
inline const Vec3 asVec3() const
-
-
inline void set(const float x, const float y, const float z, const float w)
+
inline void set(const float x, const float y, const float z, const float w)
-
-
inline void set(const osg::Vec4& v)
+
inline void set(const osg::Vec4& v)
-
-
inline const Quat operator * (const float& rhs) const
+
inline const Quat operator * (const float& rhs) const
- Multiply by scalar
-
-
inline Quat& operator *= (const float& rhs)
+
inline Quat& operator *= (const float& rhs)
- Unary multiply by scalar
-
-
inline const Quat operator*(const Quat& rhs) const
+
inline const Quat operator*(const Quat& rhs) const
- Binary multiply
-
-
inline Quat& operator*=(const Quat& rhs)
+
inline Quat& operator*=(const Quat& rhs)
- Unary multiply
-
-
inline const Quat operator / (const float& rhs) const
+
inline const Quat operator / (const float& rhs) const
- Divide by scalar
-
-
inline Quat& operator /= (const float& rhs)
+
inline Quat& operator /= (const float& rhs)
- Unary divide by scalar
-
-
inline const Quat operator/(const Quat& denom) const
+
inline const Quat operator/(const Quat& denom) const
- Binary divide
-
-
inline Quat& operator/=(const Quat& denom)
+
inline Quat& operator/=(const Quat& denom)
- Unary divide
-
-
inline const Quat operator + (const Quat& rhs) const
+
inline const Quat operator + (const Quat& rhs) const
- Binary addition
-
-
inline Quat& operator += (const Quat& rhs)
+
inline Quat& operator += (const Quat& rhs)
- Unary addition
-
-
inline const Quat operator - (const Quat& rhs) const
+
inline const Quat operator - (const Quat& rhs) const
- Binary subtraction
-
-
inline Quat& operator -= (const Quat& rhs)
+
inline Quat& operator -= (const Quat& rhs)
- Unary subtraction
-
-
inline const Quat operator - () const
+
inline const Quat operator - () const
- Negation operator - returns the negative of the quaternion.
-
-
const float length() const
+
const float length() const
- Length of the quaternion = sqrt( vec .
-
-
const float length2() const
+
const float length2() const
- Length of the quaternion = vec .
-
-
inline const Quat conj() const
+
inline const Quat conj() const
- Conjugate
-
-
inline const Quat inverse() const
+
inline const Quat inverse() const
- Multiplicative inverse method: q^(-1) = q^*/(qq^*)
-
-
void makeRot( const float angle, const float x, const float y, const float z )
+
void makeRotate( const float angle, const float x, const float y, const float z )
-
-
void makeRot( const float angle, const Vec3& vec )
+
void makeRotate( const float angle, const Vec3& vec )
-
-
void makeRot( const Vec3& vec1, const Vec3& vec2 )
+
void makeRotate( const Vec3& vec1, const Vec3& vec2 )
- Make a rotation Quat which will rotate vec1 to vec2.
-
-
void getRot( float& angle, float& x, float& y, float& z ) const
+
void getRotate( float& angle, float& x, float& y, float& z ) const
- Return the angle and vector components represented by the quaternion
-
-
void getRot( float& angle, Vec3& vec ) const
+
void getRotate( float& angle, Vec3& vec ) const
- Return the angle and vector represented by the quaternion
-
-
void slerp( const float t, const Quat& from, const Quat& to)
+
void slerp( const float t, const Quat& from, const Quat& to)
- Spherical Linear Interpolation.
-
-
void set( const osg::Matrix& m )
+
void set( const osg::Matrix& m )
- Set quaternion to be equivalent to specified matrix
-
-
void get( osg::Matrix& m ) const
+
void get( osg::Matrix& m ) const
- Get the equivalent matrix for this quaternion
@@ -117,174 +117,174 @@
-
+
Vec4 _fv
-
+
Quat()
-
-
Quat( float x, float y, float z, float w )
+
+
Quat( float x, float y, float z, float w )
-
+
Quat( const Vec4& v )
-
+
inline Vec4& asVec4()
-
+
inline const Vec4& asVec4() const
-
+
inline const Vec3 asVec3() const
-
-
inline void set(const float x, const float y, const float z, const float w)
+
+
inline void set(const float x, const float y, const float z, const float w)
-
+
inline void set(const osg::Vec4& v)
-
+
inline const Quat operator * (const float& rhs) const
- Multiply by scalar
-
+
inline Quat& operator *= (const float& rhs)
- Unary multiply by scalar
-
+
inline const Quat operator*(const Quat& rhs) const
- Binary multiply
-
+
inline Quat& operator*=(const Quat& rhs)
- Unary multiply
-
+
inline const Quat operator / (const float& rhs) const
- Divide by scalar
-
+
inline Quat& operator /= (const float& rhs)
- Unary divide by scalar
-
+
inline const Quat operator/(const Quat& denom) const
- Binary divide
-
+
inline Quat& operator/=(const Quat& denom)
- Unary divide
-
+
inline const Quat operator + (const Quat& rhs) const
- Binary addition
-
+
inline Quat& operator += (const Quat& rhs)
- Unary addition
-
+
inline const Quat operator - (const Quat& rhs) const
- Binary subtraction
-
+
inline Quat& operator -= (const Quat& rhs)
- Unary subtraction
-
+
inline const Quat operator - () const
- Negation operator - returns the negative of the quaternion.
Basically just calls operator - () on the Vec4
-
+
const float length() const
- Length of the quaternion = sqrt( vec . vec )
-
+
const float length2() const
- Length of the quaternion = vec . vec
-
+
inline const Quat conj() const
- Conjugate
-
+
inline const Quat inverse() const
- Multiplicative inverse method: q^(-1) = q^*/(qq^*)
-
-
-
void makeRot( const float angle, const float x, const float y, const float z )
+
+
+
void makeRotate( const float angle, const float x, const float y, const float z )
-
-
-
void makeRot( const float angle, const Vec3& vec )
+
+
+
void makeRotate( const float angle, const Vec3& vec )
-
-
-
void makeRot( const Vec3& vec1, const Vec3& vec2 )
+
+
+
void makeRotate( const Vec3& vec1, const Vec3& vec2 )
- Make a rotation Quat which will rotate vec1 to vec2.
Generally take adot product to get the angle between these
and then use a cross product to get the rotation axis
Watch out for the two special cases of when the vectors
are co-incident or opposite in direction.
-
-
-
void getRot( float& angle, float& x, float& y, float& z ) const
+
+
+
void getRotate( float& angle, float& x, float& y, float& z ) const
- Return the angle and vector components represented by the quaternion
-
-
-
void getRot( float& angle, Vec3& vec ) const
+
+
+
void getRotate( float& angle, Vec3& vec ) const
- Return the angle and vector represented by the quaternion
-
-
void slerp( const float t, const Quat& from, const Quat& to)
+
+
void slerp( const float t, const Quat& from, const Quat& to)
- Spherical Linear Interpolation.
As t goes from 0 to 1, the Quat object goes from "from" to "to".
-
+
void set( const osg::Matrix& m )
- Set quaternion to be equivalent to specified matrix
-
+
void get( osg::Matrix& m ) const
- Get the equivalent matrix for this quaternion
- This class has no child classes.
-- Friends:
- inline ostream& operator << (ostream& output, const Quat& vec)
Alphabetic index HTML hierarchy of classes or Java
+- Friends:
- inline std::ostream& operator << (std::ostream& output, const Quat& vec)
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.
diff --git a/doc/doc++/osg/Referenced.html b/doc/doc++/osg/Referenced.html
index 9570c73ab..4eb365696 100644
--- a/doc/doc++/osg/Referenced.html
+++ b/doc/doc++/osg/Referenced.html
@@ -11,11 +11,11 @@
Inheritance:
-
-
-
-
-
+
+
+
+
+
@@ -23,30 +23,30 @@
Public Methods
-
-
Referenced()
+
Referenced()
-
-
Referenced(const Referenced&)
+
Referenced(const Referenced&)
-
-
inline Referenced& operator = (Referenced&)
+
inline Referenced& operator = (Referenced&)
-
-
inline void ref() const
+
inline void ref() const
- increment the reference count by one, indicating that this object has another pointer which is referencing it
-
-
inline void unref() const
+
inline void unref() const
- decrement the reference count by one, indicating that a pointer to this object is referencing it.
-
-
inline const int referenceCount() const
+
inline const int referenceCount() const
- return the number pointers currently referencing this object.
Protected Fields
-
-
mutable int _refCount
+
mutable int _refCount
Protected Methods
-
-
virtual ~Referenced()
+
virtual ~Referenced()
@@ -58,42 +58,42 @@
-
+
Referenced()
-
-
Referenced(const Referenced&)
+
+
Referenced(const Referenced&)
-
+
inline Referenced& operator = (Referenced&)
-
+
inline void ref() const
- increment the reference count by one, indicating that
this object has another pointer which is referencing it
-
+
inline void unref() const
- decrement the reference count by one, indicating that
a pointer to this object is referencing it. If the
-refence count goes to zero, it is assumed that this object
-is nolonger referenced and is automatically deleted.
+reference count goes to zero, it is assumed that this object
+is no longer referenced and is automatically deleted.
-
+
inline const int referenceCount() const
- return the number pointers currently referencing this object.
-
+
virtual ~Referenced()
-
+
mutable int _refCount
@@ -106,6 +106,7 @@ is nolonger referenced and is automatically deleted.
LineSegment
ImpostorSpriteManager
FrameStamp
+DisplaySettings
Camera
diff --git a/doc/doc++/osg/State.html b/doc/doc++/osg/State.html
index 40ce3d681..cb0aaf14a 100644
--- a/doc/doc++/osg/State.html
+++ b/doc/doc++/osg/State.html
@@ -23,60 +23,63 @@
Public Methods
-
-
State()
+
State()
-
-
virtual ~State()
+
virtual ~State()
-
-
void pushStateSet(const StateSet* dstate)
+
void pushStateSet(const StateSet* dstate)
- push stateset onto state stack
-
-
void popStateSet()
+
void popStateSet()
- pop drawstate off state stack
-
-
void reset()
+
void captureCurrentState(StateSet& stateset) const
+ - copy the modes and attributes which captures the current state
+
-
+
void reset()
- reset the state object to an empty stack
-
-
inline const bool apply_mode(const StateAttribute::GLMode mode, const bool enabled)
+
inline const bool apply_mode(const StateAttribute::GLMode mode, const bool enabled)
- apply an OpenGL mode if required.
-
-
inline const bool apply_attribute(const StateAttribute* attribute)
+
inline const bool apply_attribute(const StateAttribute* attribute)
- apply an attribute if required.
-
-
void apply(const StateSet* dstate)
+
void apply(const StateSet* dstate)
- apply stateset
-
-
void apply()
+
void apply()
- apply the state
-
-
void have_applied(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
+
void have_applied(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
- mode has been set externally, update state to reflect this setting
-
-
void have_applied(const StateAttribute* attribute)
+
void have_applied(const StateAttribute* attribute)
- attribute has been applied externally, update state to reflect this setting
-
-
inline void setContextID(unsigned int contextID)
+
inline void setContextID(unsigned int contextID)
- Set the current OpenGL context uniqueID.
-
-
inline const unsigned int getContextID() const
+
inline const unsigned int getContextID() const
- Get the current OpenGL context unique ID
-
-
inline void setFrameStamp(FrameStamp* fs)
+
inline void setFrameStamp(FrameStamp* fs)
- Set the frame stamp for the current frame
-
-
inline const FrameStamp* getFrameStamp() const
+
inline const FrameStamp* getFrameStamp() const
- Set the frame stamp for the current frame
-
-
inline void setCamera(Camera* camera)
+
inline void setCamera(Camera* camera)
- Set the camera.
-
-
inline const Camera* getCamera() const
+
inline const Camera* getCamera() const
- Get the camera
-
-
void setFineGrainedErrorDetection(const bool flag)
- - Set the hint to OpenGL routines to do fine grained OpenGL error checking
+
inline void setDisplaySettings(DisplaySettings* vs)
+- Set the DisplaySettings.
-
-
const bool getFineGrainedErrorDetection() const
- - Get the hint to OpenGL routines to do fine grained OpenGL error checking
+
inline const DisplaySettings* getDisplaySettings() const
+- Get the DisplaySettings
@@ -104,142 +107,158 @@
Documentation
State class for managing a state stack.
-Lazy state updating is used to minize state changes.
+Lazy state updating is used to minimize state changes.
-
+
State()
-
+
virtual ~State()
-
+
void pushStateSet(const StateSet* dstate)
- push stateset onto state stack
-
+
void popStateSet()
- pop drawstate off state stack
+
+
+
void captureCurrentState(StateSet& stateset) const
+- copy the modes and attributes which captures the current state
+
-
+
void reset()
- reset the state object to an empty stack
-
+
inline const bool apply_mode(const StateAttribute::GLMode mode, const bool enabled)
- apply an OpenGL mode if required.
-
+
inline const bool apply_attribute(const StateAttribute* attribute)
- apply an attribute if required.
-
+
void apply(const StateSet* dstate)
- apply stateset
-
+
void apply()
- apply the state
-
+
void have_applied(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
- mode has been set externally, update state to reflect this setting
-
+
void have_applied(const StateAttribute* attribute)
- attribute has been applied externally, update state to reflect this setting
-
+
inline void setContextID(unsigned int contextID)
- Set the current OpenGL context uniqueID.
-Note, it is the application developers responsiblity to
+Note, it is the application developers responsibility to
set up unique ID for each OpenGL context. This value is
then used by osg::StateAttribure's and osg::Drawable's to
help manage OpenGL display list and texture binds appropriate
for each context.
-
+
inline const unsigned int getContextID() const
- Get the current OpenGL context unique ID
-
+
inline void setFrameStamp(FrameStamp* fs)
- Set the frame stamp for the current frame
-
+
inline const FrameStamp* getFrameStamp() const
- Set the frame stamp for the current frame
-
+
inline void setCamera(Camera* camera)
- Set the camera. Note, nothing is applied, the camera is just used
used in the State object to pass the current camera to Drawables
during rendering.
-
+
inline const Camera* getCamera() const
- Get the camera
-
-
-
void setFineGrainedErrorDetection(const bool flag)
-- Set the hint to OpenGL routines to do fine grained OpenGL error checking
+
+
+
inline void setDisplaySettings(DisplaySettings* vs)
+- Set the DisplaySettings. Note, nothing is applied, the visual settings are just used
+used in the State object to pass the current visual settings to Drawables
+during rendering.
-
-
-
const bool getFineGrainedErrorDetection() const
-- Get the hint to OpenGL routines to do fine grained OpenGL error checking
+
+
+
inline const DisplaySettings* getDisplaySettings() const
+- Get the DisplaySettings
-
+
ModeStack()
-
+
bool changed
-
+
bool last_applied_value
+
+
+
bool global_default_value
+
-
+
ValueVec valueVec
-
+
AttributeStack()
-
+
bool changed
+- apply an attribute if required, passing in attribute and appropriate attribute stack
-
+
const StateAttribute* last_applied_attribute
+
+
+
ref_ptr<StateAttribute> global_default_attribute
+
-
+
AttributeVec attributeVec
diff --git a/doc/doc++/osg/StateAttribute.html b/doc/doc++/osg/StateAttribute.html
index 7fbbf0ef3..6fb327c31 100644
--- a/doc/doc++/osg/StateAttribute.html
+++ b/doc/doc++/osg/StateAttribute.html
@@ -7,15 +7,15 @@
-Base class for state attribues
+Base class for state attribuets
Inheritance:
-
-
-
-
-
+
+
+
+
+
@@ -23,62 +23,62 @@
Public Methods
-
-
StateAttribute()
+
StateAttribute()
-
-
virtual Object* clone() const = 0
+
virtual Object* clone() const = 0
- return a shallow copy of a node, with Object* return type
-
-
virtual bool isSameKindAs(const Object* obj) const
+
virtual bool isSameKindAs(const Object* obj) const
- return true if this and obj are of the same kind of object
-
-
virtual const char* className() const
+
virtual const char* className() const
- return the name of the attribute's class type
-
-
virtual const Type getType() const = 0
- - return the Type idenitifer of the attribute's class type
+
virtual const Type getType() const = 0
+- return the Type identifier of the attribute's class type
-
-
virtual int compare(const StateAttribute& sa) const = 0
+
virtual int compare(const StateAttribute& sa) const = 0
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
bool operator < (const StateAttribute& rhs) const
+
bool operator < (const StateAttribute& rhs) const
-
-
bool operator == (const StateAttribute& rhs) const
+
bool operator == (const StateAttribute& rhs) const
-
-
bool operator != (const StateAttribute& rhs) const
+
bool operator != (const StateAttribute& rhs) const
-
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
-
-
virtual void apply(State&) const = 0
+
virtual void apply(State&) const = 0
- apply the OpenGL state attributes.
-
-
virtual void compile(State&) const
+
virtual void compile(State&) const
- default to nothing to compile - all state is applied immediately.
Public Members
-
-
typedef GLenum GLMode
+
typedef GLenum GLMode
- GLMode is the value used in glEnable/glDisable(mode)
-
-
typedef unsigned int GLModeValue
+
typedef unsigned int GLModeValue
- GLModeValue is used to specified whether an mode is enabled (ON) or disabled (OFF).
-
-
typedef unsigned int OverrideValue
+
typedef unsigned int OverrideValue
- Override is used to specified the override behavior of StateAttributes from from parent to children.
-
-
enum Values
+
enum Values
- list values which can be used in to set either GLModeValues or OverrideValues.
-
-
typedef unsigned int Type
+
typedef unsigned int Type
- Type identifier to differentiate between different state types.
-
-
enum Types
- - Values of StateAttribute::Type used to aid identification of diffenent StateAttribute subclasses.
+
enum Types
+- Values of StateAttribute::Type used to aid identification of different StateAttribute subclasses.
Protected Methods
-
-
virtual ~StateAttribute()
+
virtual ~StateAttribute()
@@ -108,33 +108,33 @@
Documentation
-Base class for state attribues
+Base class for state attribuets
-
+
typedef GLenum GLMode
- GLMode is the value used in glEnable/glDisable(mode)
-
+
typedef unsigned int GLModeValue
- GLModeValue is used to specified whether an mode is enabled (ON) or disabled (OFF).
-GLMoveValue is also used to speficy the override behavior of modes from parent to children.
+GLMoveValue is also used to specify the override behavior of modes from parent to children.
See enum Value description for more details.
-
+
typedef unsigned int OverrideValue
- Override is used to specified the override behavior of StateAttributes
from from parent to children.
See enum Value description for more details.
-
+
enum Values
- list values which can be used in to set either GLModeValues
-or OverrideValues. When using in conjection with GLModeValues
+or OverrideValues. When using in conjunction with GLModeValues
all Values have meaning. When using in conjection with
StateAttribute OverrideValue only OFF,OVERRIDE and INHERIT
are meaningful. However, they are useful when using GLModeValue
@@ -143,46 +143,46 @@ StateSet::setAttributeAndModes(..).
-
+
OFF
- means that associated GLMode and Override is disabled
-
+
ON
- means that associated GLMode is enabled and Override is disabled
-
+
OVERRIDE
- Overriding of GLMode's or StateAttributes is enabled
-
+
OVERRIDE_OFF
- means that associated GLMode is disabled and Override is enabled
-
+
OVERRIDE_ON
- means that associated GLMode and Override is enabled
-
+
INHERIT
- means that GLMode or StateAttribute should in inherited from above
-
+
typedef unsigned int Type
- Type identifier to differentiate between different state types.
-
+
enum Types
- Values of StateAttribute::Type used to aid identification
-of diffenent StateAttribute subclasses. Each subclass defines
+of different StateAttribute subclasses. Each subclass defines
it own value in the virtual Type getType() method. When
extending the osg's StateAttribute's simply define your
own Type value which is unique, using the StateAttribute::Type
@@ -191,210 +191,218 @@ needs to override a standard StateAttriubte then simple use
that types value.
-
-
-
ALPHAFUNC
-
-
-
-
ANTIALIAS
-
-
-
-
COLORTABLE
-
-
-
-
CULLFACE
-
-
-
-
FOG
-
-
-
-
FRONTFACE
-
-
-
-
LIGHT
-
-
-
-
LIGHT_0
-
-
-
-
LIGHT_1
-
-
-
-
LIGHT_2
-
-
-
-
LIGHT_3
-
-
-
-
LIGHT_4
-
-
-
-
LIGHT_5
-
-
-
-
LIGHT_6
-
-
-
-
LIGHT_7
-
-
-
-
MATERIAL
-
-
-
-
POINT
-
-
-
-
POLYGONMODE
-
-
-
-
POLYGONOFFSET
-
-
-
-
TEXENV
-
-
-
-
TEXGEN
-
-
-
-
TEXMAT
-
-
+
TEXTURE
-
+
TEXTURE_0
-
+
TEXTURE_1
-
+
TEXTURE_2
-
+
TEXTURE_3
+
+
+
MATERIAL
+
+
+
+
ALPHAFUNC
+
+
+
+
ANTIALIAS
+
+
+
+
COLORTABLE
+
+
+
+
CULLFACE
+
+
+
+
FOG
+
+
+
+
FRONTFACE
+
+
+
+
LIGHT
+
+
+
+
LIGHT_0
+
+
+
+
LIGHT_1
+
+
+
+
LIGHT_2
+
+
+
+
LIGHT_3
+
+
+
+
LIGHT_4
+
+
+
+
LIGHT_5
+
+
+
+
LIGHT_6
+
+
+
+
LIGHT_7
+
+
+
+
POINT
+
+
+
+
LINEWIDTH
+
+
+
+
POLYGONMODE
+
+
+
+
POLYGONOFFSET
+
+
+
+
TEXENV
+
+
+
+
TEXGEN
+
+
+
+
TEXMAT
+
-
+
TRANSPARENCY
-
+
STENCIL
-
+
COLORMASK
-
-
-
CLIPPLANE
-
-
-
-
CLIPPLANE_0
-
-
-
-
CLIPPLANE_1
-
-
-
-
CLIPPLANE_2
-
-
-
-
CLIPPLANE_3
-
-
-
-
CLIPPLANE_4
-
-
-
-
CLIPPLANE_5
-
-
+
DEPTH
-
+
VIEWPORT
+
+
+
+
CLIPPLANE
+
+
+
+
CLIPPLANE_0
+
+
+
+
CLIPPLANE_1
+
+
+
+
CLIPPLANE_2
+
+
+
+
CLIPPLANE_3
+
+
+
+
CLIPPLANE_4
+
+
+
+
CLIPPLANE_5
+
+
+
+
COLORMATRIX
-
+
StateAttribute()
-
+
virtual Object* clone() const = 0
- return a shallow copy of a node, with Object* return type
-
+
virtual bool isSameKindAs(const Object* obj) const
- return true if this and obj are of the same kind of object
-
+
virtual const char* className() const
- return the name of the attribute's class type
-
-
virtual const Type getType() const = 0
-- return the Type idenitifer of the attribute's class type
+
+
virtual const Type getType() const = 0
+- return the Type identifier of the attribute's class type
-
+
virtual int compare(const StateAttribute& sa) const = 0
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
bool operator < (const StateAttribute& rhs) const
-
+
bool operator == (const StateAttribute& rhs) const
-
+
bool operator != (const StateAttribute& rhs) const
-
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
-
+
virtual void apply(State&) const = 0
- apply the OpenGL state attributes.
The global state for the current OpenGL context is passed
@@ -402,12 +410,12 @@ in to allow the StateAttribute to obtain details on the
the current context and state.
-
+
virtual void compile(State&) const
- default to nothing to compile - all state is applied immediately.
-
+
virtual ~StateAttribute()
@@ -423,11 +431,13 @@ the current context and state.
PolygonMode
Point
Material
+LineWidth
Light
FrontFace
Fog
Depth
CullFace
+ColorMatrix
ColorMask
ClipPlane
AlphaFunc
diff --git a/doc/doc++/osg/StateSet.html b/doc/doc++/osg/StateSet.html
index a8425010c..5ad315e12 100644
--- a/doc/doc++/osg/StateSet.html
+++ b/doc/doc++/osg/StateSet.html
@@ -23,122 +23,137 @@
Public Methods
-
-
StateSet()
+
StateSet()
-
-
virtual Object* clone() const
+
StateSet(const StateSet&)
-
-
virtual bool isSameKindAs(const Object* obj) const
+
virtual Object* clone() const
-
-
virtual const char* className() const
+
virtual bool isSameKindAs(const Object* obj) const
-
-
void setGlobalDefaults()
+
virtual const char* className() const
+-
+
int compare(const StateSet& rhs, bool compareAttributeContents=false) const
+ - return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
+
-
+
bool operator < (const StateSet& rhs) const
+-
+
bool operator == (const StateSet& rhs) const
+-
+
bool operator != (const StateSet& rhs) const
+-
+
void setGlobalDefaults()
- set all the modes to on or off so that it defines a complete state, typically used for a default global state
-
-
void setAllToInherit()
- - set all the modes to inherit, typically used to signifiy nodes which inherit all of their modes for the global state
+
void setAllToInherit()
+- set all the modes to inherit, typically used to signify nodes which inherit all of their modes for the global state
-
-
void setMode(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
+
void merge(const StateSet& rhs)
+ - merge this stateset with stateset rhs, this overrides the rhs if OVERRIDE is specified, otherwise rhs takes precedence
+
-
+
void setMode(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
- set this StateSet to contain specified GLMode and value
-
-
void setModeToInherit(const StateAttribute::GLMode mode)
+
void setModeToInherit(const StateAttribute::GLMode mode)
- set this StateSet to inherit specified GLMode type from parents.
-
-
const StateAttribute::GLModeValue getMode(const StateAttribute::GLMode mode) const
+
const StateAttribute::GLModeValue getMode(const StateAttribute::GLMode mode) const
- get specified GLModeValue for specified GLMode.
-
-
inline ModeList& getModeList()
+
inline ModeList& getModeList()
- return the list of all GLModes contained in this StateSet
-
-
inline const ModeList& getModeList() const
+
inline const ModeList& getModeList() const
- return the const list of all GLModes contained in this const StateSet
-
-
void setAttribute(StateAttribute* attribute, const StateAttribute::OverrideValue value=StateAttribute::OFF)
+
void setAttribute(StateAttribute* attribute, const StateAttribute::OverrideValue value=StateAttribute::OFF)
- set this StateSet to contain specified attribute and override flag
-
-
void setAttributeAndModes(StateAttribute* attribute, const StateAttribute::GLModeValue value=StateAttribute::ON)
- - set this StateSet to contain specified attribute and set the associated GLMode's to specifed value
+
void setAttributeAndModes(StateAttribute* attribute, const StateAttribute::GLModeValue value=StateAttribute::ON)
+- set this StateSet to contain specified attribute and set the associated GLMode's to specified value
-
-
void setAttributeToInherit(const StateAttribute::Type type)
+
void setAttributeToInherit(const StateAttribute::Type type)
- set this StateSet to inherit specified attribute type from parents.
-
-
const StateAttribute* getAttribute(const StateAttribute::Type type) const
+
StateAttribute* getAttribute(const StateAttribute::Type type)
- get specified StateAttribute for specified type.
-
-
const RefAttributePair* getAttributePair(const StateAttribute::Type type) const
+
const StateAttribute* getAttribute(const StateAttribute::Type type) const
+ - get specified const StateAttribute for specified type.
+
-
+
const RefAttributePair* getAttributePair(const StateAttribute::Type type) const
- get specified RefAttributePair for specified type.
-
-
inline AttributeList& getAttributeList()
+
inline AttributeList& getAttributeList()
- return the list of all StateAttributes contained in this StateSet
-
-
inline const AttributeList& getAttributeList() const
+
inline const AttributeList& getAttributeList() const
- return the const list of all StateAttributes contained in this const StateSet
-
-
void setRenderingHint(const int hint)
+
void setRenderingHint(const int hint)
- set the RenderingHint of the StateSet.
-
-
inline const int getRenderingHint() const
+
inline const int getRenderingHint() const
- get the RenderingHint of the StateSet
-
-
void setRenderBinDetails(const int binNum, const std::string& binName, const RenderBinMode mode=USE_RENDERBIN_DETAILS)
+
void setRenderBinDetails(const int binNum, const std::string& binName, const RenderBinMode mode=USE_RENDERBIN_DETAILS)
- set the render bin details
-
-
void setRendingBinToInherit()
+
void setRendingBinToInherit()
- set the render bin details to inherit
-
-
inline const RenderBinMode getRenderBinMode() const
+
inline const RenderBinMode getRenderBinMode() const
- get the render bin mode
-
-
inline const bool useRenderBinDetails() const
+
inline const bool useRenderBinDetails() const
- get whether the render bin details are set and should be used
-
-
inline const int getBinNumber() const
+
inline const int getBinNumber() const
- get the render bin number
-
-
inline const std::string& getBinName() const
+
inline const std::string& getBinName() const
- get the render bin name
-
-
void compile(State& state) const
+
void compile(State& state) const
- call compile on all StateAttributes contained within this StateSet
Public Members
-
-
typedef std::map<StateAttribute::GLMode,StateAttribute::GLModeValue> ModeList
+
typedef std::map<StateAttribute::GLMode,StateAttribute::GLModeValue> ModeList
- a container to map GLModes to their respective GLModeValues
-
-
typedef std::pair<ref_ptr<StateAttribute>,StateAttribute::OverrideValue> RefAttributePair
+
typedef std::pair<ref_ptr<StateAttribute>,StateAttribute::OverrideValue> RefAttributePair
- simple pairing between an attribute and its override flag
-
-
typedef std::map<StateAttribute::Type,RefAttributePair> AttributeList
+
typedef std::map<StateAttribute::Type,RefAttributePair> AttributeList
- a container to map StateAttribyte::Types to their respective RefAttributePair
-
-
enum RenderingHint
+
enum RenderingHint
-
-
enum RenderBinMode
+
enum RenderBinMode
Protected Fields
-
-
ModeList _modeList
+
ModeList _modeList
-
-
AttributeList _attributeList
+
AttributeList _attributeList
-
-
int _renderingHint
+
int _renderingHint
-
-
RenderBinMode _binMode
+
RenderBinMode _binMode
-
-
int _binNum
+
int _binNum
-
-
std::string _binName
+
std::string _binName
Protected Methods
-
-
virtual ~StateSet()
+
virtual ~StateSet()
-
-
StateSet(const StateSet&)
--
-
StateSet& operator = (const StateSet&)
+
StateSet& operator = (const StateSet&)
@@ -168,140 +183,173 @@
Documentation
Encapsulates OpenGL state modes and attributes.
-Used to specificy textures etc of osg::Drawable's which hold references
+Used to specific textures etc of osg::Drawable's which hold references
to a single osg::StateSet. StateSet can be shared between Drawable's
and is recommend if possible as it minimize expensive state changes
in the graphics pipeline.
-
+
StateSet()
+
+
+
StateSet(const StateSet&)
+
-
+
virtual Object* clone() const
-
+
virtual bool isSameKindAs(const Object* obj) const
-
+
virtual const char* className() const
+
+
+
int compare(const StateSet& rhs, bool compareAttributeContents=false) const
+- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
+
+
+
+
bool operator < (const StateSet& rhs) const
+
+
+
+
bool operator == (const StateSet& rhs) const
+
+
+
+
bool operator != (const StateSet& rhs) const
+
-
+
void setGlobalDefaults()
- set all the modes to on or off so that it defines a
complete state, typically used for a default global state
-
+
void setAllToInherit()
-- set all the modes to inherit, typically used to signifiy
+
- set all the modes to inherit, typically used to signify
nodes which inherit all of their modes for the global state
+
+
+
void merge(const StateSet& rhs)
+- merge this stateset with stateset rhs, this overrides
+the rhs if OVERRIDE is specified, otherwise rhs takes precedence
+
-
+
typedef std::map<StateAttribute::GLMode,StateAttribute::GLModeValue> ModeList
- a container to map GLModes to their respective GLModeValues
-
+
void setMode(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
- set this StateSet to contain specified GLMode and value
-
+
void setModeToInherit(const StateAttribute::GLMode mode)
- set this StateSet to inherit specified GLMode type from parents.
has the effect of deleting any GlMode of specified type from StateSet.
-
+
const StateAttribute::GLModeValue getMode(const StateAttribute::GLMode mode) const
- get specified GLModeValue for specified GLMode.
returns INHERIT if no GLModeValue is contained within StateSet.
-
-
inline ModeList& getModeList()
+
+
inline ModeList& getModeList()
- return the list of all GLModes contained in this StateSet
-
-
inline const ModeList& getModeList() const
+
+
inline const ModeList& getModeList() const
- return the const list of all GLModes contained in this const StateSet
-
+
typedef std::pair<ref_ptr<StateAttribute>,StateAttribute::OverrideValue> RefAttributePair
- simple pairing between an attribute and its override flag
-
-
typedef std::map<StateAttribute::Type,RefAttributePair> AttributeList
+
+
typedef std::map<StateAttribute::Type,RefAttributePair> AttributeList
- a container to map StateAttribyte::Types to their respective RefAttributePair
-
+
void setAttribute(StateAttribute* attribute, const StateAttribute::OverrideValue value=StateAttribute::OFF)
- set this StateSet to contain specified attribute and override flag
-
+
void setAttributeAndModes(StateAttribute* attribute, const StateAttribute::GLModeValue value=StateAttribute::ON)
-- set this StateSet to contain specified attribute and set the associated GLMode's to specifed value
+
- set this StateSet to contain specified attribute and set the associated GLMode's to specified value
-
+
void setAttributeToInherit(const StateAttribute::Type type)
- set this StateSet to inherit specified attribute type from parents.
has the effect of deleting any state attributes of specified type from StateSet.
-
-
const StateAttribute* getAttribute(const StateAttribute::Type type) const
+
+
StateAttribute* getAttribute(const StateAttribute::Type type)
- get specified StateAttribute for specified type.
returns NULL if no type is contained within StateSet.
+
+
+
const StateAttribute* getAttribute(const StateAttribute::Type type) const
+- get specified const StateAttribute for specified type.
+returns NULL if no type is contained within const StateSet.
+
-
-
const RefAttributePair* getAttributePair(const StateAttribute::Type type) const
+
+
const RefAttributePair* getAttributePair(const StateAttribute::Type type) const
- get specified RefAttributePair for specified type.
returns NULL if no type is contained within StateSet.
-
-
inline AttributeList& getAttributeList()
+
+
inline AttributeList& getAttributeList()
- return the list of all StateAttributes contained in this StateSet
-
-
inline const AttributeList& getAttributeList() const
+
+
inline const AttributeList& getAttributeList() const
- return the const list of all StateAttributes contained in this const StateSet
-
+
enum RenderingHint
-
+
DEFAULT_BIN
-
+
OPAQUE_BIN
-
+
TRANSPARENT_BIN
-
+
void setRenderingHint(const int hint)
- set the RenderingHint of the StateSet.
RenderingHint is used by osgUtil::Renderer to determine which
@@ -310,101 +358,97 @@ objects OPAQUE_BIN would typical used, which TRANSPARENT_BIN
should be used for objects which need to be depth sorted.
-
+
inline const int getRenderingHint() const
- get the RenderingHint of the StateSet
-
+
enum RenderBinMode
-
+
INHERIT_RENDERBIN_DETAILS
-
+
USE_RENDERBIN_DETAILS
-
+
OVERRIDE_RENDERBIN_DETAILS
-
+
ENCLOSE_RENDERBIN_DETAILS
-
-
void setRenderBinDetails(const int binNum, const std::string& binName, const RenderBinMode mode=USE_RENDERBIN_DETAILS)
+
+
void setRenderBinDetails(const int binNum, const std::string& binName, const RenderBinMode mode=USE_RENDERBIN_DETAILS)
- set the render bin details
-
+
void setRendingBinToInherit()
- set the render bin details to inherit
-
-
inline const RenderBinMode getRenderBinMode() const
+
+
inline const RenderBinMode getRenderBinMode() const
- get the render bin mode
-
+
inline const bool useRenderBinDetails() const
- get whether the render bin details are set and should be used
-
+
inline const int getBinNumber() const
- get the render bin number
-
+
inline const std::string& getBinName() const
- get the render bin name
-
+
void compile(State& state) const
- call compile on all StateAttributes contained within this StateSet
-
+
virtual ~StateSet()
-
-
-
StateSet(const StateSet&)
-
-
+
StateSet& operator = (const StateSet&)
-
-
ModeList _modeList
+
+
ModeList _modeList
-
-
AttributeList _attributeList
+
+
AttributeList _attributeList
-
+
int _renderingHint
-
-
RenderBinMode _binMode
+
+
RenderBinMode _binMode
-
+
int _binNum
-
+
std::string _binName
diff --git a/doc/doc++/osg/Stencil.html b/doc/doc++/osg/Stencil.html
index 20d337388..b8d7e593d 100644
--- a/doc/doc++/osg/Stencil.html
+++ b/doc/doc++/osg/Stencil.html
@@ -7,7 +7,7 @@
-Encapsulte OpenGL glStencilFunc/Op/Mask functions
+Encapsulate OpenGL glStencilFunc/Op/Mask functions
Inheritance:
@@ -23,69 +23,69 @@
Public Methods
-
-
Stencil()
+
Stencil()
-
-
META_StateAttribute(Stencil, STENCIL)
+
META_StateAttribute(Stencil, STENCIL)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
inline void setFunction(const Function func, int ref, uint mask)
+
inline void setFunction(const Function func, int ref, uint mask)
-
-
inline const Function getFunction() const
+
inline const Function getFunction() const
-
-
inline const int getFunctionRef() const
+
inline const int getFunctionRef() const
-
-
inline const uint getFunctionMask() const
+
inline const uint getFunctionMask() const
-
-
inline void setOperation(const Operation sfail, const Operation zfail, const Operation zpass)
+
inline void setOperation(const Operation sfail, const Operation zfail, const Operation zpass)
- set the operations to apply when the various stencil and depth tests fail or pass.
-
-
inline const Operation getStencilFailOperation() const
+
inline const Operation getStencilFailOperation() const
- get the operation when the stencil test fails
-
-
inline const Operation getStencilPassAndDepthFailOperation() const
+
inline const Operation getStencilPassAndDepthFailOperation() const
- get the operation when the stencil test passes but the depth test fails
-
-
inline const Operation getStencilPassAndDepthPassOperation() const
+
inline const Operation getStencilPassAndDepthPassOperation() const
- get the operation when both the stencil test and the depth test pass
-
-
inline void setWriteMask(uint mask)
+
inline void setWriteMask(uint mask)
-
-
inline const uint getWriteMask() const
+
inline const uint getWriteMask() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Function
+
enum Function
-
-
enum Operation
+
enum Operation
Protected Fields
-
-
Function _func
+
Function _func
-
-
int _funcRef
+
int _funcRef
-
-
uint _funcMask
+
uint _funcMask
-
-
Operation _sfail
+
Operation _sfail
-
-
Operation _zfail
+
Operation _zfail
-
-
Operation _zpass
+
Operation _zpass
-
-
uint _writeMask
+
uint _writeMask
Protected Methods
-
-
virtual ~Stencil()
+
virtual ~Stencil()
@@ -99,7 +99,7 @@
-
virtual const char* className() const
-
-
virtual const Type getType() const
+
virtual const Type getType() const
-
bool operator < (const StateAttribute& rhs) const
-
@@ -152,178 +152,178 @@
Documentation
-Encapsulte OpenGL glStencilFunc/Op/Mask functions
+Encapsulate OpenGL glStencilFunc/Op/Mask functions
-
+
Stencil()
-
-
META_StateAttribute(Stencil, STENCIL)
+
+
META_StateAttribute(Stencil, STENCIL)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
enum Function
-
+
NEVER
-
+
LESS
-
+
EQUAL
-
+
LEQUAL
-
+
GREATER
-
+
NOTEQUAL
-
+
GEQUAL
-
+
ALWAYS
-
-
inline void setFunction(const Function func, int ref, uint mask)
+
+
inline void setFunction(const Function func, int ref, uint mask)
-
-
inline const Function getFunction() const
+
+
inline const Function getFunction() const
-
+
inline const int getFunctionRef() const
-
+
inline const uint getFunctionMask() const
-
+
enum Operation
-
+
KEEP
-
+
ZERO
-
+
REPLACE
-
+
INCR
-
+
DECR
-
+
INVERT
-
-
inline void setOperation(const Operation sfail, const Operation zfail, const Operation zpass)
+
+
inline void setOperation(const Operation sfail, const Operation zfail, const Operation zpass)
- set the operations to apply when the various stencil and depth
-tests fail or pass. First paramater is to control the operation
-when the stencil test fails. The second paramter is to control the
-operatiorn when the stencil test passes, but depth test fails. The
+tests fail or pass. First parameter is to control the operation
+when the stencil test fails. The second parameter is to control the
+operation when the stencil test passes, but depth test fails. The
third parameter controls the operation when both the stencil test
and depth pass. Ordering of parameter is the same as if using
glStencilOp(,,).
-
-
inline const Operation getStencilFailOperation() const
+
+
inline const Operation getStencilFailOperation() const
- get the operation when the stencil test fails
-
-
inline const Operation getStencilPassAndDepthFailOperation() const
+
+
inline const Operation getStencilPassAndDepthFailOperation() const
- get the operation when the stencil test passes but the depth test fails
-
-
inline const Operation getStencilPassAndDepthPassOperation() const
+
+
inline const Operation getStencilPassAndDepthPassOperation() const
- get the operation when both the stencil test and the depth test pass
-
+
inline void setWriteMask(uint mask)
-
+
inline const uint getWriteMask() const
-
+
virtual void apply(State& state) const
-
+
virtual ~Stencil()
-
-
Function _func
+
+
Function _func
-
+
int _funcRef
-
+
uint _funcMask
-
-
Operation _sfail
+
+
Operation _sfail
-
-
Operation _zfail
+
+
Operation _zfail
-
-
Operation _zpass
+
+
Operation _zpass
-
+
uint _writeMask
diff --git a/doc/doc++/osg/Switch.html b/doc/doc++/osg/Switch.html
index 597bb01b8..105393102 100644
--- a/doc/doc++/osg/Switch.html
+++ b/doc/doc++/osg/Switch.html
@@ -23,34 +23,34 @@
Public Methods
-
-
Switch()
+
Switch()
-
-
META_Node(Switch)
+
META_Node(Switch)
-
-
virtual void traverse(NodeVisitor& nv)
+
virtual void traverse(NodeVisitor& nv)
-
-
inline void setValue(const int value)
+
inline void setValue(const int value)
- Selects the active child Node or enables a special SwitchType mode.
-
-
inline const int getValue() const
+
inline const int getValue() const
- Returns the number of the active child Node or the SwitchType
Public Members
-
-
enum SwitchType
+
enum SwitchType
- Special mode values for the Switch.
Protected Fields
-
-
int _value
+
int _value
- The current Switch value.
Protected Methods
-
-
virtual ~Switch()
+
virtual ~Switch()
@@ -108,7 +108,7 @@
-
inline const std::string& getName() const
-
-
inline const ParentList& getParents() const
+
inline const ParentList& getParents() const
-
inline Group* getParent(const int i)
-
@@ -124,23 +124,25 @@
-
inline const int getNumChildrenRequiringAppTraversal() const
-
-
inline void setUserData(void* data, MemoryAdapter* ma=0L)
+
void setCullingActive(const bool active)
-
-
inline void* getUserData()
+
inline const bool getCullingActive() const
-
-
inline const void* getUserData() const
+
inline const int getNumChildrenWithCullingDisabled() const
-
-
inline MemoryAdapter* getMemoryAdapter()
+
inline void setUserData(osg::Referenced* obj)
-
-
inline const MemoryAdapter* getMemoryAdapter() const
+
inline Referenced* getUserData()
+-
+
inline const Referenced* getUserData() const
-
inline void setNodeMask(const NodeMask nm)
-
inline const NodeMask getNodeMask() const
-
-
inline const DescriptionList& getDescriptions() const
+
inline const DescriptionList& getDescriptions() const
-
-
inline DescriptionList& getDescriptions()
+
inline DescriptionList& getDescriptions()
-
inline const std::string& getDescription(const int i) const
-
@@ -176,19 +178,21 @@
-
std::string _name
-
-
ParentList _parents
+
ParentList _parents
-
ref_ptr<NodeCallback> _appCallback
-
int _numChildrenRequiringAppTraversal
-
-
void* _userData
+
bool _cullingActive
-
-
ref_ptr<MemoryAdapter> _memoryAdapter
+
int _numChildrenWithCullingDisabled
+-
+
osg::ref_ptr<Referenced> _userData
-
NodeMask _nodeMask
-
-
DescriptionList _descriptions
+
DescriptionList _descriptions
-
ref_ptr<StateSet> _dstate
@@ -196,6 +200,8 @@
Protected Methods
-
void setNumChildrenRequiringAppTraversal(const int num)
+-
+
void setNumChildrenWithCullingDisabled(const int num)
@@ -232,7 +238,7 @@ to represent the different states of a traffic light.
-
+
enum SwitchType
-
Special mode values for the Switch. Use these if you want to
@@ -240,50 +246,50 @@ turn on/off all child nodes.
-
+
ALL_CHILDREN_ON
- Turn on all children.
-
+
ALL_CHILDREN_OFF
- Turn off all children.
-
+
Switch()
-
+
META_Node(Switch)
-
+
virtual void traverse(NodeVisitor& nv)
-
+
inline void setValue(const int value)
-
Selects the active child Node or enables a special
SwitchType mode.
- Parameters:
- value - the number of the active child
-(first child == number 0) or SwitchType. Invalid values
+(first child == number 0) or SwitchType. Invalid values
will be ignored.
-
+
inline const int getValue() const
-
Returns the number of the active child Node or the SwitchType
-
+
virtual ~Switch()
-
+
int _value
- The current Switch value.
diff --git a/doc/doc++/osg/TexEnv.html b/doc/doc++/osg/TexEnv.html
index 4ad3e1163..284014edf 100644
--- a/doc/doc++/osg/TexEnv.html
+++ b/doc/doc++/osg/TexEnv.html
@@ -23,33 +23,33 @@
Public Methods
-
-
TexEnv( void )
+
TexEnv( void )
-
-
META_StateAttribute(TexEnv, TEXENV)
+
META_StateAttribute(TexEnv, TEXENV)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
void setMode( const Mode mode )
+
void setMode( const Mode mode )
-
-
const Mode getMode() const
+
const Mode getMode() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum Mode
+
enum Mode
Protected Fields
-
-
Mode _mode
+
Mode _mode
Protected Methods
-
-
virtual ~TexEnv( void )
+
virtual ~TexEnv( void )
@@ -63,7 +63,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -71,7 +71,7 @@
bool operator != (const StateAttribute& rhs) const
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
virtual void compile(State&) const
@@ -122,59 +122,59 @@
-
+
TexEnv( void )
-
-
META_StateAttribute(TexEnv, TEXENV)
+
+
META_StateAttribute(TexEnv, TEXENV)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
enum Mode
-
+
DECAL
-
+
MODULATE
-
+
BLEND
-
+
REPLACE
-
-
void setMode( const Mode mode )
+
+
void setMode( const Mode mode )
-
-
const Mode getMode() const
+
+
const Mode getMode() const
-
+
virtual void apply(State& state) const
-
+
virtual ~TexEnv( void )
-
-
Mode _mode
+
+
Mode _mode
- This class has no child classes.
diff --git a/doc/doc++/osg/TexGen.html b/doc/doc++/osg/TexGen.html
index 5a4cdcc21..59ca8d36e 100644
--- a/doc/doc++/osg/TexGen.html
+++ b/doc/doc++/osg/TexGen.html
@@ -23,50 +23,50 @@
Public Methods
-
-
TexGen( void )
+
TexGen( void )
-
-
META_StateAttribute(TexGen, TEXGEN)
+
META_StateAttribute(TexGen, TEXGEN)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
-
-
inline void setMode( const Mode mode )
+
inline void setMode( const Mode mode )
-
-
const Mode getMode() const
+
const Mode getMode() const
-
-
void setPlane(const Coord which, const Vec4& plane)
+
void setPlane(const Coord which, const Vec4& plane)
-
-
const Vec4& getPlane(const Coord which) const
+
const Vec4& getPlane(const Coord which) const
Public Members
-
-
enum Mode
+
enum Mode
-
-
enum Coord
+
enum Coord
Protected Fields
-
-
Mode _mode
+
Mode _mode
-
-
Vec4 _plane_s
+
Vec4 _plane_s
- additional texgen coefficents for GL_OBJECT_PLANE or GL_EYE_PLANE,
-
-
Vec4 _plane_t
+
Vec4 _plane_t
-
-
Vec4 _plane_r
+
Vec4 _plane_r
-
-
Vec4 _plane_q
+
Vec4 _plane_q
Protected Methods
-
-
virtual ~TexGen( void )
+
virtual ~TexGen( void )
@@ -80,7 +80,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -137,105 +137,105 @@
-
+
TexGen( void )
-
-
META_StateAttribute(TexGen, TEXGEN)
+
+
META_StateAttribute(TexGen, TEXGEN)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
virtual void apply(State& state) const
-
+
enum Mode
-
+
OBJECT_LINEAR
-
+
EYE_LINEAR
-
+
SPHERE_MAP
-
-
inline void setMode( const Mode mode )
+
+
inline void setMode( const Mode mode )
-
-
const Mode getMode() const
+
+
const Mode getMode() const
-
+
enum Coord
-
+
S
-
+
T
-
+
R
-
+
Q
-
-
void setPlane(const Coord which, const Vec4& plane)
+
+
void setPlane(const Coord which, const Vec4& plane)
-
-
const Vec4& getPlane(const Coord which) const
+
+
const Vec4& getPlane(const Coord which) const
-
+
virtual ~TexGen( void )
-
-
Mode _mode
+
+
Mode _mode
-
+
Vec4 _plane_s
- additional texgen coefficents for GL_OBJECT_PLANE or GL_EYE_PLANE,
-
+
Vec4 _plane_t
-
+
Vec4 _plane_r
-
+
Vec4 _plane_q
diff --git a/doc/doc++/osg/TexMat.html b/doc/doc++/osg/TexMat.html
index a0abbc151..aafaa6731 100644
--- a/doc/doc++/osg/TexMat.html
+++ b/doc/doc++/osg/TexMat.html
@@ -23,34 +23,34 @@
Public Methods
-
-
TexMat( void )
+
TexMat( void )
-
-
META_StateAttribute(TexMat, TEXMAT)
+
META_StateAttribute(TexMat, TEXMAT)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
inline void setMatrix(const Matrix& matrix)
+
inline void setMatrix(const Matrix& matrix)
- Set the texture matrix
-
-
inline Matrix& getMatrix()
+
inline Matrix& getMatrix()
- Get the texture matrix
-
-
inline const Matrix& getMatrix() const
+
inline const Matrix& getMatrix() const
- Get the const texture matrix
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
- apply as OpenGL texture matrix
Protected Fields
-
-
Matrix _matrix
+
Matrix _matrix
Protected Methods
-
-
virtual ~TexMat( void )
+
virtual ~TexMat( void )
@@ -64,7 +64,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -72,7 +72,7 @@
bool operator != (const StateAttribute& rhs) const
-
virtual void setStateSetModes(StateSet&, const GLModeValue) const
+
virtual void setStateSetModes(StateSet&, const GLModeValue) const
virtual void compile(State&) const
@@ -123,44 +123,44 @@
-
+
TexMat( void )
-
-
META_StateAttribute(TexMat, TEXMAT)
+
+
META_StateAttribute(TexMat, TEXMAT)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
+
inline void setMatrix(const Matrix& matrix)
- Set the texture matrix
-
+
inline Matrix& getMatrix()
- Get the texture matrix
-
+
inline const Matrix& getMatrix() const
- Get the const texture matrix
-
+
virtual void apply(State& state) const
- apply as OpenGL texture matrix
-
+
virtual ~TexMat( void )
-
+
Matrix _matrix
diff --git a/doc/doc++/osg/Texture.html b/doc/doc++/osg/Texture.html
index 62efb766f..595365ed9 100644
--- a/doc/doc++/osg/Texture.html
+++ b/doc/doc++/osg/Texture.html
@@ -23,160 +23,160 @@
Public Methods
-
-
Texture()
+
Texture()
-
-
META_StateAttribute(Texture, (Type)(TEXTURE_0+_textureUnit))
+
META_StateAttribute(Texture, (Type)(TEXTURE_0+_textureUnit))
-
-
virtual int compare(const StateAttribute& rhs) const
+
virtual int compare(const StateAttribute& rhs) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
void setImage(Image* image)
+
void setImage(Image* image)
- Set the texture image.
-
-
Image* getImage()
+
Image* getImage()
- Get the texture image.
-
-
inline const Image* getImage() const
+
inline const Image* getImage() const
- Get the const texture image.
-
-
void copyTexImage2D(State& state, int x, int y, int width, int height )
+
void copyTexImage2D(State& state, int x, int y, int width, int height )
- Copy pixels into a 2D texture imageAs per glCopyTexImage2D.
-
-
void copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height )
+
void copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height )
- Copy a two-dimensional texture subimage.
-
-
inline void setTextureUnit(const unsigned int textureUnit)
+
inline void setTextureUnit(const unsigned int textureUnit)
- Set the texture unit.
-
-
inline const unsigned int getTextureUnit() const
+
inline const unsigned int getTextureUnit() const
- get the texture unit
-
-
void setWrap(const WrapParameter which, const WrapMode wrap)
+
void setWrap(const WrapParameter which, const WrapMode wrap)
- Set the texture wrap mode
-
-
const WrapMode getWrap(const WrapParameter which) const
+
const WrapMode getWrap(const WrapParameter which) const
- Get the texture wrap mode
-
-
void setFilter(const FilterParameter which, const FilterMode filter)
+
void setFilter(const FilterParameter which, const FilterMode filter)
- Set the texture filter mode
-
-
const FilterMode getFilter(const FilterParameter which) const
+
const FilterMode getFilter(const FilterParameter which) const
- Get the texture filter mode
-
-
inline void setInternalFormatMode(const InternalFormatMode mode)
+
inline void setInternalFormatMode(const InternalFormatMode mode)
- Set the internal format mode.
-
-
inline const InternalFormatMode getInternalFormatMode() const
+
inline const InternalFormatMode getInternalFormatMode() const
- Get the internal format mode
-
-
inline void setInternalFormatValue(const int internalFormat)
+
inline void setInternalFormatValue(const int internalFormat)
- Set the internal format to use when creating OpenGL textures.
-
-
inline const int getInternalFormatValue() const
+
inline const int getInternalFormatValue() const
- Get the internal format to use when creating OpenGL textures
-
-
inline const uint getTextureObject(const uint contextID) const
+
inline const uint getTextureObject(const uint contextID) const
- return the OpenGL texture object for specified context
-
-
inline const uint getTextureObjectSize() const
+
inline const uint getTextureObjectSize() const
- return the memory size of texture object.
-
-
inline void setSubloadMode(const SubloadMode mode)
+
inline void setSubloadMode(const SubloadMode mode)
- Set the texture subload mode.
-
-
inline const SubloadMode getSubloadMode() const
+
inline const SubloadMode getSubloadMode() const
- Get the texture subload mode.
-
-
inline void setSubloadOffset(const int x, const int y)
+
inline void setSubloadOffset(const int x, const int y)
- Set the texture subload offsets.
-
-
inline void getSubloadOffset(int& x, int& y) const
+
inline void getSubloadOffset(int& x, int& y) const
- Get the texture subload offsets.
-
-
inline GLuint& getHandle(const uint contextID) const
+
inline GLuint& getHandle(const uint contextID) const
- Get the handle to the texture object for the current context
-
-
void dirtyTextureObject()
+
void dirtyTextureObject()
- Force a recompile on next apply() of associated OpenGL texture objects
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
- On first apply (unless already compiled), create the minmapped texture and bind it, subsequent apply will simple bind to texture
-
-
virtual void compile(State& state) const
+
virtual void compile(State& state) const
- Compile the texture mip maps.
-
-
virtual void applyImmediateMode(State& state) const
+
virtual void applyImmediateMode(State& state) const
- Method which does the creation of the texture itself, and does not set or use texture binding.
-
-
static void deleteTextureObject(uint contextID, GLuint handle)
+
static void deleteTextureObject(uint contextID, GLuint handle)
- use deleteTextureObject instead of glDeleteTextures to allow OpenGL texture objects to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID
-
-
static void flushDeletedTextureObjects(uint contextID)
+
static void flushDeletedTextureObjects(uint contextID)
- flush all the cached display list which need to be deleted in the OpenGL context related to contextID
Public Members
-
-
enum WrapParameter
+
enum WrapParameter
-
-
enum WrapMode
+
enum WrapMode
-
-
enum FilterParameter
+
enum FilterParameter
-
-
enum FilterMode
+
enum FilterMode
-
-
enum InternalFormatMode
+
enum InternalFormatMode
-
-
enum SubloadMode
+
enum SubloadMode
Protected Fields
-
-
mutable uint _textureObjectSize
+
mutable uint _textureObjectSize
-
-
mutable ref_ptr<Image> _image
+
mutable ref_ptr<Image> _image
-
-
unsigned int _textureUnit
+
unsigned int _textureUnit
-
-
WrapMode _wrap_s
+
WrapMode _wrap_s
-
-
WrapMode _wrap_t
+
WrapMode _wrap_t
-
-
WrapMode _wrap_r
+
WrapMode _wrap_r
-
-
FilterMode _min_filter
+
FilterMode _min_filter
-
-
FilterMode _mag_filter
+
FilterMode _mag_filter
-
-
InternalFormatMode _internalFormatMode
+
InternalFormatMode _internalFormatMode
-
-
int _internalFormatValue
+
int _internalFormatValue
-
-
mutable unsigned int _textureWidth
+
mutable unsigned int _textureWidth
-
-
mutable unsigned int _textureHeight
+
mutable unsigned int _textureHeight
-
-
SubloadMode _subloadMode
+
SubloadMode _subloadMode
-
-
unsigned int _subloadOffsX
+
unsigned int _subloadOffsX
-
-
unsigned int _subloadOffsY
+
unsigned int _subloadOffsY
Protected Methods
-
-
virtual ~Texture()
+
virtual ~Texture()
Protected Members
-
-
typedef std::vector<GLuint> TextureNameList mutable TextureNameList _handleList
+
typedef std::vector<GLuint> TextureNameList mutable TextureNameList _handleList
-
-
typedef std::vector<uint> ImageModifiedTag mutable ImageModifiedTag _modifiedTag
+
typedef std::vector<uint> ImageModifiedTag mutable ImageModifiedTag _modifiedTag
-
-
typedef std::map<uint,std::set<uint> >static DeletedTextureObjectCache DeletedTextureObjectCache s_deletedTextureObjectCache
+
typedef std::map<uint,std::set<uint> >static DeletedTextureObjectCache DeletedTextureObjectCache s_deletedTextureObjectCache
@@ -190,7 +190,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -245,56 +245,56 @@
-
+
Texture()
-
-
META_StateAttribute(Texture, (Type)(TEXTURE_0+_textureUnit))
+
+
META_StateAttribute(Texture, (Type)(TEXTURE_0+_textureUnit))
-
+
virtual int compare(const StateAttribute& rhs) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
void setImage(Image* image)
- Set the texture image.
-
+
Image* getImage()
- Get the texture image.
-
+
inline const Image* getImage() const
- Get the const texture image.
-
-
void copyTexImage2D(State& state, int x, int y, int width, int height )
+
+
void copyTexImage2D(State& state, int x, int y, int width, int height )
- Copy pixels into a 2D texture imageAs per glCopyTexImage2D.
Creates an OpenGL texture object from the current OpenGL background
framebuffer contents at pos \a x, \a y with width \a width and
height \a height. \a width and \a height must be a power of two.
-
-
void copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height )
+
+
void copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height )
- Copy a two-dimensional texture subimage. As per glCopyTexSubImage2D.
-Updates portion of an exisiting OpenGL texture object from the current OpenGL background
+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.
-
+
inline void setTextureUnit(const unsigned int textureUnit)
- Set the texture unit.
Valid values are 0,1,2,3.
@@ -302,248 +302,252 @@ Default value of texture unit is 0.
note, multi-texturing not fully implemented yet... April 2001.
-
+
inline const unsigned int getTextureUnit() const
- get the texture unit
-
+
enum WrapParameter
-
+
WRAP_S
-
+
WRAP_T
-
+
WRAP_R
-
+
enum WrapMode
-
+
CLAMP
+
+
+
CLAMP_TO_EDGE
+
-
+
REPEAT
-
+
MIRROR
-
-
void setWrap(const WrapParameter which, const WrapMode wrap)
+
+
void setWrap(const WrapParameter which, const WrapMode wrap)
- Set the texture wrap mode
-
-
const WrapMode getWrap(const WrapParameter which) const
+
+
const WrapMode getWrap(const WrapParameter which) const
- Get the texture wrap mode
-
+
enum FilterParameter
-
+
MIN_FILTER
-
+
MAG_FILTER
-
+
enum FilterMode
-
+
LINEAR
-
+
LINEAR_MIPMAP_LINEAR
-
+
LINEAR_MIPMAP_NEAREST
-
+
NEAREST
-
+
NEAREST_MIPMAP_LINEAR
-
+
NEAREST_MIPMAP_NEAREST
-
+
ANISOTROPIC
-
-
void setFilter(const FilterParameter which, const FilterMode filter)
+
+
void setFilter(const FilterParameter which, const FilterMode filter)
- Set the texture filter mode
-
-
const FilterMode getFilter(const FilterParameter which) const
+
+
const FilterMode getFilter(const FilterParameter which) const
- Get the texture filter mode
-
+
enum InternalFormatMode
-
+
USE_IMAGE_DATA_FORMAT
-
+
USE_USER_DEFINED_FORMAT
-
+
USE_ARB_COMPRESSION
-
+
USE_S3TC_DXT1_COMPRESSION
-
+
USE_S3TC_DXT3_COMPRESSION
-
+
USE_S3TC_DXT5_COMPRESSION
-
-
inline void setInternalFormatMode(const InternalFormatMode mode)
+
+
inline void setInternalFormatMode(const InternalFormatMode mode)
- Set the internal format mode.
Note, If the mode is set USE_IMAGE_DATA_FORMAT, USE_ARB_COMPRESSION,
USE_S3TC_COMPRESSION the internalFormat is automatically selected,
and will overwrite the previous _internalFormatValue.
-
-
inline const InternalFormatMode getInternalFormatMode() const
+
+
inline const InternalFormatMode getInternalFormatMode() const
- Get the internal format mode
-
-
inline void setInternalFormatValue(const int internalFormat)
+
+
inline void setInternalFormatValue(const int internalFormat)
- Set the internal format to use when creating OpenGL textures.
Also sets the internalFormatMode to USE_USER_DEFINED_FORMAT.
-
+
inline const int getInternalFormatValue() const
- Get the internal format to use when creating OpenGL textures
-
+
inline const uint getTextureObject(const uint contextID) const
- return the OpenGL texture object for specified context
-
+
inline const uint getTextureObjectSize() const
- return the memory size of texture object.
Texture object size can be used for estimating the cost of
-uploading the texture to graphics hardware, which inturn can
+uploading the texture to graphics hardware, which in turn can
be used for setting texture residence priorities.
-
+
enum SubloadMode
-
+
OFF
-
+
AUTO
-
+
IF_DIRTY
-
-
inline void setSubloadMode(const SubloadMode mode)
+
+
inline void setSubloadMode(const SubloadMode mode)
- Set the texture subload mode.
-
-
inline const SubloadMode getSubloadMode() const
+
+
inline const SubloadMode getSubloadMode() const
- Get the texture subload mode.
-
-
inline void setSubloadOffset(const int x, const int y)
+
+
inline void setSubloadOffset(const int x, const int y)
- Set the texture subload offsets.
-
-
inline void getSubloadOffset(int& x, int& y) const
+
+
inline void getSubloadOffset(int& x, int& y) const
- Get the texture subload offsets.
-
+
inline GLuint& getHandle(const uint contextID) const
- Get the handle to the texture object for the current context
-
+
void dirtyTextureObject()
- Force a recompile on next apply() of associated OpenGL texture objects
-
+
virtual void apply(State& state) const
- On first apply (unless already compiled), create the minmapped
texture and bind it, subsequent apply will simple bind to texture
-
+
virtual void compile(State& state) const
- Compile the texture mip maps. Implemented by simply calling apply().
-
+
virtual void applyImmediateMode(State& state) const
- Method which does the creation of the texture itself, and
does not set or use texture binding.
-
+
static void deleteTextureObject(uint contextID, GLuint handle)
- use deleteTextureObject instead of glDeleteTextures to allow
OpenGL texture objects to cached until they can be deleted
@@ -551,85 +555,85 @@ by the OpenGL context in which they were created, specified
by contextID
-
+
static void flushDeletedTextureObjects(uint contextID)
- flush all the cached display list which need to be deleted
in the OpenGL context related to contextID
-
+
virtual ~Texture()
-
+
typedef std::vector<GLuint> TextureNameList mutable TextureNameList _handleList
-
+
typedef std::vector<uint> ImageModifiedTag mutable ImageModifiedTag _modifiedTag
-
+
mutable uint _textureObjectSize
-
+
mutable ref_ptr<Image> _image
-
+
unsigned int _textureUnit
-
-
WrapMode _wrap_s
+
+
WrapMode _wrap_s
-
-
WrapMode _wrap_t
+
+
WrapMode _wrap_t
-
-
WrapMode _wrap_r
+
+
WrapMode _wrap_r
-
-
FilterMode _min_filter
+
+
FilterMode _min_filter
-
-
FilterMode _mag_filter
+
+
FilterMode _mag_filter
-
-
InternalFormatMode _internalFormatMode
+
+
InternalFormatMode _internalFormatMode
-
+
int _internalFormatValue
-
+
mutable unsigned int _textureWidth
-
+
mutable unsigned int _textureHeight
-
-
SubloadMode _subloadMode
+
+
SubloadMode _subloadMode
-
+
unsigned int _subloadOffsX
-
+
unsigned int _subloadOffsY
-
+
typedef std::map<uint,std::set<uint> >static DeletedTextureObjectCache DeletedTextureObjectCache s_deletedTextureObjectCache
diff --git a/doc/doc++/osg/Timer.html b/doc/doc++/osg/Timer.html
index d457b58d9..b092f4221 100644
--- a/doc/doc++/osg/Timer.html
+++ b/doc/doc++/osg/Timer.html
@@ -13,21 +13,21 @@
Public Methods
-
-
Timer()
+
Timer()
-
-
~Timer()
+
~Timer()
-
-
inline double delta_s( Timer_t t1, Timer_t t2 ) const
+
inline double delta_s( Timer_t t1, Timer_t t2 ) const
-
-
inline double delta_m( Timer_t t1, Timer_t t2 ) const
+
inline double delta_m( Timer_t t1, Timer_t t2 ) const
-
-
inline double delta_u( Timer_t t1, Timer_t t2 ) const
+
inline double delta_u( Timer_t t1, Timer_t t2 ) const
-
-
inline double delta_n( Timer_t t1, Timer_t t2 ) const
+
inline double delta_n( Timer_t t1, Timer_t t2 ) const
-
-
inline Timer_t tick()
+
inline Timer_t tick()
-
-
inline Timer_t tick( void )
+
inline Timer_t tick( void )
@@ -39,35 +39,35 @@
-
+
Timer()
-
+
~Timer()
-
+
inline double delta_s( Timer_t t1, Timer_t t2 ) const
-
+
inline double delta_m( Timer_t t1, Timer_t t2 ) const
-
+
inline double delta_u( Timer_t t1, Timer_t t2 ) const
-
+
inline double delta_n( Timer_t t1, Timer_t t2 ) const
-
+
inline Timer_t tick()
-
+
inline Timer_t tick( void )
diff --git a/doc/doc++/osg/Transform.html b/doc/doc++/osg/Transform.html
index 7a40a1081..74aceeaee 100644
--- a/doc/doc++/osg/Transform.html
+++ b/doc/doc++/osg/Transform.html
@@ -23,37 +23,47 @@
Public Methods
-
-
Transform()
+
Transform()
-
-
Transform(const Matrix& matix)
+
Transform(const Matrix& matix)
-
-
META_Node(Transform)
+
META_Node(Transform)
-
-
void setMatrix(const Matrix& mat )
+
inline void setType(Type type)
+ - Set the Transform Type, which can be DYNAMIC - the Marix value is updated duing the main loop, or STATIC - the Matrix is constant throughut the life of the main loop.
-
-
inline Matrix& getMatrix()
+
inline const Type getType() const
+ - Get the Transform Type
-
-
inline const Matrix& getMatrix() const
+
inline const Matrix& getMatrix() const
-
-
void preMult( const Matrix& mat )
+
inline void setMatrix(const Matrix& mat )
-
-
void preScale( const float sx, const float sy, const float sz )
+
inline void preMult( const Matrix& mat )
+ - preMult trasforms relative to the childrens coordinate system
-
-
void preTranslate( const float tx, const float ty, const float tz )
--
-
void preRotate( const float deg, const float x, const float y, const float z )
+
inline void postMult( const Matrix& mat )
+ - postMult trasforms relative to the parents coordinate system
+
+
+
+Public Members
-
+
enum Type
+ - Range of type that the Transform can be
Protected Fields
-
-
ref_ptr<Matrix> _matrix
+
Type _type
+-
+
ref_ptr<Matrix> _matrix
Protected Methods
-
-
virtual ~Transform()
+
virtual ~Transform()
-
-
virtual const bool computeBound() const
+
virtual const bool computeBound() const
@@ -108,7 +118,7 @@
inline const std::string& getName() const
-
inline const ParentList& getParents() const
+
inline const ParentList& getParents() const
inline Group* getParent(const int i)
@@ -124,23 +134,25 @@
inline const int getNumChildrenRequiringAppTraversal() const
-
inline void setUserData(void* data, MemoryAdapter* ma=0L)
+
void setCullingActive(const bool active)
-
inline void* getUserData()
+
inline const bool getCullingActive() const
-
inline const void* getUserData() const
+
inline const int getNumChildrenWithCullingDisabled() const
-
inline MemoryAdapter* getMemoryAdapter()
+
inline void setUserData(osg::Referenced* obj)
-
inline const MemoryAdapter* getMemoryAdapter() const
+
inline Referenced* getUserData()
+
+
inline const Referenced* getUserData() const
inline void setNodeMask(const NodeMask nm)
inline const NodeMask getNodeMask() const
-
inline const DescriptionList& getDescriptions() const
+
inline const DescriptionList& getDescriptions() const
-
inline DescriptionList& getDescriptions()
+
inline DescriptionList& getDescriptions()
inline const std::string& getDescription(const int i) const
@@ -176,19 +188,21 @@
std::string _name
-
ParentList _parents
+
ParentList _parents
ref_ptr<NodeCallback> _appCallback
int _numChildrenRequiringAppTraversal
-
void* _userData
+
bool _cullingActive
-
ref_ptr<MemoryAdapter> _memoryAdapter
+
int _numChildrenWithCullingDisabled
+
+
osg::ref_ptr<Referenced> _userData
NodeMask _nodeMask
-
DescriptionList _descriptions
+
DescriptionList _descriptions
ref_ptr<StateSet> _dstate
@@ -196,6 +210,8 @@
Protected Methods
-
void setNumChildrenRequiringAppTraversal(const int num)
+-
+
void setNumChildrenWithCullingDisabled(const int num)
@@ -228,59 +244,84 @@
Transform - is group which all children
are transformed by the the Transform's osg::Matrix. Typical uses
of the Transform is for positioning objects within a scene or
-producing trakerball functionality or for animatiion.
+producing trakerball functionality or for animation.
-
+
Transform()
-
+
Transform(const Matrix& matix)
-
+
META_Node(Transform)
-
-
-
void setMatrix(const Matrix& mat )
+
+
+
enum Type
+- Range of type that the Transform can be
+
+
+
+
+
DYNAMIC
+
+
+
+
STATIC
+
+
+
+
+
inline void setType(Type type)
+- Set the Transform Type, which can be DYNAMIC - the Marix
+value is updated duing the main loop, or STATIC - the Matrix
+is constant throughut the life of the main loop. STATIC
+Transforms can be optimized away is some instances, which
+can improve performanc so unless you plan to modify the
+Matrix explicity set the Matrix to STATIC. The default
+value is DYNAMIC.
+
+
+
+
inline const Type getType() const
+- Get the Transform Type
-
-
inline Matrix& getMatrix()
-
-
-
+
inline const Matrix& getMatrix() const
+
+
+
inline void setMatrix(const Matrix& mat )
+
-
-
void preMult( const Matrix& mat )
+
+
inline void preMult( const Matrix& mat )
+- preMult trasforms relative to the childrens coordinate system
-
-
-
void preScale( const float sx, const float sy, const float sz )
-
-
-
-
void preTranslate( const float tx, const float ty, const float tz )
-
-
-
-
void preRotate( const float deg, const float x, const float y, const float z )
+
+
+
inline void postMult( const Matrix& mat )
+- postMult trasforms relative to the parents coordinate system
-
+
virtual ~Transform()
-
+
virtual const bool computeBound() const
+
+
+
Type _type
+
-
+
ref_ptr<Matrix> _matrix
diff --git a/doc/doc++/osg/Transparency.html b/doc/doc++/osg/Transparency.html
index 116a7e24b..ea7008ebc 100644
--- a/doc/doc++/osg/Transparency.html
+++ b/doc/doc++/osg/Transparency.html
@@ -7,7 +7,7 @@
-Transparancy - encapsulates the OpenGL transparancy state
+Transparency - encapsulates the OpenGL blend/transparency state
Inheritance:
@@ -23,43 +23,43 @@
Public Methods
-
-
Transparency()
+
Transparency()
-
-
META_StateAttribute(Transparency, TRANSPARENCY)
+
META_StateAttribute(Transparency, TRANSPARENCY)
-
-
virtual int compare(const StateAttribute& sa) const
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
-
inline void setFunction( const int source, const int destination )
+
inline void setFunction( const int source, const int destination )
-
-
void setSource(const int source)
+
void setSource(const int source)
-
-
inline const int getSource() const
+
inline const int getSource() const
-
-
void setDestination(const int destination)
+
void setDestination(const int destination)
-
-
inline const int getDestination() const
+
inline const int getDestination() const
-
-
virtual void apply(State& state) const
+
virtual void apply(State& state) const
Public Members
-
-
enum TransparencyMode
+
enum TransparencyMode
Protected Fields
-
-
int _source_factor
+
int _source_factor
-
-
int _destination_factor
+
int _destination_factor
Protected Methods
-
-
virtual ~Transparency()
+
virtual ~Transparency()
@@ -73,7 +73,7 @@
virtual const char* className() const
-
virtual const Type getType() const
+
virtual const Type getType() const
bool operator < (const StateAttribute& rhs) const
@@ -126,110 +126,110 @@
Documentation
-Transparancy - encapsulates the OpenGL transparancy state
+Transparency - encapsulates the OpenGL blend/transparency state
-
+
Transparency()
-
-
META_StateAttribute(Transparency, TRANSPARENCY)
+
+
META_StateAttribute(Transparency, TRANSPARENCY)
-
+
virtual int compare(const StateAttribute& sa) const
- return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
-
-
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
+
+
virtual void setStateSetModes(StateSet& ds, const GLModeValue value) const
-
+
enum TransparencyMode
-
+
DST_ALPHA
-
+
DST_COLOR
-
+
ONE
-
+
ONE_MINUS_DST_ALPHA
-
+
ONE_MINUS_DST_COLOR
-
+
ONE_MINUS_SRC_ALPHA
-
+
ONE_MINUS_SRC_COLOR
-
+
SRC_ALPHA
-
+
SRC_ALPHA_SATURATE
-
+
SRC_COLOR
-
+
ZERO
-
+
inline void setFunction( const int source, const int destination )
-
+
void setSource(const int source)
-
+
inline const int getSource() const
-
+
void setDestination(const int destination)
-
+
inline const int getDestination() const
-
+
virtual void apply(State& state) const
-
+
virtual ~Transparency()
-
+
int _source_factor
-
+
int _destination_factor
diff --git a/doc/doc++/osg/Vec2.html b/doc/doc++/osg/Vec2.html
index c8d7ce624..4852caa2d 100644
--- a/doc/doc++/osg/Vec2.html
+++ b/doc/doc++/osg/Vec2.html
@@ -13,74 +13,82 @@
Public Fields
-
-
float _v[2]
+
float _v[2]
Public Methods
-
-
Vec2()
+
Vec2()
-
-
Vec2(float x, float y)
+
Vec2(float x, float y)
-
-
const bool operator == (const Vec2& v) const
+
inline const bool operator == (const Vec2& v) const
-
-
const bool operator < (const Vec2& v) const
+
inline const bool operator != (const Vec2& v) const
-
-
inline float* ptr()
+
inline const bool operator < (const Vec2& v) const
-
-
inline const float* ptr() const
+
inline float* ptr()
-
-
inline void set( float x, float y )
+
inline const float* ptr() const
-
-
inline float& operator [] (int i)
+
inline void set( float x, float y )
-
-
inline const float operator [] (int i) const
+
inline float& operator [] (int i)
-
-
inline float& x()
+
inline const float operator [] (int i) const
-
-
inline float& y()
+
inline float& x()
-
-
inline const float x() const
+
inline float& y()
-
-
inline const float y() const
+
inline const float x() const
-
-
inline const float operator * (const Vec2& rhs) const
+
inline const float y() const
+-
+
inline const bool valid() const
+-
+
inline const bool isNaN() const
+-
+
inline const bool isInfinite() const
+-
+
inline const float operator * (const Vec2& rhs) const
- dot product
-
-
inline const Vec2 operator * (const float& rhs) const
+
inline const Vec2 operator * (const float& rhs) const
- multiply by scalar
-
-
inline Vec2& operator *= (const float& rhs)
+
inline Vec2& operator *= (const float& rhs)
- unary multiply by scalar
-
-
inline const Vec2 operator / (const float& rhs) const
+
inline const Vec2 operator / (const float& rhs) const
- divide by scalar
-
-
inline Vec2& operator /= (const float& rhs)
+
inline Vec2& operator /= (const float& rhs)
- unary divide by scalar
-
-
inline const Vec2 operator + (const Vec2& rhs) const
+
inline const Vec2 operator + (const Vec2& rhs) const
- binary vector add
-
-
inline Vec2& operator += (const Vec2& rhs)
+
inline Vec2& operator += (const Vec2& rhs)
- unary vector add.
-
-
inline const Vec2 operator - (const Vec2& rhs) const
- - binary vector subract
+
inline const Vec2 operator - (const Vec2& rhs) const
+- binary vector subtract
-
-
inline Vec2& operator -= (const Vec2& rhs)
- - unary vector subract
+
inline Vec2& operator -= (const Vec2& rhs)
+- unary vector subtract
-
-
inline const Vec2 operator - () const
+
inline const Vec2 operator - () const
- negation operator.
-
-
inline const float length() const
+
inline const float length() const
- Length of the vector = sqrt( vec .
-
-
inline const float length2( void ) const
+
inline const float length2( void ) const
- Length squared of the vector = vec .
-
-
inline const float normalize()
+
inline const float normalize()
- normalize the vector so that it has length unity returns the previous length of the vector
@@ -97,124 +105,140 @@ BTW: Vec2 * float is okay
-
+
Vec2()
-
-
Vec2(float x, float y)
+
+
Vec2(float x, float y)
-
+
float _v[2]
-
-
const bool operator == (const Vec2& v) const
+
+
inline const bool operator == (const Vec2& v) const
+
+
+
+
inline const bool operator != (const Vec2& v) const
-
-
const bool operator < (const Vec2& v) const
+
+
inline const bool operator < (const Vec2& v) const
-
+
inline float* ptr()
-
+
inline const float* ptr() const
-
-
inline void set( float x, float y )
+
+
inline void set( float x, float y )
-
+
inline float& operator [] (int i)
-
+
inline const float operator [] (int i) const
-
+
inline float& x()
-
+
inline float& y()
-
+
inline const float x() const
-
+
inline const float y() const
+
+
+
inline const bool valid() const
+
+
+
+
inline const bool isNaN() const
+
+
+
+
inline const bool isInfinite() const
+
-
+
inline const float operator * (const Vec2& rhs) const
- dot product
-
+
inline const Vec2 operator * (const float& rhs) const
- multiply by scalar
-
+
inline Vec2& operator *= (const float& rhs)
- unary multiply by scalar
-
+
inline const Vec2 operator / (const float& rhs) const
- divide by scalar
-
+
inline Vec2& operator /= (const float& rhs)
- unary divide by scalar
-
+
inline const Vec2 operator + (const Vec2& rhs) const
- binary vector add
-
+
inline Vec2& operator += (const Vec2& rhs)
- unary vector add. Slightly more efficient because no temporary
intermediate object.
-
+
inline const Vec2 operator - (const Vec2& rhs) const
-- binary vector subract
+
- binary vector subtract
-
+
inline Vec2& operator -= (const Vec2& rhs)
-- unary vector subract
+
- unary vector subtract
-
+
inline const Vec2 operator - () const
- negation operator. Returns the negative of the Vec2
-
+
inline const float length() const
- Length of the vector = sqrt( vec . vec )
-
+
inline const float length2( void ) const
- Length squared of the vector = vec . vec
-
+
inline const float normalize()
- normalize the vector so that it has length unity
returns the previous length of the vector
@@ -222,7 +246,7 @@ returns the previous length of the vector
- This class has no child classes.
-- Friends:
- inline ostream& operator << (ostream& output, const Vec2& vec)
Alphabetic index HTML hierarchy of classes or Java
+- Friends:
- inline std::ostream& operator << (std::ostream& output, const Vec2& vec)
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.
diff --git a/doc/doc++/osg/Vec3.html b/doc/doc++/osg/Vec3.html
index 35e2c6057..700bba6f5 100644
--- a/doc/doc++/osg/Vec3.html
+++ b/doc/doc++/osg/Vec3.html
@@ -13,81 +13,89 @@
Public Fields
-
-
float _v[3]
+
float _v[3]
Public Methods
-
-
Vec3()
+
Vec3()
-
-
Vec3(float x, float y, float z)
+
Vec3(float x, float y, float z)
-
-
inline const bool operator == (const Vec3& v) const
+
inline const bool operator == (const Vec3& v) const
-
-
inline const bool operator < (const Vec3& v) const
+
inline const bool operator != (const Vec3& v) const
-
-
inline float* ptr()
+
inline const bool operator < (const Vec3& v) const
-
-
inline const float* ptr() const
+
inline float* ptr()
-
-
inline void set( float x, float y, float z)
+
inline const float* ptr() const
-
-
inline float& operator [] (int i)
+
inline void set( float x, float y, float z)
-
-
inline const float operator [] (int i) const
+
inline float& operator [] (int i)
-
-
inline float& x()
+
inline const float operator [] (int i) const
-
-
inline float& y()
+
inline float& x()
-
-
inline float& z()
+
inline float& y()
-
-
inline const float x() const
+
inline float& z()
-
-
inline const float y() const
+
inline const float x() const
-
-
inline const float z() const
+
inline const float y() const
-
-
inline float operator * (const Vec3& rhs) const
+
inline const float z() const
+-
+
inline const bool valid() const
+-
+
inline const bool isNaN() const
+-
+
inline const bool isInfinite() const
+-
+
inline float operator * (const Vec3& rhs) const
- dot product
-
-
inline const Vec3 operator ^ (const Vec3& rhs) const
+
inline const Vec3 operator ^ (const Vec3& rhs) const
- cross product
-
-
inline const Vec3 operator * (const float& rhs) const
+
inline const Vec3 operator * (const float& rhs) const
- multiply by scalar
-
-
inline Vec3& operator *= (const float& rhs)
+
inline Vec3& operator *= (const float& rhs)
- unary multiply by scalar
-
-
inline const Vec3 operator / (const float& rhs) const
+
inline const Vec3 operator / (const float& rhs) const
- divide by scalar
-
-
inline Vec3& operator /= (const float& rhs)
+
inline Vec3& operator /= (const float& rhs)
- unary divide by scalar
-
-
inline const Vec3 operator + (const Vec3& rhs) const
+
inline const Vec3 operator + (const Vec3& rhs) const
- binary vector add
-
-
inline Vec3& operator += (const Vec3& rhs)
+
inline Vec3& operator += (const Vec3& rhs)
- unary vector add.
-
-
inline const Vec3 operator - (const Vec3& rhs) const
- - binary vector subract
+
inline const Vec3 operator - (const Vec3& rhs) const
+- binary vector subtract
-
-
inline Vec3& operator -= (const Vec3& rhs)
- - unary vector subract
+
inline Vec3& operator -= (const Vec3& rhs)
+- unary vector subtract
-
-
inline const Vec3 operator - () const
+
inline const Vec3 operator - () const
- negation operator.
-
-
inline const float length() const
+
inline const float length() const
- Length of the vector = sqrt( vec .
-
-
inline const float length2() const
+
inline const float length2() const
- Length squared of the vector = vec .
-
-
inline const float normalize()
+
inline const float normalize()
- normalize the vector so that it has length unity returns the previous length of the vector
@@ -104,137 +112,153 @@ Vec3 * float is okay
-
+
Vec3()
-
-
Vec3(float x, float y, float z)
+
+
Vec3(float x, float y, float z)
-
+
float _v[3]
-
+
inline const bool operator == (const Vec3& v) const
+
+
+
inline const bool operator != (const Vec3& v) const
+
-
+
inline const bool operator < (const Vec3& v) const
-
+
inline float* ptr()
-
+
inline const float* ptr() const
-
-
inline void set( float x, float y, float z)
+
+
inline void set( float x, float y, float z)
-
+
inline float& operator [] (int i)
-
+
inline const float operator [] (int i) const
-
+
inline float& x()
-
+
inline float& y()
-
+
inline float& z()
-
+
inline const float x() const
-
+
inline const float y() const
-
+
inline const float z() const
+
+
+
inline const bool valid() const
+
+
+
+
inline const bool isNaN() const
+
+
+
+
inline const bool isInfinite() const
+
-
+
inline float operator * (const Vec3& rhs) const
- dot product
-
+
inline const Vec3 operator ^ (const Vec3& rhs) const
- cross product
-
+
inline const Vec3 operator * (const float& rhs) const
- multiply by scalar
-
+
inline Vec3& operator *= (const float& rhs)
- unary multiply by scalar
-
+
inline const Vec3 operator / (const float& rhs) const
- divide by scalar
-
+
inline Vec3& operator /= (const float& rhs)
- unary divide by scalar
-
+
inline const Vec3 operator + (const Vec3& rhs) const
- binary vector add
-
+
inline Vec3& operator += (const Vec3& rhs)
- unary vector add. Slightly more efficient because no temporary
intermediate object
-
+
inline const Vec3 operator - (const Vec3& rhs) const
-- binary vector subract
+
- binary vector subtract
-
+
inline Vec3& operator -= (const Vec3& rhs)
-- unary vector subract
+
- unary vector subtract
-
+
inline const Vec3 operator - () const
- negation operator. Returns the negative of the Vec3
-
+
inline const float length() const
- Length of the vector = sqrt( vec . vec )
-
+
inline const float length2() const
- Length squared of the vector = vec . vec
-
+
inline const float normalize()
- normalize the vector so that it has length unity
returns the previous length of the vector
@@ -242,7 +266,7 @@ returns the previous length of the vector
- This class has no child classes.
-- Friends:
- inline ostream& operator << (ostream& output, const Vec3& vec)
Alphabetic index HTML hierarchy of classes or Java
+- Friends:
- inline std::ostream& operator << (std::ostream& output, const Vec3& vec)
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.