Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/core/CoreIncludes.h @ 1970

Last change on this file since 1970 was 1856, checked in by landauf, 16 years ago
  • some small adjustments in identifier and co.
  • renamed GetIdentifier to ClassByName and ClassByID
  • Property svn:eol-style set to native
File size: 4.0 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
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
29/**
30    @file CoreIncludes.h
31    @brief Definition of macros for Identifier and Factory.
32
33    Every class needs the RegisterObject(class) macro in its constructor. If the class is an interface
34    or the BaseObject itself, it needs the macro RegisterRootObject(class) instead.
35
36    To allow the object being created through the factory, use the CreateFactory(class) macro outside
37    the of the class implementation, so it gets executed before main().
38*/
39
40#ifndef _CoreIncludes_H__
41#define _CoreIncludes_H__
42
43#include "CorePrereqs.h"
44
45#include "Identifier.h"
46#include "Factory.h"
47#include "ClassFactory.h"
48#include "util/Debug.h"
49
50
51/**
52    @brief Intern macro, containing the common parts of RegisterObject and RegisterRootObject.
53    @param ClassName The name of the class
54    @param bRootClass True if the class is directly derived from OrxonoxClass
55*/
56#define InternRegisterObject(ClassName, bRootClass) \
57    this->setIdentifier(orxonox::ClassIdentifier<ClassName>::getIdentifier(#ClassName)); \
58    if (orxonox::Identifier::isCreatingHierarchy()) \
59    { \
60        if (this->getParents()) \
61        { \
62            orxonox::ClassIdentifier<ClassName>::getIdentifier(#ClassName)->initializeClassHierarchy(this->getParents(), bRootClass); \
63            this->getParents()->insert(this->getParents()->end(), this->getIdentifier()); \
64        } \
65        this->setConfigValues(); \
66        return; \
67    } \
68    orxonox::ClassIdentifier<ClassName>::getIdentifier()->addObject(this)
69
70/**
71    @brief Intern macro, containing the specific part of RegisterRootObject.
72    @param ClassName The name of the class
73*/
74#define InternRegisterRootObject(ClassName) \
75    if (orxonox::Identifier::isCreatingHierarchy() && !this->getParents()) \
76        this->createParents(); \
77    InternRegisterObject(ClassName, true)
78
79/**
80    @brief RegisterObject - with and without debug output.
81    @param ClassName The name of the class
82*/
83#define RegisterObject(ClassName) \
84    COUT(5) << "*** Register Object: " << #ClassName << std::endl; \
85    InternRegisterObject(ClassName, false)
86
87/**
88    @brief RegisterRootObject - with and without debug output.
89    @param ClassName The name of the class
90*/
91#define RegisterRootObject(ClassName) \
92    COUT(5) << "*** Register Root-Object: " << #ClassName << std::endl; \
93    InternRegisterRootObject(ClassName)
94
95/**
96    @brief Creates the entry in the Factory.
97    @param ClassName The name of the class
98*/
99#define CreateFactory(ClassName) \
100    bool bCreated##ClassName##Factory = orxonox::ClassFactory<ClassName>::create(#ClassName)
101
102/**
103    @brief Returns the Identifier of the given class.
104    @param ClassName The name of the class
105*/
106#define Class(ClassName) \
107    ClassIdentifier<ClassName>::getIdentifier()
108
109/**
110    @brief Returns the Identifier with a given name through the factory.
111    @param String The name of the class
112*/
113#define ClassByName(String) \
114    orxonox::Factory::getIdentifier(String)
115
116/**
117    @brief Returns the Identifier with a given network ID through the factory.
118    @param networkID The network ID of the class
119*/
120#define ClassByID(networkID) \
121    orxonox::Factory::getIdentifier(networkID)
122
123#endif /* _CoreIncludes_H__ */
Note: See TracBrowser for help on using the repository browser.