OgreUserObjectBindings.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4(Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28#ifndef _UserObjectsBinding_H__
29#define _UserObjectsBinding_H__
30
31#include "OgrePrerequisites.h"
32#include "OgreAny.h"
33#include "OgreHeaderPrefix.h"
34
35namespace Ogre {
36
50 {
51 public:
54
57
67 void setUserAny(const Any& anything);
68
71 const Any& getUserAny(void) const;
72
81 void setUserAny(const String& key, const Any& anything);
82
88 const Any& getUserAny(const String& key) const;
89
93 void eraseUserAny(const String& key);
94
96 void clear() const;
97
100 static const Any& getEmptyUserAny() { return msEmptyAny; }
101
102 // Types.
103 protected:
105 typedef UserObjectsMap::iterator UserObjectsMapIterator;
106 typedef UserObjectsMap::const_iterator UserObjectsMapConstIterator;
107
111 {
112 public:
114 Attributes() : mUserObjectsMap(NULL) {}
115
118 {
119 if (mUserObjectsMap != NULL)
120 {
121 OGRE_DELETE mUserObjectsMap;
122 mUserObjectsMap = NULL;
123 }
124 }
125
126 Any mKeylessAny; // Will hold key less associated user object for fast access.
127 UserObjectsMap* mUserObjectsMap; // Will hold a map between user keys to user objects.
128 };
129
130 // Attributes.
131 private:
132 static Any msEmptyAny; // Shared empty any object.
133 mutable Attributes* mAttributes; // Class attributes - will be allocated on demand.
134
135 };
136
139}
140
141#include "OgreHeaderSuffix.h"
142
143#endif
#define _OgreExport
Definition: OgrePlatform.h:257
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Variant type that can hold Any other type.
Definition: OgreAny.h:57
Internal class that uses as data storage container.
Class that provides convenient interface to establish a linkage between custom user application objec...
virtual ~UserObjectBindings()
Class destructor.
void clear() const
Clear all user objects from this binding.
UserObjectBindings()
Class constructor.
void setUserAny(const String &key, const Any &anything)
Sets any kind of user object on this class instance.
map< String, Any >::type UserObjectsMap
const Any & getUserAny(const String &key) const
Retrieves the custom user object associated with this class and key.
void eraseUserAny(const String &key)
Erase the custom user object associated with this class and key from this binding.
const Any & getUserAny(void) const
Retrieves the custom key less user object associated with this class.
UserObjectsMap::iterator UserObjectsMapIterator
void setUserAny(const Any &anything)
Sets any kind of user object on this class instance.
UserObjectsMap::const_iterator UserObjectsMapConstIterator
static const Any & getEmptyUserAny()
Returns empty user any object.
#define OGRE_DELETE
_StringBase String
std::map< K, V, P, A > type

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