[790] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
[1505] | 3 | * > www.orxonox.net < |
---|
[790] | 4 | * |
---|
| 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
| 22 | * Author: |
---|
| 23 | * Fabian 'x3n' Landau |
---|
| 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
[871] | 29 | /** |
---|
[7401] | 30 | @defgroup Identifier Identifier |
---|
| 31 | @ingroup Class |
---|
| 32 | */ |
---|
| 33 | |
---|
| 34 | /** |
---|
[2171] | 35 | @file |
---|
[7401] | 36 | @ingroup Class Identifier |
---|
| 37 | @brief Declaration of Identifier, definition of ClassIdentifier<T>; used to identify the class of an object. |
---|
[790] | 38 | |
---|
[7401] | 39 | @anchor IdentifierExample |
---|
[790] | 40 | |
---|
[7401] | 41 | An Identifier "identifies" the class of an object. It contains different information about |
---|
| 42 | the class: Its name and ID, a list of all instances of this class, a factory to create new |
---|
| 43 | instances of this class, and more. |
---|
[790] | 44 | |
---|
[7401] | 45 | It also contains information about the inheritance of this class: It stores a list of the |
---|
| 46 | Identifiers of all parent-classes as well as a list of all child-classes. These relationships |
---|
| 47 | can be tested using functions like @c isA(), @c isChildOf(), @c isParentOf(), and more. |
---|
[790] | 48 | |
---|
[7401] | 49 | Every Identifier is in fact a ClassIdentifier<T> (where T is the class that is identified |
---|
| 50 | by the Identifier), Identifier is just the common base-class. |
---|
| 51 | |
---|
| 52 | Example: |
---|
| 53 | @code |
---|
| 54 | MyClass* object = new MyClass(); // create an instance of MyClass |
---|
| 55 | |
---|
| 56 | object->getIdentifier()->getName(); // returns "MyClass" |
---|
| 57 | |
---|
[9667] | 58 | Identifiable* other = object->getIdentifier()->fabricate(0); // fabricates a new instance of MyClass |
---|
[7401] | 59 | |
---|
| 60 | |
---|
| 61 | // test the class hierarchy |
---|
| 62 | object->getIdentifier()->isA(Class(MyClass)); // returns true |
---|
| 63 | object->isA(Class(MyClass)); // returns true (short version) |
---|
| 64 | |
---|
| 65 | object->isA(Class(BaseClass)); // returns true if MyClass is a child of BaseClass |
---|
| 66 | |
---|
| 67 | Class(ChildClass)->isChildOf(object->getIdentifier()); // returns true if ChildClass is a child of MyClass |
---|
| 68 | @endcode |
---|
[790] | 69 | */ |
---|
| 70 | |
---|
| 71 | #ifndef _Identifier_H__ |
---|
| 72 | #define _Identifier_H__ |
---|
[1052] | 73 | |
---|
[9563] | 74 | #include "core/CorePrereqs.h" |
---|
[1062] | 75 | |
---|
[3196] | 76 | #include <cassert> |
---|
| 77 | #include <map> |
---|
[1052] | 78 | #include <set> |
---|
[790] | 79 | #include <string> |
---|
[1639] | 80 | #include <typeinfo> |
---|
[7266] | 81 | #include <loki/TypeTraits.h> |
---|
[790] | 82 | |
---|
[8858] | 83 | #include "util/Output.h" |
---|
[9563] | 84 | #include "core/object/ObjectList.h" |
---|
[9667] | 85 | #include "core/object/Listable.h" |
---|
| 86 | #include "core/object/Context.h" |
---|
| 87 | #include "core/object/Destroyable.h" |
---|
| 88 | #include "core/object/WeakPtr.h" |
---|
[9564] | 89 | #include "IdentifierManager.h" |
---|
[5781] | 90 | #include "Super.h" |
---|
[790] | 91 | |
---|
| 92 | namespace orxonox |
---|
| 93 | { |
---|
| 94 | // ############################### |
---|
| 95 | // ### Identifier ### |
---|
| 96 | // ############################### |
---|
| 97 | /** |
---|
[7401] | 98 | @brief The Identifier is used to identify the class of an object and to store information about the class. |
---|
[790] | 99 | |
---|
[7401] | 100 | Each Identifier stores information about one class. The Identifier can then be used to identify |
---|
| 101 | this class. On the other hand it's also possible to get the corresponding Identifier of a class, |
---|
| 102 | for example by using the macro Class(). |
---|
[790] | 103 | |
---|
[7401] | 104 | @see See @ref IdentifierExample "Identifier.h" for more information and some examples. |
---|
| 105 | |
---|
| 106 | @note You can't directly create an Identifier, it's just the base-class of ClassIdentifier<T>. |
---|
[790] | 107 | */ |
---|
[9667] | 108 | class _CoreExport Identifier : public Destroyable |
---|
[790] | 109 | { |
---|
[9667] | 110 | public: |
---|
| 111 | Identifier(); |
---|
| 112 | Identifier(const Identifier& identifier); // don't copy |
---|
| 113 | virtual ~Identifier(); |
---|
[9564] | 114 | |
---|
[7401] | 115 | /// Returns the name of the class the Identifier belongs to. |
---|
[5929] | 116 | inline const std::string& getName() const { return this->name_; } |
---|
| 117 | void setName(const std::string& name); |
---|
[790] | 118 | |
---|
[9667] | 119 | /// Returns the name of the class as it is returned by typeid(T).name() |
---|
| 120 | virtual const std::string& getTypeidName() = 0; |
---|
| 121 | |
---|
[7401] | 122 | /// Returns the network ID to identify a class through the network. |
---|
[8706] | 123 | inline uint32_t getNetworkID() const { return this->networkID_; } |
---|
[5929] | 124 | void setNetworkID(uint32_t id); |
---|
[790] | 125 | |
---|
[7401] | 126 | /// Returns the unique ID of the class. |
---|
[8351] | 127 | ORX_FORCEINLINE unsigned int getClassID() const { return this->classID_; } |
---|
[5929] | 128 | |
---|
[7401] | 129 | /// Sets the Factory. |
---|
[9667] | 130 | void setFactory(Factory* factory); |
---|
[7401] | 131 | /// Returns true if the Identifier has a Factory. |
---|
[5929] | 132 | inline bool hasFactory() const { return (this->factory_ != 0); } |
---|
[790] | 133 | |
---|
[9667] | 134 | Identifiable* fabricate(Context* context); |
---|
[5929] | 135 | |
---|
[7401] | 136 | /// Returns true if the class can be loaded through XML. |
---|
[5929] | 137 | inline bool isLoadable() const { return this->bLoadable_; } |
---|
[7401] | 138 | /// Set the class to be loadable through XML or not. |
---|
[5929] | 139 | inline void setLoadable(bool bLoadable) { this->bLoadable_ = bLoadable; } |
---|
| 140 | |
---|
[9667] | 141 | /// Returns true if the Identifier was completely initialized. |
---|
| 142 | inline bool isInitialized() const { return this->bInitialized_; } |
---|
| 143 | |
---|
| 144 | |
---|
| 145 | ///////////////////////////// |
---|
| 146 | ////// Class Hierarchy ////// |
---|
| 147 | ///////////////////////////// |
---|
| 148 | Identifier& inheritsFrom(Identifier* directParent); |
---|
| 149 | |
---|
[10366] | 150 | void initializeParents(const std::set<const Identifier*>& initializationTrace); |
---|
[9667] | 151 | void initializeDirectParentsOfAbstractClass(); |
---|
| 152 | void finishInitialization(); |
---|
| 153 | |
---|
[790] | 154 | bool isA(const Identifier* identifier) const; |
---|
[871] | 155 | bool isExactlyA(const Identifier* identifier) const; |
---|
[1052] | 156 | bool isChildOf(const Identifier* identifier) const; |
---|
[871] | 157 | bool isDirectChildOf(const Identifier* identifier) const; |
---|
[1052] | 158 | bool isParentOf(const Identifier* identifier) const; |
---|
[871] | 159 | bool isDirectParentOf(const Identifier* identifier) const; |
---|
[790] | 160 | |
---|
[7401] | 161 | /// Returns the parents of the class the Identifier belongs to. |
---|
[1052] | 162 | inline const std::set<const Identifier*>& getParents() const { return this->parents_; } |
---|
[7401] | 163 | /// Returns the begin-iterator of the parents-list. |
---|
[1052] | 164 | inline std::set<const Identifier*>::const_iterator getParentsBegin() const { return this->parents_.begin(); } |
---|
[7401] | 165 | /// Returns the end-iterator of the parents-list. |
---|
[1052] | 166 | inline std::set<const Identifier*>::const_iterator getParentsEnd() const { return this->parents_.end(); } |
---|
| 167 | |
---|
[7401] | 168 | /// Returns the children of the class the Identifier belongs to. |
---|
[5929] | 169 | inline const std::set<const Identifier*>& getChildren() const { return this->children_; } |
---|
[7401] | 170 | /// Returns the begin-iterator of the children-list. |
---|
[5929] | 171 | inline std::set<const Identifier*>::const_iterator getChildrenBegin() const { return this->children_.begin(); } |
---|
[7401] | 172 | /// Returns the end-iterator of the children-list. |
---|
[5929] | 173 | inline std::set<const Identifier*>::const_iterator getChildrenEnd() const { return this->children_.end(); } |
---|
[1052] | 174 | |
---|
[7401] | 175 | /// Returns the direct parents of the class the Identifier belongs to. |
---|
[1052] | 176 | inline const std::set<const Identifier*>& getDirectParents() const { return this->directParents_; } |
---|
[7401] | 177 | /// Returns the begin-iterator of the direct-parents-list. |
---|
[1052] | 178 | inline std::set<const Identifier*>::const_iterator getDirectParentsBegin() const { return this->directParents_.begin(); } |
---|
[7401] | 179 | /// Returns the end-iterator of the direct-parents-list. |
---|
[1052] | 180 | inline std::set<const Identifier*>::const_iterator getDirectParentsEnd() const { return this->directParents_.end(); } |
---|
| 181 | |
---|
[7401] | 182 | /// Returns the direct children the class the Identifier belongs to. |
---|
[5929] | 183 | inline const std::set<const Identifier*>& getDirectChildren() const { return this->directChildren_; } |
---|
[7401] | 184 | /// Returns the begin-iterator of the direct-children-list. |
---|
[5929] | 185 | inline std::set<const Identifier*>::const_iterator getDirectChildrenBegin() const { return this->directChildren_.begin(); } |
---|
[7401] | 186 | /// Returns the end-iterator of the direct-children-list. |
---|
[5929] | 187 | inline std::set<const Identifier*>::const_iterator getDirectChildrenEnd() const { return this->directChildren_.end(); } |
---|
[1052] | 188 | |
---|
| 189 | |
---|
[5929] | 190 | ///////////////////////// |
---|
| 191 | ///// Config Values ///// |
---|
| 192 | ///////////////////////// |
---|
| 193 | virtual void updateConfigValues(bool updateChildren = true) const = 0; |
---|
| 194 | |
---|
[7401] | 195 | /// Returns true if this class has at least one config value. |
---|
[5929] | 196 | inline bool hasConfigValues() const { return this->bHasConfigValues_; } |
---|
| 197 | |
---|
| 198 | void addConfigValueContainer(const std::string& varname, ConfigValueContainer* container); |
---|
| 199 | ConfigValueContainer* getConfigValueContainer(const std::string& varname); |
---|
[1052] | 200 | |
---|
[5929] | 201 | |
---|
| 202 | /////////////////// |
---|
| 203 | ///// XMLPort ///// |
---|
| 204 | /////////////////// |
---|
[7401] | 205 | /// Returns the map that stores all XMLPort params. |
---|
[5781] | 206 | inline const std::map<std::string, XMLPortParamContainer*>& getXMLPortParamMap() const { return this->xmlportParamContainers_; } |
---|
[7401] | 207 | /// Returns a const_iterator to the beginning of the map that stores all XMLPort params. |
---|
[5781] | 208 | inline std::map<std::string, XMLPortParamContainer*>::const_iterator getXMLPortParamMapBegin() const { return this->xmlportParamContainers_.begin(); } |
---|
[7401] | 209 | /// Returns a const_iterator to the end of the map that stores all XMLPort params. |
---|
[5781] | 210 | inline std::map<std::string, XMLPortParamContainer*>::const_iterator getXMLPortParamMapEnd() const { return this->xmlportParamContainers_.end(); } |
---|
| 211 | |
---|
[7401] | 212 | /// Returns the map that stores all XMLPort objects. |
---|
[5781] | 213 | inline const std::map<std::string, XMLPortObjectContainer*>& getXMLPortObjectMap() const { return this->xmlportObjectContainers_; } |
---|
[7401] | 214 | /// Returns a const_iterator to the beginning of the map that stores all XMLPort objects. |
---|
[5781] | 215 | inline std::map<std::string, XMLPortObjectContainer*>::const_iterator getXMLPortObjectMapBegin() const { return this->xmlportObjectContainers_.begin(); } |
---|
[7401] | 216 | /// Returns a const_iterator to the end of the map that stores all XMLPort objects. |
---|
[5781] | 217 | inline std::map<std::string, XMLPortObjectContainer*>::const_iterator getXMLPortObjectMapEnd() const { return this->xmlportObjectContainers_.end(); } |
---|
| 218 | |
---|
| 219 | void addXMLPortParamContainer(const std::string& paramname, XMLPortParamContainer* container); |
---|
| 220 | XMLPortParamContainer* getXMLPortParamContainer(const std::string& paramname); |
---|
| 221 | |
---|
| 222 | void addXMLPortObjectContainer(const std::string& sectionname, XMLPortObjectContainer* container); |
---|
| 223 | XMLPortObjectContainer* getXMLPortObjectContainer(const std::string& sectionname); |
---|
| 224 | |
---|
[10363] | 225 | virtual bool canDynamicCastObjectToIdentifierClass(Identifiable* object) const = 0; |
---|
[5781] | 226 | |
---|
[1052] | 227 | protected: |
---|
[5781] | 228 | virtual void createSuperFunctionCaller() const = 0; |
---|
[1747] | 229 | |
---|
| 230 | private: |
---|
[1052] | 231 | std::set<const Identifier*> parents_; //!< The parents of the class the Identifier belongs to |
---|
[9667] | 232 | std::set<const Identifier*> children_; //!< The children of the class the Identifier belongs to |
---|
[790] | 233 | |
---|
[1052] | 234 | std::set<const Identifier*> directParents_; //!< The direct parents of the class the Identifier belongs to |
---|
[9667] | 235 | std::set<const Identifier*> directChildren_; //!< The direct children of the class the Identifier belongs to |
---|
[1052] | 236 | |
---|
[9667] | 237 | bool bInitialized_; //!< Is true if the Identifier was completely initialized |
---|
[5781] | 238 | bool bLoadable_; //!< False = it's not permitted to load the object through XML |
---|
[1052] | 239 | std::string name_; //!< The name of the class the Identifier belongs to |
---|
[5929] | 240 | Factory* factory_; //!< The Factory, able to create new objects of the given class (if available) |
---|
[5781] | 241 | uint32_t networkID_; //!< The network ID to identify a class through the network |
---|
[3325] | 242 | const unsigned int classID_; //!< Uniquely identifies a class (might not be the same as the networkID_) |
---|
[1052] | 243 | |
---|
| 244 | bool bHasConfigValues_; //!< True if this class has at least one assigned config value |
---|
| 245 | std::map<std::string, ConfigValueContainer*> configValues_; //!< A map to link the string of configurable variables with their ConfigValueContainer |
---|
[5781] | 246 | |
---|
| 247 | std::map<std::string, XMLPortParamContainer*> xmlportParamContainers_; //!< All loadable parameters |
---|
| 248 | std::map<std::string, XMLPortObjectContainer*> xmlportObjectContainers_; //!< All attachable objects |
---|
[790] | 249 | }; |
---|
| 250 | |
---|
[1052] | 251 | _CoreExport std::ostream& operator<<(std::ostream& out, const std::set<const Identifier*>& list); |
---|
[790] | 252 | |
---|
[1052] | 253 | |
---|
[790] | 254 | // ############################### |
---|
| 255 | // ### ClassIdentifier ### |
---|
| 256 | // ############################### |
---|
| 257 | /** |
---|
[7401] | 258 | @brief The ClassIdentifier is derived from Identifier and holds all class-specific functions and variables the Identifier cannot have. |
---|
| 259 | |
---|
| 260 | ClassIdentifier is a Singleton, which means that only one ClassIdentifier for a given type T exists. |
---|
[5695] | 261 | This makes it possible to store information about a class, sharing them with all |
---|
[1052] | 262 | objects of that class without defining static variables in every class. |
---|
| 263 | |
---|
| 264 | To be really sure that not more than exactly one object exists (even with libraries), |
---|
[7401] | 265 | ClassIdentifiers are stored in a static map in Identifier. |
---|
[790] | 266 | */ |
---|
| 267 | template <class T> |
---|
| 268 | class ClassIdentifier : public Identifier |
---|
[1052] | 269 | { |
---|
[7401] | 270 | #ifndef DOXYGEN_SHOULD_SKIP_THIS |
---|
| 271 | #define SUPER_INTRUSIVE_DECLARATION_INCLUDE |
---|
| 272 | #include "Super.h" |
---|
| 273 | #endif |
---|
[5781] | 274 | |
---|
[790] | 275 | public: |
---|
[5929] | 276 | static ClassIdentifier<T>* getIdentifier(); |
---|
| 277 | static ClassIdentifier<T>* getIdentifier(const std::string& name); |
---|
[1052] | 278 | |
---|
[9667] | 279 | bool initializeObject(T* object); |
---|
[3325] | 280 | |
---|
[9586] | 281 | void setConfigValues(T* object, Configurable*) const; |
---|
| 282 | void setConfigValues(T* object, Identifiable*) const; |
---|
| 283 | |
---|
[9572] | 284 | void addObjectToList(T* object, Listable*); |
---|
| 285 | void addObjectToList(T* object, Identifiable*); |
---|
| 286 | |
---|
[9667] | 287 | virtual void updateConfigValues(bool updateChildren = true) const; |
---|
[1052] | 288 | |
---|
[9667] | 289 | virtual const std::string& getTypeidName() |
---|
| 290 | { return this->typeidName_; } |
---|
| 291 | |
---|
[10363] | 292 | virtual bool canDynamicCastObjectToIdentifierClass(Identifiable* object) const |
---|
[10361] | 293 | { return dynamic_cast<T*>(object) != 0; } |
---|
| 294 | |
---|
[790] | 295 | private: |
---|
[9667] | 296 | static void initializeIdentifier(); |
---|
| 297 | |
---|
[790] | 298 | ClassIdentifier(const ClassIdentifier<T>& identifier) {} // don't copy |
---|
[1747] | 299 | ClassIdentifier() |
---|
| 300 | { |
---|
[9667] | 301 | this->typeidName_ = typeid(T).name(); |
---|
[5781] | 302 | SuperFunctionInitialization<0, T>::initialize(this); |
---|
[1747] | 303 | } |
---|
| 304 | ~ClassIdentifier() |
---|
| 305 | { |
---|
[5781] | 306 | SuperFunctionDestruction<0, T>::destroy(this); |
---|
[1747] | 307 | } |
---|
[790] | 308 | |
---|
[9667] | 309 | void updateConfigValues(bool updateChildren, Listable*) const; |
---|
| 310 | void updateConfigValues(bool updateChildren, Identifiable*) const; |
---|
| 311 | |
---|
| 312 | std::string typeidName_; |
---|
| 313 | static WeakPtr<ClassIdentifier<T> > classIdentifier_s; |
---|
[790] | 314 | }; |
---|
| 315 | |
---|
[1543] | 316 | template <class T> |
---|
[9667] | 317 | WeakPtr<ClassIdentifier<T> > ClassIdentifier<T>::classIdentifier_s; |
---|
[1543] | 318 | |
---|
[790] | 319 | /** |
---|
[1747] | 320 | @brief Returns the only instance of this class. |
---|
[1543] | 321 | @return The unique Identifier |
---|
| 322 | */ |
---|
| 323 | template <class T> |
---|
[3196] | 324 | inline ClassIdentifier<T>* ClassIdentifier<T>::getIdentifier() |
---|
[1543] | 325 | { |
---|
[5929] | 326 | // check if the Identifier already exists |
---|
| 327 | if (!ClassIdentifier<T>::classIdentifier_s) |
---|
[9667] | 328 | ClassIdentifier<T>::initializeIdentifier(); |
---|
[1543] | 329 | |
---|
| 330 | return ClassIdentifier<T>::classIdentifier_s; |
---|
| 331 | } |
---|
| 332 | |
---|
| 333 | /** |
---|
[1747] | 334 | @brief Does the same as getIdentifier() but sets the name if this wasn't done yet. |
---|
| 335 | @param name The name of this Identifier |
---|
| 336 | @return The Identifier |
---|
[790] | 337 | */ |
---|
| 338 | template <class T> |
---|
[3196] | 339 | inline ClassIdentifier<T>* ClassIdentifier<T>::getIdentifier(const std::string& name) |
---|
[790] | 340 | { |
---|
[1747] | 341 | ClassIdentifier<T>* identifier = ClassIdentifier<T>::getIdentifier(); |
---|
| 342 | identifier->setName(name); |
---|
| 343 | return identifier; |
---|
[790] | 344 | } |
---|
| 345 | |
---|
| 346 | /** |
---|
[2784] | 347 | @brief Assigns the static field for the identifier singleton. |
---|
| 348 | */ |
---|
| 349 | template <class T> |
---|
[9667] | 350 | /*static */ void ClassIdentifier<T>::initializeIdentifier() |
---|
[2784] | 351 | { |
---|
[9667] | 352 | // create a new identifier anyway. Will be deleted if not used. |
---|
[2784] | 353 | ClassIdentifier<T>* proposal = new ClassIdentifier<T>(); |
---|
| 354 | |
---|
| 355 | // Get the entry from the map |
---|
[9667] | 356 | ClassIdentifier<T>::classIdentifier_s = (ClassIdentifier<T>*)IdentifierManager::getInstance().getGloballyUniqueIdentifier(proposal); |
---|
[2784] | 357 | |
---|
| 358 | if (ClassIdentifier<T>::classIdentifier_s == proposal) |
---|
[9667] | 359 | orxout(verbose, context::identifier) << "Requested Identifier for " << proposal->getTypeidName() << " was not yet existing and got created." << endl; |
---|
[2784] | 360 | else |
---|
| 361 | { |
---|
[9667] | 362 | orxout(verbose, context::identifier) << "Requested Identifier for " << proposal->getTypeidName() << " was already existing and got assigned." << endl; |
---|
| 363 | delete proposal; // delete proposal (it is not used anymore) |
---|
[2784] | 364 | } |
---|
| 365 | } |
---|
| 366 | |
---|
| 367 | /** |
---|
[790] | 368 | @brief Adds an object of the given type to the ObjectList. |
---|
| 369 | @param object The object to add |
---|
| 370 | */ |
---|
| 371 | template <class T> |
---|
[9667] | 372 | bool ClassIdentifier<T>::initializeObject(T* object) |
---|
[790] | 373 | { |
---|
[9667] | 374 | orxout(verbose, context::object_list) << "Register Object: " << this->getName() << endl; |
---|
[3325] | 375 | |
---|
| 376 | object->identifier_ = this; |
---|
[9667] | 377 | if (IdentifierManager::getInstance().isCreatingHierarchy()) |
---|
[3325] | 378 | { |
---|
[9667] | 379 | IdentifierManager::getInstance().createdObject(object); |
---|
[3325] | 380 | |
---|
[9586] | 381 | this->setConfigValues(object, object); |
---|
[3325] | 382 | return true; |
---|
| 383 | } |
---|
| 384 | else |
---|
| 385 | { |
---|
[9572] | 386 | this->addObjectToList(object, object); |
---|
[3325] | 387 | |
---|
[9566] | 388 | // Add pointer of type T to the map in the Identifiable instance that enables "dynamic_casts" |
---|
[3333] | 389 | object->objectPointers_.push_back(std::make_pair(this->getClassID(), static_cast<void*>(object))); |
---|
[3325] | 390 | return false; |
---|
| 391 | } |
---|
[790] | 392 | } |
---|
| 393 | |
---|
| 394 | /** |
---|
[9586] | 395 | * @brief Only configures the object if is a @ref Configurable |
---|
| 396 | */ |
---|
| 397 | template <class T> |
---|
| 398 | void ClassIdentifier<T>::setConfigValues(T* object, Configurable*) const |
---|
| 399 | { |
---|
| 400 | object->setConfigValues(); |
---|
| 401 | } |
---|
| 402 | |
---|
| 403 | template <class T> |
---|
| 404 | void ClassIdentifier<T>::setConfigValues(T*, Identifiable*) const |
---|
| 405 | { |
---|
| 406 | // no action |
---|
| 407 | } |
---|
| 408 | |
---|
| 409 | /** |
---|
[9572] | 410 | * @brief Only adds the object to the object list if is a @ref Listable |
---|
| 411 | */ |
---|
| 412 | template <class T> |
---|
[9667] | 413 | void ClassIdentifier<T>::addObjectToList(T* object, Listable* listable) |
---|
[9572] | 414 | { |
---|
[9667] | 415 | if (listable->getContext()) |
---|
| 416 | listable->getContext()->addObject(object); |
---|
[9572] | 417 | } |
---|
| 418 | |
---|
| 419 | template <class T> |
---|
| 420 | void ClassIdentifier<T>::addObjectToList(T*, Identifiable*) |
---|
| 421 | { |
---|
| 422 | // no action |
---|
| 423 | } |
---|
| 424 | |
---|
| 425 | /** |
---|
[1052] | 426 | @brief Updates the config-values of all existing objects of this class by calling their setConfigValues() function. |
---|
[790] | 427 | */ |
---|
| 428 | template <class T> |
---|
[1747] | 429 | void ClassIdentifier<T>::updateConfigValues(bool updateChildren) const |
---|
[790] | 430 | { |
---|
[9667] | 431 | this->updateConfigValues(updateChildren, static_cast<T*>(NULL)); |
---|
| 432 | } |
---|
| 433 | |
---|
| 434 | template <class T> |
---|
| 435 | void ClassIdentifier<T>::updateConfigValues(bool updateChildren, Listable*) const |
---|
| 436 | { |
---|
[1747] | 437 | if (!this->hasConfigValues()) |
---|
| 438 | return; |
---|
[790] | 439 | |
---|
[1747] | 440 | for (ObjectListIterator<T> it = ObjectList<T>::begin(); it; ++it) |
---|
[9586] | 441 | this->setConfigValues(*it, *it); |
---|
[1052] | 442 | |
---|
[1747] | 443 | if (updateChildren) |
---|
| 444 | for (std::set<const Identifier*>::const_iterator it = this->getChildrenBegin(); it != this->getChildrenEnd(); ++it) |
---|
| 445 | (*it)->updateConfigValues(false); |
---|
[1052] | 446 | } |
---|
| 447 | |
---|
[9667] | 448 | template <class T> |
---|
| 449 | void ClassIdentifier<T>::updateConfigValues(bool updateChildren, Identifiable*) const |
---|
| 450 | { |
---|
| 451 | // no action |
---|
| 452 | } |
---|
[1052] | 453 | |
---|
[9667] | 454 | |
---|
[790] | 455 | // ############################### |
---|
[3325] | 456 | // ### orxonox_cast ### |
---|
| 457 | // ############################### |
---|
| 458 | /** |
---|
| 459 | @brief |
---|
[9566] | 460 | Casts on object of type Identifiable to any derived type that is |
---|
[3325] | 461 | registered in the class hierarchy. |
---|
| 462 | @return |
---|
| 463 | Returns NULL if the cast is not possible |
---|
| 464 | @note |
---|
| 465 | In case of NULL return (and using MSVC), a dynamic_cast might still be possible if |
---|
| 466 | a class forgot to register its objects. |
---|
| 467 | Also note that the function is implemented differently for GCC/MSVC. |
---|
| 468 | */ |
---|
| 469 | template <class T, class U> |
---|
[8351] | 470 | ORX_FORCEINLINE T orxonox_cast(U* source) |
---|
[3325] | 471 | { |
---|
[3332] | 472 | #ifdef ORXONOX_COMPILER_MSVC |
---|
[3333] | 473 | typedef Loki::TypeTraits<typename Loki::TypeTraits<T>::PointeeType>::NonConstType ClassType; |
---|
[3370] | 474 | if (source != NULL) |
---|
| 475 | return source->template getDerivedPointer<ClassType>(ClassIdentifier<ClassType>::getIdentifier()->getClassID()); |
---|
| 476 | else |
---|
| 477 | return NULL; |
---|
[3332] | 478 | #else |
---|
| 479 | return dynamic_cast<T>(source); |
---|
| 480 | #endif |
---|
[3325] | 481 | } |
---|
[790] | 482 | } |
---|
| 483 | |
---|
| 484 | #endif /* _Identifier_H__ */ |
---|