libs/mathlib/mathlib.c

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