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

Base class/standard interface for objects which require IO support, cloning and reference counting. More...

Inherits osg::Referenced.

Inherited by osg::AnimationPath [virtual], osg::AudioSink, osg::AudioStream, osg::BufferData, osg::BufferData::ModifiedCallback [virtual], osg::BufferObject, osg::Callback [virtual], osg::Camera::DrawCallback [virtual], osg::ConvexPlanarOccluder, osg::Drawable::ComputeBoundingBoxCallback, osg::Drawable::DrawCallback [virtual], osg::DummyObject, osg::EllipsoidModel, osg::GraphicsContext, osg::Node, osg::Node::ComputeBoundingSphereCallback, osg::NodeVisitor [virtual], osg::Program::ProgramBinary, osg::RefMatrixd, osg::RefMatrixf, osg::RenderBuffer, osg::Script, osg::ScriptEngine, osg::Shader, osg::ShaderBinary, osg::ShaderComponent, osg::ShaderComposer, osg::Shape, osg::StateAttribute, osg::StateSet, osg::TessellationHints, osg::TransferFunction, osg::Uniform, osg::UserDataContainer, osg::ValueObject, osg::View [virtual], osgAnimation::Action, osgAnimation::Action::Callback, osgAnimation::Animation, osgAnimation::AnimationUpdateCallbackBase [virtual], osgAnimation::StackedTransformElement, osgAnimation::VertexInfluenceMap, osgDB::DatabaseRevision, osgDB::DatabaseRevisions, osgDB::FileList, osgDB::ImageProcessor, osgDB::MapIteratorObject, osgDB::Options, osgDB::ReaderWriter, osgGA::Device, osgGA::Event, osgGA::GUIEventAdapter::TouchData, osgManipulator::DraggerCallback [virtual], osgParticle::Counter, osgParticle::Interpolator, osgParticle::Operator, osgParticle::Placer, osgParticle::Shooter, osgShadow::ShadowSettings, osgShadow::ShadowTechnique, osgSim::BlinkSequence, osgSim::LightPointSystem, osgSim::ObjectRecordData, osgSim::Sector, osgSim::SequenceGroup, osgSim::ShapeAttributeList, osgTerrain::Layer, osgTerrain::Locator, osgTerrain::TerrainTechnique, osgText::Bevel, osgText::Font, osgText::Style, osgUtil::PositionalStateContainer, osgUtil::RenderBin, osgUtil::SceneView, osgViewer::Keystone, osgViewer::ViewConfig, osgViewer::ViewerBase [virtual], osgVolume::ImageDetails, osgVolume::Layer, osgVolume::Locator, osgVolume::Locator::LocatorCallback [virtual], osgVolume::Property, osgVolume::VolumeTechnique, osgWidget::BrowserManager, osgWidget::Style, and osgWidget::StyleManager.

Public Types

enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 return the name of the object's library. More...
 
virtual const char * className () const =0
 return the name of the object's class type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
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

virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- 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

Base class/standard interface for objects which require IO support, cloning and reference counting.

Based on GOF Composite, Prototype and Template Method patterns.

Member Enumeration Documentation

Enumerator
DYNAMIC 
STATIC 
UNSPECIFIED 

Constructor & Destructor Documentation

osg::Object::Object ( )
inline

Construct an object.

Note Object is a pure virtual base class and therefore cannot be constructed on its own, only derived classes which override the clone and className methods are concrete classes and can be constructed.

osg::Object::Object ( bool  threadSafeRefUnref)
inlineexplicit
osg::Object::Object ( const Object ,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.

virtual osg::Object::~Object ( )
protectedvirtual

Object destructor.

Note, is protected so that Objects cannot be deleted other than by being dereferenced and the reference count being zero (see osg::Referenced), preventing the deletion of nodes which are still in use. This also means that Nodes cannot be created on stack i.e Node node will not compile, forcing all nodes to be created on the heap i.e Node* node = new Node().

Member Function Documentation

virtual Node* osg::Object::asNode ( )
inlinevirtual

Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.

Equivalent to dynamic_cast<Node*>(this).

Reimplemented in osg::Node.

virtual const Node* osg::Object::asNode ( ) const
inlinevirtual

convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.

Equivalent to dynamic_cast<const Node*>(this).

Reimplemented in osg::Node.

virtual NodeVisitor* osg::Object::asNodeVisitor ( )
inlinevirtual

Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.

Equivalent to dynamic_cast<NodeVisitor*>(this).

virtual const NodeVisitor* osg::Object::asNodeVisitor ( ) const
inlinevirtual

convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.

Equivalent to dynamic_cast<const NodeVisitor*>(this).

Reimplemented in osg::NodeVisitor.

virtual StateAttribute* osg::Object::asStateAttribute ( )
inlinevirtual

Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.

Equivalent to dynamic_cast<StateAttribute*>(this).

Reimplemented in osg::StateAttribute.

virtual const StateAttribute* osg::Object::asStateAttribute ( ) const
inlinevirtual

convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.

Equivalent to dynamic_cast<const StateAttribute*>(this).

Reimplemented in osg::StateAttribute.

virtual Uniform* osg::Object::asUniform ( )
inlinevirtual

Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.

Equivalent to dynamic_cast<Uniform*>(this).

Reimplemented in osg::Uniform.

virtual const Uniform* osg::Object::asUniform ( ) const
inlinevirtual

convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.

Equivalent to dynamic_cast<const Uniform*>(this).

Reimplemented in osg::Uniform.

virtual const char* osg::Object::className ( ) const
pure virtual

return the name of the object's class type.

Must be defined by derived classes.

Implemented in osg::DrawElementsUInt, osg::RefMatrixf, osg::BufferData, osg::DrawElementsUShort, osg::GraphicsContext, osg::DrawElementsUByte, osg::Texture, osg::RefMatrixd, osg::BufferObject, osg::DrawArrayLengths, osg::DrawArrays, osgText::GlyphTexture, osgViewer::GraphicsWindowEmbedded, osg::StateAttribute, osgShadow::ShadowVolumeGeometry, osg::PrimitiveSet, osg::Image, osg::ShapeDrawable, osg::Array, osg::TemplateValueObject< T >, osg::Node, osg::BufferTemplate< std::vector< T > >, osgText::Font, osgViewer::GraphicsWindowX11, osg::Shape, osgFX::Effect, osgUtil::RenderBin, osg::Light, osgGA::UFOManipulator, osg::AudioStream, osg::ClipPlane, osgAnimation::MorphGeometry, osg::StateSet, osgSim::ImpostorSprite, osgGA::StandardManipulator, osgParticle::ParticleProcessor, osgUtil::RenderStage, osgViewer::GraphicsWindow, osgGA::CameraManipulator, osg::BufferTemplate< T >, osgShadow::OccluderGeometry, osg::Hint, osgManipulator::AntiSquish, osg::VertexAttribDivisor, osgGA::AnimationPathManipulator, osgParticle::Program, osg::DrawPixels, osgParticle::Emitter, osgParticle::Operator, osgParticle::ParticleEffect, osg::ImageSequence, osg::ImageStream, osg::UserDataContainer, osgParticle::Interpolator, osgUtil::PositionalStateContainer, osgGA::KeySwitchMatrixManipulator, osgGA::StateSetManipulator, osgSim::Sector, osgViewer::GraphicsWindowWin32, osgViewer::PixelBufferWin32, osg::AutoTransform, osgParticle::Placer, osgText::Text, osg::ShaderAttribute, osgDB::Archive, osgParticle::PrecipitationEffect, osgParticle::Shooter, osgText::TextBase, osgViewer::PixelBufferX11, osgGA::DriveManipulator, osgParticle::CenteredPlacer, osgParticle::VariableRateCounter, osg::AudioSink, osgParticle::Counter, osgGA::SphericalManipulator, and osgGA::CameraViewSwitchManipulator.

virtual Object* osg::Object::clone ( const CopyOp ) const
pure virtual
virtual Object* osg::Object::cloneType ( ) const
pure virtual
virtual void osg::Object::computeDataVariance ( )
inlinevirtual

Compute the DataVariance based on an assessment of callback etc.

Reimplemented in osg::Drawable, and osg::StateSet.

std::string osg::Object::getCompoundClassName ( ) const
inline

return the compound class name that combines the library name and class name.

DataVariance osg::Object::getDataVariance ( ) const
inline

Get the data variance of this object.

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

Get the name of object.

osg::UserDataContainer* osg::Object::getOrCreateUserDataContainer ( )

Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.

virtual Referenced* osg::Object::getUserData ( )
virtual

Get user data.

Reimplemented in osg::DefaultUserDataContainer, and osg::UserDataContainer.

virtual const Referenced* osg::Object::getUserData ( ) const
virtual

Get const user data.

Reimplemented in osg::DefaultUserDataContainer, and osg::UserDataContainer.

osg::UserDataContainer* osg::Object::getUserDataContainer ( )
inline

get the UserDataContainer attached to this object.

const osg::UserDataContainer* osg::Object::getUserDataContainer ( ) const
inline

get the const UserDataContainer attached to this object.

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool osg::Object::getUserValue ( const std::string &  name,
T &  value 
) const

provide implementation of osg::Object::getUserValue(..) template

template<typename T >
bool osg::Object::getUserValue ( const std::string &  name,
T &  value 
) const

Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.

To use this template method you need to include the osg/ValueObject header.

virtual bool osg::Object::isSameKindAs ( const Object ) const
inlinevirtual
virtual const char* osg::Object::libraryName ( ) const
pure virtual

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implemented in osg::DrawElementsUInt, osg::RefMatrixf, osg::BufferData, osg::DrawElementsUShort, osg::GraphicsContext, osg::DrawElementsUByte, osg::Texture, osg::RefMatrixd, osg::BufferObject, osg::DrawArrayLengths, osg::DrawArrays, osgViewer::GraphicsWindowEmbedded, osg::StateAttribute, osgShadow::ShadowVolumeGeometry, osg::PrimitiveSet, osg::Image, osg::ShapeDrawable, osg::Array, osg::TemplateValueObject< T >, osg::Node, osg::BufferTemplate< std::vector< T > >, osgText::Font, osgViewer::GraphicsWindowX11, osgFX::Effect, osgUtil::RenderBin, osg::Shape, osg::Light, osg::AudioStream, osg::ClipPlane, osgAnimation::MorphGeometry, osg::StateSet, osgSim::ImpostorSprite, osgParticle::ParticleProcessor, osgViewer::GraphicsWindow, osg::BufferTemplate< T >, osgShadow::OccluderGeometry, osg::Hint, osgManipulator::AntiSquish, osg::VertexAttribDivisor, osgParticle::Program, osg::DrawPixels, osgParticle::Emitter, osgParticle::Operator, osgParticle::ParticleEffect, osg::ImageSequence, osg::ImageStream, osg::AutoTransform, osgParticle::Interpolator, osgText::Text, osgUtil::PositionalStateContainer, osgSim::Sector, osgText::TextBase, osgViewer::GraphicsWindowWin32, osgViewer::PixelBufferWin32, osg::UserDataContainer, osgParticle::Placer, osg::ShaderAttribute, osgParticle::PrecipitationEffect, osgParticle::Shooter, osgViewer::PixelBufferX11, osgDB::Archive, osgParticle::CenteredPlacer, osgParticle::VariableRateCounter, osg::AudioSink, and osgParticle::Counter.

virtual void osg::Object::releaseGLObjects ( osg::State = 0) const
inlinevirtual
virtual void osg::Object::resizeGLObjectBuffers ( unsigned int  )
inlinevirtual
void osg::Object::setDataVariance ( DataVariance  dv)
inline

Set the data variance of this object.

Can be set to either STATIC for values that do not change over the lifetime of the object, or DYNAMIC for values that vary over the lifetime of the object. The DataVariance value can be used by routines such as optimization codes that wish to share static data. UNSPECIFIED is used to specify that the DataVariance hasn't been set yet.

virtual void osg::Object::setName ( const std::string &  name)
inlinevirtual

Set the name of object using C++ style string.

Reimplemented in osg::Uniform.

void osg::Object::setName ( const char *  name)
inline

Set the name of object using a C style string.

virtual void osg::Object::setThreadSafeRefUnref ( bool  threadSafe)
virtual
virtual void osg::Object::setUserData ( Referenced obj)
virtual

Set user data, data must be subclassed from Referenced to allow automatic memory handling.

If your own data isn't directly subclassed from Referenced then create an adapter object which points to your own object and handles the memory addressing.

Reimplemented in osg::DefaultUserDataContainer, and osg::UserDataContainer.

template<class T >
void osg::Object::setUserData ( const ref_ptr< T > &  ud)
inline
void osg::Object::setUserDataContainer ( osg::UserDataContainer udc)

set the UserDataContainer object.

template<class T >
void osg::Object::setUserDataContainer ( const ref_ptr< T > &  udc)
inline
template<typename T >
void osg::Object::setUserValue ( const std::string &  name,
const T &  value 
)

Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.

provide implementation of osg::Object::setUserValue(..) template.

To use this template method you need to include the osg/ValueObject header.

Member Data Documentation

DataVariance osg::Object::_dataVariance
protected
std::string osg::Object::_name
protected
osg::UserDataContainer* osg::Object::_userDataContainer
protected

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

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