osg::DefaultUserDataContainer Class Reference

#include <UserDataContainer.h>

Inheritance diagram for osg::DefaultUserDataContainer:

Collaboration diagram for osg::DefaultUserDataContainer:

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)
virtual Referenced *	getUserData ()
virtual const Referenced *	getUserData () const
virtual unsigned int	addUserObject (Object *obj)
virtual void	setUserObject (unsigned int i, Object *obj)
virtual void	removeUserObject (unsigned int i)
virtual Object *	getUserObject (unsigned int i)
virtual const Object *	getUserObject (unsigned int i) const
virtual unsigned int	getNumUserObjects () const
virtual unsigned int	getUserObjectIndex (const osg::Object *obj, unsigned int startPos=0) const
virtual unsigned int	getUserObjectIndex (const std::string &name, unsigned int startPos=0) const
virtual void	setDescriptions (const DescriptionList &descriptions)
virtual DescriptionList &	getDescriptions ()
virtual const DescriptionList &	getDescriptions () const
virtual unsigned int	getNumDescriptions () const
virtual void	addDescription (const std::string &desc)
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
virtual const char *	className () const
virtual Object *	getUserObject (const std::string &name, unsigned int startPos=0)
virtual const Object *	getUserObject (const std::string &name, unsigned int startPos=0) const
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const =0
virtual Object *	clone (const CopyOp &) const =0
std::string	getCompoundClassName () const
virtual Node *	asNode ()
virtual const Node *	asNode () const
virtual NodeVisitor *	asNodeVisitor ()
virtual const NodeVisitor *	asNodeVisitor () const
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
virtual void	setThreadSafeRefUnref (bool threadSafe)
virtual void	setName (const std::string &name)
void	setName (const char *name)
const std::string &	getName () const
void	setDataVariance (DataVariance dv)
DataVariance	getDataVariance () const
virtual void	computeDataVariance ()
void	setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
template<typename T >
void	setUserValue (const std::string &name, const T &value)
virtual void	resizeGLObjectBuffers (unsigned int)
virtual void	releaseGLObjects (osg::State *=0) const
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
int	unref () const
int	unref_nodelete () const
int	referenceCount () const
ObserverSet *	getObserverSet () const
ObserverSet *	getOrCreateObserverSet () const
void	addObserver (Observer *observer) const
void	removeObserver (Observer *observer) const

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 ()
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 ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()

Detailed Description

Internal structure for storing all user data.

Definition at line 111 of file UserDataContainer.h.

Member Typedef Documentation

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

protected

Definition at line 183 of file UserDataContainer.h.

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

Definition at line 181 of file UserDataContainer.h.

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

Definition at line 186 of file UserDataContainer.h.

ObjectList osg::DefaultUserDataContainer::_objectList

protected

Definition at line 187 of file UserDataContainer.h.

ref_ptr<Referenced> osg::DefaultUserDataContainer::_userData

protected

Definition at line 185 of file UserDataContainer.h.

---

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

• osg_head/include/osg/UserDataContainer.h