OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreUserObjectBindings.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE 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 
35 namespace Ogre {
36 
50  {
51  public:
54 
56  virtual ~UserObjectBindings();
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
Internal class that uses as data storage container.
#define _OgreExport
Definition: OgrePlatform.h:255
Variant type that can hold Any other type.
Definition: OgreAny.h:54
UserObjectsMap::iterator UserObjectsMapIterator
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
#define OGRE_DELETE
std::map< K, V, P, A > type
UserObjectsMap::const_iterator UserObjectsMapConstIterator
_StringBase String
Definition: OgreCommon.h:53
map< String, Any >::type UserObjectsMap
Class that provides convenient interface to establish a linkage between custom user application objec...
static const Any & getEmptyUserAny()
Returns empty user any object.