Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 1608 was 1543, checked in by rgrieder, 16 years ago
  • applied patch to remove ClassManager (wouldn't wanna maintain it anymore ;))
  • sorted core CMLs a little bit
  • updated OrxonoxStableHeaders.h
  • Property svn:eol-style set to native
File size: 3.8 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 "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()->registerClass(this->getParents(), #ClassName, bRootClass)); \
58    if (orxonox::Identifier::isCreatingHierarchy() && this->getParents()) \
59        this->getParents()->insert(this->getParents()->end(), this->getIdentifier()); \
60    orxonox::ClassIdentifier<ClassName>::getIdentifier()->addObject(this); \
61    if (orxonox::Identifier::isCreatingHierarchy()) \
62      return
63
64/**
65    @brief Intern macro, containing the specific part of RegisterRootObject.
66    @param ClassName The name of the class
67*/
68#define InternRegisterRootObject(ClassName) \
69    if (orxonox::Identifier::isCreatingHierarchy() && !this->getParents()) \
70        this->createParents(); \
71    InternRegisterObject(ClassName, true)
72
73/**
74    @brief RegisterObject - with and without debug output.
75    @param ClassName The name of the class
76*/
77#define RegisterObject(ClassName) \
78    COUT(5) << "*** Register Object: " << #ClassName << std::endl; \
79    InternRegisterObject(ClassName, false)
80
81/**
82    @brief RegisterRootObject - with and without debug output.
83    @param ClassName The name of the class
84*/
85#define RegisterRootObject(ClassName) \
86    COUT(5) << "*** Register Root-Object: " << #ClassName << std::endl; \
87    InternRegisterRootObject(ClassName)
88
89/**
90    @brief Returns the Identifier of the given class.
91    @param ClassName The name of the class
92*/
93#define Class(ClassName) \
94    ClassIdentifier<ClassName>::getIdentifier()
95
96/**
97    @brief Creates the entry in the Factory.
98    @param ClassName The name of the class
99*/
100#define CreateFactory(ClassName) \
101    bool bCreated##ClassName##Factory = orxonox::ClassFactory<ClassName>::create(#ClassName)
102
103/**
104    @brief Returns the Identifier with either a given name or a given network ID through the factory.
105    @param StringOrInt The name or the network ID of the class
106*/
107#define ID(StringOrInt) \
108    orxonox::Factory::getIdentifier(StringOrInt)
109
110#endif /* _CoreIncludes_H__ */
Note: See TracBrowser for help on using the repository browser.