OpenSceneGraph 3.6.5
osg::Operation Class Referenceabstract

Base class for implementing graphics operations. More...

#include <OperationThread>

Inheritance diagram for osg::Operation:

Public Member Functions

 Operation (const std::string &name, bool keep)
void setName (const std::string &name)
 Set the human readable name of the operation.
const std::string & getName () const
 Get the human readable name of the operation.
void setKeep (bool keep)
 Set whether the operation should be kept once its been applied.
bool getKeep () const
 Get whether the operation should be kept once its been applied.
virtual void release ()
 if this operation is a barrier then release it.
virtual void operator() (Object *)=0
 Do the actual task of this operation.
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
virtual void setThreadSafeRefUnref (bool)
 Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called.
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Member Functions

 Operation ()
virtual ~Operation ()
Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

std::string _name
bool _keep
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.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

Detailed Description

Base class for implementing graphics operations.

Constructor & Destructor Documentation

◆ Operation() [1/2]

osg::Operation::Operation ( const std::string & name,
bool keep )
inline

◆ Operation() [2/2]

osg::Operation::Operation ( )
inlineprotected

References _keep.

◆ ~Operation()

virtual osg::Operation::~Operation ( )
inlineprotectedvirtual

Member Function Documentation

◆ getKeep()

bool osg::Operation::getKeep ( ) const
inline

Get whether the operation should be kept once its been applied.

References _keep.

◆ getName()

const std::string & osg::Operation::getName ( ) const
inline

Get the human readable name of the operation.

References _name.

◆ operator()()

virtual void osg::Operation::operator() ( Object * )
pure virtual

Do the actual task of this operation.

Implemented in osg::BarrierOperation, osg::GraphicsOperation, and osgViewer::Renderer.

◆ release()

virtual void osg::Operation::release ( )
inlinevirtual

if this operation is a barrier then release it.

Reimplemented in osg::BarrierOperation, osg::BlockAndFlushOperation, osg::ReleaseContext_Block_MakeCurrentOperation, and osgViewer::Renderer.

◆ setKeep()

void osg::Operation::setKeep ( bool keep)
inline

Set whether the operation should be kept once its been applied.

References _keep.

◆ setName()

void osg::Operation::setName ( const std::string & name)
inline

Set the human readable name of the operation.

References _name.

Member Data Documentation

◆ _keep

bool osg::Operation::_keep
protected

Referenced by getKeep(), Operation(), Operation(), and setKeep().

◆ _name

std::string osg::Operation::_name
protected

Referenced by getName(), Operation(), and setName().


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

osg logo
Generated at Wed Jul 23 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.