From 32a78e5a16b0381d42963388f73dd7042d6e87da Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Tue, 31 Aug 2004 14:49:33 +0000 Subject: [PATCH] From Geoff Michel, typo and spelling fixes. --- include/osg/ConvexPlanarOccluder | 4 ++-- include/osg/ConvexPlanarPolygon | 4 ++-- include/osg/CoordinateSystemNode | 24 +++++++++++++----------- include/osg/CopyOp | 2 +- include/osg/CullFace | 8 ++++---- include/osg/CullSettings | 6 +++--- include/osg/CullStack | 5 +---- include/osg/CullingSet | 4 ++-- include/osg/Depth | 2 +- 9 files changed, 29 insertions(+), 30 deletions(-) diff --git a/include/osg/ConvexPlanarOccluder b/include/osg/ConvexPlanarOccluder index 8fdb9c3b2..e09e910e6 100644 --- a/include/osg/ConvexPlanarOccluder +++ b/include/osg/ConvexPlanarOccluder @@ -21,8 +21,8 @@ namespace osg { class OccluderVolume; -/** A class for representing convex clipping volumes made up. - * When adding planes, their normals should point inwards (into the volume) */ +/** A class for representing convex clipping volumes made up of several ConvexPlanarPolygon. + * When adding polygons, their normals should point inwards (into the volume) */ class SG_EXPORT ConvexPlanarOccluder : public Object { diff --git a/include/osg/ConvexPlanarPolygon b/include/osg/ConvexPlanarPolygon index 14d09439c..89a1e3d4b 100644 --- a/include/osg/ConvexPlanarPolygon +++ b/include/osg/ConvexPlanarPolygon @@ -23,8 +23,8 @@ namespace osg { class BoundingBox; class BoundingSphere; -/** A class for representing convex clipping volumes made up. - * When adding planes, their normals should point inwards (into the volume) */ +/** A class for representing components of convex clipping volumes. + * ConvexPlanarPolygon normals should point inwards (into the volume) */ class SG_EXPORT ConvexPlanarPolygon { diff --git a/include/osg/CoordinateSystemNode b/include/osg/CoordinateSystemNode index c8543f3ff..b0e1aaac9 100644 --- a/include/osg/CoordinateSystemNode +++ b/include/osg/CoordinateSystemNode @@ -23,14 +23,16 @@ namespace osg const double WGS_84_RADIUS_EQUATOR = 6378137.0; const double WGS_84_RADIUS_POLAR = 6356752.3142; -/** EllipsoidModel encapsulates the ellipsoid used to model astral bodies such as plants, moon etc.*/ +/** EllipsoidModel encapsulates the ellipsoid used to model astronomical bodies, + * such as sun, planets, moon etc. */ class EllipsoidModel : public Object { public: - + /** WGS_84 is a common representation of the earth's spheroid + */ EllipsoidModel(double radiusEquator = WGS_84_RADIUS_EQUATOR, - double radiusPolar = WGS_84_RADIUS_POLAR): + double radiusPolar = WGS_84_RADIUS_POLAR): _radiusEquator(radiusEquator), _radiusPolar(radiusPolar) { computeCoefficients(); } @@ -73,10 +75,10 @@ class EllipsoidModel : public Object }; -/** CoordinateFrame encapsulate the orientiation of east, north and up.*/ +/** CoordinateFrame encapsulates the orientation of east, north and up.*/ typedef Matrixd CoordinateFrame; -/** CoordinateSystem encapsulate the coordinate system that associated with objects in a scene. +/** CoordinateSystem encapsulate the coordinate system that is associated with objects in a scene. For an overview of common earth bases coordinate systems see http://www.colorado.edu/geography/gcraft/notes/coordsys/coordsys_f.html */ class SG_EXPORT CoordinateSystemNode : public Group { @@ -101,26 +103,26 @@ class SG_EXPORT CoordinateSystemNode : public Group /** Get the coordinate system format string.*/ const std::string& getFormat() const { return _format; } - /** Set the CoordinateSystem reference string, should be stored form consistent with the Format.*/ + /** Set the CoordinateSystem reference string, should be stored in a form consistent with the Format.*/ void setCoordinateSystem(const std::string& cs) { _cs = cs; } /** Get the CoordinateSystem reference string.*/ const std::string& getCoordinateSystem() const { return _cs; } - /** set EllipsoidModel to describe the model used to map lat, long and height into geocentric XYZ and back. */ + /** Set EllipsoidModel to describe the model used to map lat, long and height into geocentric XYZ and back. */ void setEllipsoidModel(EllipsoidModel* ellipsode) { _ellipsoidModel = ellipsode; } - /** get the EllipsoidModel.*/ + /** Get the EllipsoidModel.*/ EllipsoidModel* getEllipsoidModel() { return _ellipsoidModel.get(); } - /** get the const EllipsoidModel.*/ + /** Get the const EllipsoidModel.*/ const EllipsoidModel* getEllipsoidModel() const { return _ellipsoidModel.get(); } - /** compute the local coorindate frame for specified point.*/ + /** Compute the local coordinate frame for specified point.*/ CoordinateFrame computeLocalCoordinateFrame(const Vec3d& position) const; - /** compute the local coorindate frame for specified point.*/ + /** Compute the local coordinate frame for specified point.*/ osg::Vec3d computeLocalUpVector(const Vec3d& position) const; protected: diff --git a/include/osg/CopyOp b/include/osg/CopyOp index c9961733a..b104b7fc0 100644 --- a/include/osg/CopyOp +++ b/include/osg/CopyOp @@ -31,7 +31,7 @@ class Array; class PrimitiveSet; class Shape; -/** Copy Op(erator) used to control the whether shallow or deep copy is used +/** Copy Op(erator) used to control whether shallow or deep copy is used * during copy construction and clone operation.*/ class SG_EXPORT CopyOp { diff --git a/include/osg/CullFace b/include/osg/CullFace index a20831f92..968194ac2 100644 --- a/include/osg/CullFace +++ b/include/osg/CullFace @@ -19,8 +19,8 @@ namespace osg { -/** Class to globally enable/disable OpenGL's polygon culling mode=. -*/ +/** Class to globally enable/disable OpenGL's polygon culling mode. + */ class SG_EXPORT CullFace : public StateAttribute { public : @@ -45,10 +45,10 @@ class SG_EXPORT CullFace : public StateAttribute virtual int compare(const StateAttribute& sa) const { // check the types are equal and then create the rhs variable - // used by the COMPARE_StateAttribute_Paramter macro's below. + // used by the COMPARE_StateAttribute_Parameter macro's below. COMPARE_StateAttribute_Types(CullFace,sa) - // compare each paramter in turn against the rhs. + // compare each parameter in turn against the rhs. COMPARE_StateAttribute_Parameter(_mode) return 0; // passed all the above comparison macro's, must be equal. diff --git a/include/osg/CullSettings b/include/osg/CullSettings index bf06fbfc7..ab0d576a6 100644 --- a/include/osg/CullSettings +++ b/include/osg/CullSettings @@ -83,13 +83,13 @@ class SG_EXPORT CullSettings void setDepthSortImpostorSprites(bool doDepthSort) { _depthSortImpostorSprites = doDepthSort; } /** Get whether ImpostorSprite's are depth sorted bin for rendering.*/ - bool setDepthSortImpostorSprites() const { return _depthSortImpostorSprites; } + bool getDepthSortImpostorSprites() const { return _depthSortImpostorSprites; } - /** Set the number of frames that an ImpostorSprite's is kept whilst not being beyond, + /** Set the number of frames that an ImpostorSprite is kept whilst not being beyond, * before being recycled.*/ void setNumberOfFrameToKeepImpostorSprites(int numFrames) { _numFramesToKeepImpostorSprites = numFrames; } - /** Get the number of frames that an ImpostorSprite's is kept whilst not being beyond, + /** Get the number of frames that an ImpostorSprite is kept whilst not being beyond, * before being recycled.*/ int getNumberOfFrameToKeepImpostorSprites() const { return _numFramesToKeepImpostorSprites; } diff --git a/include/osg/CullStack b/include/osg/CullStack index f2737182e..410420efa 100644 --- a/include/osg/CullStack +++ b/include/osg/CullStack @@ -59,7 +59,7 @@ class SG_EXPORT CullStack : public osg::CullSettings return getCurrentCullingSet().pixelSize(v,radius); } - /** Compute the pixel of an bounding sphere.*/ + /** Compute the pixel of the bounding sphere.*/ float pixelSize(const BoundingSphere& bs) const { return pixelSize(bs.center(),bs.radius()); @@ -114,9 +114,6 @@ class SG_EXPORT CullStack : public osg::CullSettings inline CullingStack& getModelViewCullingStack() { return _modelviewCullingStack; } -// inline CullingSet& getCurrentCullingSet() { return _modelviewCullingStack.back(); } -// inline const CullingSet& getCurrentCullingSet() const { return _modelviewCullingStack.back(); } - inline CullingSet& getCurrentCullingSet() { return *_back_modelviewCullingStack; } inline const CullingSet& getCurrentCullingSet() const { return *_back_modelviewCullingStack; } diff --git a/include/osg/CullingSet b/include/osg/CullingSet index 2ec2c3e62..076aec3b0 100644 --- a/include/osg/CullingSet +++ b/include/osg/CullingSet @@ -20,7 +20,7 @@ namespace osg { -/** A CullingSet class which contains a frustum and a list of occluder. */ +/** A CullingSet class which contains a frustum and a list of occluders. */ class SG_EXPORT CullingSet : public Referenced { @@ -147,7 +147,7 @@ class SG_EXPORT CullingSet : public Referenced /** Compute the pixel of an object at position v, with specified radius.*/ float pixelSize(const Vec3& v,float radius) const { return radius/(v*_pixelSizeVector); } - /** Compute the pixel of an bounding sphere.*/ + /** Compute the pixel of a bounding sphere.*/ float pixelSize(const BoundingSphere& bs) const { return bs.radius()/(bs.center()*_pixelSizeVector); } diff --git a/include/osg/Depth b/include/osg/Depth index 0077db3ec..60035e334 100644 --- a/include/osg/Depth +++ b/include/osg/Depth @@ -55,7 +55,7 @@ class SG_EXPORT Depth : public StateAttribute virtual int compare(const StateAttribute& sa) const { // check the types are equal and then create the rhs variable - // used by the COMPARE_StateAttribute_Paramter macro's below. + // used by the COMPARE_StateAttribute_Parameter macro's below. COMPARE_StateAttribute_Types(Depth,sa) // compare each paramter in turn against the rhs.