openscenegraph
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
osg::Referenced Class Reference
Inheritance diagram for osg::Referenced:
osg::ApplicationUsage osg::ArrayDispatchers osg::AttributeDispatch osg::BlendColor::Extensions osg::BlendEquation::Extensions osg::BlendFunc::Extensions osg::ClampColor::Extensions osg::CullingSet osg::CullSettings::ClampProjectionMatrixCallback osg::DisplaySettings osg::Drawable::Extensions osg::FBOExtensions osg::FragmentProgram::Extensions osg::FrameStamp osg::GeometryCostEstimator osg::GL2Extensions osg::GLBufferObject osg::GLBufferObject::Extensions osg::GLBufferObjectManager osg::GLBufferObjectSet osg::GraphicsContext::ResizedCallback osg::GraphicsContext::SwapCallback osg::GraphicsContext::Traits osg::GraphicsContext::WindowingSystemInterface osg::GraphicsCostEstimator osg::Image::DimensionsChangedCallback osg::LineSegment osg::Multisample::Extensions osg::NodeVisitor osg::NodeVisitor::DatabaseRequestHandler osg::NodeVisitor::ImageRequestHandler osg::NotifyHandler osg::Object osg::ObserverSet osg::Operation osg::OperationQueue osg::OperationThread osg::Point::Extensions osg::PrimitiveRestartIndex::Extensions osg::ProgramCostEstimator osg::RefBlock osg::RefBlockCount osg::SampleMaski::Extensions osg::State osg::State::DynamicObjectRenderingCompletedCallback osg::Stats osg::Stencil::Extensions osg::StencilTwoSided::Extensions osg::TestResult osg::Texture1D::SubloadCallback osg::Texture2D::SubloadCallback osg::Texture2DArray::Extensions osg::Texture2DArray::SubloadCallback osg::Texture3D::Extensions osg::Texture3D::SubloadCallback osg::Texture::Extensions osg::Texture::TextureObject osg::Texture::TextureObjectManager osg::Texture::TextureObjectSet osg::TextureBuffer::TextureBufferObject osg::TextureCostEstimator osg::TextureCubeMap::Extensions osg::TextureCubeMap::SubloadCallback osg::TextureRectangle::SubloadCallback osg::VertexProgram::Extensions osg::View::Slave::UpdateSlaveCallback osgAnimation::ActionVisitor osgAnimation::Channel osgAnimation::KeyframeContainer osgAnimation::Motion osgAnimation::RigTransform osgAnimation::Sampler osgAnimation::Target osgAnimation::TemplateCompositeSampler< VALUESAMPLERTYPE, TIMESAMPLERTYPE > osgDB::AuthenticationDetails osgDB::AuthenticationMap osgDB::BaseCompressor osgDB::BaseSerializer osgDB::DatabasePager::DatabaseRequest osgDB::DatabasePager::DatabaseThread osgDB::DatabasePager::PagedLODList osgDB::DatabasePager::RequestQueue osgDB::DeprecatedDotOsgWrapperManager osgDB::DotOsgWrapper osgDB::DynamicLibrary osgDB::FileCache osgDB::FileLocationCallback osgDB::FindFileCallback osgDB::FinishedObjectReadCallback osgDB::ImageOptions::TexCoordRange osgDB::ImagePager::ImageRequest osgDB::ImagePager::ImageThread osgDB::ImagePager::RequestQueue osgDB::InputException osgDB::InputIterator osgDB::ObjectWrapper osgDB::ObjectWrapperManager osgDB::OutputException osgDB::OutputIterator osgDB::ReaderWriterInfo osgDB::ReadFileCallback osgDB::Registry osgDB::WriteFileCallback osgDB::XmlNode osgFX::Registry osgFX::Technique osgGA::AnimationPathManipulator::AnimationCompletedCallback osgGA::CameraManipulator::CoordinateFrameCallback osgGA::EventQueue osgGA::PointerData osgGA::StandardManipulator::AnimationData osgManipulator::CommandManager osgManipulator::Constraint osgManipulator::MotionCommand osgManipulator::Projector osgPresentation::FilePathData osgPresentation::HomePosition osgPresentation::HUDSettings osgPresentation::LayerAttributes osgPresentation::LayerCallback osgPresentation::ObjectOperator osgQt::GraphicsWindowQt::WindowData osgShadow::ParallelSplitShadowMap::FragmentShaderGenerator osgShadow::ViewDependentShadowMap::LightData osgShadow::ViewDependentShadowMap::ShadowData osgShadow::ViewDependentShadowMap::ViewDependentData osgShadow::ViewDependentShadowTechnique::ViewData osgSim::GeographicLocation osgSim::ImpostorSpriteManager osgSim::OverlayNode::OverlayData osgSim::ScalarBar::ScalarPrinter osgSim::ScalarsToColors osgTerrain::GeometryTechnique::BufferData osgTerrain::TerrainTile::TileLoadedCallback osgTerrain::ValidDataOperator osgText::Font::FontImplementation osgText::Glyph3D osgText::GlyphGeometry osgUtil::CubeMapGenerator osgUtil::CullVisitor::Identifier osgUtil::DelaunayTriangulator osgUtil::EdgeCollector::Edge osgUtil::EdgeCollector::Edgeloop osgUtil::EdgeCollector::Point osgUtil::EdgeCollector::Triangle osgUtil::IncrementalCompileOperation::CompileCompletedCallback osgUtil::IncrementalCompileOperation::CompileOp osgUtil::IncrementalCompileOperation::CompileSet osgUtil::IntersectionVisitor::ReadCallback osgUtil::Intersector osgUtil::IntersectVisitor::IntersectState osgUtil::Optimizer::IsOperationPermissibleForObjectCallback osgUtil::Optimizer::TextureAtlasBuilder::Atlas osgUtil::Optimizer::TextureAtlasBuilder::Source osgUtil::RenderBin::DrawCallback osgUtil::RenderBin::SortCallback osgUtil::RenderLeaf osgUtil::SceneView::ComputeStereoMatricesCallback osgUtil::ShaderGenCache osgUtil::Simplifier::ContinueSimplificationCallback osgUtil::StateGraph osgUtil::TangentSpaceGenerator osgUtil::Tessellator osgUtil::Tessellator::Prim osgViewer::GraphicsWindowWin32::WindowData osgViewer::GraphicsWindowX11::WindowData osgViewer::OpenGLQuerySupport osgViewer::Scene osgViewer::ScreenCaptureHandler::CaptureOperation osgWidget::Callback osgWidget::CallbackInterface osgWidget::ScriptEngine

