Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/weaponFS15/src/modules/objects/ForceField.h @ 10602

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

more cleanup

  • Property svn:eol-style set to native
File size: 7.6 KB
Line 
1
2/*
3 *   ORXONOX - the hottest 3D action shooter ever to exist
4 *                    > www.orxonox.net <
5 *
6 *
7 *   License notice:
8 *
9 *   This program is free software; you can redistribute it and/or
10 *   modify it under the terms of the GNU General Public License
11 *   as published by the Free Software Foundation; either version 2
12 *   of the License, or (at your option) any later version.
13 *
14 *   This program is distributed in the hope that it will be useful,
15 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
16 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 *   GNU General Public License for more details.
18 *
19 *   You should have received a copy of the GNU General Public License
20 *   along with this program; if not, write to the Free Software
21 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
22 *
23 *   Author:
24 *      Aurelian Jaggi
25 *   Co-authors:
26 *      Damian 'Mozork' Frick
27 *      Kevin Young
28 *
29 */
30
31/**
32    @file ForceField.h
33    @brief Definition of the ForceField class.
34    @ingroup Objects
35*/
36
37#ifndef _ForceField_H__
38#define _ForceField_H__
39
40#include "objects/ObjectsPrereqs.h"
41
42#include "tools/interfaces/Tickable.h"
43#include "worldentities/StaticEntity.h"
44
45namespace orxonox
46{
47
48    /**
49    @brief
50        The mode of the ForceField.
51
52    @ingroup Objects
53    */
54    namespace forceFieldMode
55    {
56        enum Value {
57            tube, //!< The ForceField has a tube shape.
58            sphere, //!< The ForceField has a spherical shape.
59            invertedSphere, //!< The ForceField has a spherical shape but "inverted" behavior.
60            newtonianGravity, //!< The ForceField imitates Newtonian gravitation for use in stellar bodies.
61            homogen //!< Local homogenous Force field with changeable direction for the Space Station
62        };
63    }
64
65    /**
66    @brief
67        Implements a force field, that applies a force to any @ref orxonox::MobileEntity "MobileEntity" that enters its range.
68
69        The following parameters can be set to specify the behavior of the ForceField.
70        - @b forcedirection The direction and the strength of the homogenous force field. Default is 0,-400,0.
71        - @b velocity The amount of force the ForceField excerts. Default is 100.
72        - @b diameter The diameter of the ForceField. Default is 500.
73        - @b length The length of the ForceField. Default is 2000.
74        - @b mode The mode the ForceField is in. For mode:
75            - <em>tube</em> A ForceField which exerts force only in the direction it is oriented. The force is only exerted on objects that are in a tube of length <em>length</em> and diameter <em>diameter</em> (with rounded start and end faces, so in fact the <em>length</em> parameter specifies a ball with <code>origin + length/2</code> as the center and <code>length/2</code> as the radius). The magintude of the force is proportional to the <em>velocity</em>, being highest when an object is in the middle of the tube (radius-wise), linearly decreasing with greater radii and finally reaching zero, when the object is <code>diameter/2</code> away from the orientation vector.
76            - <em>sphere</em> A Force Field which exerts force radially away from itself, with the greatest magnitude (proportional to <em>velocity</em>) being in the origin of the ForceField, linearly decreasing with respect to the distance to the origin and finally reaching zero at distance <code>diameter/2</code>.
77            Default is <em>tube</em>.
78            - <em>invertedSphere</em> A ForceField which excerts force radially towards itself, with the highest force at the boundary of the sphere, linear decreasing until reaching a distance of <code>radius-length</code> from the origin, where the force reaches zero.
79
80    @author
81        Aurelian Jaggi
82
83    @author
84        Damian 'Mozork' Frick
85
86    @ingroup Objects
87    */
88    class _ObjectsExport ForceField : public StaticEntity, public Tickable
89    {
90        public:
91            ForceField(Context* context);
92            virtual ~ForceField();
93
94            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Creates a ForceField object through XML.
95            void registerVariables(); //!< Registers the variables that should get synchronised over the network
96            virtual void tick(float dt); //!< A method that is called every tick.
97           
98
99            /**
100            @brief Set the velocity of the ForceField.
101            @param vel The velocity to be set.
102            */
103            inline void setVelocity(float vel)
104                { this->velocity_ = vel; }
105            /**
106            @brief Get the velocity of the ForceField.
107            @return Returns the velocity of the ForceField.
108            */
109            inline float getVelocity()
110                { return this->velocity_; }
111
112            /**
113            @brief Set the diameter of the ForceField. In mode StellarBody this stands for the outer radius.
114            @param diam The diameter to be set.
115            */
116            inline void setDiameter(float diam)
117                { this->radius_ = diam/2; }
118            /**
119            @brief Get the diameter of the ForceField. In mode StellarBody this stands for the outer radius.
120            @return Returns the diameter of the ForceField.
121            */
122            inline float getDiameter()
123                { return this->radius_*2; }
124       
125            /**
126            @brief Set the diameter of the stellar body for the Newtonian ForceField.
127            @param massDiam The diameter of the stellar body.
128            */
129            inline void setMassDiameter(float massDiam)
130                { this->massRadius_ = massDiam/2; }
131       
132            /**
133            @brief Get the diameter of the stellar body for the Newtonian ForceField.
134            @return float Returns the diameter of the stellar body.
135            */
136            inline float getMassDiameter()
137                { return this->massRadius_*2; }
138
139            /**
140            @brief Set the length of the ForceField.
141            @param l The length to be set.
142            */
143            inline void setLength(float l)
144                { this->halfLength_ = l/2; }
145            /**
146            @brief Get the length of the ForceField.
147            @return Returns the length of the ForceField.
148            */
149            inline float getLength()
150                { return this->halfLength_*2; }
151
152            inline void setForceDirection(Vector3 forcedir)
153                { this->forceDirection_ = forcedir; }
154
155            inline Vector3 getForceDirection()
156                { return this->forceDirection_; }
157
158
159            void setMode(const std::string& mode); //!< Set the mode of the ForceField.
160            const std::string& getMode(void); //!< Get the mode of the ForceField.
161
162            //! Strings to represent the modes.
163            static const std::string modeTube_s;
164            static const std::string modeSphere_s;
165            static const std::string modeInvertedSphere_s;
166            static const std::string modeNewtonianGravity_s;
167            static const std::string modeHomogen_s;
168
169        private:
170            float velocity_; //!< The velocity of the ForceField.
171            float radius_; //!< The radius of the ForceField.
172            float massRadius_; //!< The radius of the stellar body for the Newtonian ForceField.
173            float halfLength_; //!< Half of the length of the ForceField.
174            int mode_; //!< The mode of the ForceField.
175           
176            //! Gravitational constant for Newtonian ForceFields.
177            static const float gravConstant_;
178            //! Attenuation factor for Newtonian ForceFields
179            static const float attenFactor_;
180            Vector3 forceDirection_;
181  };
182}
183
184#endif
Note: See TracBrowser for help on using the repository browser.