]> git.lizzy.rs Git - minetest.git/blobdiff - src/util/numeric.h
Allow rotating entity selectionboxes (#12379)
[minetest.git] / src / util / numeric.h
index 0eba01359ea6db92c9cfcf67c0ac157df04ca738..265046a63243c4769260e585d18df57ef627c2af 100644 (file)
@@ -17,51 +17,33 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef UTIL_NUMERIC_HEADER
-#define UTIL_NUMERIC_HEADER
-
-#include "../irrlichttypes.h"
-#include "../irr_v2d.h"
-#include "../irr_v3d.h"
-#include "../irr_aabb3d.h"
-#include <list>
-#include <map>
-#include <vector>
-#include <algorithm>
-
+#pragma once
+
+#include "basic_macros.h"
+#include "constants.h"
+#include "irrlichttypes.h"
+#include "irr_v2d.h"
+#include "irr_v3d.h"
+#include "irr_aabb3d.h"
+#include "SColor.h"
+#include <matrix4.h>
+
+#define rangelim(d, min, max) ((d) < (min) ? (min) : ((d) > (max) ? (max) : (d)))
+#define myfloor(x) ((x) < 0.0 ? (int)(x) - 1 : (int)(x))
+// The naive swap performs better than the xor version
+#define SWAP(t, x, y) do { \
+       t temp = x; \
+       x = y; \
+       y = temp; \
+} while (0)
 
-/*
- * This class permits to cache getFacePosition call results
- * This reduces CPU usage and vector calls
- */
-class FacePositionCache
-{
-public:
-       static std::vector<v3s16> getFacePositions(u16 d);
-private:
-       static void generateFacePosition(u16 d);
-       static std::map<u16, std::vector<v3s16> > m_cache;
-};
-
-class IndentationRaiser
-{
-public:
-       IndentationRaiser(u16 *indentation)
-       {
-               m_indentation = indentation;
-               (*m_indentation)++;
-       }
-       ~IndentationRaiser()
-       {
-               (*m_indentation)--;
-       }
-private:
-       u16 *m_indentation;
-};
+// Maximum radius of a block.  The magic number is
+// sqrt(3.0) / 2.0 in literal form.
+static constexpr const f32 BLOCK_MAX_RADIUS = 0.866025403784f * MAP_BLOCKSIZE * BS;
 
 inline s16 getContainerPos(s16 p, s16 d)
 {
-       return (p>=0 ? p : p-d+1) / d;
+       return (p >= 0 ? p : p - d + 1) / d;
 }
 
 inline v2s16 getContainerPos(v2s16 p, s16 d)
@@ -144,36 +126,6 @@ inline bool isInArea(v3s16 p, v3s16 d)
        );
 }
 
