>From 76320b1a51fd007dbaa879c141407ae302f28128 Mon Sep 17 00:00:00 2001
From: Magnus Kessler <[email protected]>
Date: Fri, 14 Oct 2011 13:48:26 +0100
Subject: [PATCH 07/12] Fix typos in documentation for osg::Observer
TODO: fix the name of the misspelled "getObserverdObject" methods.
---
include/osg/Observer | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/include/osg/Observer b/include/osg/Observer
index 9e0fa87..9a0f411 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*) {}
--
1.7.3.4
/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
*
* This library is open source and may be redistributed and/or modified under
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
* (at your option) any later version. The full license is in LICENSE file
* included with this distribution, and on the openscenegraph.org website.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* OpenSceneGraph Public License for more details.
*/
#ifndef OSG_OBSERVER
#define OSG_OBSERVER 1
#include <OpenThreads/Mutex>
#include <osg/Referenced>
#include <set>
namespace osg {
/** Observer base class for tracking when objects are unreferenced (their reference count goes to 0) and are being deleted.*/
class OSG_EXPORT Observer
{
public:
Observer();
virtual ~Observer();
/** objectDeleted is called when the observed object is about to be deleted. The observer will be automatically
* 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*) {}
};
/** Class used by osg::Referenced to track the observers associated with it.*/
class OSG_EXPORT ObserverSet : public osg::Referenced
{
public:
ObserverSet(const Referenced* observedObject);
Referenced* getObserverdObject() { return _observedObject; }
const Referenced* getObserverdObject() const { return _observedObject; }
/** "Lock" a Referenced object i.e., protect it from being deleted
* by incrementing its reference count.
*
* returns null if object doesn't exist anymore. */
Referenced* addRefLock();
inline OpenThreads::Mutex* getObserverSetMutex() const { return &_mutex; }
void addObserver(Observer* observer);
void removeObserver(Observer* observer);
void signalObjectDeleted(void* ptr);
typedef std::set<Observer*> Observers;
Observers& getObservers() { return _observers; }
const Observers& getObservers() const { return _observers; }
protected:
ObserverSet(const ObserverSet& rhs): osg::Referenced(rhs) {}
ObserverSet& operator = (const ObserverSet& /*rhs*/) { return *this; }
virtual ~ObserverSet();
mutable OpenThreads::Mutex _mutex;
Referenced* _observedObject;
Observers _observers;
};
}
#endif
_______________________________________________
osg-submissions mailing list
[email protected]
http://lists.openscenegraph.org/listinfo.cgi/osg-submissions-openscenegraph.org
