FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

From Geoff Michel, typo and spelling fixes.

Browse Source
This commit is contained in:
Robert Osfield 2004-08-31 14:49:33 +00:00
parent de686f409b
commit 32a78e5a16
9 changed files with 29 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/osg/ConvexPlanarOccluder
View File

@ -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
{

4
include/osg/ConvexPlanarPolygon
View File

@ -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
{

24
include/osg/CoordinateSystemNode
View File

@ -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:

2
include/osg/CopyOp
View File

@ -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
{

8
include/osg/CullFace
View File

@ -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.

6
include/osg/CullSettings
View File

@ -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; }

5
include/osg/CullStack
View File

@ -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; }

4
include/osg/CullingSet
View File

@ -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); }

2
include/osg/Depth
View File

@ -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.