-#define rangelim(d, min, max) ((d) < (min) ? (min) : ((d)>(max)?(max):(d)))
-#define myfloor(x) ((x) > 0.0 ? (int)(x) : (int)(x) - 1)
-
-inline v3s16 arealim(v3s16 p, s16 d)
-{
-       if(p.X < 0)
-               p.X = 0;
-       if(p.Y < 0)
-               p.Y = 0;
-       if(p.Z < 0)
-               p.Z = 0;
-       if(p.X > d-1)
-               p.X = d-1;
-       if(p.Y > d-1)
-               p.Y = d-1;
-       if(p.Z > d-1)
-               p.Z = d-1;
-       return p;
-}
-
-#define ARRLEN(x) (sizeof(x) / sizeof((x)[0]))
-#define CONTAINS(c, v) (std::find((c).begin(), (c).end(), (v)) != (c).end())
-
-// The naive swap performs better than the xor version
-#define SWAP(t, x, y) do { \
-       t temp = x;            \
-       x = y;                 \
-       y = temp;              \
-} while (0)
-
 inline void sortBoxVerticies(v3s16 &p1, v3s16 &p2) {
        if (p1.X > p2.X)
                SWAP(s16, p1.X, p2.X);
@@ -183,6 +135,16 @@ inline void sortBoxVerticies(v3s16 &p1, v3s16 &p2) {
                SWAP(s16, p1.Z, p2.Z);
 }
 
+inline v3s16 componentwise_min(const v3s16 &a, const v3s16 &b)
+{
+       return v3s16(MYMIN(a.X, b.X), MYMIN(a.Y, b.Y), MYMIN(a.Z, b.Z));
+}
+
+inline v3s16 componentwise_max(const v3s16 &a, const v3s16 &b)
+{
+       return v3s16(MYMAX(a.X, b.X), MYMAX(a.Y, b.Y), MYMAX(a.Z, b.Z));
+}
+
 
 /** Returns \p f wrapped to the range [-360, 360]
  *
@@ -226,6 +188,23 @@ inline float wrapDegrees_0_360(float f)
 }
 
 
+/** Returns \p v3f wrapped to the range [0, 360]
+  */
+inline v3f wrapDegrees_0_360_v3f(v3f v)
+{
+       v3f value_v3f;
+       value_v3f.X = modulo360f(v.X);
+       value_v3f.Y = modulo360f(v.Y);
+       value_v3f.Z = modulo360f(v.Z);
+
+       // Now that values are wrapped, use to get values for certain ranges
+       value_v3f.X = value_v3f.X < 0 ? value_v3f.X + 360 : value_v3f.X;
+       value_v3f.Y = value_v3f.Y < 0 ? value_v3f.Y + 360 : value_v3f.Y;
+       value_v3f.Z = value_v3f.Z < 0 ? value_v3f.Z + 360 : value_v3f.Z;
+       return value_v3f;
+}
+
+
 /** Returns \p f wrapped to the range [-180, 180]
   */
 inline float wrapDegrees_180(float f)
@@ -244,6 +223,8 @@ u32 myrand();
 void mysrand(unsigned int seed);
 void myrand_bytes(void *out, size_t len);
 int myrand_range(int min, int max);
+float myrand_range(float min, float max);
+float myrand_float();
 
 /*
        Miscellaneous functions
@@ -276,11 +257,7 @@ u64 murmur_hash_64_ua(const void *key, int len, unsigned int seed);
 bool isBlockInSight(v3s16 blockpos_b, v3f camera_pos, v3f camera_dir,
                f32 camera_fov, f32 range, f32 *distance_ptr=NULL);
 
-/*
-       Some helper stuff
-*/
-#define MYMIN(a,b) ((a)<(b)?(a):(b))
-#define MYMAX(a,b) ((a)>(b)?(a):(b))
+s16 adjustDist(s16 dist, float zoom_fov);
 
 /*
        Returns nearest 32-bit integer for given floating point number.
@@ -291,16 +268,31 @@ inline s32 myround(f32 f)
        return (s32)(f < 0.f ? (f - 0.5f) : (f + 0.5f));
 }
 
+inline constexpr f32 sqr(f32 f)
+{
+       return f * f;
+}
+
 /*
        Returns integer position of node in given floating point position
 */
 inline v3s16 floatToInt(v3f p, f32 d)
 {
-       v3s16 p2(
-               (p.X + (p.X>0 ? d/2 : -d/2))/d,
-               (p.Y + (p.Y>0 ? d/2 : -d/2))/d,
-               (p.Z + (p.Z>0 ? d/2 : -d/2))/d);
-       return p2;
+       return v3s16(
+               (p.X + (p.X > 0 ? d / 2 : -d / 2)) / d,
+               (p.Y + (p.Y > 0 ? d / 2 : -d / 2)) / d,
+               (p.Z + (p.Z > 0 ? d / 2 : -d / 2)) / d);
+}
+
+/*
+       Returns integer position of node in given double precision position
+ */
+inline v3s16 doubleToInt(v3d p, double d)
+{
+       return v3s16(
+               (p.X + (p.X > 0 ? d / 2 : -d / 2)) / d,
+               (p.Y + (p.Y > 0 ? d / 2 : -d / 2)) / d,
+               (p.Z + (p.Z > 0 ? d / 2 : -d / 2)) / d);
 }
 
 /*
@@ -308,34 +300,32 @@ inline v3s16 floatToInt(v3f p, f32 d)
 */
 inline v3f intToFloat(v3s16 p, f32 d)
 {
-       v3f p2(
+       return v3f(
                (f32)p.X * d,
                (f32)p.Y * d,
                (f32)p.Z * d
        );
-       return p2;
 }
 
 // Random helper. Usually d=BS
-inline core::aabbox3d<f32> getNodeBox(v3s16 p, float d)
-{
-       return core::aabbox3d<f32>(
-               (float)p.X * d - 0.5*d,
-               (float)p.Y * d - 0.5*d,
-               (float)p.Z * d - 0.5*d,
-               (float)p.X * d + 0.5*d,
-               (float)p.Y * d + 0.5*d,
-               (float)p.Z * d + 0.5*d
+inline aabb3f getNodeBox(v3s16 p, float d)
+{
+       return aabb3f(
+               (float)p.X * d - 0.5f * d,
+               (float)p.Y * d - 0.5f * d,
+               (float)p.Z * d - 0.5f * d,
+               (float)p.X * d + 0.5f * d,
+               (float)p.Y * d + 0.5f * d,
+               (float)p.Z * d + 0.5f * d
        );
 }
 
+
 class IntervalLimiter
 {
 public:
-       IntervalLimiter():
-               m_accumulator(0)
-       {
-       }
+       IntervalLimiter() = default;
+
        /*
                dtime: time from last call to this method
                wanted_interval: interval wanted
@@ -346,15 +336,17 @@ class IntervalLimiter
        bool step(float dtime, float wanted_interval)
        {
                m_accumulator += dtime;
-               if(m_accumulator < wanted_interval)
+               if (m_accumulator < wanted_interval)
                        return false;
                m_accumulator -= wanted_interval;
                return true;
        }
-protected:
-       float m_accumulator;
+
+private:
+       float m_accumulator = 0.0f;
 };
 
+
 /*
        Splits a list into "pages". For example, the list [1,2,3,4,5] split
        into two pages would be [1,2,3],[4,5]. This function computes the
@@ -370,29 +362,21 @@ class IntervalLimiter
 */
 inline void paging(u32 length, u32 page, u32 pagecount, u32 &minindex, u32 &maxindex)
 {
-       if(length < 1 || pagecount < 1 || page < 1 || page > pagecount)
-       {
+       if (length < 1 || pagecount < 1 || page < 1 || page > pagecount) {
                // Special cases or invalid parameters
                minindex = maxindex = 0;
-       }
-       else if(pagecount <= length)
-       {
+       } else if(pagecount <= length) {
                // Less pages than entries in the list:
                // Each page contains at least one entry
                minindex = (length * (page-1) + (pagecount-1)) / pagecount;
                maxindex = (length * page + (pagecount-1)) / pagecount;
-       }
-       else
-       {
+       } else {
                // More pages than entries in the list:
                // Make sure the empty pages are at the end
-               if(page < length)
-               {
+               if (page < length) {
                        minindex = page-1;
                        maxindex = page;
-               }
-               else
-               {
+               } else {
                        minindex = 0;
                        maxindex = 0;
                }
@@ -401,14 +385,14 @@ inline void paging(u32 length, u32 page, u32 pagecount, u32 &minindex, u32 &maxi
 
 inline float cycle_shift(float value, float by = 0, float max = 1)
 {
-    if (value + by < 0) return max + by + value;
+    if (value + by < 0)   return value + by + max;
     if (value + by > max) return value + by - max;
     return value + by;
 }
 
 inline bool is_power_of_two(u32 n)
 {
-       return n != 0 && (n & (n-1)) == 0;
+       return n != 0 && (n & (n - 1)) == 0;
 }
 
 // Compute next-higher power of 2 efficiently, e.g. for power-of-2 texture sizes.
@@ -423,4 +407,65 @@ inline u32 npot2(u32 orig) {
        return orig + 1;
 }
 
-#endif
+// Gradual steps towards the target value in a wrapped (circular) system
+// using the shorter of both ways
+template<typename T>
+inline void wrappedApproachShortest(T &current, const T target, const T stepsize,
+       const T maximum)
+{
+       T delta = target - current;
+       if (delta < 0)
+               delta += maximum;
+
+       if (delta > stepsize && maximum - delta > stepsize) {
+               current += (delta < maximum / 2) ? stepsize : -stepsize;
+               if (current >= maximum)
+                       current -= maximum;
+       } else {
+               current = target;
+       }
+}
+
+void setPitchYawRollRad(core::matrix4 &m, const v3f &rot);
+
+inline void setPitchYawRoll(core::matrix4 &m, const v3f &rot)
+{
+       setPitchYawRollRad(m, rot * core::DEGTORAD64);
+}
+
+v3f getPitchYawRollRad(const core::matrix4 &m);
+
+inline v3f getPitchYawRoll(const core::matrix4 &m)
+{
+       return getPitchYawRollRad(m) * core::RADTODEG64;
+}
+
+// Muliply the RGB value of a color linearly, and clamp to black/white
+inline irr::video::SColor multiplyColorValue(const irr::video::SColor &color, float mod)
+{
+       return irr::video::SColor(color.getAlpha(),
+                       core::clamp<u32>(color.getRed() * mod, 0, 255),
+                       core::clamp<u32>(color.getGreen() * mod, 0, 255),
+                       core::clamp<u32>(color.getBlue() * mod, 0, 255));
+}
+
+template <typename T> inline T numericAbsolute(T v) { return v < 0 ? T(-v) : v;                }
+template <typename T> inline T numericSign(T v)     { return T(v < 0 ? -1 : (v == 0 ? 0 : 1)); }
+
+inline v3f vecAbsolute(v3f v)
+{
+       return v3f(
+               numericAbsolute(v.X),
+               numericAbsolute(v.Y),
+               numericAbsolute(v.Z)
+       );
+}
+
+inline v3f vecSign(v3f v)
+{
+       return v3f(
+               numericSign(v.X),
+               numericSign(v.Y),
+               numericSign(v.Z)
+       );
+}