diff --git a/include/osg/DeleteHandler b/include/osg/DeleteHandler index 5d0302d94..7e2411c42 100644 --- a/include/osg/DeleteHandler +++ b/include/osg/DeleteHandler @@ -21,12 +21,13 @@ namespace osg { -/** Class for override the default delete behavior so that users can implement their own object - * deletion schemes. This might be done to help implement protection of multiple threads from deleting - * objects unintentionally. +/** Class for overriding the default delete behaviour so that users can implement their own object + * deletion schemes. + * This might be used to implement a protection scheme that avoids + * multiple threads deleting objects unintentionally. * Note, the DeleteHandler cannot itself be reference counted, otherwise it * would be responsible for deleting itself! - * An static auto_ptr<> is used internally in Referenced.cpp to manage the + * A static auto_ptr<> is used internally in Referenced.cpp to manage the * DeleteHandler's memory.*/ class OSG_EXPORT DeleteHandler { @@ -39,10 +40,10 @@ class OSG_EXPORT DeleteHandler virtual ~DeleteHandler(); - /** Set the number of frames to retain objects that are have been requested for deletion. - * When set to zero objects are deleted immediately, by set to 1 there are kept around for an extra frame etc. + /** Set the number of frames to retain objects that have been requested for deletion. + * When set to zero objects are deleted immediately, by setting to 1 they are kept around for an extra frame etc. * The ability to retain objects for several frames is useful to prevent premature deletion when objects - * are still be used the graphics threads that are using double buffering of rendering data structures with + * are still being used by graphics threads that use double buffering of rendering data structures with * non ref_ptr<> pointers to scene graph elements.*/ void setNumFramesToRetainObjects(unsigned int numberOfFramesToRetainObjects) { _numFramesToRetainObjects = numberOfFramesToRetainObjects; } @@ -56,7 +57,7 @@ class OSG_EXPORT DeleteHandler inline void doDelete(const Referenced* object) { delete object; } - /** Flush objects that ready to be fully deleted.*/ + /** Flush objects that are ready to be fully deleted.*/ virtual void flush(); /** Flush all objects that the DeleteHandler holds. diff --git a/include/osg/Image b/include/osg/Image index bb4555ec7..be8ac9f9f 100644 --- a/include/osg/Image +++ b/include/osg/Image @@ -236,7 +236,7 @@ class OSG_EXPORT Image : public BufferData void setPacking(unsigned int packing) { _packing = packing; } inline unsigned int getPacking() const { return _packing; } - /** return true of the pixel format is an OpenGL compressed pixel format.*/ + /** Return true of the pixel format is an OpenGL compressed pixel format.*/ bool isCompressed() const; /** Set the pixel aspect ratio, defined as the pixel width divided by the pixel height.*/ @@ -415,13 +415,13 @@ class OSG_EXPORT Image : public BufferData /** Get the const PixelBufferObject.*/ const PixelBufferObject* getPixelBufferObject() const { return dynamic_cast(_bufferObject.get()); } - /** return whether the update(NodeVisitor* nv) should be required on each frame to enable proper working of osg::Image.*/ + /** Return whether the update(NodeVisitor* nv) should be required on each frame to enable proper working of osg::Image.*/ virtual bool requiresUpdateCall() const { return false; } /** update method for osg::Image subclasses that update themselves during the update traversal.*/ virtual void update(NodeVisitor* /*nv*/) {} - /** convience update callback class that can be attached to StateAttribute (such as Textures) to ensure + /** Convenience update callback class that can be attached to a StateAttribute (such as Textures) to ensure * that the Image::update(NodeVisitor*) method is called during the update traversal. This callback * is automatically attached when Image::requiresUpdateCall() is true (it's false by default.) */ @@ -430,16 +430,16 @@ class OSG_EXPORT Image : public BufferData virtual void operator () (osg::StateAttribute* attr, osg::NodeVisitor* nv); }; - /** method for hinting whether to enable or disable focus to images acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled. */ + /** Hint whether to enable or disable focus to images acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled. */ virtual bool sendFocusHint(bool /*focus*/) { return false; } - /** method for sending pointer events to images that are acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled. */ + /** Send pointer events to images that are acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled. */ virtual bool sendPointerEvent(int /*x*/, int /*y*/, int /*buttonMask*/) { return false; } - /** method for sending key events to images that are acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled.*/ + /** Send key events to images that are acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled.*/ virtual bool sendKeyEvent(int /*key*/, bool /*keyDown*/) { return false; } - /** method for passing frame information to the custom Image classes, to be called only when objects associated with imagery are not culled.*/ + /** Pass frame information to the custom Image classes, to be called only when objects associated with imagery are not culled.*/ virtual void setFrameLastRendered(const osg::FrameStamp* /*frameStamp*/) {} protected : diff --git a/include/osg/Observer b/include/osg/Observer index 9e0fa8761..9a0f41106 100644 --- a/include/osg/Observer +++ b/include/osg/Observer @@ -20,7 +20,7 @@ namespace osg { -/** Observer base class for tracking when objects are unreferenced (there reference count goes to 0) and are being deleted.*/ +/** Observer base class for tracking when objects are unreferenced (their reference count goes to 0) and are being deleted.*/ class OSG_EXPORT Observer { public: @@ -28,7 +28,7 @@ class OSG_EXPORT Observer virtual ~Observer(); /** objectDeleted is called when the observed object is about to be deleted. The observer will be automatically - * removed from the observerd objects observer set so there is no need for the objectDeleted implementation + * removed from the observed object's observer set so there is no need for the objectDeleted implementation * to call removeObserver() on the observed object. */ virtual void objectDeleted(void*) {} diff --git a/include/osg/ProxyNode b/include/osg/ProxyNode index aad2dc023..797f777ee 100644 --- a/include/osg/ProxyNode +++ b/include/osg/ProxyNode @@ -42,13 +42,13 @@ class OSG_EXPORT ProxyNode : public Group virtual bool removeChildren(unsigned int pos,unsigned int numChildrenToRemove); - /** Set the optional database osgDB::Options object to use when loaded children.*/ + /** Set the optional database osgDB::Options object to use when loading children.*/ void setDatabaseOptions(osg::Referenced* options) { _databaseOptions = options; } - /** Get the optional database osgDB::Options object used when loaded children.*/ + /** Get the optional database osgDB::Options object used when loading children.*/ osg::Referenced* getDatabaseOptions() { return _databaseOptions.get(); } - /** Get the optional database osgDB::Options object used when loaded children.*/ + /** Get the optional database osgDB::Options object used when loading children.*/ const osg::Referenced* getDatabaseOptions() const { return _databaseOptions.get(); } @@ -62,7 +62,7 @@ class OSG_EXPORT ProxyNode : public Group unsigned int getNumFileNames() const { return _filenameList.size(); } /** Return the DatabaseRequest object used by the DatabasePager to keep track of file load requests - * being carried on behalf of the DatabasePager. + * being carried out on behalf of the DatabasePager. * Note, in normal OSG usage you should not set this value yourself, as this will be managed by * the osgDB::DatabasePager.*/ osg::ref_ptr& getDatabaseRequest(unsigned int childNo) { return _filenameList[childNo].second; } @@ -71,7 +71,7 @@ class OSG_EXPORT ProxyNode : public Group const osg::ref_ptr& getDatabaseRequest(unsigned int childNo) const { return _filenameList[childNo].second; } - /** Modes which control how the center of object should be determined when computed which child is active.*/ + /** Modes which control how the center of object should be determined when computing which child is active.*/ enum CenterMode { USE_BOUNDING_SPHERE_CENTER, @@ -79,10 +79,10 @@ class OSG_EXPORT ProxyNode : public Group UNION_OF_BOUNDING_SPHERE_AND_USER_DEFINED }; - /** Set how the center of object should be determined when computed which child is active.*/ + /** Set how the center of object should be determined when computing which child is active.*/ void setCenterMode(CenterMode mode) { _centerMode=mode; } - /** Get how the center of object should be determined when computed which child is active.*/ + /** Get how the center of object should be determined when computing which child is active.*/ CenterMode getCenterMode() const { return _centerMode; } /** Modes which control how the proxynode external reference are loaded.*/ @@ -96,14 +96,14 @@ class OSG_EXPORT ProxyNode : public Group /** Set how the child loading is done.*/ void setLoadingExternalReferenceMode(LoadingExternalReferenceMode mode) { _loadingExtReference=mode; } - /** Get the setted mode of loading.*/ + /** Get the loading mode.*/ LoadingExternalReferenceMode getLoadingExternalReferenceMode() const { return _loadingExtReference; } /** Sets the object-space point which defines the center of the osg::ProxyNode. - center is affected by any transforms in the hierarchy above the osg::ProxyNode.*/ + Center is affected by any transforms in the hierarchy above the osg::ProxyNode.*/ inline void setCenter(const vec_type& center) { if (_centerMode!=UNION_OF_BOUNDING_SPHERE_AND_USER_DEFINED) { _centerMode=USER_DEFINED_CENTER; } _userDefinedCenter = center; } - /** return the ProxyNode center point. */ + /** Return the ProxyNode center point. */ inline const vec_type& getCenter() const { if ((_centerMode==USER_DEFINED_CENTER)||(_centerMode==UNION_OF_BOUNDING_SPHERE_AND_USER_DEFINED)) return _userDefinedCenter; else return getBound().center(); } diff --git a/include/osg/Texture3D b/include/osg/Texture3D index 005ca2015..4af0c5dac 100644 --- a/include/osg/Texture3D +++ b/include/osg/Texture3D @@ -22,7 +22,7 @@ namespace osg { -/** Encapsulates OpenGL 2D texture functionality. Doesn't support cube maps, +/** Encapsulates OpenGL 3D texture functionality. Doesn't support cube maps, * so ignore \a face parameters. */ class OSG_EXPORT Texture3D : public Texture diff --git a/include/osgGA/FlightManipulator b/include/osgGA/FlightManipulator index b5ea50d56..c39ff9255 100644 --- a/include/osgGA/FlightManipulator +++ b/include/osgGA/FlightManipulator @@ -20,7 +20,7 @@ namespace osgGA { -/** FlightManipulator is a MatrixManipulator which provides flight simulator-like +/** FlightManipulator is a CameraManipulator which provides flight simulator-like * updating of the camera position & orientation. By default, the left mouse * button accelerates, the right mouse button decelerates, and the middle mouse * button (or left and right simultaneously) stops dead. diff --git a/include/osgGA/GUIActionAdapter b/include/osgGA/GUIActionAdapter index f70e6fa71..07ddce4fb 100644 --- a/include/osgGA/GUIActionAdapter +++ b/include/osgGA/GUIActionAdapter @@ -67,8 +67,8 @@ public: virtual void requestRedraw() = 0; /** - requestContinousUpdate(bool) is for en/disabling a throw or idle - callback to be requested by a GUIEventHandler (typically a MatrixManipulator, + requestContinuousUpdate(bool) is for en/disabling a throw or idle + callback to be requested by a GUIEventHandler (typically a CameraManipulator, though other GUIEventHandler's may also provide functionality). GUI toolkits can respond to this immediately by registering an idle/timed callback, or can delay setting the callback and update at their own leisure. diff --git a/include/osgGA/KeySwitchMatrixManipulator b/include/osgGA/KeySwitchMatrixManipulator index d318008c1..78367a79a 100644 --- a/include/osgGA/KeySwitchMatrixManipulator +++ b/include/osgGA/KeySwitchMatrixManipulator @@ -24,7 +24,7 @@ class GUIActionAdapter; /** KeySwitchMatrixManipulator is a decorator which allows the type of camera manipulator -being used to be switched by pressing a key. E.g. '1' for a TrackballManipultor, +being used to be switched by pressing a key. E.g. '1' for a TrackballManipulator, '2' for a DriveManipulator, '3' for a FlightManipulator. The manipulators available, and the associated switch keys, can be configured. */ diff --git a/include/osgSim/MultiSwitch b/include/osgSim/MultiSwitch index 63c873363..fc4a8e156 100644 --- a/include/osgSim/MultiSwitch +++ b/include/osgSim/MultiSwitch @@ -20,7 +20,7 @@ namespace osgSim { /** MultiSwitch is a Group node which allows switching between sets of selected children. - MultiSwtich is based on the OpenFlight switch behaviour. + MultiSwitch is based on the OpenFlight switch behaviour. */ class OSGSIM_EXPORT MultiSwitch : public osg::Group { diff --git a/include/osgUtil/SceneView b/include/osgUtil/SceneView index 90eecd90b..21d7b249e 100644 --- a/include/osgUtil/SceneView +++ b/include/osgUtil/SceneView @@ -248,7 +248,7 @@ class OSGUTIL_EXPORT SceneView : public osg::Object, public osg::CullSettings /** Set the view matrix. Can be thought of as setting the position of the world relative to the camera in camera coordinates. */ inline void setViewMatrix(const osg::Matrixd& matrix) { _camera->setViewMatrix(matrix); } - /** Set the position and orientation of view matrix, using the same convention as gluLookAt. */ + /** Set the position and orientation components of the view matrix, using the same convention as gluLookAt. */ void setViewMatrixAsLookAt(const osg::Vec3& eye,const osg::Vec3& center,const osg::Vec3& up); /** Get the view matrix. */ @@ -257,7 +257,7 @@ class OSGUTIL_EXPORT SceneView : public osg::Object, public osg::CullSettings /** Get the const view matrix. */ const osg::Matrixd& getViewMatrix() const { return _camera->getViewMatrix(); } - /** Get the position and orientation of a modelview matrix, using the same convention as gluLookAt. */ + /** Get the position and orientation components of a modelview matrix, using the same convention as gluLookAt. */ void getViewMatrixAsLookAt(osg::Vec3& eye,osg::Vec3& center,osg::Vec3& up,float lookDistance=1.0f) const; @@ -438,14 +438,14 @@ class OSGUTIL_EXPORT SceneView : public osg::Object, public osg::CullSettings virtual osg::Matrixd computeRightEyeProjectionImplementation(const osg::Matrixd& projection) const; virtual osg::Matrixd computeRightEyeViewImplementation(const osg::Matrixd& view) const; - /** Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask.*/ + /** Inherit the local cull settings variable from a specified CullSettings object, according to the inheritance mask.*/ virtual void inheritCullSettings(const osg::CullSettings& settings) { inheritCullSettings(settings, _inheritanceMask); } - /** Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask.*/ + /** Inherit the local cull settings variable from a specified CullSettings object, according to the inheritance mask.*/ virtual void inheritCullSettings(const osg::CullSettings& settings, unsigned int inheritanceMask); - /** Do init traversal of attached scene graph using Init NodeVisitor. + /** Do init traversal of the attached scene graph using Init NodeVisitor. * The init traversal is called once for each SceneView, and should * be used to compile display lists, texture objects and intialize data * not otherwise intialized during scene graph loading. Note, is @@ -454,10 +454,10 @@ class OSGUTIL_EXPORT SceneView : public osg::Object, public osg::CullSettings * graphics context.*/ virtual void init(); - /** Do app traversal of attached scene graph using App NodeVisitor.*/ + /** Do app traversal of the attached scene graph using App NodeVisitor.*/ virtual void update(); - /** Do cull traversal of attached scene graph using Cull NodeVisitor.*/ + /** Do cull traversal of the attached scene graph using Cull NodeVisitor.*/ virtual void cull(); /** Do draw traversal of draw bins generated by cull traversal.*/ diff --git a/include/osgViewer/View b/include/osgViewer/View index 1c52f8cf9..2f4ecd905 100644 --- a/include/osgViewer/View +++ b/include/osgViewer/View @@ -196,17 +196,17 @@ class OSGVIEWER_EXPORT View : public osg::View, public osgGA::GUIActionAdapter /** Convenience method for spherical display using 6 slave cameras rendering the 6 sides of a cube map, and 7th camera doing distortion correction to present on a spherical display.*/ void setUpViewFor3DSphericalDisplay(double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image* intensityMap=0, const osg::Matrixd& projectorMatrix = osg::Matrixd()); - /** Convenience method for spherical display by rendering main scene to as panoramic 2:1 texture and then doing distortion correction to present onto a spherical display.*/ + /** Convenience method for spherical display by rendering main scene to a panoramic 2:1 texture and then doing distortion correction to present onto a spherical display.*/ void setUpViewForPanoramicSphericalDisplay(double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image* intensityMap=0, const osg::Matrixd& projectorMatrix = osg::Matrixd()); /** Convenience method for autostereoscopic Philips WoWvx display.*/ void setUpViewForWoWVxDisplay(unsigned int screenNum, unsigned char wow_content, unsigned char wow_factor, unsigned char wow_offset, float wow_disparity_Zd, float wow_disparity_vz, float wow_disparity_M, float wow_disparity_C); - /** Convenience method for setting up multiple slave cameras that depth partition the specified camera.*/ + /** Convenience method for setting up depth partitioning on the specified camera.*/ bool setUpDepthPartitionForCamera(osg::Camera* cameraToPartition, DepthPartitionSettings* dps=0); - /** Convenience method for setting up multiple slave cameras that depth partition each of the view's active cameras.*/ + /** Convenience method for setting up multiple slave cameras with depth partitioning on each of the view's active cameras.*/ bool setUpDepthPartition(DepthPartitionSettings* dsp=0); diff --git a/src/osgPlugins/osg/ReaderWriterOSG.cpp b/src/osgPlugins/osg/ReaderWriterOSG.cpp index 422992726..aceb848b3 100644 --- a/src/osgPlugins/osg/ReaderWriterOSG.cpp +++ b/src/osgPlugins/osg/ReaderWriterOSG.cpp @@ -116,7 +116,7 @@ class OSGReaderWriter : public ReaderWriter { supportsExtension("osg","OpenSceneGraph Ascii file format"); - supportsExtension("osgs","Psuedo OpenSceneGraph file loaded, with file encoded in filename string"); + supportsExtension("osgs","Pseudo OpenSceneGraph file loaded, with file encoded in filename string"); supportsOption("precision","Set the floating point precision when writing out files"); supportsOption("OutputTextureFiles","Write out the texture images to file"); supportsOption("includeExternalReferences","Export option");