OpenSceneGraph  3.0.1
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
osg::DefaultUserDataContainer Class Reference

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

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

List of all members.

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.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
virtual unsigned int addUserObject (Object *obj)
 Add user data object.
virtual void setUserObject (unsigned int i, Object *obj)
 Add element to list of user data objects.
virtual void removeUserObject (unsigned int i)
 Remove element from the list of user data objects.
virtual ObjectgetUserObject (unsigned int i)
 Get user data object as specified index position.
virtual const ObjectgetUserObject (unsigned int i) const
 Get const user data object as specified index position.
virtual unsigned int getNumUserObjects () const
 Get number of user objects assigned to this object.
virtual unsigned int getUserObjectIndex (const osg::Object *obj, unsigned int startPos=0) const
 Get the index position of specified user data object.
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.
virtual void setDescriptions (const DescriptionList &descriptions)
 Set the list of string descriptions.
virtual DescriptionListgetDescriptions ()
 Get the description list.
virtual const DescriptionListgetDescriptions () const
 Get the const description list.
virtual unsigned int getNumDescriptions () const
 Get number of description strings.
virtual void addDescription (const std::string &desc)
 Add a description string.

Protected Types

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

Protected Member Functions

virtual ~DefaultUserDataContainer ()

Protected Attributes

ref_ptr< Referenced_userData
DescriptionList _descriptionList
ObjectList _objectList

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 ( ) [inline, protected, virtual]

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


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

osg logo
Generated at Mon Oct 3 2011 12:39:45 for the OpenSceneGraph by doxygen 1.7.5.