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

Made spelling corrections to osg include files, spelling mistakes detected by a script written by Neil Salter which analyses comments for mistakes.

Browse Source
This commit is contained in:
Robert Osfield
2001-09-28 20:10:41 +00:00
parent 4c4d99f19a
commit ef2e9236bd
14 changed files with 62 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/osg/AlphaFunc
View File

@@ -6,7 +6,7 @@
namespace osg {
/** Encapsulte OpenGL glAlphaFunc.
/** Encapsulate OpenGL glAlphaFunc.
*/
class SG_EXPORT AlphaFunc : public StateAttribute
{

8
include/osg/Billboard
View File

@@ -7,8 +7,7 @@
namespace osg {
/** 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.
*/
class SG_EXPORT Billboard : public Geode
{
@@ -42,9 +41,10 @@ class SG_EXPORT Billboard : public Geode
/** PositionList represents a list of pivot points for each drawable.*/
typedef std::vector<Vec3> PositionList;
/** Get the PostionList from the billboard.*/
/** Get the PositionList from the billboard.*/
inline PositionList& getPositionList() { return _positionList; }
/** Get a const PostionList from the billboard.*/
/** Get a const PositionList from the billboard.*/
inline const PositionList& getPositionList() const { return _positionList; }
/** Add Drawable to Billboard with default position(0,0,0);

10
include/osg/BoundingBox
View File

@@ -80,7 +80,7 @@ class SG_EXPORT BoundingBox
}
/** 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.*/
@@ -89,15 +89,15 @@ class SG_EXPORT BoundingBox
return Vec3(pos&1?_max.x():_min.x(),pos&2?_max.y():_min.y(),pos&4?_max.z():_min.z());
}
/** 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 Vec3& v);
/** 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 BoundingBox& bb);
/** 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. */
void expandBy(const BoundingSphere& sh);

8
include/osg/BoundingSphere
View File

@@ -8,7 +8,7 @@ namespace osg {
/** 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.
*/
@@ -48,13 +48,13 @@ class SG_EXPORT BoundingSphere
/** 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.*/
inline const float radius2() const { return _radius*_radius; }
/** 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 expandBy(const Vec3& v);
/** If the vertex is outwith the sphere expand radius to ecompass vertex.

50
include/osg/Camera
View File

@@ -13,7 +13,7 @@ namespace osg {
/** 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.
*/
class SG_EXPORT Camera: public osg::Referenced
{
@@ -24,10 +24,10 @@ class SG_EXPORT Camera: public osg::Referenced
virtual ~Camera();
/** 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.*/
enum ProjectionType
{
ORTHO,
@@ -40,12 +40,12 @@ class SG_EXPORT Camera: public osg::Referenced
* and set perspective methods.*/
const ProjectionType getProjectionType() const { return _projectionType; }
/** Set a orthographics projection. See glOrtho for further details.*/
/** Set a orthographic 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 2D orthographics projection. See gluOrtho2D for further details.*/
/** Set a 2D orthographic projection. See gluOrtho2D for further details.*/
void setOrtho2D(const double left, const double right,
const double bottom, const double top);
@@ -54,12 +54,12 @@ class SG_EXPORT Camera: public osg::Referenced
const double bottom, const double top,
const double zNear, const double zFar);
/** Set a sysmetical perspective projection, See gluPerspective for further details.
/** Set a symmetrical perspective projection, See gluPerspective for further details.
* Aspect ratio is defined as width/height.*/
void setPerspective(const double fovy,const double aspectRatio,
const double zNear, const double zFar);
/** Set a sysmetical perspective projection using field of view.*/
/** Set a sysmmetical perspective projection using field of view.*/
void setFOV(const double fovx,const double fovy,
const double zNear, const double zFar);
@@ -83,15 +83,15 @@ class SG_EXPORT Camera: public osg::Referenced
* are adjusted on a resize. */
const AdjustAspectRatioMode getAdjustAspectRatioMode() const { return _adjustAspectRatioMode; }
/** 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)
{
adjustAspectRatio(newAspectRatio,_adjustAspectRatioMode);
}
/** Adjust the clipping planes to account for a new window aspcect ratio.
/** 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.*/
void adjustAspectRatio(const double newAspectRatio, const AdjustAspectRatioMode aa);
@@ -103,13 +103,13 @@ class SG_EXPORT Camera: public osg::Referenced
const double zNear() const;
const double zFar() 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_fovy() 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_fovx() const;
@@ -143,14 +143,14 @@ class SG_EXPORT Camera: public osg::Referenced
const Vec3& lookPoint,
const Vec3& upVector);
/** 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 setLookAt(const Vec3& eye,
const Vec3& center,
const Vec3& up);
/** 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 setLookAt(const double eyeX, const double eyeY, const double eyeZ,
@@ -193,12 +193,12 @@ class SG_EXPORT Camera: public osg::Referenced
/** 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
@@ -225,9 +225,9 @@ class SG_EXPORT Camera: public osg::Referenced
/** 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.*/
const Matrix& getModelViewMatrix() const;
@@ -242,11 +242,11 @@ class SG_EXPORT Camera: public osg::Referenced
/** Map object coordinates into windows coordinates.
* Equivilant to gluProject(...). */
* Equivalent to gluProject(...). */
const bool project(const Vec3& obj,const Viewport& viewport,Vec3& win) const;
/** Map window coordinates into object coordinates.
* Equivilant to gluUnProject(...). */
* Equivalent to gluUnProject(...). */
const bool unproject(const Vec3& win,const Viewport& viewport,Vec3& obj) const;
@@ -287,7 +287,7 @@ class SG_EXPORT Camera: public osg::Referenced
ref_ptr<Matrix> _eyeToModelTransform;
ref_ptr<Matrix> _modelToEyeTransform;
// flags to determin if near and far clipping planes are required.
// flags to determine if near and far clipping planes are required.
bool _useNearClippingPlane;
bool _useFarClippingPlane;

15
include/osg/Drawable
View File

@@ -12,7 +12,7 @@
namespace osg {
/** 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
@@ -39,7 +39,7 @@ class SG_EXPORT Drawable : public Object
inline const StateSet* getStateSet() const { return _dstate.get();}
/** 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
@@ -48,7 +48,7 @@ class SG_EXPORT Drawable : public Object
* algorithms.*/
void setSupportsDisplayList(const bool flag);
/** Get whether display lists are supportd for this drawable instance.*/
/** Get whether display lists are supported for this drawable instance.*/
inline const bool getSupportsDisplayList() const { return _supportsDisplayList; }
@@ -80,7 +80,7 @@ class SG_EXPORT Drawable : public Object
* 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
* Note, draw method should not be overridden in subclasses as it
* manages the optional display list.
*/
inline void draw(State& state)
@@ -98,7 +98,7 @@ class SG_EXPORT Drawable : public Object
// get the globj for the current contextID.
uint& globj = _globjList[contextID];
// call the globj if already set otherwise comple and execute.
// call the globj if already set otherwise compile and execute.
if( globj != 0 )
{
glCallList( globj );
@@ -120,7 +120,8 @@ class SG_EXPORT Drawable : public Object
}
/** 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.*/
void compile(State& state);
/** draw directly ignoring an OpenGL display list which could be attached.
@@ -147,7 +148,7 @@ class SG_EXPORT Drawable : public Object
virtual ~Drawable();
/** compute the bounding box of the drawable. Method must be
implementated by subclasses.*/
implemented by subclasses.*/
virtual const bool computeBound() const = 0;
ref_ptr<StateSet> _dstate;

2
include/osg/GL
View File

@@ -3,7 +3,7 @@
#ifndef WIN32
// non windows, doesn't require nonesense as seen below :-)
// non windows, doesn't require nonsense as seen below :-)
#ifndef __gl_h_
#include <GL/gl.h>
#endif

2
include/osg/GLExtensions
View File

@@ -7,7 +7,7 @@ namespace osg {
/** return true if OpenGL "extension" is supported.
* note: Must only called within a valid OpenGL context,
* undefined behaviour may occur otherwise.
* undefined behavior may occur otherwise.
*/
SG_EXPORT extern const bool isGLExtensionSupported(const char *extension);

8
include/osg/GeoSet
View File

@@ -174,11 +174,11 @@ class SG_EXPORT GeoSet : public Drawable
void setCoords( Vec3 *cp );
/** set the coords (i.e 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, ushort *ci );
/** set the coords (i.e 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, uint *ci );
/** set the coords (i.e the geometry) and indices of the geoset.*/
void setCoords( Vec3 *cp, IndexPointer& ip );
@@ -325,11 +325,7 @@ class SG_EXPORT GeoSet : public Drawable
InterleaveArrayType _iaformat;
unsigned int _ogliaformat;
int _fast_path;
void set_fast_path( void );
void draw_fast_path( void );

6
include/osg/Geode
View File

@@ -68,7 +68,7 @@ class SG_EXPORT Geode : public Node
return false;
}
/** 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::iterator findDrawable(const Drawable* gset)
@@ -83,7 +83,7 @@ class SG_EXPORT Geode : public Node
return _drawables.end();
}
/** 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.
*/
inline DrawableList::const_iterator findDrawable(const Drawable* gset) const
@@ -98,7 +98,7 @@ class SG_EXPORT Geode : public Node
return _drawables.end();
}
/** complile OpenGL Display List for each geoset.*/
/** compile OpenGL Display List for each geoset.*/
void compileDrawables(State& state);
protected:

8
include/osg/Group
View File

@@ -72,8 +72,8 @@ class SG_EXPORT Group : public Node
}
/** return the iterator postion for specified Node.
* return _chilren.end() if node is not contained in Group.
/** return the iterator position for specified Node.
* return _children.end() if node is not contained in Group.
*/
inline ChildList::iterator findNode( const Node* node )
{
@@ -86,8 +86,8 @@ class SG_EXPORT Group : public Node
return _children.end();
}
/** return the const_iterator postion for specified Node.
* return _chilren.end() if node is not contained in Group.
/** return the const_iterator position for specified Node.
* return _children.end() if node is not contained in Group.
*/
inline ChildList::const_iterator findNode( const Node* node ) const
{

2
include/osg/Image
View File

@@ -28,7 +28,7 @@ class SG_EXPORT Image : public Object
/** 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.
*/
void setImage(const int s,const int t,const int r,

4
include/osg/LOD
View File

@@ -23,7 +23,7 @@ class SG_EXPORT LOD : public Group
/** 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().*/
void setRange(const unsigned int index, const float range);
@@ -43,7 +43,7 @@ class SG_EXPORT LOD : public Group
/** 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.*/
const int evaluate(const Vec3& eye_local,const float bias=1.0f) const;

2
include/osg/LineSegment
View File

@@ -7,7 +7,7 @@
namespace osg {
/** LineSegmentment class for representing a line segment.*/
/** LineSegment class for representing a line segment.*/
class SG_EXPORT LineSegment : public Referenced
{
public: