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

Internal structure for storing all user data. More...

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

Public Member Functions

 DefaultUserDataContainer ()
 
 DefaultUserDataContainer (const DefaultUserDataContainer &udc, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osg, DefaultUserDataContainer) virtual void setThreadSafeRefUnref(bool threadSafe)
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
virtual unsigned int addUserObject (Object *obj)
 Add user data object. More...
 
virtual void setUserObject (unsigned int i, Object *obj)
 Add element to list of user data objects. More...
 
virtual void removeUserObject (unsigned int i)
 Remove element from the list of user data objects. More...
 
virtual ObjectgetUserObject (unsigned int i)
 Get user data object as specified index position. More...
 
virtual const ObjectgetUserObject (unsigned int i) const
 Get const user data object as specified index position. More...
 
virtual unsigned int getNumUserObjects () const
 Get number of user objects assigned to this object. More...
 
virtual unsigned int getUserObjectIndex (const osg::Object *obj, unsigned int startPos=0) const
 Get the index position of specified user data object. More...
 
virtual unsigned int getUserObjectIndex (const std::string &name, unsigned int startPos=0) const
 Get the index position of first user data object that matches specified name. More...
 
virtual void setDescriptions (const DescriptionList &descriptions)
 Set the list of string descriptions. More...
 
virtual DescriptionListgetDescriptions ()
 Get the description list. More...
 
virtual const DescriptionListgetDescriptions () const
 Get the const description list. More...
 
virtual unsigned int getNumDescriptions () const
 Get number of description strings. More...
 
virtual void addDescription (const std::string &desc)
 Add a description string. More...
 
- Public Member Functions inherited from osg::UserDataContainer
 UserDataContainer ()
 
 UserDataContainer (const UserDataContainer &udc, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 return the name of the object's library. More...
 
virtual const char * className () const
 return the name of the object's class type. More...
 
template<class T >
unsigned int addUserObject (const osg::ref_ptr< T > &obj)
 
virtual ObjectgetUserObject (const std::string &name, unsigned int startPos=0)
 Get first user data object with specified name. More...
 
virtual const ObjectgetUserObject (const std::string &name, unsigned int startPos=0) const
 Get first const user data object with specified name. More...
 
- Public Member Functions inherited from osg::Object
 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...
 
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...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
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 Types

typedef std::vector< osg::ref_ptr< osg::Object > > ObjectList
 

Protected Member Functions

virtual ~DefaultUserDataContainer ()
 
- Protected Member Functions inherited from osg::UserDataContainer
virtual ~UserDataContainer ()
 
- Protected Member Functions inherited from osg::Object
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

ref_ptr< Referenced_userData
 
DescriptionList _descriptionList
 
ObjectList _objectList
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Public Types inherited from osg::UserDataContainer
typedef std::vector< std::string > DescriptionList
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 
- 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

Internal structure for storing all user data.

Member Typedef Documentation

Constructor & Destructor Documentation

osg::DefaultUserDataContainer::DefaultUserDataContainer ( )
osg::DefaultUserDataContainer::DefaultUserDataContainer ( const DefaultUserDataContainer udc,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osg::DefaultUserDataContainer::~DefaultUserDataContainer ( )
inlineprotectedvirtual

Member Function Documentation

virtual void osg::DefaultUserDataContainer::addDescription ( const std::string &  desc)
virtual

Add a description string.

Implements osg::UserDataContainer.

virtual unsigned int osg::DefaultUserDataContainer::addUserObject ( Object obj)
virtual

Add user data object.

Returns the index position of object added.

Implements osg::UserDataContainer.

virtual DescriptionList& osg::DefaultUserDataContainer::getDescriptions ( )
virtual

Get the description list.

Implements osg::UserDataContainer.

virtual const DescriptionList& osg::DefaultUserDataContainer::getDescriptions ( ) const
virtual

Get the const description list.

Implements osg::UserDataContainer.

virtual unsigned int osg::DefaultUserDataContainer::getNumDescriptions ( ) const
virtual

Get number of description strings.

Implements osg::UserDataContainer.

virtual unsigned int osg::DefaultUserDataContainer::getNumUserObjects ( ) const
virtual

Get number of user objects assigned to this object.

Implements osg::UserDataContainer.

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

Get user data.

Implements osg::UserDataContainer.

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

Get const user data.

Implements osg::UserDataContainer.

virtual Object* osg::DefaultUserDataContainer::getUserObject ( unsigned int  i)
virtual

Get user data object as specified index position.

Implements osg::UserDataContainer.

virtual const Object* osg::DefaultUserDataContainer::getUserObject ( unsigned int  i) const
virtual

Get const user data object as specified index position.

Implements osg::UserDataContainer.

virtual unsigned int osg::DefaultUserDataContainer::getUserObjectIndex ( const osg::Object obj,
unsigned int  startPos = 0 
) const
virtual

Get the index position of specified user data object.

Implements osg::UserDataContainer.

virtual unsigned int osg::DefaultUserDataContainer::getUserObjectIndex ( const std::string &  name,
unsigned int  startPos = 0 
) const
virtual

Get the index position of first user data object that matches specified name.

Implements osg::UserDataContainer.

osg::DefaultUserDataContainer::META_Object ( osg  ,
DefaultUserDataContainer   
)
virtual void osg::DefaultUserDataContainer::removeUserObject ( unsigned int  i)
virtual

Remove element from the list of user data objects.

Implements osg::UserDataContainer.

virtual void osg::DefaultUserDataContainer::setDescriptions ( const DescriptionList descriptions)
virtual

Set the list of string descriptions.

Implements osg::UserDataContainer.

virtual void osg::DefaultUserDataContainer::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.

Implements osg::UserDataContainer.

virtual void osg::DefaultUserDataContainer::setUserObject ( unsigned int  i,
Object obj 
)
virtual

Add element to list of user data objects.

Implements osg::UserDataContainer.

Member Data Documentation

DescriptionList osg::DefaultUserDataContainer::_descriptionList
protected
ObjectList osg::DefaultUserDataContainer::_objectList
protected
ref_ptr<Referenced> osg::DefaultUserDataContainer::_userData
protected

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

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