libs/mathlib.h

   1 /*
   2 Copyright (C) 1999-2006 Id Software, Inc. and contributors.
   3 For a list of contributors, see the accompanying CONTRIBUTORS file.
   4
   5 This file is part of GtkRadiant.
   6
   7 GtkRadiant is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 GtkRadiant is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GtkRadiant; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20 */
  21
  22 #ifndef __MATHLIB__
  23 #define __MATHLIB__
  24
  25 // mathlib.h
  26 #include <math.h>
  27
  28 #ifdef __cplusplus
  29
  30 // start declarations of functions defined in C library.
  31 extern "C"
  32 {
  33
  34 #endif
  35
  36 #include "bytebool.h"
  37
  38 typedef float vec_t;
  39 typedef vec_t vec3_t[3];
  40 typedef vec_t vec5_t[5];
  41 typedef vec_t vec4_t[4];
  42
  43 #define SIDE_FRONT              0
  44 #define SIDE_ON                 2
  45 #define SIDE_BACK               1
  46 #define SIDE_CROSS              -2
  47
  48 // plane types are used to speed some tests
  49 // 0-2 are axial planes
  50 #define PLANE_X                 0
  51 #define PLANE_Y                 1
  52 #define PLANE_Z                 2
  53 #define PLANE_NON_AXIAL 3
  54
  55 #define Q_PI    3.14159265358979323846f
  56
  57 extern const vec3_t vec3_origin;
  58
  59 extern const vec3_t g_vec3_axis_x;
  60 extern const vec3_t g_vec3_axis_y;
  61 extern const vec3_t g_vec3_axis_z;
  62
  63 #define EQUAL_EPSILON   0.001
  64
  65 #define DotProduct(x,y) ((x)[0]*(y)[0]+(x)[1]*(y)[1]+(x)[2]*(y)[2])
  66 #define VectorSubtract(a,b,c) ((c)[0]=(a)[0]-(b)[0],(c)[1]=(a)[1]-(b)[1],(c)[2]=(a)[2]-(b)[2])
  67 #define VectorAdd(a,b,c) ((c)[0]=(a)[0]+(b)[0],(c)[1]=(a)[1]+(b)[1],(c)[2]=(a)[2]+(b)[2])
  68 #define VectorIncrement(a,b) ((b)[0]+=(a)[0],(b)[1]+=(a)[1],(b)[2]+=(a)[2])
  69 #define VectorCopy(a,b) ((b)[0]=(a)[0],(b)[1]=(a)[1],(b)[2]=(a)[2])
  70 #define VectorSet(v, a, b, c) ((v)[0]=(a),(v)[1]=(b),(v)[2]=(c))
  71 #define VectorScale(a,b,c) ((c)[0]=(b)*(a)[0],(c)[1]=(b)*(a)[1],(c)[2]=(b)*(a)[2])
  72 #define VectorMid(a,b,c) ((c)[0]=((a)[0]+(b)[0])*0.5f,(c)[1]=((a)[1]+(b)[1])*0.5f,(c)[2]=((a)[2]+(b)[2])*0.5f)
  73 #define VectorNegate(a,b) ((b)[0]=-(a)[0],(b)[1]=-(a)[1],(b)[2]=-(a)[2])
  74 #define CrossProduct(a,b,c) ((c)[0]=(a)[1]*(b)[2]-(a)[2]*(b)[1],(c)[1]=(a)[2]*(b)[0]-(a)[0]*(b)[2],(c)[2]=(a)[0]*(b)[1]-(a)[1]*(b)[0])
  75 #define VectorClear(x) ((x)[0]=(x)[1]=(x)[2]=0)
  76
  77 #define FLOAT_SNAP(f,snap) ( (float)( floor( (f) / (snap) + 0.5 ) * (snap) ) )
  78 #define FLOAT_TO_INTEGER(f) ( (float)( floor( (f) + 0.5 ) ) )
  79
  80 #define Q_rint(in) ((vec_t)floor(in+0.5))
  81
  82 qboolean VectorCompare (const vec3_t v1, const vec3_t v2);
  83
  84 vec_t VectorLength(const vec3_t v);
  85
  86 void VectorMA( const vec3_t va, vec_t scale, const vec3_t vb, vec3_t vc );
  87
  88 void _CrossProduct (vec3_t v1, vec3_t v2, vec3_t cross);
  89 vec_t VectorNormalize (const vec3_t in, vec3_t out);
  90 vec_t ColorNormalize( const vec3_t in, vec3_t out );
  91 void VectorInverse (vec3_t v);
  92 void VectorPolar(vec3_t v, float radius, float theta, float phi);
  93
  94 // default snapping, to 1
  95 void VectorSnap(vec3_t v);
  96
  97 // integer snapping
  98 void VectorISnap(vec3_t point, int snap);
  99
 100 // Gef:   added snap to float for sub-integer grid sizes
 101 // TTimo: we still use the int version of VectorSnap when possible
 102 //        to avoid potential rounding issues
 103 // TTimo: renaming to VectorFSnap for C implementation
 104 void VectorFSnap(vec3_t point, float snap);
 105
 106 // NOTE: added these from Ritual's Q3Radiant
 107 void ClearBounds (vec3_t mins, vec3_t maxs);
 108 void AddPointToBounds (vec3_t v, vec3_t mins, vec3_t maxs);
 109
 110
 111 #define PITCH                           0               // up / down
 112 #define YAW                                     1               // left / right
 113 #define ROLL                            2               // fall over
 114
 115 void AngleVectors (vec3_t angles, vec3_t forward, vec3_t right, vec3_t up);
 116 void VectorToAngles( vec3_t vec, vec3_t angles );
 117
 118 #define ZERO_EPSILON 1.0E-6
 119 #define RAD2DEGMULT 57.29577951308232f
 120 #define DEG2RADMULT 0.01745329251994329f
 121 #define RAD2DEG( a ) ( (a) * RAD2DEGMULT )
 122 #define DEG2RAD( a ) ( (a) * DEG2RADMULT )
 123
 124 void VectorRotate (vec3_t vIn, vec3_t vRotation, vec3_t out);
 125 void VectorRotateOrigin (vec3_t vIn, vec3_t vRotation, vec3_t vOrigin, vec3_t out);
 126
 127 // some function merged from tools mathlib code
 128
 129 qboolean PlaneFromPoints( vec4_t plane, const vec3_t a, const vec3_t b, const vec3_t c );
 130 void NormalToLatLong( const vec3_t normal, byte bytes[2] );
 131 int     PlaneTypeForNormal (vec3_t normal);
 132 void RotatePointAroundVector( vec3_t dst, const vec3_t dir, const vec3_t point, float degrees );
 133
 134
 135 /*!
 136 \todo
 137 FIXME test calls such as intersect tests should be named test_
 138 */
 139
 140 typedef vec_t m3x3_t[9];
 141 /*!NOTE
 142 m4x4 looks like this..
 143
 144                 x  y  z
 145 x axis        ( 0  1  2)
 146 y axis        ( 4  5  6)
 147 z axis        ( 8  9 10)
 148 translation   (12 13 14)
 149 scale         ( 0  5 10)
 150 */
 151 typedef vec_t m4x4_t[16];
 152
 153 #define M4X4_INDEX(m,row,col) (m[(col<<2)+row])
 154
 155 typedef enum { eXYZ, eYZX, eZXY, eXZY, eYXZ, eZYX } eulerOrder_t;
 156
 157 #define CLIP_PASS 0x00 // 000000
 158 #define CLIP_LT_X 0x01 // 000001
 159 #define CLIP_GT_X 0x02 // 000010
 160 #define CLIP_LT_Y 0x04 // 000100
 161 #define CLIP_GT_Y 0x08 // 001000
 162 #define CLIP_LT_Z 0x10 // 010000
 163 #define CLIP_GT_Z 0x20 // 100000
 164 #define CLIP_FAIL 0x3F // 111111
 165 typedef unsigned char clipmask_t;
 166
 167 extern const m4x4_t g_m4x4_identity;
 168
 169 #define M4X4_COPY(dst,src) (\
 170 (dst)[0]=(src)[0],\
 171 (dst)[1]=(src)[1],\
 172 (dst)[2]=(src)[2],\
 173 (dst)[3]=(src)[3],\
 174 (dst)[4]=(src)[4],\
 175 (dst)[5]=(src)[5],\
 176 (dst)[6]=(src)[6],\
 177 (dst)[7]=(src)[7],\
 178 (dst)[8]=(src)[8],\
 179 (dst)[9]=(src)[9],\
 180 (dst)[10]=(src)[10],\
 181 (dst)[11]=(src)[11],\
 182 (dst)[12]=(src)[12],\
 183 (dst)[13]=(src)[13],\
 184 (dst)[14]=(src)[14],\
 185 (dst)[15]=(src)[15])
 186
 187 typedef enum
 188 {
 189   eRightHanded = 0,
 190   eLeftHanded = 1,
 191 }
 192 m4x4Handedness_t;
 193
 194 m4x4Handedness_t m4x4_handedness(const m4x4_t matrix);
 195
 196 /*! assign other m4x4 to this m4x4 */
 197 void m4x4_assign(m4x4_t matrix, const m4x4_t other);
 198
 199 // constructors
 200 /*! create m4x4 as identity matrix */
 201 void m4x4_identity(m4x4_t matrix);
 202 /*! create m4x4 as a translation matrix, for a translation vec3 */
 203 void m4x4_translation_for_vec3(m4x4_t matrix, const vec3_t translation);
 204 /*! create m4x4 as a rotation matrix, for an euler angles (degrees) vec3 */
 205 void m4x4_rotation_for_vec3(m4x4_t matrix, const vec3_t euler, eulerOrder_t order);
 206 /*! create m4x4 as a scaling matrix, for a scale vec3 */
 207 void m4x4_scale_for_vec3(m4x4_t matrix, const vec3_t scale);
 208 /*! create m4x4 as a rotation matrix, for a quaternion vec4 */
 209 void m4x4_rotation_for_quat(m4x4_t matrix, const vec4_t rotation);
 210 /*! create m4x4 as a rotation matrix, for an axis vec3 and an angle (radians) */
 211 void m4x4_rotation_for_axisangle(m4x4_t matrix, const vec3_t axis, double angle);
 212 /*! generate a perspective matrix by specifying the view frustum */
 213 void m4x4_frustum(m4x4_t matrix, vec_t left, vec_t right, vec_t bottom, vec_t top, vec_t nearval, vec_t farval);
 214
 215 // a valid m4x4 to access is always first argument
 216 /*! extract translation vec3 from matrix */
 217 void m4x4_get_translation_vec3(const m4x4_t matrix, vec3_t translation);
 218 /*! extract euler rotation angles from a rotation-only matrix */
 219 void m4x4_get_rotation_vec3(const m4x4_t matrix, vec3_t euler, eulerOrder_t order);
 220 /*! extract scale vec3 from matrix */
 221 void m4x4_get_scale_vec3(const m4x4_t matrix, vec3_t scale);
 222 /*! extract translation/euler/scale from an orthogonal matrix. NOTE: requires right-handed axis-base */
 223 void m4x4_get_transform_vec3(const m4x4_t matrix, vec3_t translation, vec3_t euler, eulerOrder_t order, vec3_t scale);
 224
 225 // a valid m4x4 to be modified is always first argument
 226 /*! translate m4x4 by a translation vec3 */
 227 void m4x4_translate_by_vec3(m4x4_t matrix, const vec3_t translation);
 228 /*! rotate m4x4 by a euler (degrees) vec3 */
 229 void m4x4_rotate_by_vec3(m4x4_t matrix, const vec3_t euler, eulerOrder_t order);
 230 /*! scale m4x4 by a scaling vec3 */
 231 void m4x4_scale_by_vec3(m4x4_t matrix, const vec3_t scale);
 232 /*! rotate m4x4 by a quaternion vec4 */
 233 void m4x4_rotate_by_quat(m4x4_t matrix, const vec4_t rotation);
 234 /*! rotate m4x4 by an axis vec3 and an angle (radians) */
 235 void m4x4_rotate_by_axisangle(m4x4_t matrix, const vec3_t axis, double angle);
 236 /*! transform m4x4 by translation/eulerZYX/scaling vec3 (transform = scale * eulerZ * eulerY * eulerX * translation) */
 237 void m4x4_transform_by_vec3(m4x4_t matrix, const vec3_t translation, const vec3_t euler, eulerOrder_t order, const vec3_t scale);
 238 /*! rotate m4x4 around a pivot point by eulerZYX vec3 */
 239 void m4x4_pivoted_rotate_by_vec3(m4x4_t matrix, const vec3_t euler, eulerOrder_t order, const vec3_t pivotpoint);
 240 /*! scale m4x4 around a pivot point by scaling vec3 */
 241 void m4x4_pivoted_scale_by_vec3(m4x4_t matrix, const vec3_t scale, const vec3_t pivotpoint);
 242 /*! transform m4x4 around a pivot point by translation/eulerZYX/scaling vec3 */
 243 void m4x4_pivoted_transform_by_vec3(m4x4_t matrix, const vec3_t translation, const vec3_t euler, eulerOrder_t order, const vec3_t scale, const vec3_t pivotpoint);
 244 /*! transform m4x4 around a pivot point by translation/rotation/scaling vec3 */
 245 void m4x4_pivoted_transform_by_rotation(m4x4_t matrix, const vec3_t translation, const m4x4_t rotation, const vec3_t scale, const vec3_t pivotpoint);
 246 /*! rotate m4x4 around a pivot point by quaternion vec4 */
 247 void m4x4_pivoted_rotate_by_quat(m4x4_t matrix, const vec4_t quat, const vec3_t pivotpoint);
 248 /*! rotate m4x4 around a pivot point by axis vec3 and angle (radians) */
 249 void m4x4_pivoted_rotate_by_axisangle(m4x4_t matrix, const vec3_t axis, double angle, const vec3_t pivotpoint);
 250
 251 /*! postmultiply m4x4 by another m4x4 */
 252 void m4x4_multiply_by_m4x4(m4x4_t matrix, const m4x4_t matrix_src);
 253 /*! premultiply m4x4 by another m4x4 */
 254 void m4x4_premultiply_by_m4x4(m4x4_t matrix, const m4x4_t matrix_src);
 255 /*! postmultiply orthogonal m4x4 by another orthogonal m4x4 */
 256 void m4x4_orthogonal_multiply_by_m4x4(m4x4_t matrix, const m4x4_t matrix_src);
 257 /*! premultiply orthogonal m4x4 by another orthogonal m4x4 */
 258 void m4x4_orthogonal_premultiply_by_m4x4(m4x4_t matrix, const m4x4_t matrix_src);
 259
 260 /*! multiply a point (x,y,z,1) by matrix */
 261 void m4x4_transform_point(const m4x4_t matrix, vec3_t point);
 262 /*! multiply a normal (x,y,z,0) by matrix */
 263 void m4x4_transform_normal(const m4x4_t matrix, vec3_t normal);
 264 /*! multiply a vec4 (x,y,z,w) by matrix */
 265 void m4x4_transform_vec4(const m4x4_t matrix, vec4_t vector);
 266
 267 /*! multiply a point (x,y,z,1) by matrix */
 268 void m4x4_transform_point(const m4x4_t matrix, vec3_t point);
 269 /*! multiply a normal (x,y,z,0) by matrix */
 270 void m4x4_transform_normal(const m4x4_t matrix, vec3_t normal);
 271
 272 /*! transpose a m4x4 */
 273 void m4x4_transpose(m4x4_t matrix);
 274 /*! invert an orthogonal 4x3 subset of a 4x4 matrix */
 275 int m4x4_orthogonal_invert(m4x4_t matrix);
 276 /*! invert any m4x4 using Kramer's rule.. return 1 if matrix is singular, else return 0 */
 277 int m4x4_invert(m4x4_t matrix);
 278
 279 /*! clip a point (x,y,z,1) by canonical matrix */
 280 clipmask_t m4x4_clip_point(const m4x4_t matrix, const vec3_t point, vec4_t clipped);
 281 /*! device-space polygon for clipped triangle */
 282 unsigned int m4x4_clip_triangle(const m4x4_t matrix, const vec3_t p0, const vec3_t p1, const vec3_t p2, vec4_t clipped[9]);
 283 /*! device-space line for clipped line  */
 284 unsigned int m4x4_clip_line(const m4x4_t matrix, const vec3_t p0, const vec3_t p1, vec4_t clipped[2]);
 285
 286
 287 //! quaternion identity
 288 void quat_identity(vec4_t quat);
 289 //! quaternion from two unit vectors
 290 void quat_for_unit_vectors(vec4_t quat, const vec3_t from, const vec3_t to);
 291 //! quaternion from axis and angle (radians)
 292 void quat_for_axisangle(vec4_t quat, const vec3_t axis, double angle);
 293 //! concatenates two rotations.. equivalent to m4x4_multiply_by_m4x4 .. postmultiply.. the right-hand side is the first rotation performed
 294 void quat_multiply_by_quat(vec4_t quat, const vec4_t other);
 295 //! negate a quaternion
 296 void quat_conjugate(vec4_t quat);
 297 //! normalise a quaternion
 298 void quat_normalise(vec4_t quat);
 299
 300
 301
 302 /*!
 303 \todo object/ray intersection functions should maybe return a point rather than a distance?
 304 */
 305
 306 /*!
 307 aabb_t -  "axis-aligned" bounding box...
 308   origin: centre of bounding box...
 309   extents: +/- extents of box from origin...
 310 */
 311 typedef struct aabb_s
 312 {
 313   vec3_t origin;
 314   vec3_t extents;
 315 } aabb_t;
 316
 317 extern const aabb_t g_aabb_null;
 318
 319 /*!
 320 bbox_t - oriented bounding box...
 321   aabb: axis-aligned bounding box...
 322   axes: orientation axes...
 323 */
 324 typedef struct bbox_s
 325 {
 326   aabb_t aabb;
 327   vec3_t axes[3];
 328   vec_t radius;
 329 } bbox_t;
 330
 331 /*!
 332 ray_t - origin point and direction unit-vector
 333 */
 334 typedef struct ray_s
 335 {
 336   vec3_t origin;
 337   vec3_t direction;
 338 } ray_t;
 339
 340 /*!
 341 line_t - centre point and displacement of end point from centre
 342 */
 343 typedef struct line_s
 344 {
 345   vec3_t origin;
 346   vec3_t extents;
 347 } line_t;
 348
 349
 350 /*! Generate line from start/end points. */
 351 void line_construct_for_vec3(line_t* line, const vec3_t start, const vec3_t end);
 352 /*! Return 2 if line is behind plane, else return 1 if line intersects plane, else return 0. */
 353 int line_test_plane(const line_t* line, const vec4_t plane);
 354
 355 /*! Generate AABB from min/max. */
 356 void aabb_construct_for_vec3(aabb_t* aabb, const vec3_t min, const vec3_t max);
 357 /*! Initialise AABB to negative size. */
 358 void aabb_clear(aabb_t* aabb);
 359
 360 /*! Extend AABB to include point. */
 361 void aabb_extend_by_point(aabb_t* aabb, const vec3_t point);
 362 /*! Extend AABB to include aabb_src. */
 363 void aabb_extend_by_aabb(aabb_t* aabb, const aabb_t* aabb_src);
 364 /*! Extend AABB by +/- extension vector. */
 365 void aabb_extend_by_vec3(aabb_t* aabb, vec3_t extension);
 366
 367 /*! Return 2 if point is inside, else 1 if point is on surface, else 0. */
 368 int aabb_test_point(const aabb_t* aabb, const vec3_t point);
 369 /*! Return 2 if aabb_src intersects, else 1 if aabb_src touches exactly, else 0. */
 370 int aabb_test_aabb(const aabb_t* aabb, const aabb_t* aabb_src);
 371 /*! Return 2 if aabb is behind plane, else 1 if aabb intersects plane, else 0. */
 372 int aabb_test_plane(const aabb_t* aabb, const float* plane);
 373 /*! Return 1 if aabb intersects ray, else 0... dist = closest intersection. */
 374 int aabb_intersect_ray(const aabb_t* aabb, const ray_t* ray, vec3_t intersection);
 375 /*! Return 1 if aabb intersects ray, else 0. Faster, but does not provide point of intersection */
 376 int aabb_test_ray(const aabb_t* aabb, const ray_t* ray);
 377
 378 /*! Return 2 if oriented aabb is behind plane, else 1 if aabb intersects plane, else 0. */
 379 int aabb_oriented_intersect_plane(const aabb_t* aabb, const m4x4_t transform, const vec_t* plane);
 380
 381 /*! Calculate the corners of the aabb. */
 382 void aabb_corners(const aabb_t* aabb, vec3_t corners[8]);
 383
 384 /*! (deprecated) Generate AABB from oriented bounding box. */
 385 void aabb_for_bbox(aabb_t* aabb, const bbox_t* bbox);
 386 /*! (deprecated) Generate AABB from 2-dimensions of min/max, specified by axis. */
 387 void aabb_for_area(aabb_t* aabb, vec3_t area_tl, vec3_t area_br, int axis);
 388 /*! Generate AABB to contain src*  transform. NOTE: transform must be orthogonal */
 389 void aabb_for_transformed_aabb(aabb_t* dst, const aabb_t* src, const m4x4_t transform);
 390
 391 /*! Update bounding-sphere radius. */
 392 void bbox_update_radius(bbox_t* bbox);
 393 /*! Generate oriented bounding box from AABB and transformation matrix. */
 394 /*!\todo Remove need to specify eulerZYX/scale. */
 395 void bbox_for_oriented_aabb(bbox_t* bbox, const aabb_t* aabb,
 396                     const m4x4_t matrix, const vec3_t eulerZYX, const vec3_t scale);
 397 /*! Return 2 if bbox is behind plane, else return 1 if bbox intersects plane, else return 0. */
 398 int bbox_intersect_plane(const bbox_t* bbox, const vec_t* plane);
 399
 400
 401 /*! Generate a ray from an origin point and a direction unit-vector */
 402 void ray_construct_for_vec3(ray_t* ray, const vec3_t origin, const vec3_t direction);
 403
 404 /*! Transform a ray */
 405 void ray_transform(ray_t* ray, const m4x4_t matrix);
 406
 407 /*! distance from ray origin in ray direction to point. FLT_MAX if no intersection. */
 408 vec_t ray_intersect_point(const ray_t* ray, const vec3_t point, vec_t epsilon, vec_t divergence);
 409 /*! distance from ray origin in ray direction to triangle. FLT_MAX if no intersection. */
 410 vec_t ray_intersect_triangle(const ray_t* ray, qboolean bCullBack, const vec3_t vert0, const vec3_t vert1, const vec3_t vert2);
 411 /*! distance from ray origin in ray direction to plane. */
 412 vec_t ray_intersect_plane(const ray_t* ray, const vec3_t normal, vec_t dist);
 413
 414
 415 int plane_intersect_planes(const vec4_t plane1, const vec4_t plane2, const vec4_t plane3, vec3_t intersection);
 416
 417
 418 #ifdef __cplusplus
 419 }
 420 #endif
 421
 422 #endif /* __MATHLIB__ */