HI Magus,
On 27 March 2012 12:58, Magnus Kessler <[email protected]> wrote:
> And now with the correct attachment...
I have now merged all your typo/documentation fixes except from the
change of signify to signal in GraphicsContext as I felt the original
meaning was appropriate. I've included the svn diff results just
before my check-in so you can double check I haven't missed anything.
Thank for your thoroughness on spotting all these mistakes in the
documentation, it's an area where I struggle, English language is my
weak point even though I'm a native speaker!
Cheers,
Robert.
svn diff
Index: include/osgUtil/SceneView
===================================================================
--- include/osgUtil/SceneView (revision 13048)
+++ include/osgUtil/SceneView (working copy)
@@ -248,7 +248,7 @@
/** 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 @@
/** 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 @@
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 @@
* 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.*/
Index: include/osg/Texture3D
===================================================================
--- include/osg/Texture3D (revision 13048)
+++ include/osg/Texture3D (working copy)
@@ -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
Index: include/osg/Observer
===================================================================
--- include/osg/Observer (revision 13048)
+++ include/osg/Observer (working copy)
@@ -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 @@
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*) {}
Index: include/osg/Image
===================================================================
--- include/osg/Image (revision 13049)
+++ include/osg/Image (working copy)
@@ -236,7 +236,7 @@
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 @@
/** Get the const PixelBufferObject.*/
const PixelBufferObject* getPixelBufferObject() const {
return dynamic_cast<const PixelBufferObject*>(_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 @@
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 :
Index: include/osg/ProxyNode
===================================================================
--- include/osg/ProxyNode (revision 13048)
+++ include/osg/ProxyNode (working copy)
@@ -42,13 +42,13 @@
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 @@
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<osg::Referenced>& getDatabaseRequest(unsigned
int childNo) { return _filenameList[childNo].second; }
@@ -71,7 +71,7 @@
const osg::ref_ptr<osg::Referenced>&
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 @@
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 @@
/** 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(); }
Index: include/osg/DeleteHandler
===================================================================
--- include/osg/DeleteHandler (revision 13048)
+++ include/osg/DeleteHandler (working copy)
@@ -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 @@
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 @@
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.
Index: include/osgGA/GUIActionAdapter
===================================================================
--- include/osgGA/GUIActionAdapter (revision 13048)
+++ include/osgGA/GUIActionAdapter (working copy)
@@ -67,8 +67,8 @@
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.
Index: include/osgGA/FlightManipulator
===================================================================
--- include/osgGA/FlightManipulator (revision 13048)
+++ include/osgGA/FlightManipulator (working copy)
@@ -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.
Index: include/osgGA/KeySwitchMatrixManipulator
===================================================================
--- include/osgGA/KeySwitchMatrixManipulator (revision 13048)
+++ include/osgGA/KeySwitchMatrixManipulator (working copy)
@@ -24,7 +24,7 @@
/**
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.
*/
Index: include/osgSim/MultiSwitch
===================================================================
--- include/osgSim/MultiSwitch (revision 13048)
+++ include/osgSim/MultiSwitch (working copy)
@@ -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
{
Index: include/osgViewer/View
===================================================================
--- include/osgViewer/View (revision 13048)
+++ include/osgViewer/View (working copy)
@@ -196,17 +196,17 @@
/** 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);
Index: src/osgPlugins/osg/ReaderWriterOSG.cpp
===================================================================
--- src/osgPlugins/osg/ReaderWriterOSG.cpp (revision 13048)
+++ src/osgPlugins/osg/ReaderWriterOSG.cpp (working copy)
@@ -116,7 +116,7 @@
{
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");
_______________________________________________
osg-submissions mailing list
[email protected]
http://lists.openscenegraph.org/listinfo.cgi/osg-submissions-openscenegraph.org
