Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/physics/src/core/BaseObject.h @ 2141

Last change on this file since 2141 was 2087, checked in by landauf, 16 years ago

merged objecthierarchy branch back to trunk

  • Property svn:eol-style set to native
File size: 7.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 BaseObject.h
31    @brief Definition of the BaseObject class.
32
33    The BaseObject is the parent of all classes representing an instance in the game.
34*/
35
36#ifndef _BaseObject_H__
37#define _BaseObject_H__
38
39#include <map>
40
41#include "CorePrereqs.h"
42
43#include "Super.h"
44#include "OrxonoxClass.h"
45#include "XMLIncludes.h"
46#include "Event.h"
47
48namespace orxonox
49{
50    class Scene;
51    class Gametype;
52
53    //! The BaseObject is the parent of all classes representing an instance in the game.
54    class _CoreExport BaseObject : virtual public OrxonoxClass
55    {
56        public:
57            BaseObject(BaseObject* creator);
58            virtual ~BaseObject();
59            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
60
61            /** @brief Returns if the object was initialized (passed the object registration). @return True was the object is initialized */
62            inline bool isInitialized() const { return this->bInitialized_; }
63
64            /** @brief Sets the name of the object. @param name The name */
65            inline void setName(const std::string& name) { this->oldName_ = this->name_; this->name_ = name; this->changedName(); }
66            /** @brief Returns the name of the object. */
67            inline const std::string& getName() const { return this->name_; }
68            /** @brief Returns the old name of the object. */
69            inline const std::string& getOldName() const { return this->oldName_; }
70            /** @brief This function gets called if the name of the object changes. */
71            virtual void changedName() {}
72
73            /** @brief Sets the state of the objects activity. @param bActive True = active */
74            inline void setActive(bool bActive) { this->bActive_ = bActive; this->changedActivity(); }
75            /** @brief Returns the state of the objects activity. @return The state of the activity */
76            inline bool isActive() const { return this->bActive_; }
77            /** @brief This function gets called if the activity of the object changes. */
78            virtual void changedActivity() {}
79
80            /** @brief Sets the state of the objects visibility. @param bVisible True = visible */
81            inline void setVisible(bool bVisible) { this->bVisible_ = bVisible; this->changedVisibility(); }
82            /** @brief Returns the state of the objects visibility. @return The state of the visibility */
83            inline bool isVisible() const { return this->bVisible_; }
84            /** @brief This function gets called if the visibility of the object changes. */
85            virtual void changedVisibility() {}
86
87            /** @brief Sets a pointer to the xml file that loaded this object. @param file The pointer to the XMLFile */
88            inline void setFile(const XMLFile* file) { this->file_ = file; }
89            /** @brief Returns a pointer to the XMLFile that loaded this object. @return The XMLFile */
90            inline const XMLFile* getFile() const { return this->file_; }
91            const std::string& getFilename() const;
92
93            void addTemplate(const std::string& name);
94            void addTemplate(Template* temp);
95            /** @brief Returns the set of all aplied templates. */
96            inline const std::set<Template*>& getTemplates() const
97                { return this->templates_; }
98
99            virtual inline void setNamespace(Namespace* ns) { this->namespace_ = ns; }
100            inline Namespace* getNamespace() const { return this->namespace_; }
101
102            inline void setCreator(BaseObject* creator) { this->creator_ = creator; }
103            inline BaseObject* getCreator() const { return this->creator_; }
104
105            inline void setScene(Scene* scene) { this->scene_ = scene; }
106            inline Scene* getScene() const { return this->scene_; }
107
108            inline void setGametype(Gametype* gametype) { this->oldGametype_ = this->gametype_; this->gametype_ = gametype; this->changedGametype(); }
109            inline Gametype* getGametype() const { return this->gametype_; }
110            inline Gametype* getOldGametype() const { return this->oldGametype_; }
111            virtual inline void changedGametype() {}
112
113            void fireEvent();
114            void fireEvent(bool activate);
115            void fireEvent(bool activate, BaseObject* originator);
116            void fireEvent(Event& event);
117
118            virtual void processEvent(Event& event);
119
120            inline void registerEventListener(BaseObject* object, const std::string& sectionname)
121                { this->eventListeners_[object] = sectionname; }
122            inline void unregisterEventListener(BaseObject* object)
123                { this->eventListeners_.erase(object); }
124
125            void addEvent(BaseObject* event, const std::string& sectionname);
126            void removeEvent(BaseObject* event);
127            BaseObject* getEvent(unsigned int index) const;
128
129            void addEventContainer(const std::string& sectionname, EventContainer* container);
130            EventContainer* getEventContainer(const std::string& sectionname) const;
131
132            /** @brief Sets the indentation of the debug output in the Loader. @param indentation The indentation */
133            inline void setLoaderIndentation(const std::string& indentation) { this->loaderIndentation_ = indentation; }
134            /** @brief Returns the indentation of the debug output in the Loader. @return The indentation */
135            inline const std::string& getLoaderIndentation() const { return this->loaderIndentation_; }
136
137        protected:
138            std::string name_;                          //!< The name of the object
139            std::string oldName_;                       //!< The old name of the object
140            bool bActive_;                              //!< True = the object is active
141            bool bVisible_;                             //!< True = the object is visible
142
143        private:
144            void setXMLName(const std::string& name);
145            Template* getTemplate(unsigned int index) const;
146
147            bool                  bInitialized_;         //!< True if the object was initialized (passed the object registration)
148            const XMLFile*        file_;                 //!< The XMLFile that loaded this object
149            std::string           loaderIndentation_;    //!< Indentation of the debug output in the Loader
150            Namespace*            namespace_;
151            BaseObject*           creator_;
152            Scene*                scene_;
153            Gametype*             gametype_;
154            Gametype*             oldGametype_;
155            std::set<Template*>   templates_;
156            std::map<BaseObject*, std::string> eventListeners_;
157            std::list<BaseObject*> events_;
158            std::map<std::string, EventContainer*> eventContainers_;
159    };
160
161    SUPER_FUNCTION(0, BaseObject, XMLPort, false);
162    SUPER_FUNCTION(2, BaseObject, changedActivity, false);
163    SUPER_FUNCTION(3, BaseObject, changedVisibility, false);
164    SUPER_FUNCTION(4, BaseObject, processEvent, false);
165}
166
167#endif /* _BaseObject_H__ */
Note: See TracBrowser for help on using the repository browser.