Ogre::UserObjectBindings Class Reference
Core » Scene

Class that provides convenient interface to establish a linkage between custom user application objects and Ogre core classes. More...

`#include <OgreUserObjectBindings.h>`

Inheritance diagram for Ogre::UserObjectBindings:
[legend]

## Classes

class | Attributes
| Internal class that uses as data storage container. More...

## Public Member Functions

| UserObjectBindings ()
| Class constructor. More...
virtual | ~UserObjectBindings ()
| Class destructor. More...
void | clear () const
| Clear all user objects from this binding. More...
void | eraseUserAny (const String &key)
| Erase the custom user object associated with this class and key from this binding. More...
const Any & | getUserAny (void) const
| Retrieves the custom key less user object associated with this class. More...
const Any & | getUserAny (const String &key) const
| Retrieves the custom user object associated with this class and key. More...
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
void | setUserAny (const Any &anything)
| Sets any kind of user object on this class instance. More...
void | setUserAny (const String &key, const Any &anything)
| Sets any kind of user object on this class instance. More...

## Static Public Member Functions

static const Any & | getEmptyUserAny ()
| Returns empty user any object. More...

## Protected Types

typedef map< String, Any >::type | UserObjectsMap
typedef UserObjectsMap::const_iterator | UserObjectsMapConstIterator
typedef UserObjectsMap::iterator | UserObjectsMapIterator

## Private Attributes

Attributes * | mAttributes

## Static Private Attributes

static Any | msEmptyAny

## Detailed Description

Class that provides convenient interface to establish a linkage between custom user application objects and Ogre core classes.

Any instance of Ogre class that will derive from this class could be associated with custom application object using this class interface.

Definition at line 49 of file OgreUserObjectBindings.h.

## Member Typedef Documentation

## UserObjectsMap

typedef map<String, Any>::type Ogre::UserObjectBindings::UserObjectsMap

protected

Definition at line 104 of file OgreUserObjectBindings.h.

## UserObjectsMapConstIterator

typedef UserObjectsMap::const_iterator Ogre::UserObjectBindings::UserObjectsMapConstIterator

protected

Definition at line 106 of file OgreUserObjectBindings.h.

## UserObjectsMapIterator

typedef UserObjectsMap::iterator Ogre::UserObjectBindings::UserObjectsMapIterator

protected

Definition at line 105 of file OgreUserObjectBindings.h.

## Constructor & Destructor Documentation

## UserObjectBindings()

Ogre::UserObjectBindings::UserObjectBindings | ( |  | ) |

Class constructor.

## ~UserObjectBindings()

virtual Ogre::UserObjectBindings::~UserObjectBindings | ( |  | ) |

virtual

Class destructor.

## Member Function Documentation

## clear()

void Ogre::UserObjectBindings::clear | ( |  | ) | const

Clear all user objects from this binding.

## eraseUserAny()

void Ogre::UserObjectBindings::eraseUserAny | ( | const String & | key | ) |

Erase the custom user object associated with this class and key from this binding.

Parameters

  key | The key that the requested user object is associated with.

## getEmptyUserAny()

static const Any& Ogre::UserObjectBindings::getEmptyUserAny | ( |  | ) |

static

Returns empty user any object.

Definition at line 100 of file OgreUserObjectBindings.h.

## getUserAny() [1/2]

const Any& Ogre::UserObjectBindings::getUserAny | ( | void |  | ) | const

Retrieves the custom key less user object associated with this class.

## getUserAny() [2/2]

const Any& Ogre::UserObjectBindings::getUserAny | ( | const String & | key | ) | const

Retrieves the custom user object associated with this class and key.

Parameters

  key | The key that the requested user object is associated with.

Remarks
  In case no object associated with this key the returned Any object will be empty.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  |

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) |

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## setUserAny() [1/2]

void Ogre::UserObjectBindings::setUserAny | ( | const Any & | anything | ) |

Sets any kind of user object on this class instance.

Remarks
  This method allows you to associate any user object you like with this class. This can be a pointer back to one of your own classes for instance.

Note
  This method is key less meaning that each call for it will override previous object that were set. If you need to associate multiple objects with this class use the extended version that takes key.

## setUserAny() [2/2]

void Ogre::UserObjectBindings::setUserAny | ( | const String & | key,
|  | const Any & | anything
| ) |  |

Sets any kind of user object on this class instance.

Remarks
  This method allows you to associate multiple object with this class. This can be a pointer back to one of your own classes for instance. Use a unique key to distinguish between each of these objects.

Parameters

  key | The key that this data is associate with.
  anything | The data to associate with the given key.

## Member Data Documentation

## mAttributes

Attributes* Ogre::UserObjectBindings::mAttributes

mutable private

Definition at line 133 of file OgreUserObjectBindings.h.

## msEmptyAny

Any Ogre::UserObjectBindings::msEmptyAny

static private

Definition at line 132 of file OgreUserObjectBindings.h.

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

- OgreUserObjectBindings.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.