libs/mathlib/mathlib.c

   1 /*
   2 Copyright (C) 1999-2007 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 // mathlib.c -- math primitives
  23 #include "mathlib.h"
  24 // we use memcpy and memset
  25 #include <memory.h>
  26
  27 vec3_t vec3_origin = {0.0f,0.0f,0.0f};
  28
  29 /*
  30 ================
  31 MakeNormalVectors
  32
  33 Given a normalized forward vector, create two
  34 other perpendicular vectors
  35 ================
  36 */
  37 void MakeNormalVectors (vec3_t forward, vec3_t right, vec3_t up)
  38 {
  39         float           d;
  40
  41         // this rotate and negate guarantees a vector
  42         // not colinear with the original
  43         right[1] = -forward[0];
  44         right[2] = forward[1];
  45         right[0] = forward[2];
  46
  47         d = DotProduct (right, forward);
  48         VectorMA (right, -d, forward, right);
  49         VectorNormalize (right, right);
  50         CrossProduct (right, forward, up);
  51 }
  52
  53 vec_t VectorLength(vec3_t v)
  54 {
  55         int             i;
  56         float   length;
  57
  58         length = 0.0f;
  59         for (i=0 ; i< 3 ; i++)
  60                 length += v[i]*v[i];
  61         length = (float)sqrt (length);
  62
  63         return length;
  64 }
  65
  66 qboolean VectorCompare (vec3_t v1, vec3_t v2)
  67 {
  68         int             i;
  69
  70         for (i=0 ; i<3 ; i++)
  71                 if (fabs(v1[i]-v2[i]) > EQUAL_EPSILON)
  72                         return qfalse;
  73
  74         return qtrue;
  75 }
  76
  77 /*
  78 // FIXME TTimo this implementation has to be particular to radiant
  79 //   through another name I'd say
  80 vec_t Q_rint (vec_t in)
  81 {
  82   if (g_PrefsDlg.m_bNoClamp)
  83     return in;
  84   else
  85     return (float)floor (in + 0.5);
  86 }
  87 */
  88
  89 void VectorMA( const vec3_t va, vec_t scale, const vec3_t vb, vec3_t vc )
  90 {
  91         vc[0] = va[0] + scale*vb[0];
  92         vc[1] = va[1] + scale*vb[1];
  93         vc[2] = va[2] + scale*vb[2];
  94 }
  95
  96 void _CrossProduct (vec3_t v1, vec3_t v2, vec3_t cross)
  97 {
  98         cross[0] = v1[1]*v2[2] - v1[2]*v2[1];
  99         cross[1] = v1[2]*v2[0] - v1[0]*v2[2];
 100         cross[2] = v1[0]*v2[1] - v1[1]*v2[0];
 101 }
 102
 103 vec_t _DotProduct (vec3_t v1, vec3_t v2)
 104 {
 105         return v1[0]*v2[0] + v1[1]*v2[1] + v1[2]*v2[2];
 106 }
 107
 108 void _VectorSubtract (vec3_t va, vec3_t vb, vec3_t out)
 109 {
 110         out[0] = va[0]-vb[0];
 111         out[1] = va[1]-vb[1];
 112         out[2] = va[2]-vb[2];
 113 }
 114
 115 void _VectorAdd (vec3_t va, vec3_t vb, vec3_t out)
 116 {
 117         out[0] = va[0]+vb[0];
 118         out[1] = va[1]+vb[1];
 119         out[2] = va[2]+vb[2];
 120 }
 121
 122 void _VectorCopy (vec3_t in, vec3_t out)
 123 {
 124         out[0] = in[0];
 125         out[1] = in[1];
 126         out[2] = in[2];
 127 }
 128
 129 vec_t VectorNormalize( const vec3_t in, vec3_t out ) {
 130         vec_t   length, ilength;
 131
 132         length = (vec_t)sqrt (in[0]*in[0] + in[1]*in[1] + in[2]*in[2]);
 133         if (length == 0)
 134         {
 135                 VectorClear (out);
 136                 return 0;
 137         }
 138
 139         ilength = 1.0f/length;
 140         out[0] = in[0]*ilength;
 141         out[1] = in[1]*ilength;
 142         out[2] = in[2]*ilength;
 143
 144         return length;
 145 }
 146
 147 vec_t ColorNormalize( const vec3_t in, vec3_t out ) {
 148         float   max, scale;
 149
 150         max = in[0];
 151         if (in[1] > max)
 152                 max = in[1];
 153         if (in[2] > max)
 154                 max = in[2];
 155
 156         if (max == 0) {
 157                 out[0] = out[1] = out[2] = 1.0;
 158                 return 0;
 159         }
 160
 161         scale = 1.0f / max;
 162
 163         VectorScale (in, scale, out);
 164
 165         return max;
 166 }
 167
 168 void VectorInverse (vec3_t v)
 169 {
 170         v[0] = -v[0];
 171         v[1] = -v[1];
 172         v[2] = -v[2];
 173 }
 174
 175 /*
 176 void VectorScale (vec3_t v, vec_t scale, vec3_t out)
 177 {
 178         out[0] = v[0] * scale;
 179         out[1] = v[1] * scale;
 180         out[2] = v[2] * scale;
 181 }
 182 */
 183
 184 void VectorRotate (vec3_t vIn, vec3_t vRotation, vec3_t out)
 185 {
 186   vec3_t vWork, va;
 187   int nIndex[3][2];
 188   int i;
 189
 190   VectorCopy(vIn, va);
 191   VectorCopy(va, vWork);
 192   nIndex[0][0] = 1; nIndex[0][1] = 2;
 193   nIndex[1][0] = 2; nIndex[1][1] = 0;
 194   nIndex[2][0] = 0; nIndex[2][1] = 1;
 195
 196   for (i = 0; i < 3; i++)
 197   {
 198     if (vRotation[i] != 0)
 199     {
 200       float dAngle = vRotation[i] * Q_PI / 180.0f;
 201             float c = (vec_t)cos(dAngle);
 202       float s = (vec_t)sin(dAngle);
 203       vWork[nIndex[i][0]] = va[nIndex[i][0]] * c - va[nIndex[i][1]] * s;
 204       vWork[nIndex[i][1]] = va[nIndex[i][0]] * s + va[nIndex[i][1]] * c;
 205     }
 206     VectorCopy(vWork, va);
 207   }
 208   VectorCopy(vWork, out);
 209 }
 210
 211 void VectorRotateOrigin (vec3_t vIn, vec3_t vRotation, vec3_t vOrigin, vec3_t out)
 212 {
 213   vec3_t vTemp, vTemp2;
 214
 215   VectorSubtract(vIn, vOrigin, vTemp);
 216   VectorRotate(vTemp, vRotation, vTemp2);
 217   VectorAdd(vTemp2, vOrigin, out);
 218 }
 219
 220 void VectorPolar(vec3_t v, float radius, float theta, float phi)
 221 {
 222         v[0]=(float)(radius * cos(theta) * cos(phi));
 223         v[1]=(float)(radius * sin(theta) * cos(phi));
 224         v[2]=(float)(radius * sin(phi));
 225 }
 226
 227 void VectorSnap(vec3_t v)
 228 {
 229   int i;
 230   for (i = 0; i < 3; i++)
 231   {
 232     v[i] = (vec_t)floor (v[i] + 0.5);
 233   }
 234 }
 235
 236 void VectorISnap(vec3_t point, int snap)
 237 {
 238   int i;
 239         for (i = 0 ;i < 3 ; i++)
 240         {
 241                 point[i] = (vec_t)floor (point[i] / snap + 0.5) * snap;
 242         }
 243 }
 244
 245 void VectorFSnap(vec3_t point, float snap)
 246 {
 247   int i;
 248         for (i = 0 ;i < 3 ; i++)
 249         {
 250                 point[i] = (vec_t)floor (point[i] / snap + 0.5) * snap;
 251         }
 252 }
 253
 254 void _Vector5Add (vec5_t va, vec5_t vb, vec5_t out)
 255 {
 256         out[0] = va[0]+vb[0];
 257         out[1] = va[1]+vb[1];
 258         out[2] = va[2]+vb[2];
 259         out[3] = va[3]+vb[3];
 260         out[4] = va[4]+vb[4];
 261 }
 262
 263 void _Vector5Scale (vec5_t v, vec_t scale, vec5_t out)
 264 {
 265         out[0] = v[0] * scale;
 266         out[1] = v[1] * scale;
 267         out[2] = v[2] * scale;
 268         out[3] = v[3] * scale;
 269         out[4] = v[4] * scale;
 270 }
 271
 272 void _Vector53Copy (vec5_t in, vec3_t out)
 273 {
 274         out[0] = in[0];
 275         out[1] = in[1];
 276         out[2] = in[2];
 277 }
 278
 279 // NOTE: added these from Ritual's Q3Radiant
 280 void ClearBounds (vec3_t mins, vec3_t maxs)
 281 {
 282         mins[0] = mins[1] = mins[2] = 99999;
 283         maxs[0] = maxs[1] = maxs[2] = -99999;
 284 }
 285
 286 void AddPointToBounds (vec3_t v, vec3_t mins, vec3_t maxs)
 287 {
 288         int             i;
 289         vec_t   val;
 290
 291         for (i=0 ; i<3 ; i++)
 292         {
 293                 val = v[i];
 294                 if (val < mins[i])
 295                         mins[i] = val;
 296                 if (val > maxs[i])
 297                         maxs[i] = val;
 298         }
 299 }
 300
 301 #define PITCH                           0               // up / down
 302 #define YAW                                     1               // left / right
 303 #define ROLL                            2               // fall over
 304 #ifndef M_PI
 305 #define M_PI            3.14159265358979323846f // matches value in gcc v2 math.h
 306 #endif
 307
 308 void AngleVectors (vec3_t angles, vec3_t forward, vec3_t right, vec3_t up)
 309 {
 310         float           angle;
 311         static float            sr, sp, sy, cr, cp, cy;
 312         // static to help MS compiler fp bugs
 313
 314         angle = angles[YAW] * (M_PI*2.0f / 360.0f);
 315         sy = (vec_t)sin(angle);
 316         cy = (vec_t)cos(angle);
 317         angle = angles[PITCH] * (M_PI*2.0f / 360.0f);
 318         sp = (vec_t)sin(angle);
 319         cp = (vec_t)cos(angle);
 320         angle = angles[ROLL] * (M_PI*2.0f / 360.0f);
 321         sr = (vec_t)sin(angle);
 322         cr = (vec_t)cos(angle);
 323
 324         if (forward)
 325         {
 326                 forward[0] = cp*cy;
 327                 forward[1] = cp*sy;
 328                 forward[2] = -sp;
 329         }
 330         if (right)
 331         {
 332                 right[0] = -sr*sp*cy+cr*sy;
 333                 right[1] = -sr*sp*sy-cr*cy;
 334                 right[2] = -sr*cp;
 335         }
 336         if (up)
 337         {
 338                 up[0] = cr*sp*cy+sr*sy;
 339                 up[1] = cr*sp*sy-sr*cy;
 340                 up[2] = cr*cp;
 341         }
 342 }
 343
 344 void VectorToAngles( vec3_t vec, vec3_t angles )
 345 {
 346         float forward;
 347         float yaw, pitch;
 348
 349         if ( ( vec[ 0 ] == 0 ) && ( vec[ 1 ] == 0 ) )
 350         {
 351                 yaw = 0;
 352                 if ( vec[ 2 ] > 0 )
 353                 {
 354                         pitch = 90;
 355                 }
 356                 else
 357                 {
 358                         pitch = 270;
 359                 }
 360         }
 361         else
 362         {
 363                 yaw = (vec_t)atan2( vec[ 1 ], vec[ 0 ] ) * 180 / M_PI;
 364                 if ( yaw < 0 )
 365                 {
 366                         yaw += 360;
 367                 }
 368
 369                 forward = ( float )sqrt( vec[ 0 ] * vec[ 0 ] + vec[ 1 ] * vec[ 1 ] );
 370                 pitch = (vec_t)atan2( vec[ 2 ], forward ) * 180 / M_PI;
 371                 if ( pitch < 0 )
 372                 {
 373                         pitch += 360;
 374                 }
 375         }
 376
 377         angles[ 0 ] = pitch;
 378         angles[ 1 ] = yaw;
 379         angles[ 2 ] = 0;
 380 }
 381
 382 /*
 383 =====================
 384 PlaneFromPoints
 385
 386 Returns false if the triangle is degenrate.
 387 The normal will point out of the clock for clockwise ordered points
 388 =====================
 389 */
 390 qboolean PlaneFromPoints( vec4_t plane, const vec3_t a, const vec3_t b, const vec3_t c ) {
 391         vec3_t  d1, d2;
 392
 393         VectorSubtract( b, a, d1 );
 394         VectorSubtract( c, a, d2 );
 395         CrossProduct( d2, d1, plane );
 396         if ( VectorNormalize( plane, plane ) == 0 ) {
 397                 return qfalse;
 398         }
 399
 400         plane[3] = DotProduct( a, plane );
 401         return qtrue;
 402 }
 403
 404 /*
 405 ** NormalToLatLong
 406 **
 407 ** We use two byte encoded normals in some space critical applications.
 408 ** Lat = 0 at (1,0,0) to 360 (-1,0,0), encoded in 8-bit sine table format
 409 ** Lng = 0 at (0,0,1) to 180 (0,0,-1), encoded in 8-bit sine table format
 410 **
 411 */
 412 void NormalToLatLong( const vec3_t normal, byte bytes[2] ) {
 413         // check for singularities
 414         if ( normal[0] == 0 && normal[1] == 0 ) {
 415                 if ( normal[2] > 0 ) {
 416                         bytes[0] = 0;
 417                         bytes[1] = 0;           // lat = 0, long = 0
 418                 } else {
 419                         bytes[0] = 128;
 420                         bytes[1] = 0;           // lat = 0, long = 128
 421                 }
 422         } else {
 423                 int     a, b;
 424
 425                 a = (int)( RAD2DEG( atan2( normal[1], normal[0] ) ) * (255.0f / 360.0f ) );
 426                 a &= 0xff;
 427
 428                 b = (int)( RAD2DEG( acos( normal[2] ) ) * ( 255.0f / 360.0f ) );
 429                 b &= 0xff;
 430
 431                 bytes[0] = b;   // longitude
 432                 bytes[1] = a;   // lattitude
 433         }
 434 }
 435
 436 /*
 437 =================
 438 PlaneTypeForNormal
 439 =================
 440 */
 441 int     PlaneTypeForNormal (vec3_t normal) {
 442         if (normal[0] == 1.0 || normal[0] == -1.0)
 443                 return PLANE_X;
 444         if (normal[1] == 1.0 || normal[1] == -1.0)
 445                 return PLANE_Y;
 446         if (normal[2] == 1.0 || normal[2] == -1.0)
 447                 return PLANE_Z;
 448
 449         return PLANE_NON_AXIAL;
 450 }
 451
 452 /*
 453 ================
 454 MatrixMultiply
 455 ================
 456 */
 457 void MatrixMultiply(float in1[3][3], float in2[3][3], float out[3][3]) {
 458         out[0][0] = in1[0][0] * in2[0][0] + in1[0][1] * in2[1][0] +
 459                                 in1[0][2] * in2[2][0];
 460         out[0][1] = in1[0][0] * in2[0][1] + in1[0][1] * in2[1][1] +
 461                                 in1[0][2] * in2[2][1];
 462         out[0][2] = in1[0][0] * in2[0][2] + in1[0][1] * in2[1][2] +
 463                                 in1[0][2] * in2[2][2];
 464         out[1][0] = in1[1][0] * in2[0][0] + in1[1][1] * in2[1][0] +
 465                                 in1[1][2] * in2[2][0];
 466         out[1][1] = in1[1][0] * in2[0][1] + in1[1][1] * in2[1][1] +
 467                                 in1[1][2] * in2[2][1];
 468         out[1][2] = in1[1][0] * in2[0][2] + in1[1][1] * in2[1][2] +
 469                                 in1[1][2] * in2[2][2];
 470         out[2][0] = in1[2][0] * in2[0][0] + in1[2][1] * in2[1][0] +
 471                                 in1[2][2] * in2[2][0];
 472         out[2][1] = in1[2][0] * in2[0][1] + in1[2][1] * in2[1][1] +
 473                                 in1[2][2] * in2[2][1];
 474         out[2][2] = in1[2][0] * in2[0][2] + in1[2][1] * in2[1][2] +
 475                                 in1[2][2] * in2[2][2];
 476 }
 477
 478 void ProjectPointOnPlane( vec3_t dst, const vec3_t p, const vec3_t normal )
 479 {
 480         float d;
 481         vec3_t n;
 482         float inv_denom;
 483
 484         inv_denom = 1.0F / DotProduct( normal, normal );
 485
 486         d = DotProduct( normal, p ) * inv_denom;
 487
 488         n[0] = normal[0] * inv_denom;
 489         n[1] = normal[1] * inv_denom;
 490         n[2] = normal[2] * inv_denom;
 491
 492         dst[0] = p[0] - d * n[0];
 493         dst[1] = p[1] - d * n[1];
 494         dst[2] = p[2] - d * n[2];
 495 }
 496
 497 /*
 498 ** assumes "src" is normalized
 499 */
 500 void PerpendicularVector( vec3_t dst, const vec3_t src )
 501 {
 502         int     pos;
 503         int i;
 504         vec_t minelem = 1.0F;
 505         vec3_t tempvec;
 506
 507         /*
 508         ** find the smallest magnitude axially aligned vector
 509         */
 510         for ( pos = 0, i = 0; i < 3; i++ )
 511         {
 512                 if ( fabs( src[i] ) < minelem )
 513                 {
 514                         pos = i;
 515                         minelem = (vec_t)fabs( src[i] );
 516                 }
 517         }
 518         tempvec[0] = tempvec[1] = tempvec[2] = 0.0F;
 519         tempvec[pos] = 1.0F;
 520
 521         /*
 522         ** project the point onto the plane defined by src
 523         */
 524         ProjectPointOnPlane( dst, tempvec, src );
 525
 526         /*
 527         ** normalize the result
 528         */
 529         VectorNormalize( dst, dst );
 530 }
 531
 532 /*
 533 ===============
 534 RotatePointAroundVector
 535
 536 This is not implemented very well...
 537 ===============
 538 */
 539 void RotatePointAroundVector( vec3_t dst, const vec3_t dir, const vec3_t point,
 540                                                          float degrees ) {
 541         float   m[3][3];
 542         float   im[3][3];
 543         float   zrot[3][3];
 544         float   tmpmat[3][3];
 545         float   rot[3][3];
 546         int     i;
 547         vec3_t vr, vup, vf;
 548         float   rad;
 549
 550         vf[0] = dir[0];
 551         vf[1] = dir[1];
 552         vf[2] = dir[2];
 553
 554         PerpendicularVector( vr, dir );
 555         CrossProduct( vr, vf, vup );
 556
 557         m[0][0] = vr[0];
 558         m[1][0] = vr[1];
 559         m[2][0] = vr[2];
 560
 561         m[0][1] = vup[0];
 562         m[1][1] = vup[1];
 563         m[2][1] = vup[2];
 564
 565         m[0][2] = vf[0];
 566         m[1][2] = vf[1];
 567         m[2][2] = vf[2];
 568
 569         memcpy( im, m, sizeof( im ) );
 570
 571         im[0][1] = m[1][0];
 572         im[0][2] = m[2][0];
 573         im[1][0] = m[0][1];
 574         im[1][2] = m[2][1];
 575         im[2][0] = m[0][2];
 576         im[2][1] = m[1][2];
 577
 578         memset( zrot, 0, sizeof( zrot ) );
 579         zrot[0][0] = zrot[1][1] = zrot[2][2] = 1.0F;
 580
 581         rad = DEG2RAD( degrees );
 582         zrot[0][0] = (vec_t)cos( rad );
 583         zrot[0][1] = (vec_t)sin( rad );
 584         zrot[1][0] = (vec_t)-sin( rad );
 585         zrot[1][1] = (vec_t)cos( rad );
 586
 587         MatrixMultiply( m, zrot, tmpmat );
 588         MatrixMultiply( tmpmat, im, rot );
 589
 590         for ( i = 0; i < 3; i++ ) {
 591                 dst[i] = rot[i][0] * point[0] + rot[i][1] * point[1] + rot[i][2] * point[2];
 592         }
 593 }