Made spelling corrections, the spelling mistakes picked up by a script
written by Neil Salter. script
This commit is contained in:
parent
ef3217cfde
commit
7359d33d53
@ -7,7 +7,7 @@ namespace osg {
|
||||
|
||||
|
||||
/** if value is greater than or equal to minValue do nothing - legal value,
|
||||
* otherise clamp value to specified maximum value and return warning
|
||||
* otherwise clamp value to specified maximum value and return warning
|
||||
* with valueName specifying which variable was clamped.*/
|
||||
template <class T>
|
||||
inline void clampGEQUAL(T& value,const T minValue,const char* valueName)
|
||||
@ -20,7 +20,7 @@ inline void clampGEQUAL(T& value,const T minValue,const char* valueName)
|
||||
}
|
||||
|
||||
/** if value is less than or equal to maxValue do nothing - legal value,
|
||||
* otherise clamp value to specified maximum value and return warning
|
||||
* otherwise clamp value to specified maximum value and return warning
|
||||
* with valueName specifying which variable was clamped.*/
|
||||
template <class T>
|
||||
inline void clampLEQUAL(T& value,const T maxValue,const char* valueName)
|
||||
@ -33,7 +33,7 @@ inline void clampLEQUAL(T& value,const T maxValue,const char* valueName)
|
||||
}
|
||||
|
||||
/** if value is between or equal to minValue and maxValue do nothing - legal value,
|
||||
* otherise clamp value to specified to range and return warning
|
||||
* otherwise clamp value to specified to range and return warning
|
||||
* with valueName specifying which variable was clamped. Equivilant to
|
||||
* calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName); */
|
||||
template <class T>
|
||||
@ -54,7 +54,7 @@ inline void clampBetweenRange(T& value,const T minValue,const T maxValue,const c
|
||||
}
|
||||
|
||||
/** if array element value[i] is greater than or equal to minValue do nothing - legal value,
|
||||
* otherise clamp value to specified maximum value and return warning
|
||||
* otherwise clamp value to specified maximum value and return warning
|
||||
* with valueName specifying which variable was clamped.*/
|
||||
template <class A, class T>
|
||||
inline void clampArrayElementGEQUAL(A& value,const unsigned int i,const T minValue,const char* valueName)
|
||||
@ -67,7 +67,7 @@ inline void clampArrayElementGEQUAL(A& value,const unsigned int i,const T minVal
|
||||
}
|
||||
|
||||
/** if array element value[i] is less than or equal to maxValue do nothing - legal value,
|
||||
* otherise clamp value to specified maximum value and return warning
|
||||
* otherwise clamp value to specified maximum value and return warning
|
||||
* with valueName specifying which variable was clamped.*/
|
||||
template <class A, class T>
|
||||
inline void clampArrayElementLEQUAL(A& value,const unsigned int i,const T maxValue,const char* valueName)
|
||||
@ -80,7 +80,7 @@ inline void clampArrayElementLEQUAL(A& value,const unsigned int i,const T maxVal
|
||||
}
|
||||
|
||||
/** if array element value[i] is between or equal to minValue and maxValue do nothing - legal value,
|
||||
* otherise clamp value to specified to range and return warning
|
||||
* otherwise clamp value to specified to range and return warning
|
||||
* with valueName specifying which variable was clamped. Equivilant to
|
||||
* calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName); */
|
||||
template <class A, class T>
|
||||
@ -101,7 +101,7 @@ inline void clampArrayElementBetweenRange(A& value,const unsigned int i,const T
|
||||
}
|
||||
|
||||
/** if array elements are greater than or equal to minValue do nothing - legal value,
|
||||
* otherise clamp value to specified maximum value and return warning
|
||||
* otherwise clamp value to specified maximum value and return warning
|
||||
* with valueName specifying which variable was clamped.*/
|
||||
template <class A, class T>
|
||||
inline void clampArrayElementsGEQUAL(A& value,const unsigned int first,const unsigned int last,const T minValue,const char* valueName)
|
||||
@ -111,7 +111,7 @@ inline void clampArrayElementsGEQUAL(A& value,const unsigned int first,const uns
|
||||
}
|
||||
|
||||
/** if array elements are less than or equal to maxValue do nothing - legal value,
|
||||
* otherise clamp value to specified maximum value and return warning
|
||||
* otherwise clamp value to specified maximum value and return warning
|
||||
* with valueName specifying which variable was clamped.*/
|
||||
template <class A, class T>
|
||||
inline void clampArrayElementsLEQUAL(A& value,const unsigned int first,const unsigned int last,const T maxValue,const char* valueName)
|
||||
@ -121,8 +121,8 @@ inline void clampArrayElementsLEQUAL(A& value,const unsigned int first,const uns
|
||||
}
|
||||
|
||||
/** if array elements are between or equal to minValue and maxValue do nothing - legal value,
|
||||
* otherise clamp value to specified to range and return warning
|
||||
* with valueName specifying which variable was clamped. Equivilant to
|
||||
* otherwise clamp value to specified to range and return warning
|
||||
* with valueName specifying which variable was clamped. Equivalent to
|
||||
* calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName); */
|
||||
template <class A, class T>
|
||||
inline void clampArrayElementsBetweenRange(A& value,const unsigned int first,const unsigned int last,const T minValue,const T maxValue,const char* valueName)
|
||||
@ -133,7 +133,7 @@ inline void clampArrayElementsBetweenRange(A& value,const unsigned int first,con
|
||||
|
||||
|
||||
/** if array4 elements are greater than or equal to minValue do nothing - legal value,
|
||||
* otherise clamp value to specified maximum value and return warning
|
||||
* otherwise clamp value to specified maximum value and return warning
|
||||
* with valueName specifying which variable was clamped.*/
|
||||
template <class A, class T>
|
||||
inline void clampArray3GEQUAL(A& value,const T minValue,const char* valueName)
|
||||
@ -142,7 +142,7 @@ inline void clampArray3GEQUAL(A& value,const T minValue,const char* valueName)
|
||||
}
|
||||
|
||||
/** if array4 elements are is less than or equal to maxValue do nothing - legal value,
|
||||
* otherise clamp value to specified maximum value and return warning
|
||||
* otherwise clamp value to specified maximum value and return warning
|
||||
* with valueName specifying which variable was clamped.*/
|
||||
template <class A, class T>
|
||||
inline void clampArray3LEQUAL(A& value,const T maxValue,const char* valueName)
|
||||
@ -151,7 +151,7 @@ inline void clampArray3LEQUAL(A& value,const T maxValue,const char* valueName)
|
||||
}
|
||||
|
||||
/** if array4 elements are between or equal to minValue and maxValue do nothing - legal value,
|
||||
* otherise clamp value to specified to range and return warning
|
||||
* otherwise clamp value to specified to range and return warning
|
||||
* with valueName specifying which variable was clamped. Equivilant to
|
||||
* calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName); */
|
||||
template <class A, class T>
|
||||
@ -163,7 +163,7 @@ inline void clampArray3BetweenRange(A& value,const T minValue,const T maxValue,c
|
||||
|
||||
|
||||
/** if array4 elements are greater than or equal to minValue do nothing - legal value,
|
||||
* otherise clamp value to specified maximum value and return warning
|
||||
* otherwise clamp value to specified maximum value and return warning
|
||||
* with valueName specifying which variable was clamped.*/
|
||||
template <class A, class T>
|
||||
inline void clampArray4GEQUAL(A& value,const T minValue,const char* valueName)
|
||||
@ -172,7 +172,7 @@ inline void clampArray4GEQUAL(A& value,const T minValue,const char* valueName)
|
||||
}
|
||||
|
||||
/** if array4 elements are is less than or equal to maxValue do nothing - legal value,
|
||||
* otherise clamp value to specified maximum value and return warning
|
||||
* otherwise clamp value to specified maximum value and return warning
|
||||
* with valueName specifying which variable was clamped.*/
|
||||
template <class A, class T>
|
||||
inline void clampArray4LEQUAL(A& value,const unsigned int first,const unsigned int last,const T maxValue,const char* valueName)
|
||||
@ -181,7 +181,7 @@ inline void clampArray4LEQUAL(A& value,const unsigned int first,const unsigned i
|
||||
}
|
||||
|
||||
/** if array4 elements are between or equal to minValue and maxValue do nothing - legal value,
|
||||
* otherise clamp value to specified to range and return warning
|
||||
* otherwise clamp value to specified to range and return warning
|
||||
* with valueName specifying which variable was clamped. Equivilant to
|
||||
* calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName); */
|
||||
template <class A, class T>
|
||||
|
@ -7,7 +7,7 @@
|
||||
|
||||
namespace osg {
|
||||
|
||||
/** A ClippingVolume class for represecting convex clipping volumes made up.*/
|
||||
/** A ClippingVolume class for representing convex clipping volumes made up.*/
|
||||
class SG_EXPORT ClippingVolume
|
||||
{
|
||||
|
||||
@ -69,7 +69,7 @@ class SG_EXPORT ClippingVolume
|
||||
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.*/
|
||||
inline const bool contains(const osg::BoundingSphere& bs,unsigned int& mask) const
|
||||
{
|
||||
if (!(mask & _localMask)) return true;
|
||||
@ -106,7 +106,7 @@ class SG_EXPORT ClippingVolume
|
||||
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.*/
|
||||
inline const bool contains(const osg::BoundingBox& bb,unsigned int& mask) const
|
||||
{
|
||||
if (!(mask & _localMask)) return true;
|
||||
|
@ -7,7 +7,7 @@
|
||||
|
||||
namespace osg {
|
||||
|
||||
/** Encapsulte OpenGL glColorMaskFunc/Op/Mask functions.
|
||||
/** Encapsulate OpenGL glColorMaskFunc/Op/Mask functions.
|
||||
*/
|
||||
class SG_EXPORT ColorMask : public StateAttribute
|
||||
{
|
||||
|
@ -7,7 +7,7 @@
|
||||
|
||||
namespace osg {
|
||||
|
||||
/** Encapsulte OpenGL glDepthFunc/Mask/Range functions.
|
||||
/** Encapsulate OpenGL glDepthFunc/Mask/Range functions.
|
||||
*/
|
||||
class SG_EXPORT Depth : public StateAttribute
|
||||
{
|
||||
|
@ -27,7 +27,7 @@ namespace osg {
|
||||
* 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
|
||||
@ -62,10 +62,10 @@ class SG_EXPORT Impostor : public LOD
|
||||
* sphere's radius.*/
|
||||
inline void setImpostorThresholdToBound(float ratio=1.0f) { _impostorThreshold = getBound().radius()*ratio; }
|
||||
|
||||
/* Get the Impostor threshold disntance.*/
|
||||
/* Get the Impostor threshold distance.*/
|
||||
inline const float getImpostorThreshold() const { return _impostorThreshold; }
|
||||
|
||||
/* Get the Impostor threshold disntance squared.*/
|
||||
/* Get the Impostor threshold distance squared.*/
|
||||
inline const float getImpostorThreshold2() const { return _impostorThreshold*_impostorThreshold; }
|
||||
|
||||
/** Find the ImposterSprite which fits the current eye point best.*/
|
||||
|
@ -18,7 +18,7 @@ class ImpostorSpriteManager;
|
||||
/** 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.
|
||||
*/
|
||||
class SG_EXPORT ImpostorSprite : public Drawable
|
||||
@ -75,15 +75,15 @@ class SG_EXPORT ImpostorSprite : public Drawable
|
||||
inline const Vec2* getTexCoords() const { return _texcoords; }
|
||||
|
||||
/** 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 Vec3* getControlCoords() { return _controlcoords; }
|
||||
|
@ -89,12 +89,12 @@ class SG_EXPORT Material : public StateAttribute
|
||||
/** Get the whether specular values are equal for front and back faces.*/
|
||||
inline const bool getSpecularFrontAndBack() const { return _specularFrontAndBack; }
|
||||
|
||||
/** Set emmision value of specified face(s) of the material,
|
||||
/** Set emission value of specified face(s) of the material,
|
||||
* valid emmison[0..3] range is 0.0 to 1.0.*/
|
||||
void setEmission( const Face face, const Vec4& emission );
|
||||
/** Get the emmsion value for specified face.*/
|
||||
const Vec4& getEmission(const Face face) 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.*/
|
||||
inline const bool getEmissionFrontAndBack() const { return _emissionFrontAndBack; }
|
||||
|
||||
/** Set shininess of specified face(s) of the material, valid shininess range is 0.0 to 1.0.*/
|
||||
@ -104,12 +104,12 @@ class SG_EXPORT Material : public StateAttribute
|
||||
/** Get the whether shininess values are equal for front and back faces.*/
|
||||
inline const bool getShininessFrontAndBack() const { return _shininessFrontAndBack; }
|
||||
|
||||
/** 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.*/
|
||||
/** 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 setTransparency(const Face face,float trans);
|
||||
|
||||
/** Set the alpha value of ambient,diffuse,specular and emmission colors.
|
||||
* Valid transparancy range is 0.0 to 1.0.*/
|
||||
/** Set the alpha value of ambient,diffuse,specular and emission colors.
|
||||
* Valid transparency range is 0.0 to 1.0.*/
|
||||
void setAlpha(const Face face,float alpha);
|
||||
|
||||
protected :
|
||||
|
@ -21,7 +21,7 @@ class SG_EXPORT MemoryAdapter : public Referenced
|
||||
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 unref_data(void* /*userData*/) = 0;
|
||||
|
||||
/** not current used, but will be used in future.*/
|
||||
|
@ -102,7 +102,7 @@ class SG_EXPORT Node : public Object
|
||||
inline const int getNumChildrenRequiringAppTraversal() const { return _numChildrenRequiringAppTraversal; }
|
||||
|
||||
/**
|
||||
* Set user data. See MemoryAdapter documention for details
|
||||
* Set user data. See MemoryAdapter documentation for details
|
||||
* of how to specify memory management of _userData.
|
||||
*/
|
||||
inline void setUserData(void* data,MemoryAdapter* ma=0L)
|
||||
|
@ -34,7 +34,7 @@ class SG_EXPORT NodeVisitor : public Referenced
|
||||
virtual ~NodeVisitor();
|
||||
|
||||
/** 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.*/
|
||||
virtual void reset() {}
|
||||
@ -99,7 +99,7 @@ class SG_EXPORT NodeVisitor : public Referenced
|
||||
inline const TraversalMode getTraversalMode() const { return _traversalMode; }
|
||||
|
||||
/** Set a visitor to handle traversal.
|
||||
Overides the traverse mode setting it to TRAVERSAL_VISITOR.*/
|
||||
Overrides the traverse mode setting it to TRAVERSAL_VISITOR.*/
|
||||
void setTraversalVisitor(NodeVisitor* nv);
|
||||
|
||||
/** Get the traversal visitor, returns NULL if none is attached.*/
|
||||
@ -144,7 +144,7 @@ class SG_EXPORT NodeVisitor : public Referenced
|
||||
};
|
||||
|
||||
|
||||
/** Convinience functor for assisting visiting of arrays of osg::Node's.*/
|
||||
/** Convenience functor for assisting visiting of arrays of osg::Node's.*/
|
||||
struct NodeAcceptOp
|
||||
{
|
||||
NodeVisitor& _nv;
|
||||
|
@ -24,7 +24,7 @@ class SG_EXPORT Object : public Referenced
|
||||
public:
|
||||
/** 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.*/
|
||||
Object() {}
|
||||
|
||||
@ -41,7 +41,7 @@ class SG_EXPORT Object : public Referenced
|
||||
protected:
|
||||
|
||||
/** 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,
|
||||
|
@ -83,7 +83,7 @@ class SG_EXPORT Plane
|
||||
_fv[3];
|
||||
}
|
||||
|
||||
/** 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.*/
|
||||
@ -97,7 +97,7 @@ class SG_EXPORT Plane
|
||||
}
|
||||
|
||||
|
||||
/** 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.*/
|
||||
|
@ -7,7 +7,7 @@
|
||||
|
||||
namespace osg {
|
||||
|
||||
/** Point - encapsulates the OpenGL point smmothing and size state.*/
|
||||
/** Point - encapsulates the OpenGL point smoothing and size state.*/
|
||||
class SG_EXPORT Point : public StateAttribute
|
||||
{
|
||||
public :
|
||||
|
@ -21,7 +21,7 @@ class SG_EXPORT Quat
|
||||
In other words, osg:Quat is composed of an osg::Vec4
|
||||
The osg::Quat aggregates an osg::Vec4
|
||||
|
||||
These seem to be different jargons for the same thing :-)
|
||||
These seem to be different jargon for the same thing :-)
|
||||
---------------------------------------------------------- */
|
||||
Vec4 _fv; // a four-vector
|
||||
|
||||
@ -191,7 +191,7 @@ class SG_EXPORT Quat
|
||||
angle around the axis given by the vector (x,y,z).
|
||||
Should be written to also accept an angle and a Vec3?
|
||||
|
||||
Define Spherical Linear intERPolation method also
|
||||
Define Spherical Linear interpolation method also
|
||||
|
||||
Not inlined - see the Quat.cpp file for implementation
|
||||
-------------------------------------------------------- */
|
||||
|
@ -21,8 +21,8 @@ class SG_EXPORT Referenced
|
||||
inline void ref() const { ++_refCount; }
|
||||
/** 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 void unref() const { --_refCount; if (_refCount<=0) delete this; }
|
||||
/** return the number pointers currently referencing this object. */
|
||||
inline const int referenceCount() const { return _refCount; }
|
||||
|
@ -26,7 +26,7 @@ namespace osg {
|
||||
}
|
||||
|
||||
/** 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.
|
||||
*/
|
||||
class SG_EXPORT State : public Referenced
|
||||
{
|
||||
@ -74,7 +74,7 @@ class SG_EXPORT State : public Referenced
|
||||
|
||||
|
||||
/** 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
|
||||
|
@ -40,7 +40,7 @@ class StateSet;
|
||||
if (parameter<rhs.parameter) return -1; \
|
||||
if (rhs.parameter<parameter) return 1;
|
||||
|
||||
/** Base class for state attribues.
|
||||
/** Base class for state attribuets.
|
||||
*/
|
||||
class SG_EXPORT StateAttribute : public Object
|
||||
{
|
||||
@ -49,7 +49,7 @@ class SG_EXPORT StateAttribute : public Object
|
||||
/** GLMode is the value used in glEnable/glDisable(mode) */
|
||||
typedef GLenum GLMode;
|
||||
/** 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 GLModeValue;
|
||||
/** Override is used to specified the override behavior of StateAttributes
|
||||
@ -58,7 +58,7 @@ class SG_EXPORT StateAttribute : public Object
|
||||
typedef unsigned int OverrideValue;
|
||||
|
||||
/** 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
|
||||
@ -84,7 +84,7 @@ class SG_EXPORT StateAttribute : public Object
|
||||
typedef unsigned int Type;
|
||||
|
||||
/** 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
|
||||
@ -145,7 +145,7 @@ class SG_EXPORT StateAttribute : public Object
|
||||
/** return the name of the attribute's class type.*/
|
||||
virtual const char* className() const { return "StateAttribute"; }
|
||||
|
||||
/** return the Type idenitifer of the attribute's class type.*/
|
||||
/** return the Type identifier of the attribute's class type.*/
|
||||
virtual const Type getType() const = 0;
|
||||
|
||||
/** return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.*/
|
||||
@ -158,7 +158,7 @@ class SG_EXPORT StateAttribute : public Object
|
||||
|
||||
virtual void setStateSetModes(StateSet&,const GLModeValue) const
|
||||
{
|
||||
// default to no GLMode's assocated with use of the StateAttribute.
|
||||
// default to no GLMode's associated with use of the StateAttribute.
|
||||
}
|
||||
|
||||
/** apply the OpenGL state attributes.
|
||||
|
@ -13,7 +13,7 @@ namespace osg {
|
||||
|
||||
/**
|
||||
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.
|
||||
@ -32,7 +32,7 @@ class SG_EXPORT StateSet : public Object
|
||||
complete state, typically used for a default global state.*/
|
||||
void setGlobalDefaults();
|
||||
|
||||
/** 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 setAllToInherit();
|
||||
|
||||
@ -63,7 +63,7 @@ class SG_EXPORT StateSet : public Object
|
||||
|
||||
/** set this StateSet to contain specified attribute and override flag.*/
|
||||
void setAttribute(StateAttribute *attribute, const StateAttribute::OverrideValue value=StateAttribute::OFF);
|
||||
/** 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 setAttributeAndModes(StateAttribute *attribute, const StateAttribute::GLModeValue value=StateAttribute::ON);
|
||||
/** set this StateSet to inherit specified attribute type from parents.
|
||||
* has the effect of deleting any state attributes of specified type from StateSet.*/
|
||||
|
@ -7,7 +7,7 @@
|
||||
|
||||
namespace osg {
|
||||
|
||||
/** Encapsulte OpenGL glStencilFunc/Op/Mask functions.
|
||||
/** Encapsulate OpenGL glStencilFunc/Op/Mask functions.
|
||||
*/
|
||||
class SG_EXPORT Stencil : public StateAttribute
|
||||
{
|
||||
@ -79,9 +79,9 @@ class SG_EXPORT Stencil : public StateAttribute
|
||||
};
|
||||
|
||||
/** 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(,,).*/
|
||||
|
@ -40,12 +40,12 @@ class SG_EXPORT TexGen : public StateAttribute
|
||||
|
||||
// Not happy with turning all tex gen paramters on
|
||||
// as the OSG currently only supports 2D textures and therefore
|
||||
// only S and T will only be required, R&Q would be redundent...
|
||||
// So commenting out the following until OSG supports 3D texures.
|
||||
// only S and T will only be required, R&Q would be redundant...
|
||||
// So commenting out the following until OSG supports 3D textures.
|
||||
// I plan to revamp the OpenGL state management later so will
|
||||
// tidy up then. Robert Osfield. Jan 2001.
|
||||
|
||||
// The tidy up is now happening, but wiil have a think before
|
||||
// The tidy up is now happening, but will have a think before
|
||||
// resolving the below parameters.
|
||||
|
||||
// ds.setMode(GL_TEXTURE_GEN_R,value);
|
||||
|
@ -88,7 +88,7 @@ class SG_EXPORT Texture : public StateAttribute
|
||||
void copyTexImage2D(State& state, 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.
|
||||
@ -181,7 +181,7 @@ class SG_EXPORT Texture : public StateAttribute
|
||||
|
||||
/** 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. */
|
||||
inline const uint getTextureObjectSize() const { return _textureObjectSize; }
|
||||
|
||||
|
@ -9,7 +9,7 @@ namespace osg {
|
||||
/** 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.
|
||||
*/
|
||||
class SG_EXPORT Transform : public Group
|
||||
{
|
||||
|
@ -6,7 +6,7 @@
|
||||
|
||||
namespace osg {
|
||||
|
||||
/** Transparancy - encapsulates the OpenGL transparancy state.*/
|
||||
/** Transparency - encapsulates the OpenGL blend/transparency state.*/
|
||||
class SG_EXPORT Transparency : public StateAttribute
|
||||
{
|
||||
public :
|
||||
|
@ -100,13 +100,13 @@ class Vec2
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// binary vector subract
|
||||
/// binary vector subtract
|
||||
inline const Vec2 operator - (const Vec2& rhs) const
|
||||
{
|
||||
return Vec2(_v[0]-rhs._v[0], _v[1]-rhs._v[1]);
|
||||
}
|
||||
|
||||
/// unary vector subract
|
||||
/// unary vector subtract
|
||||
inline Vec2& operator -= (const Vec2& rhs)
|
||||
{
|
||||
_v[0]-=rhs._v[0];
|
||||
|
@ -117,13 +117,13 @@ class Vec3
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// binary vector subract
|
||||
/// binary vector subtract
|
||||
inline const Vec3 operator - (const Vec3& rhs) const
|
||||
{
|
||||
return Vec3(_v[0]-rhs._v[0], _v[1]-rhs._v[1], _v[2]-rhs._v[2]);
|
||||
}
|
||||
|
||||
/// unary vector subract
|
||||
/// unary vector subtract
|
||||
inline Vec3& operator -= (const Vec3& rhs)
|
||||
{
|
||||
_v[0]-=rhs._v[0];
|
||||
|
@ -125,14 +125,14 @@ class Vec4
|
||||
return *this;
|
||||
}
|
||||
|
||||
/// binary vector subract
|
||||
/// binary vector subtract
|
||||
inline Vec4 operator - (const Vec4& rhs) const
|
||||
{
|
||||
return Vec4(_v[0]-rhs._v[0], _v[1]-rhs._v[1],
|
||||
_v[2]-rhs._v[2], _v[3]-rhs._v[3] );
|
||||
}
|
||||
|
||||
/// unary vector subract
|
||||
/// unary vector subtract
|
||||
inline Vec4& operator -= (const Vec4& rhs)
|
||||
{
|
||||
_v[0]-=rhs._v[0];
|
||||
|
@ -7,9 +7,9 @@ extern "C" {
|
||||
|
||||
/**
|
||||
* getVersion_osg() returns the library version number.
|
||||
* Numbering conventon : osg_src-0.8-31 will return 0.8.31 from getVersion_osg.
|
||||
* Numbering convention : osg_src-0.8-31 will return 0.8.31 from getVersion_osg.
|
||||
*
|
||||
* This C function can be also used to check for the existance of the OpenSceneGraph
|
||||
* This C function can be also used to check for the existence of the OpenSceneGraph
|
||||
* library using autoconf and its m4 macro AC_CHECK_LIB.
|
||||
*
|
||||
* Here is the code to add to your configure.in:
|
||||
|
@ -101,7 +101,7 @@ class mem_ptr
|
||||
};
|
||||
|
||||
|
||||
// /** Exprimental memory adapter implmentation.*/
|
||||
// /** Experimental memory adapter implementation.*/
|
||||
// template<class T>
|
||||
// class CppMemoryAdapter : public MemoryAdapter
|
||||
// {
|
||||
@ -125,7 +125,7 @@ class mem_ptr
|
||||
//
|
||||
// };
|
||||
//
|
||||
// /** Exprimental memory adapter implmentation.*/
|
||||
// /** Experimental memory adapter implementation.*/
|
||||
// class NewMemoryAdapter : public MemoryAdapter
|
||||
// {
|
||||
// public:
|
||||
@ -154,7 +154,7 @@ class mem_ptr
|
||||
//
|
||||
// };
|
||||
//
|
||||
// /** Exprimental memory adapter implmentation.*/
|
||||
// /** Experimental memory adapter implementation.*/
|
||||
// template<class T>
|
||||
// class newMemoryAdapter : public MemoryAdapter
|
||||
// {
|
||||
|
Loading…
Reference in New Issue
Block a user