3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
20 #ifndef UTIL_NUMERIC_HEADER
21 #define UTIL_NUMERIC_HEADER
23 #include "../irrlichttypes.h"
24 #include "../irr_v2d.h"
25 #include "../irr_v3d.h"
26 #include "../irr_aabb3d.h"
34 * This class permits to cache getFacePosition call results
35 * This reduces CPU usage and vector calls
37 class FacePositionCache
40 static std::vector<v3s16> getFacePositions(u16 d);
42 static void generateFacePosition(u16 d);
43 static std::map<u16, std::vector<v3s16> > m_cache;
46 class IndentationRaiser
49 IndentationRaiser(u16 *indentation)
51 m_indentation = indentation;
62 inline s16 getContainerPos(s16 p, s16 d)
64 return (p>=0 ? p : p-d+1) / d;
67 inline v2s16 getContainerPos(v2s16 p, s16 d)
70 getContainerPos(p.X, d),
71 getContainerPos(p.Y, d)
75 inline v3s16 getContainerPos(v3s16 p, s16 d)
78 getContainerPos(p.X, d),
79 getContainerPos(p.Y, d),
80 getContainerPos(p.Z, d)
84 inline v2s16 getContainerPos(v2s16 p, v2s16 d)
87 getContainerPos(p.X, d.X),
88 getContainerPos(p.Y, d.Y)
92 inline v3s16 getContainerPos(v3s16 p, v3s16 d)
95 getContainerPos(p.X, d.X),
96 getContainerPos(p.Y, d.Y),
97 getContainerPos(p.Z, d.Z)
101 inline void getContainerPosWithOffset(s16 p, s16 d, s16 &container, s16 &offset)
103 container = (p >= 0 ? p : p - d + 1) / d;
104 offset = p & (d - 1);
107 inline void getContainerPosWithOffset(const v2s16 &p, s16 d, v2s16 &container, v2s16 &offset)
109 getContainerPosWithOffset(p.X, d, container.X, offset.X);
110 getContainerPosWithOffset(p.Y, d, container.Y, offset.Y);
113 inline void getContainerPosWithOffset(const v3s16 &p, s16 d, v3s16 &container, v3s16 &offset)
115 getContainerPosWithOffset(p.X, d, container.X, offset.X);
116 getContainerPosWithOffset(p.Y, d, container.Y, offset.Y);
117 getContainerPosWithOffset(p.Z, d, container.Z, offset.Z);
121 inline bool isInArea(v3s16 p, s16 d)
124 p.X >= 0 && p.X < d &&
125 p.Y >= 0 && p.Y < d &&
130 inline bool isInArea(v2s16 p, s16 d)
133 p.X >= 0 && p.X < d &&
138 inline bool isInArea(v3s16 p, v3s16 d)
141 p.X >= 0 && p.X < d.X &&
142 p.Y >= 0 && p.Y < d.Y &&
143 p.Z >= 0 && p.Z < d.Z
147 #define rangelim(d, min, max) ((d) < (min) ? (min) : ((d)>(max)?(max):(d)))
148 #define myfloor(x) ((x) > 0.0 ? (int)(x) : (int)(x) - 1)
150 inline v3s16 arealim(v3s16 p, s16 d)
167 #define ARRLEN(x) (sizeof(x) / sizeof((x)[0]))
168 #define CONTAINS(c, v) (std::find((c).begin(), (c).end(), (v)) != (c).end())
170 // The naive swap performs better than the xor version
171 #define SWAP(t, x, y) do { \
177 inline void sortBoxVerticies(v3s16 &p1, v3s16 &p2) {
179 SWAP(s16, p1.X, p2.X);
181 SWAP(s16, p1.Y, p2.Y);
183 SWAP(s16, p1.Z, p2.Z);
187 /** Returns \p f wrapped to the range [-360, 360]
189 * See test.cpp for example cases.
191 * \note This is also used in cases where degrees wrapped to the range [0, 360]
192 * is innapropriate (e.g. pitch needs negative values)
194 * \internal functionally equivalent -- although precision may vary slightly --
195 * to fmodf((f), 360.0f) however empirical tests indicate that this approach is
198 inline float modulo360f(float f)
213 fraction = f - whole;
216 return sign * (whole + fraction);
220 /** Returns \p f wrapped to the range [0, 360]
222 inline float wrapDegrees_0_360(float f)
224 float value = modulo360f(f);
225 return value < 0 ? value + 360 : value;
229 /** Returns \p f wrapped to the range [-180, 180]
231 inline float wrapDegrees_180(float f)
233 float value = modulo360f(f + 180);
240 Pseudo-random (VC++ rand() sucks)
243 void mysrand(unsigned seed);
244 #define MYRAND_MAX 32767
246 int myrand_range(int min, int max);
249 Miscellaneous functions
252 u64 murmur_hash_64_ua(const void *key, int len, unsigned int seed);
254 bool isBlockInSight(v3s16 blockpos_b, v3f camera_pos, v3f camera_dir,
255 f32 camera_fov, f32 range, f32 *distance_ptr=NULL);
260 #define MYMIN(a,b) ((a)<(b)?(a):(b))
261 #define MYMAX(a,b) ((a)>(b)?(a):(b))
264 Returns nearest 32-bit integer for given floating point number.
265 <cmath> and <math.h> in VC++ don't provide round().
267 inline s32 myround(f32 f)
269 return floor(f + 0.5);
273 Returns integer position of node in given floating point position
275 inline v3s16 floatToInt(v3f p, f32 d)
278 (p.X + (p.X>0 ? d/2 : -d/2))/d,
279 (p.Y + (p.Y>0 ? d/2 : -d/2))/d,
280 (p.Z + (p.Z>0 ? d/2 : -d/2))/d);
285 Returns floating point position of node in given integer position
287 inline v3f intToFloat(v3s16 p, f32 d)
297 // Random helper. Usually d=BS
298 inline core::aabbox3d<f32> getNodeBox(v3s16 p, float d)
300 return core::aabbox3d<f32>(
301 (float)p.X * d - 0.5*d,
302 (float)p.Y * d - 0.5*d,
303 (float)p.Z * d - 0.5*d,
304 (float)p.X * d + 0.5*d,
305 (float)p.Y * d + 0.5*d,
306 (float)p.Z * d + 0.5*d
310 class IntervalLimiter
318 dtime: time from last call to this method
319 wanted_interval: interval wanted
321 true: action should be skipped
322 false: action should be done
324 bool step(float dtime, float wanted_interval)
326 m_accumulator += dtime;
327 if(m_accumulator < wanted_interval)
329 m_accumulator -= wanted_interval;
337 Splits a list into "pages". For example, the list [1,2,3,4,5] split
338 into two pages would be [1,2,3],[4,5]. This function computes the
339 minimum and maximum indices of a single page.
341 length: Length of the list that should be split
342 page: Page number, 1 <= page <= pagecount
343 pagecount: The number of pages, >= 1
344 minindex: Receives the minimum index (inclusive).
345 maxindex: Receives the maximum index (exclusive).
347 Ensures 0 <= minindex <= maxindex <= length.
349 inline void paging(u32 length, u32 page, u32 pagecount, u32 &minindex, u32 &maxindex)
351 if(length < 1 || pagecount < 1 || page < 1 || page > pagecount)
353 // Special cases or invalid parameters
354 minindex = maxindex = 0;
356 else if(pagecount <= length)
358 // Less pages than entries in the list:
359 // Each page contains at least one entry
360 minindex = (length * (page-1) + (pagecount-1)) / pagecount;
361 maxindex = (length * page + (pagecount-1)) / pagecount;
365 // More pages than entries in the list:
366 // Make sure the empty pages are at the end
380 inline float cycle_shift(float value, float by = 0, float max = 1)
382 if (value + by < 0) return max + by + value;
383 if (value + by > max) return value + by - max;
387 inline bool is_power_of_two(u32 n)
389 return n != 0 && (n & (n-1)) == 0;