OGRE: OgreUserObjectBindings.h Source File - OGRE Documentation

# OgreUserObjectBindings.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004 (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef _UserObjectsBinding_H__
    00029 #define _UserObjectsBinding_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032 #include "OgreAny.h"
    00033
    00034 namespace Ogre {
    00035
    00048     class _OgreExport UserObjectBindings : public GeneralAllocatedObject
    00049     {
    00050     public:
    00052         UserObjectBindings();
    00053
    00055         virtual ~UserObjectBindings();
    00056
    00066         void setUserAny(const Any& anything);
    00067
    00070         const Any& getUserAny(void) const;
    00071
    00080         void setUserAny(const String& key, const Any& anything);
    00081
    00087         const Any& getUserAny(const String& key) const;
    00088
    00092         void eraseUserAny(const String& key);
    00093
    00095         void clear() const;
    00096
    00099         static const Any& getEmptyUserAny() { return msEmptyAny; }
    00100
    00101     // Types.
    00102     protected:
    00103         typedef map<String, Any>::type          UserObjectsMap;
    00104         typedef UserObjectsMap::iterator        UserObjectsMapIterator;
    00105         typedef UserObjectsMap::const_iterator  UserObjectsMapConstIterator;
    00106
    00109         class Attributes : public GeneralAllocatedObject
    00110         {
    00111         public:
    00113             Attributes() : mpUserObjectsMap(NULL) {}
    00114
    00116             ~Attributes()
    00117             {
    00118                 if (mpUserObjectsMap != NULL)
    00119                 {
    00120                     OGRE_DELETE mpUserObjectsMap;
    00121                     mpUserObjectsMap = NULL;
    00122                 }
    00123             }
    00124
    00125             Any                 mKeylessAny;        // Will hold key less associated user object for fast access.
    00126             UserObjectsMap*     mpUserObjectsMap;   // Will hold a map between user keys to user objects.
    00127         };
    00128
    00129     // Attributes.
    00130     private:
    00131         static Any              msEmptyAny;         // Shared empty any object.
    00132         mutable Attributes*     mAttributes;        // Class attributes - will be allocated on demand.
    00133
    00134     };
    00135
    00138 }
    00139
    00140 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52