Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/OrxoBlox_FS19/src/modules/OrxoBlox/OrxoBloxBall.h @ 12366

Last change on this file since 12366 was 12366, checked in by ahuwyler, 5 years ago

Here and there

File size: 5.2 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 OrxoBloxBall.h
31    @brief Declaration of the OrxoBloxBall class.
32    @ingroup OrxoBlox
33*/
34
35#ifndef _OrxoBloxBall_H__
36#define _OrxoBloxBall_H__
37
38#include "OrxoBlox/OrxoBloxPrereqs.h"
39
40#include "util/Math.h"
41
42#include "worldentities/pawns/Pawn.h"
43#include <bullet/BulletCollision/NarrowPhaseCollision/btManifoldPoint.h>
44
45
46namespace orxonox
47{
48
49    /**
50    @brief
51        This class manages the ball for @ref orxonox::OrxoBlox "OrxoBlox".
52
53        It is responsible for both the movement of the ball in the x,z-plane as well as its interaction with the boundaries of the playing field (defined by the @ref orxonox::OrxoBloxCenterpoint "OrxoBloxCenterpoint") and the @ref orxonox::OrxoBloxBat "OrxoBloxBats". Or more precisely, it makes the ball bounce off then upper and lower delimiters of the playing field, it makes the ball bounce off the bats and also detects when a player scores and takes appropriate measures.
54
55    @author
56        Fabian 'x3n' Landau
57
58    @ingroup OrxoBlox
59    */
60    class _OrxoBloxExport OrxoBloxBall : public Pawn
61    {
62        public:
63            OrxoBloxBall(Context* context);
64            virtual ~OrxoBloxBall();
65
66            virtual void tick(float dt) override;
67
68            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;
69
70            /**
71            @brief Set the dimensions of the playing field.
72            @param width The width of the playing field.
73            @param height The height of the playing field.
74            */
75            void setFieldDimension(float width, float height)
76                { this->fieldWidth_ = width; this->fieldHeight_ = height; }
77            /**
78            @brief Get the dimensions of the playing field.
79            @param dimension A vector with the width as the first and height as the second component.
80            */
81            void setFieldDimension(const Vector2& dimension)
82                { this->setFieldDimension(dimension.x, dimension.y); }
83            /**
84            @brief Get the dimensions of the playing field.
85            @return Returns a vector with the width as the first and height as the second component.
86            */
87            Vector2 getFieldDimension() const
88                { return Vector2(this->fieldWidth_, this->fieldHeight_); }
89
90            void setSpeed(float speed); //!< Set the speed of the ball (in x-direction).
91            /**
92            @brief Get the speed of the ball (in x-direction).
93            @return Returns the speed of the ball (in x-direction).
94            */
95            float getSpeed() const
96                { return this->speed_; }
97
98            /**
99            @brief Set the acceleration factor of the ball.
100            @param factor The factor the acceleration of the ball is set to.
101            */
102            void setAccelerationFactor(float factor)
103                { this->accelerationFactor_ = factor; }
104            /**
105            @brief Get the acceleration factor of the ball.
106            @return Returns the acceleration factor of the ball.
107            */
108            float getAccelerationFactor() const
109                { return this->accelerationFactor_; }
110
111       
112
113            void Bounce(OrxoBloxStones* otherObject);
114            void Collides(OrxoBloxStones* otherObject);
115
116            static const float MAX_REL_Z_VELOCITY;
117
118            void setDefScoreSound(const std::string& engineSound);
119            const std::string& getDefScoreSound();
120           
121            void setDefBoundarySound(const std::string& engineSound);
122            const std::string& getDefBoundarySound();
123            float getRadius();
124
125
126        private:
127            void registerVariables();
128
129            OrxoBlox* getOrxoBlox();
130            float radius_;
131            float fieldWidth_; //!< The width of the playing field.
132            float fieldHeight_; //!< The height of the playing field.
133            float speed_; //!< The speed (in x-direction) of the ball.
134            float accelerationFactor_; //!< The acceleration factor of the ball.
135           
136            unsigned int* batID_; //!< The object IDs of the bats, to be able to synchronize them over the network.
137            float relMercyOffset_; //!< Offset, that makes the player not loose, when, in all fairness, he would have.
138            WorldSound* defScoreSound_;
139            WorldSound* defBoundarySound_;
140            OrxoBlox* orxoblox_;
141    };
142}
143
144#endif /* _OrxoBloxBall_H__ */
Note: See TracBrowser for help on using the repository browser.