OpenSceneGraph  3.5.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::ObserverSet Class Reference

Class used by osg::Referenced to track the observers associated with it. More...

Inheritance diagram for osg::ObserverSet:
Inheritance graph
[legend]

Public Types

typedef std::set< Observer * > Observers
 

Public Member Functions

 ObserverSet (const Referenced *observedObject)
 
ReferencedgetObserverdObject ()
 
const ReferencedgetObserverdObject () const
 
ReferencedaddRefLock ()
 "Lock" a Referenced object i.e., protect it from being deleted by incrementing its reference count. More...
 
OpenThreads::Mutex * getObserverSetMutex () const
 
void addObserver (Observer *observer)
 
void removeObserver (Observer *observer)
 
void signalObjectDeleted (void *ptr)
 
ObserversgetObservers ()
 
const ObserversgetObservers () const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Member Functions

 ObserverSet (const ObserverSet &rhs)
 
ObserverSetoperator= (const ObserverSet &)
 
virtual ~ObserverSet ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

OpenThreads::Mutex _mutex
 
Referenced_observedObject
 
Observers _observers
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

Class used by osg::Referenced to track the observers associated with it.

Member Typedef Documentation

Constructor & Destructor Documentation

osg::ObserverSet::ObserverSet ( const Referenced observedObject)
osg::ObserverSet::ObserverSet ( const ObserverSet rhs)
inlineprotected
virtual osg::ObserverSet::~ObserverSet ( )
protectedvirtual

Member Function Documentation

void osg::ObserverSet::addObserver ( Observer observer)
Referenced* osg::ObserverSet::addRefLock ( )

"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* osg::ObserverSet::getObserverdObject ( )
inline
const Referenced* osg::ObserverSet::getObserverdObject ( ) const
inline
Observers& osg::ObserverSet::getObservers ( )
inline
const Observers& osg::ObserverSet::getObservers ( ) const
inline
OpenThreads::Mutex* osg::ObserverSet::getObserverSetMutex ( ) const
inline
ObserverSet& osg::ObserverSet::operator= ( const ObserverSet )
inlineprotected
void osg::ObserverSet::removeObserver ( Observer observer)
void osg::ObserverSet::signalObjectDeleted ( void ptr)

Member Data Documentation

OpenThreads::Mutex osg::ObserverSet::_mutex
mutableprotected
Referenced* osg::ObserverSet::_observedObject
protected
Observers osg::ObserverSet::_observers
protected

The documentation for this class was generated from the following file:

osg logo
Generated at Wed Nov 11 2015 22:14:38 for the OpenSceneGraph by doxygen 1.8.10.