Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/pch/src/util/Math.h @ 3163

Last change on this file since 3163 was 3163, checked in by rgrieder, 15 years ago

Moved orxonox::TransformSpace::Enum to WorldEntity::TransformSpace and asserted the conversions with a BOOST_STATIC_ASSERT (avoids unnecessary switch statements).
Also

  • Property svn:eol-style set to native
File size: 9.5 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
31    @brief Declaration and implementation of several math-functions, typedefs of some Ogre::Math classes to the orxonox namespace.
32*/
33
34#ifndef _Util_Math_H__
35#define _Util_Math_H__
36
37#include "UtilPrereqs.h"
38
39#include <string>
40#include <cmath>
41
42#include <OgreMath.h>
43#include <OgreVector2.h>
44#include <OgreVector3.h>
45#include <OgreVector4.h>
46#include <OgreQuaternion.h>
47#include <OgreColourValue.h>
48
49// Certain headers might define min and max macros
50#if defined(max) || defined(min) || defined(sgn) || defined(clamp) || defined(square) || defined(mod)
51#  error An inline math function was overridden by a macro
52#endif
53
54namespace orxonox
55{
56    _UtilExport std::ostream& operator<<(std::ostream& out, const orxonox::Radian& radian);
57    _UtilExport std::istream& operator>>(std::istream& in, orxonox::Radian& radian);
58    _UtilExport std::ostream& operator<<(std::ostream& out, const orxonox::Degree& degree);
59    _UtilExport std::istream& operator>>(std::istream& in, orxonox::Degree& degree);
60
61    _UtilExport float getAngle(const orxonox::Vector3& myposition, const orxonox::Vector3& mydirection, const orxonox::Vector3& otherposition);
62    _UtilExport orxonox::Vector2 get2DViewdirection(const orxonox::Vector3& myposition, const orxonox::Vector3& mydirection, const orxonox::Vector3& myorthonormal, const orxonox::Vector3& otherposition);
63    _UtilExport orxonox::Vector2 get2DViewcoordinates(const orxonox::Vector3& myposition, const orxonox::Vector3& mydirection, const orxonox::Vector3& myorthonormal, const orxonox::Vector3& otherposition);
64    _UtilExport orxonox::Vector3 getPredictedPosition(const orxonox::Vector3& myposition, float projectilespeed, const orxonox::Vector3& targetposition, const orxonox::Vector3& targetvelocity);
65
66    /**
67        @brief Returns the sign of the given value.
68        @param x The value
69        @return 1 if the value is positive or zero, -1 if the value is negative
70    */
71    template <typename T>
72    inline T sgn(T x)
73    {
74        return (x >= 0) ? 1 : -1;
75    }
76
77    /**
78        @brief Returns the smaller of two values.
79    */
80    template <typename T>
81    inline T min(T a, T b)
82    {
83        return (a <= b) ? a : b;
84    }
85
86    /**
87        @brief Returns the greater of two values.
88    */
89    template <typename T>
90    inline T max(T a, T b)
91    {
92        return (a >= b) ? a : b;
93    }
94
95    /**
96        @brief Keeps a value between a lower and an upper limit.
97        @param x The value
98        @param min The lower limit
99        @param max The upper limit
100    */
101    template <typename T>
102    inline T clamp(T x, T min, T max)
103    {
104        if (x < min)
105            return min;
106
107        if (x > max)
108            return max;
109
110        return x;
111    }
112
113    /**
114        @brief Returns the square value (x^2).
115    */
116    template <typename T>
117    inline T square(T x)
118    {
119        return x*x;
120    }
121
122    /**
123        @brief Returns the cube value (x^3).
124    */
125    template <typename T>
126    inline T cube(T x)
127    {
128        return x*x*x;
129    }
130
131    /**
132        @brief Rounds the value.
133    */
134    template <typename T>
135    inline int round(T x)
136    {
137        return (int)(x + 0.5);
138    }
139
140    /**
141        @brief The modulo operation, enhanced to work properly with negative values.
142        @param x The value
143        @param max The operand
144    */
145    template <typename T>
146    inline int mod(T x, int max)
147    {
148        if (x >= 0)
149            return (x % max);
150        else
151            return ((x % max) + max);
152    }
153
154    template <typename T>
155    inline T zeroise()
156    {
157        // Default, raise a compiler error without including large boost header cascade.
158        T temp();
159        *********temp; // If you reach this code, you abused zeroise()!
160        return temp;
161    }
162
163    template <> inline char                 zeroise<char>()                 { return 0; }
164    template <> inline unsigned char        zeroise<unsigned char>()        { return 0; }
165    template <> inline short                zeroise<short>()                { return 0; }
166    template <> inline unsigned short       zeroise<unsigned short>()       { return 0; }
167    template <> inline int                  zeroise<int>()                  { return 0; }
168    template <> inline unsigned int         zeroise<unsigned int>()         { return 0; }
169    template <> inline long                 zeroise<long>()                 { return 0; }
170    template <> inline unsigned long        zeroise<unsigned long>()        { return 0; }
171    template <> inline long long            zeroise<long long>()            { return 0; }
172    template <> inline unsigned long long   zeroise<unsigned long long>()   { return 0; }
173    template <> inline float                zeroise<float>()                { return 0; }
174    template <> inline double               zeroise<double>()               { return 0; }
175    template <> inline long double          zeroise<long double>()          { return 0; }
176    template <> inline bool                 zeroise<bool>()                 { return 0; }
177    template <> inline void*                zeroise<void*>()                { return 0; }
178    template <> inline std::string          zeroise<std::string>()          { return ""; }
179    template <> inline orxonox::Radian      zeroise<orxonox::Radian>()      { return orxonox::Radian(0.0f); }
180    template <> inline orxonox::Degree      zeroise<orxonox::Degree>()      { return orxonox::Degree(0.0f); }
181    template <> inline orxonox::Vector2     zeroise<orxonox::Vector2>()     { return orxonox::Vector2    (0, 0)      ; }
182    template <> inline orxonox::Vector3     zeroise<orxonox::Vector3>()     { return orxonox::Vector3    (0, 0, 0)   ; }
183    template <> inline orxonox::Vector4     zeroise<orxonox::Vector4>()     { return orxonox::Vector4    (0, 0, 0, 0); }
184    template <> inline orxonox::ColourValue zeroise<orxonox::ColourValue>() { return orxonox::ColourValue(0, 0, 0, 0); }
185    template <> inline orxonox::Quaternion  zeroise<orxonox::Quaternion>()  { return orxonox::Quaternion (0, 0, 0, 0); }
186
187    //! Provides zero value symbols that can be returned as reference
188    template <typename T>
189    struct NilValue
190    {
191        inline operator const T&() const
192        {
193            return value;
194        }
195        static T value;
196    };
197    template <typename T>
198    T NilValue<T>::value = zeroise<T>();
199
200    /**
201        @brief Interpolates between two values for a time between 0 and 1.
202        @param time The time is a value between 0 and 1 - the function returns start if time is 0 and end if time is 1 and interpolates if time is between 0 and 1.
203        @param start The value at time = 0
204        @param end The value at time = 1
205        @return The interpolation at a given time
206    */
207    template <typename T>
208    inline T interpolate(float time, const T& start, const T& end)
209    {
210        return time * (end - start) + start;
211    }
212
213    /**
214        @brief Interpolates smoothly between two values for a time between 0 and 1. The function starts slowly, increases faster and stops slowly again.
215        @param time The time is a value between 0 and 1 - the function returns start if time is 0 and end if time is 1 and interpolates if time is between 0 and 1.
216        @param start The value at time = 0
217        @param end The value at time = 1
218        @return The smoothed interpolation at a given time
219    */
220    template <typename T>
221    inline T interpolateSmooth(float time, const T& start, const T& end)
222    {
223        return (-2 * (end - start) * cube(time)) + (3 * (end - start) * square(time)) + start;
224    }
225
226    /**
227        @brief Returns a random number between 0 and almost 1: 0 <= rnd < 1.
228    */
229    inline float rnd()
230    {
231        return rand() / (RAND_MAX + 1.0);
232    }
233
234    /**
235        @brief Returns a random number between 0 and almost max: 0 <= rnd < max.
236        @param max The maximum
237    */
238    inline float rnd(float max)
239    {
240        return rnd() * max;
241    }
242
243    /**
244        @brief Returns a random number between min and almost max: min <= rnd < max.
245        @param min The minimum
246        @param max The maximum
247    */
248    inline float rnd(float min, float max)
249    {
250        return rnd(max - min) + min;
251    }
252
253    /**
254        @brief Returns randomly 1 or -1 with equal probability.
255    */
256    inline float rndsgn()
257    {
258        return ((rand() & 0x2) - 1); // rand() & 0x2 is either 2 or 0
259    }
260
261    _UtilExport unsigned long getUniqueNumber();
262
263    class IntVector2
264    {
265    public:
266        IntVector2() : x(0), y(0) { }
267        IntVector2(int _x, int _y) : x(_x), y(_y) { }
268        int x;
269        int y;
270    };
271
272    class IntVector3
273    {
274    public:
275        IntVector3() : x(0), y(0), z(0) { }
276        IntVector3(int _x, int _y, int _z) : x(_x), y(_y), z(_z) { }
277        int x;
278        int y;
279        int z;
280    };
281}
282
283#endif /* _Util_Math_H__ */
Note: See TracBrowser for help on using the repository browser.