OpenSceneGraph
3.2.0
|
Internal structure for storing all user data. More...
Public Types | |
typedef std::vector< std::string > | DescriptionList |
![]() | |
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. More... | |
virtual const char * | className () const |
return the name of the object's class type. More... | |
virtual void | setUserData (Referenced *obj)=0 |
Set user data, data must be subclassed from Referenced to allow automatic memory handling. More... | |
virtual Referenced * | getUserData ()=0 |
Get user data. More... | |
virtual const Referenced * | getUserData () const =0 |
Get const user data. More... | |
virtual unsigned int | addUserObject (Object *obj)=0 |
Add user data object. More... | |
virtual void | setUserObject (unsigned int i, Object *obj)=0 |
Add element to list of user data objects. More... | |
virtual void | removeUserObject (unsigned int i)=0 |
Remove element from the list of user data objects. More... | |
virtual Object * | getUserObject (unsigned int i)=0 |
Get user data object as specified index position. More... | |
virtual const Object * | getUserObject (unsigned int i) const =0 |
Get const user data object as specified index position. More... | |
virtual unsigned int | getNumUserObjects () const =0 |
Get number of user objects assigned to this object. More... | |
virtual unsigned int | getUserObjectIndex (const osg::Object *obj, unsigned int startPos=0) const =0 |
Get the index position of specified user data object. More... | |
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. More... | |
virtual Object * | getUserObject (const std::string &name, unsigned int startPos=0) |
Get first user data object with specified name. More... | |
virtual const Object * | getUserObject (const std::string &name, unsigned int startPos=0) const |
Get first const user data object with specified name. More... | |
virtual void | setDescriptions (const DescriptionList &descriptions)=0 |
Set the list of string descriptions. More... | |
virtual DescriptionList & | getDescriptions ()=0 |
Get the description list. More... | |
virtual const DescriptionList & | getDescriptions () const =0 |
Get the const description list. More... | |
virtual unsigned int | getNumDescriptions () const =0 |
Get number of description strings. More... | |
virtual void | addDescription (const std::string &desc)=0 |
Add a description string. More... | |
![]() | |
Object () | |
Construct an object. More... | |
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. More... | |
virtual Object * | cloneType () const =0 |
Clone the type of an object, with Object* return type. More... | |
virtual Object * | clone (const CopyOp &) const =0 |
Clone an object, with Object* return type. 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... | |
osg::UserDataContainer * | getUserDataContainer () |
get the UserDataContainer attached to this object. More... | |
const osg::UserDataContainer * | getUserDataContainer () const |
get the const UserDataContainer attached to this object. More... | |
osg::UserDataContainer * | getOrCreateUserDataContainer () |
Convinience 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<typename T > | |
bool | getUserValue (const std::string &name, T &value) const |
Convinience 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) |
Convinience 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 bool | getUserValue (const std::string &name, T &value) const |
provide implementation of osg::Object::getUserValue(..) template More... | |
![]() | |
Referenced () | |
Referenced (bool threadSafeRefUnref) | |
Referenced (const Referenced &) | |
Referenced & | operator= (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... | |
ObserverSet * | getObserverSet () const |
Get the ObserverSet if one is attached, otherwise return NULL. More... | |
ObserverSet * | getOrCreateObserverSet () 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 | ~UserDataContainer () |
![]() | |
virtual | ~Object () |
Object destructor. More... | |
![]() | |
virtual | ~Referenced () |
void | signalObserversAndDelete (bool signalDelete, bool doDelete) const |
void | deleteUsingDeleteHandler () const |
Additional Inherited Members | |
![]() | |
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 DeleteHandler * | getDeleteHandler () |
Get a DeleteHandler. More... | |
![]() | |
std::string | _name |
DataVariance | _dataVariance |
osg::UserDataContainer * | _userDataContainer |
Internal structure for storing all user data.
typedef std::vector<std::string> osg::UserDataContainer::DescriptionList |
osg::UserDataContainer::UserDataContainer | ( | ) |
osg::UserDataContainer::UserDataContainer | ( | const UserDataContainer & | udc, |
const osg::CopyOp & | copyop = osg::CopyOp::SHALLOW_COPY |
||
) |
|
inlineprotectedvirtual |
|
pure virtual |
Add a description string.
Implemented in osg::DefaultUserDataContainer.
|
pure virtual |
Add user data object.
Returns the index position of object added.
Implemented in osg::DefaultUserDataContainer.
Referenced by osg::Object::setUserValue().
|
inlinevirtual |
return the name of the object's class type.
Must be defined by derived classes.
Implements osg::Object.
|
pure virtual |
Get the description list.
Implemented in osg::DefaultUserDataContainer.
|
pure virtual |
Get the const 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.
|
pure virtual |
|
pure virtual |
|
pure virtual |
Get user data object as specified index position.
Implemented in osg::DefaultUserDataContainer.
Referenced by osg::Object::getUserValue().
|
pure virtual |
Get const user data object as specified index position.
Implemented in osg::DefaultUserDataContainer.
|
virtual |
Get first user data object with specified name.
|
virtual |
Get first const user data object with specified name.
|
pure virtual |
Get the index position of specified user data object.
Implemented in osg::DefaultUserDataContainer.
Referenced by 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.
|
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.
|
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.
Add element to list of user data objects.
Implemented in osg::DefaultUserDataContainer.
Referenced by osg::Object::setUserValue().
![]() | Generated at Wed Aug 14 2013 13:02:15 for the OpenSceneGraph by doxygen 1.8.4. |