Public Member Functions

 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Static Public Member Functions

static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Protected Member Functions

virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Friends

class DeleteHandler
 

Detailed Description

Base class for providing reference counted objects.

Constructor & Destructor Documentation

osg::Referenced::Referenced ( )
osg::Referenced::Referenced ( bool  threadSafeRefUnref)
explicit
osg::Referenced::Referenced ( const Referenced )
virtual osg::Referenced::~Referenced ( )
protectedvirtual

Member Function Documentation

void osg::Referenced::addObserver ( Observer observer) const

Add a Observer that is observing this object, notify the Observer when this object gets deleted.

void osg::Referenced::deleteUsingDeleteHandler ( ) const
protected
static DeleteHandler* osg::Referenced::getDeleteHandler ( )
static

Get a DeleteHandler.

static OpenThreads::Mutex* osg::Referenced::getGlobalReferencedMutex ( )
static

Get the optional global Referenced mutex, this can be shared between all osg::Referenced.

ObserverSet* osg::Referenced::getObserverSet ( ) const
inline

Get the ObserverSet if one is attached, otherwise return NULL.

ObserverSet* osg::Referenced::getOrCreateObserverSet ( ) const

Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.

OpenThreads::Mutex* osg::Referenced::getRefMutex ( ) const
inline

Get the mutex used to ensure thread safety of ref()/unref().

static bool osg::Referenced::getThreadSafeReferenceCounting ( )
static

Get whether reference counting is active.

bool osg::Referenced::getThreadSafeRefUnref ( ) const
inline

Get whether a mutex is used to ensure ref() and unref() are thread safe.

Referenced& osg::Referenced::operator= ( const Referenced )
inline
int osg::Referenced::ref ( ) const
inline

Increment the reference count by one, indicating that this object has another pointer which is referencing it.

References _refCount.

Referenced by osg::intrusive_ptr_add_ref(), and osgPresentation::PropertyManager::ref().

int osg::Referenced::referenceCount ( ) const
inline

Return the number of pointers currently referencing this object.

void osg::Referenced::removeObserver ( Observer observer) const

Remove Observer that is observing this object.

static void osg::Referenced::setDeleteHandler ( DeleteHandler handler)
static

Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.

static void osg::Referenced::setThreadSafeReferenceCounting ( bool  enableThreadSafeReferenceCounting)
static

Set whether reference counting should use a mutex for thread safe reference counting.

virtual void osg::Referenced::setThreadSafeRefUnref ( bool  threadSafe)
virtual
void osg::Referenced::signalObserversAndDelete ( bool  signalDelete,
bool  doDelete 
) const
protected

Referenced by unref().

int osg::Referenced::unref ( ) const
inline

Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. If the reference count goes to zero, it is assumed that this object is no longer referenced and is automatically deleted.

References _refCount, and signalObserversAndDelete().

Referenced by osg::intrusive_ptr_release(), and osgPresentation::PropertyManager::unref().

int osg::Referenced::unref_nodelete ( ) const

Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. However, do not delete it, even if ref count goes to 0. Warning, unref_nodelete() should only be called if the user knows exactly who will be responsible for, one should prefer unref() over unref_nodelete() as the latter can lead to memory leaks.

Referenced by osg::observer_ptr< osgWidget::Widget >::lock().

Friends And Related Function Documentation

friend class DeleteHandler
friend

Member Data Documentation

OpenThreads::AtomicPtr osg::Referenced::_observerSet
mutableprotected
OpenThreads::Atomic osg::Referenced::_refCount
mutableprotected

Referenced by ref(), and unref().


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