OpenSceneGraph 3.6.5
|
Internal structure for storing all user data. More...
#include <UserDataContainer>
Public Types | |
typedef std::vector< std::string > | DescriptionList |
Public Types inherited from osg::Object | |
enum | DataVariance { DYNAMIC , STATIC , UNSPECIFIED } |
Public Member Functions | |
UserDataContainer () | |
UserDataContainer (const UserDataContainer &udc, const osg::CopyOp ©op=osg::CopyOp::SHALLOW_COPY) | |
virtual bool | isSameKindAs (const Object *obj) const |
virtual const char * | libraryName () const |
return the name of the object's library. | |
virtual const char * | className () const |
return the name of the object's class type. | |
virtual UserDataContainer * | asUserDataContainer () |
Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. | |
virtual const UserDataContainer * | asUserDataContainer () const |
convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. | |
virtual void | setUserData (Referenced *obj)=0 |
Set user data, data must be subclassed from Referenced to allow automatic memory handling. | |
virtual Referenced * | getUserData ()=0 |
Get user data. | |
virtual const Referenced * | getUserData () const =0 |
Get const user data. | |
virtual unsigned int | addUserObject (Object *obj)=0 |
Add user data object. | |
template<class T> | |
unsigned int | addUserObject (const osg::ref_ptr< T > &obj) |
virtual void | setUserObject (unsigned int i, Object *obj)=0 |
Add element to list of user data objects. | |
virtual void | removeUserObject (unsigned int i)=0 |
Remove element from the list of user data objects. | |
virtual Object * | getUserObject (unsigned int i)=0 |
Get user data object as specified index position. | |
virtual const Object * | getUserObject (unsigned int i) const =0 |
Get const user data object as specified index position. | |
virtual unsigned int | getNumUserObjects () const =0 |
Get number of user objects assigned to this object. | |
virtual unsigned int | getUserObjectIndex (const osg::Object *obj, unsigned int startPos=0) const =0 |
Get the index position of specified user data object. | |
virtual unsigned int | getUserObjectIndex (const std::string &name, unsigned int startPos=0) const =0 |
Get the index position of first user data object that matches specified name. | |
virtual Object * | getUserObject (const std::string &name, unsigned int startPos=0) |
Get first user data object with specified name. | |
virtual const Object * | getUserObject (const std::string &name, unsigned int startPos=0) const |
Get first const user data object with specified name. | |
virtual void | setDescriptions (const DescriptionList &descriptions)=0 |
Set the list of string descriptions. | |
virtual DescriptionList & | getDescriptions ()=0 |
Get the description list. | |
virtual const DescriptionList & | getDescriptions () const =0 |
Get the const description list. | |
virtual unsigned int | getNumDescriptions () const =0 |
Get number of description strings. | |
virtual void | addDescription (const std::string &desc)=0 |
Add a description string. | |
template<class T> | |
void | setUserData (const ref_ptr< T > &ud) |
Public Member Functions inherited from osg::Object | |
Object () | |
Construct an object. | |
Object (bool threadSafeRefUnref) | |
Object (const Object &, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. | |
virtual Object * | cloneType () const =0 |
Clone the type of an object, with Object* return type. | |
virtual Object * | clone (const CopyOp &) const =0 |
Clone an object, with Object* return type. | |
std::string | getCompoundClassName () const |
return the compound class name that combines the library name and class name. | |
virtual Node * | asNode () |
Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. | |
virtual const Node * | asNode () const |
convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. | |
virtual NodeVisitor * | asNodeVisitor () |
Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. | |
virtual const NodeVisitor * | asNodeVisitor () const |
convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. | |
virtual StateSet * | asStateSet () |
Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. | |
virtual const StateSet * | asStateSet () const |
convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. | |
virtual StateAttribute * | asStateAttribute () |
Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. | |
virtual const StateAttribute * | asStateAttribute () const |
convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. | |
virtual Uniform * | asUniform () |
Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. | |
virtual const Uniform * | asUniform () const |
convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. | |
virtual Camera * | asCamera () |
Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. | |
virtual const Camera * | asCamera () const |
convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. | |
virtual Drawable * | asDrawable () |
Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. | |
virtual const Drawable * | asDrawable () const |
convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. | |
virtual Callback * | asCallback () |
Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. | |
virtual const Callback * | asCallback () const |
convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. | |
virtual CallbackObject * | asCallbackObject () |
Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. | |
virtual const CallbackObject * | asCallbackObject () const |
convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. | |
virtual ValueObject * | asValueObject () |
Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. | |
virtual const ValueObject * | asValueObject () const |
Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. | |
virtual Image * | asImage () |
Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. | |
virtual const Image * | asImage () const |
Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. | |
virtual void | setThreadSafeRefUnref (bool threadSafe) |
Set whether to use a mutex to ensure ref() and unref() are thread safe. | |
virtual void | setName (const std::string &name) |
Set the name of object using C++ style string. | |
void | setName (const char *name) |
Set the name of object using a C style string. | |
const std::string & | getName () const |
Get the name of object. | |
void | setDataVariance (DataVariance dv) |
Set the data variance of this object. | |
DataVariance | getDataVariance () const |
Get the data variance of this object. | |
virtual void | computeDataVariance () |
Compute the DataVariance based on an assessment of callback etc. | |
void | setUserDataContainer (osg::UserDataContainer *udc) |
set the UserDataContainer object. | |
template<class T> | |
void | setUserDataContainer (const ref_ptr< T > &udc) |
osg::UserDataContainer * | getUserDataContainer () |
get the UserDataContainer attached to this object. | |
const osg::UserDataContainer * | getUserDataContainer () const |
get the const UserDataContainer attached to this object. | |
osg::UserDataContainer * | 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. | |
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. | |
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. | |
virtual void | resizeGLObjectBuffers (unsigned int) |
Resize any per context GLObject buffers to specified size. | |
virtual void | releaseGLObjects (osg::State *=0) const |
If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. | |
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 | |
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 &) | |
Referenced & | operator= (const Referenced &) |
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. | |
ObserverSet * | getObserverSet () const |
Get the ObserverSet if one is attached, otherwise return NULL. | |
ObserverSet * | getOrCreateObserverSet () 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 | |
virtual | ~UserDataContainer () |
Protected Member Functions inherited from osg::Object | |
virtual | ~Object () |
Object destructor. | |
Protected Member Functions inherited from osg::Referenced | |
virtual | ~Referenced () |
void | signalObserversAndDelete (bool signalDelete, bool doDelete) const |
void | deleteUsingDeleteHandler () const |
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 DeleteHandler * | getDeleteHandler () |
Get a DeleteHandler. | |
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 |
Internal structure for storing all user data.
typedef std::vector<std::string> osg::UserDataContainer::DescriptionList |
osg::UserDataContainer::UserDataContainer | ( | ) |
Referenced by asUserDataContainer(), asUserDataContainer(), isSameKindAs(), and UserDataContainer().
osg::UserDataContainer::UserDataContainer | ( | const UserDataContainer & | udc, |
const osg::CopyOp & | copyop = osg::CopyOp::SHALLOW_COPY ) |
References osg::CopyOp::SHALLOW_COPY, and UserDataContainer().
|
inlineprotectedvirtual |
|
pure virtual |
Add a description string.
Implemented in osg::DefaultUserDataContainer.
|
inline |
References addUserObject(), and osg::ref_ptr< T >::get().
Referenced by addUserObject().
|
pure virtual |
Add user data object.
Returns the index position of object added.
Implemented in osg::DefaultUserDataContainer.
References osg::Object::Object().
Referenced by osg::getOrCreateUserObjectOfType(), osgDB::ClassInterface::setProperty(), osg::DefaultUserDataContainer::setUserData(), and osg::Object::setUserValue().
|
inlinevirtual |
Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
Equivalent to dynamic_cast<UserDataContainer*>(this).
Reimplemented from osg::Object.
References UserDataContainer().
|
inlinevirtual |
convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
Equivalent to dynamic_cast<const UserDataContainer*>(this).
Reimplemented from osg::Object.
References UserDataContainer().
|
inlinevirtual |
return the name of the object's class type.
Must be defined by derived classes.
Implements osg::Object.
|
pure virtual |
Get the const description list.
Implemented in osg::DefaultUserDataContainer.
|
pure virtual |
Get the description list.
Implemented in osg::DefaultUserDataContainer.
|
pure virtual |
Get number of description strings.
Implemented in osg::DefaultUserDataContainer.
|
pure virtual |
Get number of user objects assigned to this object.
Implemented in osg::DefaultUserDataContainer.
Referenced by osg::runNamedCallbackObjects().
|
pure virtual |
|
pure virtual |
|
virtual |
Get first user data object with specified name.
References osg::Object::Object().
|
virtual |
Get first const user data object with specified name.
References osg::Object::Object().
|
pure virtual |
Get const user data object as specified index position.
Implemented in osg::DefaultUserDataContainer.
References osg::Object::Object().
|
pure virtual |
Get user data object as specified index position.
Implemented in osg::DefaultUserDataContainer.
References osg::Object::Object().
Referenced by osg::getCallbackObject(), osg::getCallbackObject(), osg::getOrCreateUserObjectOfType(), osgDB::ClassInterface::getProperty(), osg::getUserObject(), osg::getUserObject(), osg::Object::getUserValue(), osg::runNamedCallbackObjects(), osgDB::ClassInterface::setProperty(), and osg::Object::setUserValue().
|
pure virtual |
Get the index position of specified user data object.
Implemented in osg::DefaultUserDataContainer.
Referenced by osg::getOrCreateUserObjectOfType(), osgDB::ClassInterface::setProperty(), and osg::Object::setUserValue().
|
pure virtual |
Get the index position of first user data object that matches specified name.
Implemented in osg::DefaultUserDataContainer.
|
inlinevirtual |
Reimplemented from osg::Object.
References osg::Object::Object(), and UserDataContainer().
|
inlinevirtual |
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.
Implements osg::Object.
|
pure virtual |
Remove element from the list of user data objects.
Implemented in osg::DefaultUserDataContainer.
|
pure virtual |
Set the list of string descriptions.
Implemented in osg::DefaultUserDataContainer.
|
inline |
|
pure 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 from osg::Object.
Implemented in osg::DefaultUserDataContainer.
References osg::Object::setUserData().
|
pure virtual |
Add element to list of user data objects.
Implemented in osg::DefaultUserDataContainer.
References osg::Object::Object().
Referenced by osg::getOrCreateUserObjectOfType(), osgDB::ClassInterface::setProperty(), and osg::Object::setUserValue().
![]() | Generated at Sun Jul 27 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0. |