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

From Magnus Kessler, typo and documentation fixes

Browse Source
This commit is contained in:
Robert Osfield
2012-03-29 15:08:15 +00:00
parent ba2432ca45
commit c0bd5cda99
12 changed files with 45 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
include/osg/DeleteHandler
View File

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

14
include/osg/Image
View File

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

4
include/osg/Observer
View File

@@ -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*) {}

20
include/osg/ProxyNode
View File

@@ -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<osg::Referenced>& getDatabaseRequest(unsigned int childNo) { return _filenameList[childNo].second; }
@@ -71,7 +71,7 @@ class OSG_EXPORT ProxyNode : public Group
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 @@ 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(); }

2
include/osg/Texture3D
View File

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