Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 2446 was 2171, checked in by landauf, 16 years ago

merged revisions 2111-2170 from objecthierarchy branch back to trunk.

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