Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

MultipleUserDefinedObject Class Reference

Hashmap for multiple user defined objects. More...

#include <MultipleUserDefinedObject.h>

List of all members.

Public Member Functions

void attachUserObject (UserDefinedObject *object)
 Inserts a new UserDefinedObject. Loses reference to existing object of the same type, if it already exists.
UserDefinedObject * detachUserObject (long typeId)
 Removes the UserDefinedObject of the specified type ID.
long getTypeID (void) const
 Inherted from Ogre::UserDefinedObject.
const String & getTypeName (void) const
 Inherted from Ogre::UserDefinedObject.
UserDefinedObject * getUserObjectByType (long typeId) const
 Retrieves a UserDefinedObject of specific type.

Static Public Attributes

static const long multipleUserDefinedObjectTypeId
static const String multipleUserDefinedObjectTypeName

Private Attributes

std::map< long, UserDefinedObject * > userDefinedObjects


Detailed Description

Hashmap for multiple user defined objects.


Member Function Documentation

void attachUserObject UserDefinedObject *  object  )  [inline]
 

Inserts a new UserDefinedObject. Loses reference to existing object of the same type, if it already exists.

Parameters:
object The object to be inserted.

UserDefinedObject* detachUserObject long  typeId  )  [inline]
 

Removes the UserDefinedObject of the specified type ID.

Parameters:
typeId The type ID the object to be removed returns on getTypeID.
Returns:
A pointer to the removed object, or NULL if not found.

long getTypeID void   )  const [inline]
 

Inherted from Ogre::UserDefinedObject.

Returns:
The UserDefinedObject subclass ID, for type reflection.

const String& getTypeName void   )  const [inline]
 

Inherted from Ogre::UserDefinedObject.

Returns:
The UserDefinedObject subclass name, for type reflection.

UserDefinedObject* getUserObjectByType long  typeId  )  const [inline]
 

Retrieves a UserDefinedObject of specific type.

Parameters:
typeId The type ID the object returns on getTypeID.
Returns:
The UserDefinedObject of the given type, or NULL, if not found.


Member Data Documentation

const long multipleUserDefinedObjectTypeId [static]
 

Ogre::UserDefinedObject subclass ID, for type reflection.

const String multipleUserDefinedObjectTypeName [static]
 

Ogre::UserDefinedObject subclass name, for type reflection.

std::map<long, UserDefinedObject*> userDefinedObjects [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Apr 18 10:59:27 2005 for OGRE_IllumModule by  doxygen 1.4.2