src/util/numeric.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef UTIL_NUMERIC_HEADER
  21 #define UTIL_NUMERIC_HEADER
  22
  23 #include "../irrlichttypes.h"
  24 #include "../irr_v2d.h"
  25 #include "../irr_v3d.h"
  26 #include "../irr_aabb3d.h"
  27 #include <list>
  28 #include <algorithm>
  29
  30 // Calculate the borders of a "d-radius" cube
  31 void getFacePositions(std::list<v3s16> &list, u16 d);
  32
  33 class IndentationRaiser
  34 {
  35 public:
  36         IndentationRaiser(u16 *indentation)
  37         {
  38                 m_indentation = indentation;
  39                 (*m_indentation)++;
  40         }
  41         ~IndentationRaiser()
  42         {
  43                 (*m_indentation)--;
  44         }
  45 private:
  46         u16 *m_indentation;
  47 };
  48
  49 inline s16 getContainerPos(s16 p, s16 d)
  50 {
  51         return (p>=0 ? p : p-d+1) / d;
  52 }
  53
  54 inline v2s16 getContainerPos(v2s16 p, s16 d)
  55 {
  56         return v2s16(
  57                 getContainerPos(p.X, d),
  58                 getContainerPos(p.Y, d)
  59         );
  60 }
  61
  62 inline v3s16 getContainerPos(v3s16 p, s16 d)
  63 {
  64         return v3s16(
  65                 getContainerPos(p.X, d),
  66                 getContainerPos(p.Y, d),
  67                 getContainerPos(p.Z, d)
  68         );
  69 }
  70
  71 inline v2s16 getContainerPos(v2s16 p, v2s16 d)
  72 {
  73         return v2s16(
  74                 getContainerPos(p.X, d.X),
  75                 getContainerPos(p.Y, d.Y)
  76         );
  77 }
  78
  79 inline v3s16 getContainerPos(v3s16 p, v3s16 d)
  80 {
  81         return v3s16(
  82                 getContainerPos(p.X, d.X),
  83                 getContainerPos(p.Y, d.Y),
  84                 getContainerPos(p.Z, d.Z)
  85         );
  86 }
  87
  88 inline bool isInArea(v3s16 p, s16 d)
  89 {
  90         return (
  91                 p.X >= 0 && p.X < d &&
  92                 p.Y >= 0 && p.Y < d &&
  93                 p.Z >= 0 && p.Z < d
  94         );
  95 }
  96
  97 inline bool isInArea(v2s16 p, s16 d)
  98 {
  99         return (
 100                 p.X >= 0 && p.X < d &&
 101                 p.Y >= 0 && p.Y < d
 102         );
 103 }
 104
 105 inline bool isInArea(v3s16 p, v3s16 d)
 106 {
 107         return (
 108                 p.X >= 0 && p.X < d.X &&
 109                 p.Y >= 0 && p.Y < d.Y &&
 110                 p.Z >= 0 && p.Z < d.Z
 111         );
 112 }
 113
 114 #define rangelim(d, min, max) ((d) < (min) ? (min) : ((d)>(max)?(max):(d)))
 115 #define myfloor(x) ((x) > 0.0 ? (int)(x) : (int)(x) - 1)
 116
 117 inline v3s16 arealim(v3s16 p, s16 d)
 118 {
 119         if(p.X < 0)
 120                 p.X = 0;
 121         if(p.Y < 0)
 122                 p.Y = 0;
 123         if(p.Z < 0)
 124                 p.Z = 0;
 125         if(p.X > d-1)
 126                 p.X = d-1;
 127         if(p.Y > d-1)
 128                 p.Y = d-1;
 129         if(p.Z > d-1)
 130                 p.Z = d-1;
 131         return p;
 132 }
 133
 134 #define ARRLEN(x) (sizeof(x) / sizeof((x)[0]))
 135 #define CONTAINS(c, v) (std::find((c).begin(), (c).end(), (v)) != (c).end())
 136
 137 // The naive swap performs better than the xor version
 138 #define SWAP(t, x, y) do { \
 139         t temp = x;            \
 140         x = y;                 \
 141         y = temp;              \
 142 } while (0)
 143
 144 inline void sortBoxVerticies(v3s16 &p1, v3s16 &p2) {
 145         if (p1.X > p2.X)
 146                 SWAP(s16, p1.X, p2.X);
 147         if (p1.Y > p2.Y)
 148                 SWAP(s16, p1.Y, p2.Y);
 149         if (p1.Z > p2.Z)
 150                 SWAP(s16, p1.Z, p2.Z);
 151 }
 152
 153
 154 /*
 155         See test.cpp for example cases.
 156         wraps degrees to the range of -360...360
 157         NOTE: Wrapping to 0...360 is not used because pitch needs negative values.
 158 */
 159 inline float wrapDegrees(float f)
 160 {
 161         // Take examples of f=10, f=720.5, f=-0.5, f=-360.5
 162         // This results in
 163         // 10, 720, -1, -361
 164         int i = floor(f);
 165         // 0, 2, 0, -1
 166         int l = i / 360;
 167         // NOTE: This would be used for wrapping to 0...360
 168         // 0, 2, -1, -2
 169         /*if(i < 0)
 170                 l -= 1;*/
 171         // 0, 720, 0, -360
 172         int k = l * 360;
 173         // 10, 0.5, -0.5, -0.5
 174         f -= float(k);
 175         return f;
 176 }
 177
 178 /* Wrap to 0...360 */
 179 inline float wrapDegrees_0_360(float f)
 180 {
 181         // Take examples of f=10, f=720.5, f=-0.5, f=-360.5
 182         // This results in
 183         // 10, 720, -1, -361
 184         int i = floor(f);
 185         // 0, 2, 0, -1
 186         int l = i / 360;
 187         // Wrap to 0...360
 188         // 0, 2, -1, -2
 189         if(i < 0)
 190                 l -= 1;
 191         // 0, 720, 0, -360
 192         int k = l * 360;
 193         // 10, 0.5, -0.5, -0.5
 194         f -= float(k);
 195         return f;
 196 }
 197
 198 /* Wrap to -180...180 */
 199 inline float wrapDegrees_180(float f)
 200 {
 201         f += 180;
 202         f = wrapDegrees_0_360(f);
 203         f -= 180;
 204         return f;
 205 }
 206
 207 /*
 208         Pseudo-random (VC++ rand() sucks)
 209 */
 210 int myrand(void);
 211 void mysrand(unsigned seed);
 212 #define MYRAND_MAX 32767
 213
 214 int myrand_range(int min, int max);
 215
 216 /*
 217         Miscellaneous functions
 218 */
 219
 220 u64 murmur_hash_64_ua(const void *key, int len, unsigned int seed);
 221
 222 bool isBlockInSight(v3s16 blockpos_b, v3f camera_pos, v3f camera_dir,
 223                 f32 camera_fov, f32 range, f32 *distance_ptr=NULL);
 224
 225 /*
 226         Some helper stuff
 227 */
 228 #define MYMIN(a,b) ((a)<(b)?(a):(b))
 229 #define MYMAX(a,b) ((a)>(b)?(a):(b))
 230
 231 /*
 232         Returns nearest 32-bit integer for given floating point number.
 233         <cmath> and <math.h> in VC++ don't provide round().
 234 */
 235 inline s32 myround(f32 f)
 236 {
 237         return floor(f + 0.5);
 238 }
 239
 240 /*
 241         Returns integer position of node in given floating point position
 242 */
 243 inline v3s16 floatToInt(v3f p, f32 d)
 244 {
 245         v3s16 p2(
 246                 (p.X + (p.X>0 ? d/2 : -d/2))/d,
 247                 (p.Y + (p.Y>0 ? d/2 : -d/2))/d,
 248                 (p.Z + (p.Z>0 ? d/2 : -d/2))/d);
 249         return p2;
 250 }
 251
 252 /*
 253         Returns floating point position of node in given integer position
 254 */
 255 inline v3f intToFloat(v3s16 p, f32 d)
 256 {
 257         v3f p2(
 258                 (f32)p.X * d,
 259                 (f32)p.Y * d,
 260                 (f32)p.Z * d
 261         );
 262         return p2;
 263 }
 264
 265 // Random helper. Usually d=BS
 266 inline core::aabbox3d<f32> getNodeBox(v3s16 p, float d)
 267 {
 268         return core::aabbox3d<f32>(
 269                 (float)p.X * d - 0.5*d,
 270                 (float)p.Y * d - 0.5*d,
 271                 (float)p.Z * d - 0.5*d,
 272                 (float)p.X * d + 0.5*d,
 273                 (float)p.Y * d + 0.5*d,
 274                 (float)p.Z * d + 0.5*d
 275         );
 276 }
 277
 278 class IntervalLimiter
 279 {
 280 public:
 281         IntervalLimiter():
 282                 m_accumulator(0)
 283         {
 284         }
 285         /*
 286                 dtime: time from last call to this method
 287                 wanted_interval: interval wanted
 288                 return value:
 289                         true: action should be skipped
 290                         false: action should be done
 291         */
 292         bool step(float dtime, float wanted_interval)
 293         {
 294                 m_accumulator += dtime;
 295                 if(m_accumulator < wanted_interval)
 296                         return false;
 297                 m_accumulator -= wanted_interval;
 298                 return true;
 299         }
 300 protected:
 301         float m_accumulator;
 302 };
 303
 304 /*
 305         Splits a list into "pages". For example, the list [1,2,3,4,5] split
 306         into two pages would be [1,2,3],[4,5]. This function computes the
 307         minimum and maximum indices of a single page.
 308
 309         length: Length of the list that should be split
 310         page: Page number, 1 <= page <= pagecount
 311         pagecount: The number of pages, >= 1
 312         minindex: Receives the minimum index (inclusive).
 313         maxindex: Receives the maximum index (exclusive).
 314
 315         Ensures 0 <= minindex <= maxindex <= length.
 316 */
 317 inline void paging(u32 length, u32 page, u32 pagecount, u32 &minindex, u32 &maxindex)
 318 {
 319         if(length < 1 || pagecount < 1 || page < 1 || page > pagecount)
 320         {
 321                 // Special cases or invalid parameters
 322                 minindex = maxindex = 0;
 323         }
 324         else if(pagecount <= length)
 325         {
 326                 // Less pages than entries in the list:
 327                 // Each page contains at least one entry
 328                 minindex = (length * (page-1) + (pagecount-1)) / pagecount;
 329                 maxindex = (length * page + (pagecount-1)) / pagecount;
 330         }
 331         else
 332         {
 333                 // More pages than entries in the list:
 334                 // Make sure the empty pages are at the end
 335                 if(page < length)
 336                 {
 337                         minindex = page-1;
 338                         maxindex = page;
 339                 }
 340                 else
 341                 {
 342                         minindex = 0;
 343                         maxindex = 0;
 344                 }
 345         }
 346 }
 347
 348 inline float cycle_shift(float value, float by = 0, float max = 1)
 349 {
 350     if (value + by < 0) return max + by + value;
 351     if (value + by > max) return value + by - max;
 352     return value + by;
 353 }
 354
 355 inline bool is_power_of_two(u32 n)
 356 {
 357         return n != 0 && (n & (n-1)) == 0;
 358 }
 359
 360 #endif
 361