Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/spacestationentry/src/modules/objects/ForceField.h @ 9699

Last change on this file since 9699 was 9667, checked in by landauf, 11 years ago

merged core6 back to trunk

  • Property svn:eol-style set to native
File size: 7.1 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 *      Aurelian Jaggi
24 *   Co-authors:
25 *      Damian 'Mozork' Frick
26 *      Kevin Young
27 *
28 */
29
30/**
31    @file ForceField.h
32    @brief Definition of the ForceField class.
33    @ingroup Objects
34*/
35
36#ifndef _ForceField_H__
37#define _ForceField_H__
38
39#include "objects/ObjectsPrereqs.h"
40
41#include "tools/interfaces/Tickable.h"
42#include "worldentities/StaticEntity.h"
43
44namespace orxonox
45{
46
47    /**
48    @brief
49        The mode of the ForceField.
50
51    @ingroup Objects
52    */
53    namespace forceFieldMode
54    {
55        enum Value {
56            tube, //!< The ForceField has a tube shape.
57            sphere, //!< The ForceField has a spherical shape.
58            invertedSphere, //!< The ForceField has a spherical shape but "inverted" behavior.
59            newtonianGravity //!< The ForceField imitates Newtonian gravitation for use in stellar bodies.
60        };
61    }
62
63    /**
64    @brief
65        Implements a force field, that applies a force to any @ref orxonox::MobileEntity "MobileEntity" that enters its range.
66
67        The following parameters can be set to specify the behavior of the ForceField.
68        - @b velocity The amount of force the ForceField excerts. Default is 100.
69        - @b diameter The diameter of the ForceField. Default is 500.
70        - @b length The length of the ForceField. Default is 2000.
71        - @b mode The mode the ForceField is in. For mode:
72            - <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.
73            - <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>.
74            Default is <em>tube</em>.
75            - <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.
76
77    @author
78        Aurelian Jaggi
79
80    @author
81        Damian 'Mozork' Frick
82
83    @ingroup Objects
84    */
85    class _ObjectsExport ForceField : public StaticEntity, public Tickable
86    {
87        public:
88            ForceField(Context* context);
89            virtual ~ForceField();
90
91            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Creates a ForceField object through XML.
92            void registerVariables(); //!< Registers the variables that should get synchronised over the network
93            virtual void tick(float dt); //!< A method that is called every tick.
94           
95
96            /**
97            @brief Set the velocity of the ForceField.
98            @param vel The velocity to be set.
99            */
100            inline void setVelocity(float vel)
101                { this->velocity_ = vel; }
102            /**
103            @brief Get the velocity of the ForceField.
104            @return Returns the velocity of the ForceField.
105            */
106            inline float getVelocity()
107                { return this->velocity_; }
108
109            /**
110            @brief Set the diameter of the ForceField. In mode StellarBody this stands for the outer radius.
111            @param diam The diameter to be set.
112            */
113            inline void setDiameter(float diam)
114                { this->radius_ = diam/2; }
115            /**
116            @brief Get the diameter of the ForceField. In mode StellarBody this stands for the outer radius.
117            @return Returns the diameter of the ForceField.
118            */
119            inline float getDiameter()
120                { return this->radius_*2; }
121       
122            /**
123            @brief Set the diameter of the stellar body for the Newtonian ForceField.
124            @param massDiam The diameter of the stellar body.
125            */
126            inline void setMassDiameter(float massDiam)
127                { this->massRadius_ = massDiam/2; }
128       
129            /**
130            @brief Get the diameter of the stellar body for the Newtonian ForceField.
131            @return float Returns the diameter of the stellar body.
132            */
133            inline float getMassDiameter()
134                { return this->massRadius_*2; }
135
136            /**
137            @brief Set the length of the ForceField.
138            @param l The length to be set.
139            */
140            inline void setLength(float l)
141                { this->halfLength_ = l/2; }
142            /**
143            @brief Get the length of the ForceField.
144            @return Returns the length of the ForceField.
145            */
146            inline float getLength()
147                { return this->halfLength_*2; }
148
149            void setMode(const std::string& mode); //!< Set the mode of the ForceField.
150            const std::string& getMode(void); //!< Get the mode of the ForceField.
151
152        private:
153            //! Strings to represent the modes.
154            static const std::string modeTube_s;
155            static const std::string modeSphere_s;
156            static const std::string modeInvertedSphere_s;
157            static const std::string modeNewtonianGravity_s;
158
159            float velocity_; //!< The velocity of the ForceField.
160            float radius_; //!< The radius of the ForceField.
161            float massRadius_; //!< The radius of the stellar body for the Newtonian ForceField.
162            float halfLength_; //!< Half of the length of the ForceField.
163            int mode_; //!< The mode of the ForceField.
164           
165            //! Gravitational constant for Newtonian ForceFields.
166            static const float gravConstant_;
167            //! Attenuation factor for Newtonian ForceFields
168            static const float attenFactor_;
169  };
170}
171
172#endif
Note: See TracBrowser for help on using the repository browser.