Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/worldentities/ControllableEntity.h @ 12205

Last change on this file since 12205 was 12028, checked in by merholzl, 6 years ago

added scriptable controller

  • Property svn:eol-style set to native
File size: 9.8 KB
RevLine 
[2072]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:
[2662]25 *      Reto Grieder
[2072]26 *
27 */
28
29#ifndef _ControllableEntity_H__
30#define _ControllableEntity_H__
31
32#include "OrxonoxPrereqs.h"
[3196]33
34#include <list>
35#include <string>
36#include "util/Math.h"
[2662]37#include "MobileEntity.h"
[2072]38
39namespace orxonox
40{
[10437]41    /**
42    @brief
43        The ControllableEntity is derived from the @ref orxonox::MobileEntity. ControllableEntities can be controlled by @ref orxonox::Controller Controllers.
44        A Controller will call (based on user input, AI decision, ...) for example the function @see moveFrontBack or the function @see rotateYaw to
45        move the ControllableEntity through space. A Controller could also call the @see boost function to tell the ControllableEntity that he wants it to boost.
46    */
47
[2662]48    class _OrxonoxExport ControllableEntity : public MobileEntity
[2072]49    {
[3038]50        friend class PlayerInfo; // PlayerInfo uses setPlayer and removePlayer
51
[2072]52        public:
[9667]53            ControllableEntity(Context* context);
[2072]54            virtual ~ControllableEntity();
55
[11071]56            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;
57            virtual void tick(float dt) override;
[2662]58            void setConfigValues();
[2072]59
[2839]60            virtual void changedPlayer() {}
[2662]61
[2072]62            inline PlayerInfo* getPlayer() const
63                { return this->player_; }
[7533]64            /**
65            @brief Get the player even after the ControllableEntity has stopped being the players ControllableEntity.
66            @return Returns the most recent PlayerInfo.
67            */
68            inline PlayerInfo* getFormerPlayer() const
69                { return this->formerPlayer_; }
[2072]70
71            inline void setDestroyWhenPlayerLeft(bool bDestroy)
72                { this->bDestroyWhenPlayerLeft_ = bDestroy; }
73            inline bool getDestroyWhenPlayerLeft() const
74                { return this->bDestroyWhenPlayerLeft_; }
75
76            virtual void moveFrontBack(const Vector2& value) {}
77            virtual void moveRightLeft(const Vector2& value) {}
78            virtual void moveUpDown(const Vector2& value) {}
79
[2662]80            virtual void rotateYaw(const Vector2& value);
81            virtual void rotatePitch(const Vector2& value);
82            virtual void rotateRoll(const Vector2& value);
[2072]83
[2662]84            inline void moveFrontBack(float value)
85                { this->moveFrontBack(Vector2(value, 0)); }
86            inline void moveRightLeft(float value)
87                { this->moveRightLeft(Vector2(value, 0)); }
88            inline void moveUpDown(float value)
89                { this->moveUpDown(Vector2(value, 0)); }
[2072]90
[2662]91            inline void rotateYaw(float value)
92                { this->rotateYaw(Vector2(value, 0)); }
93            inline void rotatePitch(float value)
94                { this->rotatePitch(Vector2(value, 0)); }
95            inline void rotateRoll(float value)
96                { this->rotateRoll(Vector2(value, 0)); }
97
[6417]98            void fire(unsigned int firemode);
99            virtual void fired(unsigned int firemode) {}
[3053]100            virtual void reload() {}
[2662]101
[8706]102            /**
103            @brief Tells the ControllableEntity to either start or stop boosting.
104                   This doesn't mean, that the ControllableEntity will do so, there might be additional restrictions on boosting, but if it can, then it will.
105            @param bBoost If true the ControllableEntity is told to start boosting, if false it is told to stop.
106            */
107            virtual void boost(bool bBoost) {}
[8891]108
[2072]109            virtual void greet() {}
110            virtual void switchCamera();
[2662]111            virtual void mouseLook();
[2072]112
113            inline const std::string& getHudTemplate() const
114                { return this->hudtemplate_; }
115
116            inline Camera* getCamera() const
117                { return this->camera_; }
118            inline OverlayGroup* getHUD() const
119                { return this->hud_; }
120
121            void addCameraPosition(CameraPosition* position);
122            CameraPosition* getCameraPosition(unsigned int index) const;
[11071]123            inline const std::list<StrongPtr<CameraPosition>>& getCameraPositions() const
[2072]124                { return this->cameraPositions_; }
[8706]125            unsigned int getCurrentCameraIndex() const;
126            bool setCameraPosition(unsigned int index);
[2072]127
128            inline void setCameraPositionTemplate(const std::string& name)
129                { this->cameraPositionTemplate_ = name; }
[8706]130            inline const std::string& getCameraPositionTemplate() const
[2072]131                { return this->cameraPositionTemplate_; }
132
[3089]133            inline void setReverseCamera(CameraPosition* camera)
134                { this->reverseCamera_ = camera; }
135            inline CameraPosition* getReverseCamera() const
136                { return this->reverseCamera_; }
137
[2662]138            using WorldEntity::setPosition;
139            using WorldEntity::setOrientation;
140            using MobileEntity::setVelocity;
141            using MobileEntity::setAngularVelocity;
142
[11071]143            virtual void setPosition(const Vector3& position) override;
144            virtual void setOrientation(const Quaternion& orientation) override;
145            virtual void setVelocity(const Vector3& velocity) override;
146            virtual void setAngularVelocity(const Vector3& velocity) override;
[2662]147
148            inline bool hasLocalController() const
149                { return this->bHasLocalController_; }
150            inline bool hasHumanController() const
151                { return this->bHasHumanController_; }
152
153            inline bool isInMouseLook() const
154                { return this->bMouseLook_; }
155            inline float getMouseLookSpeed() const
156                { return this->mouseLookSpeed_; }
[7163]157            inline CameraPosition* getCurrentCameraPosition()
158                { return this->currentCameraPosition_; }
[2662]159
[3049]160            inline Controller* getXMLController() const
161                { return this->xmlcontroller_; }
162
[6417]163            inline Controller* getController() const
[10624]164                { return this->controller_; }
[8891]165            void setController(Controller* val);
[6417]166
[8891]167
[6417]168            virtual void setTarget( WorldEntity* target );
169            virtual WorldEntity* getTarget()
[10624]170                { return this->target_; }
[6417]171            void setTargetInternal( uint32_t targetID );
172
[9348]173            inline void setTeam(int team)
174                { this->team_ = team; }
175            inline int getTeam() const
176                { return this->team_; }
[9016]177
[12028]178
[2072]179        protected:
[11071]180            virtual void preDestroy() override;
[7889]181
[3038]182            virtual void setPlayer(PlayerInfo* player); // don't call this directly, use friend class PlayerInfo instead
183            virtual void removePlayer();                // don't call this directly, use friend class PlayerInfo instead
184
[2662]185            virtual void startLocalHumanControl();
186            virtual void stopLocalHumanControl();
[11071]187            virtual void parentChanged() override;
[2072]188
189            inline void setHudTemplate(const std::string& name)
190                { this->hudtemplate_ = name; }
[8706]191            // HACK-ish
192            void createHud(void);
193            void destroyHud(void);
[2072]194
[7163]195            Ogre::SceneNode* cameraPositionRootNode_;
196
[2072]197        private:
[7163]198            void registerVariables();
[3049]199            void setXMLController(Controller* controller);
200
[2072]201            void overwrite();
202            void processOverwrite();
203
204            void processServerPosition();
[2662]205            void processServerLinearVelocity();
[2072]206            void processServerOrientation();
[2662]207            void processServerAngularVelocity();
[2072]208
209            void processClientPosition();
[2662]210            void processClientLinearVelocity();
[2072]211            void processClientOrientation();
[2662]212            void processClientAngularVelocity();
[2072]213
214            void networkcallback_changedplayerID();
215
[2662]216            // Bullet btMotionState related
[11071]217            virtual void setWorldTransform(const btTransform& worldTrans) override;
[2662]218
[2072]219            unsigned int server_overwrite_;
220            unsigned int client_overwrite_;
221
[2662]222            bool bHasLocalController_;
223            bool bHasHumanController_;
224            bool bDestroyWhenPlayerLeft_;
[2072]225
226            Vector3 server_position_;
227            Vector3 client_position_;
[2662]228            Vector3 server_linear_velocity_;
229            Vector3 client_linear_velocity_;
[2072]230            Quaternion server_orientation_;
231            Quaternion client_orientation_;
[2662]232            Vector3 server_angular_velocity_;
233            Vector3 client_angular_velocity_;
[2072]234
235            PlayerInfo* player_;
[7533]236            PlayerInfo* formerPlayer_;
[2072]237            unsigned int playerID_;
[2662]238
[2072]239            std::string hudtemplate_;
240            OverlayGroup* hud_;
[2662]241
[2072]242            Camera* camera_;
[2662]243            bool bMouseLook_;
244            float mouseLookSpeed_;
[11071]245            std::list<StrongPtr<CameraPosition>> cameraPositions_;
[6417]246            CameraPosition* currentCameraPosition_;
[2072]247            std::string cameraPositionTemplate_;
[3049]248            Controller* xmlcontroller_;
[8891]249            WeakPtr<Controller> controller_;
[3089]250            CameraPosition* reverseCamera_;
[6417]251            WeakPtr<WorldEntity> target_;
[9016]252
[9348]253            int team_ ; //<! teamnumber
[2072]254    };
255}
256
257#endif /* _ControllableEntity_H__ */
Note: See TracBrowser for help on using the repository browser.