Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/core7/src/libraries/core/BaseObject.h @ 10570

Last change on this file since 10570 was 10570, checked in by landauf, 5 years ago

not sure why Level was synchronized in Scene, but it doesn't seem to be necessary anymore

  • Property svn:eol-style set to native
File size: 11.4 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    @defgroup BaseObject BaseObject
31    @ingroup Core
32*/
33
34/**
35    @file
36    @ingroup BaseObject
37    @brief Declaration of BaseObject, the base class of all objects in Orxonox.
38
39    The BaseObject is the parent of all classes representing an instance in the game.
40*/
41
42#ifndef _BaseObject_H__
43#define _BaseObject_H__
44
45#include "CorePrereqs.h"
46
47#include <map>
48#include <list>
49
50#include "util/mbool.h"
51#include "class/OrxonoxClass.h"
52#include "class/Super.h"
53#include "object/StrongPtr.h"
54
55namespace orxonox
56{
57    class Scene;
58    class Gametype;
59    class Level;
60
61    /// The BaseObject is the parent of all classes representing an instance in the game.
62    class _CoreExport BaseObject : public OrxonoxClass
63    {
64        template <class T> friend class XMLPortClassParamContainer;
65
66        public:
67            BaseObject(Context* context);
68            virtual ~BaseObject();
69            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
70            virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
71
72            /** @brief Returns if the object was initialized (passed the object registration). @return True was the object is initialized */
73            inline bool isInitialized() const { return this->bInitialized_; }
74
75            /** @brief Sets the name of the object. @param name The name */
76            inline void setName(const std::string& name) { this->oldName_ = this->name_; this->name_ = name; this->changedName(); }
77            /** @brief Returns the name of the object. */
78            inline const std::string& getName() const { return this->name_; }
79            /** @brief Returns the old name of the object. */
80            inline const std::string& getOldName() const { return this->oldName_; }
81            /** @brief This function gets called if the name of the object changes. */
82            virtual void changedName() {}
83
84            /** @brief Sets the state of the objects activity. @param bActive True = active */
85            inline void setActive(bool bActive)
86            {
87                if (this->bActive_ != bActive)
88                {
89                    this->bActive_ = bActive;
90                    this->changedActivity();
91                }
92            }
93            /** @brief Returns the state of the objects activity. @return The state of the activity */
94            inline const mbool& isActive() const { return this->bActive_; }
95            /** @brief This function gets called if the activity of the object changes. */
96            virtual void changedActivity() {}
97
98            /** @brief Sets the state of the objects visibility. @param bVisible True = visible */
99            inline void setVisible(bool bVisible)
100            {
101                if (this->bVisible_ != bVisible)
102                {
103                    this->bVisible_ = bVisible;
104                    this->changedVisibility();
105                }
106            }
107            /** @brief Returns the state of the objects visibility. @return The state of the visibility */
108            inline const mbool& isVisible() const { return this->bVisible_; }
109            /** @brief This function gets called if the visibility of the object changes. */
110            virtual void changedVisibility() {}
111
112            void setMainState(bool state);
113
114            /** @brief Sets the name of the main state (used for event reactions). */
115            void setMainStateName(const std::string& name)
116            {
117                if (this->mainStateName_ != name)
118                {
119                    this->mainStateName_ = name;
120                    this->changedMainStateName();
121                }
122            }
123            /** @brief Returns the name of the main state. */
124            inline const std::string& getMainStateName() const { return this->mainStateName_; }
125            /** @brief This function gets called if the main state name of the object changes. */
126            virtual void changedMainStateName();
127
128            /** @brief Sets a pointer to the xml file that loaded this object. @param file The pointer to the XMLFile */
129            inline void setFile(const XMLFile* file) { this->file_ = file; }
130            /** @brief Returns a pointer to the XMLFile that loaded this object. @return The XMLFile */
131            inline const XMLFile* getFile() const { return this->file_; }
132            const std::string& getFilename() const;
133
134            void addTemplate(const std::string& name);
135            void addTemplate(Template* temp);
136            /** @brief Returns the set of all aplied templates. */
137            inline const std::set<Template*>& getTemplates() const
138                { return this->templates_; }
139
140            inline void setNamespace(const StrongPtr<Namespace>& ns) { this->namespace_ = ns; }
141            inline const StrongPtr<Namespace>& getNamespace() const { return this->namespace_; }
142
143            inline void setCreator(BaseObject* creator) { this->creator_ = creator; }
144            inline BaseObject* getCreator() const { return this->creator_; }
145
146            inline void setScene(const StrongPtr<Scene>& scene, uint32_t sceneID) { this->scene_ = scene; this->sceneID_=sceneID; }
147            inline const StrongPtr<Scene>& getScene() const { return this->scene_; }
148            inline virtual uint32_t getSceneID() const { return this->sceneID_; }
149
150            inline void setGametype(const StrongPtr<Gametype>& gametype)
151            {
152                if (gametype != this->gametype_)
153                {
154                    this->oldGametype_ = this->gametype_;
155                    this->gametype_ = gametype;
156                    this->changedGametype();
157                }
158            }
159            inline const StrongPtr<Gametype>& getGametype() const { return this->gametype_; }
160            inline Gametype* getOldGametype() const { return this->oldGametype_; }
161            virtual void changedGametype() {}
162
163            inline void setLevel(const StrongPtr<Level>& level) { this->level_ = level; }
164            inline const StrongPtr<Level>& getLevel() const { return this->level_; }
165
166            void addEventSource(BaseObject* source, const std::string& state);
167            void removeEventSource(BaseObject* source);
168            BaseObject* getEventSource(unsigned int index, const std::string& state) const;
169
170            void addEventListener(BaseObject* listener);
171            BaseObject* getEventListener(unsigned int index) const;
172
173            void fireEvent(const std::string& name = "");
174            void fireEvent(bool activate, const std::string& name = "");
175            void fireEvent(bool activate, BaseObject* originator, const std::string& name = "");
176            void fireEvent(Event& event);
177
178            virtual void processEvent(Event& event);
179
180            /** @brief Sets the indentation of the debug output in the Loader. @param indentation The indentation */
181            inline void setLoaderIndentation(const std::string& indentation) { this->loaderIndentation_ = indentation; }
182            /** @brief Returns the indentation of the debug output in the Loader. @return The indentation */
183            inline const std::string& getLoaderIndentation() const { return this->loaderIndentation_; }
184
185            static void loadAllEventStates(Element& xmlelement, XMLPort::Mode mode, BaseObject* object, Identifier* identifier);
186
187        protected:
188            void addEventState(const std::string& name, EventState* container);
189            EventState* getEventState(const std::string& name) const;
190
191            std::string             name_;                     //!< The name of the object
192            std::string             oldName_;                  //!< The old name of the object
193            mbool                   bActive_;                  //!< True = the object is active
194            mbool                   bVisible_;                 //!< True = the object is visible
195            std::string             mainStateName_;
196            FunctorPtr              mainStateFunctor_;
197            std::set<std::string>   networkTemplateNames_;
198
199        private:
200            /** @brief Adds an object which listens to the events of this object. */
201            void registerEventListener(BaseObject* object);
202            /** @brief Removes an event listener from this object. */
203            inline void unregisterEventListener(BaseObject* object)
204                { this->eventListeners_.erase(object); }
205
206            void setXMLName(const std::string& name);
207            const std::string& getSingleTemplate(void) const;
208            Template* getTemplate(unsigned int index) const;
209            void registerEventStates();
210
211            bool                   bInitialized_;              //!< True if the object was initialized (passed the object registration)
212            const XMLFile*         file_;                      //!< The XMLFile that loaded this object
213            Element*               lastLoadedXMLElement_;      //!< Non 0 if the TinyXML attributes have already been copied to our own lowercase map
214            std::map<std::string, std::string> xmlAttributes_; //!< Lowercase XML attributes
215            std::string            loaderIndentation_;         //!< Indentation of the debug output in the Loader
216            StrongPtr<Namespace>   namespace_;
217            BaseObject*            creator_;
218            StrongPtr<Scene>       scene_;
219            uint32_t               sceneID_;
220            StrongPtr<Gametype>    gametype_;
221            Gametype*              oldGametype_;
222            StrongPtr<Level>       level_;
223            std::set<Template*>    templates_;
224
225            std::map<BaseObject*, std::string>  eventSources_;           //!< List of objects which send events to this object, mapped to the state which they affect
226            std::set<BaseObject*>               eventListeners_;         //!< List of objects which listen to the events of this object
227            std::set<BaseObject*>               eventListenersXML_;      //!< List of objects which listen to the events of this object through the "eventlisteners" subsection in XML
228            std::map<std::string, EventState*>  eventStates_;            //!< Maps the name of the event states to their helper objects
229            bool                                bRegisteredEventStates_; //!< Becomes true after the object registered its event states (with XMLEventPort)
230    };
231
232    SUPER_FUNCTION(0, BaseObject, XMLPort, false);
233    SUPER_FUNCTION(2, BaseObject, changedActivity, false);
234    SUPER_FUNCTION(3, BaseObject, changedVisibility, false);
235    SUPER_FUNCTION(4, BaseObject, XMLEventPort, false);
236    SUPER_FUNCTION(8, BaseObject, changedName, false);
237    SUPER_FUNCTION(9, BaseObject, changedGametype, false);
238}
239
240#endif /* _BaseObject_H__ */
Note: See TracBrowser for help on using the repository browser.