Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/util/Math.h @ 4372

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

Found a few more C-Style casts.

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