simgear/math/SGIntersect.hxx

   1 // Copyright (C) 2006  Mathias Froehlich - Mathias.Froehlich@web.de
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Library General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Library General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with this program; if not, write to the Free Software
  15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  16 //
  17
  18 #ifndef SGIntersect_HXX
  19 #define SGIntersect_HXX
  20
  21 template<typename T>
  22 inline bool
  23 intersects(const SGBox<T>& box, const SGSphere<T>& sphere)
  24 {
  25   if (sphere.empty())
  26     return false;
  27   // Is more or less trivially included in the next tests
  28   // if (box.empty())
  29   //   return false;
  30
  31   if (sphere.getCenter().x() < box.getMin().x() - sphere.getRadius())
  32     return false;
  33   if (sphere.getCenter().y() < box.getMin().y() - sphere.getRadius())
  34     return false;
  35   if (sphere.getCenter().z() < box.getMin().z() - sphere.getRadius())
  36     return false;
  37
  38   if (box.getMax().x() + sphere.getRadius() < sphere.getCenter().x())
  39     return false;
  40   if (box.getMax().y() + sphere.getRadius() < sphere.getCenter().y())
  41     return false;
  42   if (box.getMax().z() + sphere.getRadius() < sphere.getCenter().z())
  43     return false;
  44
  45   return true;
  46 }
  47 // make it symmetric
  48 template<typename T>
  49 inline bool
  50 intersects(const SGSphere<T>& sphere, const SGBox<T>& box)
  51 { return intersects(box, sphere); }
  52
  53
  54 template<typename T>
  55 inline bool
  56 intersects(const SGVec3<T>& v, const SGBox<T>& box)
  57 {
  58   if (v[0] < box.getMin()[0])
  59     return false;
  60   if (box.getMax()[0] < v[0])
  61     return false;
  62   if (v[1] < box.getMin()[1])
  63     return false;
  64   if (box.getMax()[1] < v[1])
  65     return false;
  66   if (v[2] < box.getMin()[2])
  67     return false;
  68   if (box.getMax()[2] < v[2])
  69     return false;
  70   return true;
  71 }
  72 template<typename T>
  73 inline bool
  74 intersects(const SGBox<T>& box, const SGVec3<T>& v)
  75 { return intersects(v, box); }
  76
  77
  78 template<typename T>
  79 inline bool
  80 intersects(const SGRay<T>& ray, const SGPlane<T>& plane)
  81 {
  82   // We compute the intersection point
  83   //   x = origin + \alpha*direction
  84   // from the ray origin and non nomalized direction.
  85   // For 0 <= \alpha the ray intersects the infinite plane.
  86   // The intersection point x can also be written
  87   //   x = n*dist + y
  88   // where n is the planes normal, dist is the distance of the plane from
  89   // the origin in normal direction and y is ana aproriate vector
  90   // perpendicular to n.
  91   // Equate the x values and take the scalar product with the plane normal n.
  92   //   dot(n, origin) + \alpha*dot(n, direction) = dist
  93   // We can now compute alpha from the above equation.
  94   //   \alpha = (dist - dot(n, origin))/dot(n, direction)
  95
  96   // The negative numerator for the \alpha expression
  97   T num = plane.getPositiveDist();
  98   num -= dot(plane.getNormal(), ray.getOrigin());
  99
 100   // If the numerator is zero, we have the rays origin included in the plane
 101   if (fabs(num) <= SGLimits<T>::min())
 102     return true;
 103
 104   // The denominator for the \alpha expression
 105   T den = dot(plane.getNormal(), ray.getDirection());
 106
 107   // If we get here, we already know that the rays origin is not included
 108   // in the plane. Thus if we have a zero denominator we have
 109   // a ray paralell to the plane. That is no intersection.
 110   if (fabs(den) <= SGLimits<T>::min())
 111     return false;
 112
 113   // We would now compute \alpha = num/den and compare with 0 and 1.
 114   // But to avoid that expensive division, check equation multiplied by
 115   // the denominator.
 116   T alphaDen = copysign(1, den)*num;
 117   if (alphaDen < 0)
 118     return false;
 119
 120   return true;
 121 }
 122 // make it symmetric
 123 template<typename T>
 124 inline bool
 125 intersects(const SGPlane<T>& plane, const SGRay<T>& ray)
 126 { return intersects(ray, plane); }
 127
 128 template<typename T>
 129 inline bool
 130 intersects(SGVec3<T>& dst, const SGRay<T>& ray, const SGPlane<T>& plane)
 131 {
 132   // We compute the intersection point
 133   //   x = origin + \alpha*direction
 134   // from the ray origin and non nomalized direction.
 135   // For 0 <= \alpha the ray intersects the infinite plane.
 136   // The intersection point x can also be written
 137   //   x = n*dist + y
 138   // where n is the planes normal, dist is the distance of the plane from
 139   // the origin in normal direction and y is ana aproriate vector
 140   // perpendicular to n.
 141   // Equate the x values and take the scalar product with the plane normal n.
 142   //   dot(n, origin) + \alpha*dot(n, direction) = dist
 143   // We can now compute alpha from the above equation.
 144   //   \alpha = (dist - dot(n, origin))/dot(n, direction)
 145
 146   // The negative numerator for the \alpha expression
 147   T num = plane.getPositiveDist();
 148   num -= dot(plane.getNormal(), ray.getOrigin());
 149
 150   // If the numerator is zero, we have the rays origin included in the plane
 151   if (fabs(num) <= SGLimits<T>::min()) {
 152     dst = ray.getOrigin();
 153     return true;
 154   }
 155
 156   // The denominator for the \alpha expression
 157   T den = dot(plane.getNormal(), ray.getDirection());
 158
 159   // If we get here, we already know that the rays origin is not included
 160   // in the plane. Thus if we have a zero denominator we have
 161   // a ray paralell to the plane. That is no intersection.
 162   if (fabs(den) <= SGLimits<T>::min())
 163     return false;
 164
 165   // We would now compute \alpha = num/den and compare with 0 and 1.
 166   // But to avoid that expensive division, check equation multiplied by
 167   // the denominator.
 168   T alpha = num/den;
 169   if (alpha < 0)
 170     return false;
 171
 172   dst = ray.getOrigin() + alpha*ray.getDirection();
 173   return true;
 174 }
 175 // make it symmetric
 176 template<typename T>
 177 inline bool
 178 intersects(SGVec3<T>& dst, const SGPlane<T>& plane, const SGRay<T>& ray)
 179 { return intersects(dst, ray, plane); }
 180
 181 template<typename T>
 182 inline bool
 183 intersects(const SGLineSegment<T>& lineSegment, const SGPlane<T>& plane)
 184 {
 185   // We compute the intersection point
 186   //   x = origin + \alpha*direction
 187   // from the line segments origin and non nomalized direction.
 188   // For 0 <= \alpha <= 1 the line segment intersects the infinite plane.
 189   // The intersection point x can also be written
 190   //   x = n*dist + y
 191   // where n is the planes normal, dist is the distance of the plane from
 192   // the origin in normal direction and y is ana aproriate vector
 193   // perpendicular to n.
 194   // Equate the x values and take the scalar product with the plane normal n.
 195   //   dot(n, origin) + \alpha*dot(n, direction) = dist
 196   // We can now compute alpha from the above equation.
 197   //   \alpha = (dist - dot(n, origin))/dot(n, direction)
 198
 199   // The negative numerator for the \alpha expression
 200   T num = plane.getPositiveDist();
 201   num -= dot(plane.getNormal(), lineSegment.getOrigin());
 202
 203   // If the numerator is zero, we have the lines origin included in the plane
 204   if (fabs(num) <= SGLimits<T>::min())
 205     return true;
 206
 207   // The denominator for the \alpha expression
 208   T den = dot(plane.getNormal(), lineSegment.getDirection());
 209
 210   // If we get here, we already know that the lines origin is not included
 211   // in the plane. Thus if we have a zero denominator we have
 212   // a line paralell to the plane. That is no intersection.
 213   if (fabs(den) <= SGLimits<T>::min())
 214     return false;
 215
 216   // We would now compute \alpha = num/den and compare with 0 and 1.
 217   // But to avoid that expensive division, compare equations
 218   // multiplied by |den|. Note that copysign is usually a compiler intrinsic
 219   // that expands in assembler code that not even stalls the cpus pipes.
 220   T alphaDen = copysign(1, den)*num;
 221   if (alphaDen < 0)
 222     return false;
 223   if (den < alphaDen)
 224     return false;
 225
 226   return true;
 227 }
 228 // make it symmetric
 229 template<typename T>
 230 inline bool
 231 intersects(const SGPlane<T>& plane, const SGLineSegment<T>& lineSegment)
 232 { return intersects(lineSegment, plane); }
 233
 234 template<typename T>
 235 inline bool
 236 intersects(SGVec3<T>& dst, const SGLineSegment<T>& lineSegment, const SGPlane<T>& plane)
 237 {
 238   // We compute the intersection point
 239   //   x = origin + \alpha*direction
 240   // from the line segments origin and non nomalized direction.
 241   // For 0 <= \alpha <= 1 the line segment intersects the infinite plane.
 242   // The intersection point x can also be written
 243   //   x = n*dist + y
 244   // where n is the planes normal, dist is the distance of the plane from
 245   // the origin in normal direction and y is an aproriate vector
 246   // perpendicular to n.
 247   // Equate the x values and take the scalar product with the plane normal n.
 248   //   dot(n, origin) + \alpha*dot(n, direction) = dist
 249   // We can now compute alpha from the above equation.
 250   //   \alpha = (dist - dot(n, origin))/dot(n, direction)
 251
 252   // The negative numerator for the \alpha expression
 253   T num = plane.getPositiveDist();
 254   num -= dot(plane.getNormal(), lineSegment.getOrigin());
 255
 256   // If the numerator is zero, we have the lines origin included in the plane
 257   if (fabs(num) <= SGLimits<T>::min()) {
 258     dst = lineSegment.getOrigin();
 259     return true;
 260   }
 261
 262   // The denominator for the \alpha expression
 263   T den = dot(plane.getNormal(), lineSegment.getDirection());
 264
 265   // If we get here, we already know that the lines origin is not included
 266   // in the plane. Thus if we have a zero denominator we have
 267   // a line paralell to the plane. That is: no intersection.
 268   if (fabs(den) <= SGLimits<T>::min())
 269     return false;
 270
 271   // We would now compute \alpha = num/den and compare with 0 and 1.
 272   // But to avoid that expensive division, check equation multiplied by
 273   // the denominator. FIXME: shall we do so? or compute like that?
 274   T alpha = num/den;
 275   if (alpha < 0)
 276     return false;
 277   if (1 < alpha)
 278     return false;
 279
 280   dst = lineSegment.getOrigin() + alpha*lineSegment.getDirection();
 281   return true;
 282 }
 283 // make it symmetric
 284 template<typename T>
 285 inline bool
 286 intersects(SGVec3<T>& dst, const SGPlane<T>& plane, const SGLineSegment<T>& lineSegment)
 287 { return intersects(dst, lineSegment, plane); }
 288
 289
 290 // Distance of a line segment to a point
 291 template<typename T>
 292 inline T
 293 distSqr(const SGLineSegment<T>& lineSeg, const SGVec3<T>& p)
 294 {
 295   SGVec3<T> ps = p - lineSeg.getStart();
 296
 297   T psdotdir = dot(ps, lineSeg.getDirection());
 298   if (psdotdir <= 0)
 299     return dot(ps, ps);
 300
 301   SGVec3<T> pe = p - lineSeg.getEnd();
 302   if (0 <= dot(pe, lineSeg.getDirection()))
 303     return dot(pe, pe);
 304
 305   return dot(ps, ps) - psdotdir*psdotdir/dot(lineSeg.getDirection(), lineSeg.getDirection());
 306 }
 307 // make it symmetric
 308 template<typename T>
 309 inline T
 310 distSqr(const SGVec3<T>& p, const SGLineSegment<T>& lineSeg)
 311 { return distSqr(lineSeg, p); }
 312 // with sqrt
 313 template<typename T>
 314 inline T
 315 dist(const SGVec3<T>& p, const SGLineSegment<T>& lineSeg)
 316 { return sqrt(distSqr(lineSeg, p)); }
 317 template<typename T>
 318 inline T
 319 dist(const SGLineSegment<T>& lineSeg, const SGVec3<T>& p)
 320 { return sqrt(distSqr(lineSeg, p)); }
 321
 322 template<typename T>
 323 inline bool
 324 intersects(const SGRay<T>& ray, const SGSphere<T>& sphere)
 325 {
 326   // See Tomas Akeniene - Moeller/Eric Haines: Real Time Rendering,
 327   // second edition, page 571
 328   SGVec3<T> l = sphere.getCenter() - ray.getOrigin();
 329   T s = dot(l, ray.getDirection());
 330   T l2 = dot(l, l);
 331
 332   T r2 = sphere.getRadius2();
 333   if (s < 0 && l2 > r2)
 334     return false;
 335
 336   T d2 = dot(ray.getDirection(), ray.getDirection());
 337   // The original test would read
 338   //   T m2 = l2 - s*s/d2;
 339   //   if (m2 > r2)
 340   //     return false;
 341   // but to avoid the expensive division, we multiply by d2
 342   T m2 = d2*l2 - s*s;
 343   if (m2 > d2*r2)
 344     return false;
 345
 346   return true;
 347 }
 348 // make it symmetric
 349 template<typename T>
 350 inline bool
 351 intersects(const SGSphere<T>& sphere, const SGRay<T>& ray)
 352 { return intersects(ray, sphere); }
 353
 354 template<typename T>
 355 inline bool
 356 intersects(const SGLineSegment<T>& lineSegment, const SGSphere<T>& sphere)
 357 {
 358   // See Tomas Akeniene - Moeller/Eric Haines: Real Time Rendering,
 359   // second edition, page 571
 360   SGVec3<T> l = sphere.getCenter() - lineSegment.getStart();
 361   T ld = length(lineSegment.getDirection());
 362   T s = dot(l, lineSegment.getDirection())/ld;
 363   T l2 = dot(l, l);
 364
 365   T r2 = sphere.getRadius2();
 366   if (s < 0 && l2 > r2)
 367     return false;
 368
 369   T m2 = l2 - s*s;
 370   if (m2 > r2)
 371     return false;
 372
 373   T q = sqrt(r2 - m2);
 374   T t = s - q;
 375   if (ld < t)
 376     return false;
 377
 378   return true;
 379 }
 380 // make it symmetric
 381 template<typename T>
 382 inline bool
 383 intersects(const SGSphere<T>& sphere, const SGLineSegment<T>& lineSegment)
 384 { return intersects(lineSegment, sphere); }
 385
 386
 387 template<typename T>
 388 inline bool
 389 // FIXME do not use that default argument later. Just for development now
 390 intersects(SGVec3<T>& x, const SGTriangle<T>& tri, const SGRay<T>& ray, T eps = 0)
 391 {
 392   // See Tomas Akeniene - Moeller/Eric Haines: Real Time Rendering
 393
 394   // Method based on the observation that we are looking for a
 395   // point x that can be expressed in terms of the triangle points
 396   //  x = v_0 + u*(v_1 - v_0) + v*(v_2 - v_0)
 397   // with 0 <= u, v and u + v <= 1.
 398   // OTOH it could be expressed in terms of the ray
 399   //  x = o + t*d
 400   // Now we can compute u, v and t.
 401   SGVec3<T> p = cross(ray.getDirection(), tri.getEdge(1));
 402
 403   T denom = dot(p, tri.getEdge(0));
 404   T signDenom = copysign(1, denom);
 405
 406   SGVec3<T> s = ray.getOrigin() - tri.getBaseVertex();
 407   SGVec3<T> q = cross(s, tri.getEdge(0));
 408   // Now t would read
 409   //   t = 1/denom*dot(q, tri.getEdge(1));
 410   // To avoid an expensive division we multiply by |denom|
 411   T tDenom = signDenom*dot(q, tri.getEdge(1));
 412   if (tDenom < 0)
 413     return false;
 414   // For line segment we would test against
 415   // if (1 < t)
 416   //   return false;
 417   // with the original t. The multiplied test would read
 418   // if (absDenom < tDenom)
 419   //   return false;
 420
 421   T absDenom = fabs(denom);
 422   T absDenomEps = absDenom*eps;
 423
 424   // T u = 1/denom*dot(p, s);
 425   T u = signDenom*dot(p, s);
 426   if (u < -absDenomEps)
 427     return false;
 428   // T v = 1/denom*dot(q, d);
 429   // if (v < -eps)
 430   //   return false;
 431   T v = signDenom*dot(q, ray.getDirection());
 432   if (v < -absDenomEps)
 433     return false;
 434
 435   if (u + v > absDenom + absDenomEps)
 436     return false;
 437
 438   // return if paralell ??? FIXME what if paralell and in plane?
 439   // may be we are ok below than anyway??
 440   if (absDenom <= SGLimits<T>::min())
 441     return false;
 442
 443   x = ray.getOrigin();
 444   // if we have survived here it could only happen with denom == 0
 445   // that the point is already in plane. Then return the origin ...
 446   if (SGLimitsd::min() < absDenom)
 447     x += (tDenom/absDenom)*ray.getDirection();
 448
 449   return true;
 450 }
 451
 452 template<typename T>
 453 inline bool
 454 intersects(const SGTriangle<T>& tri, const SGRay<T>& ray, T eps = 0)
 455 {
 456   // FIXME: for now just wrap the other method. When that has prooven
 457   // well optimized, implement that special case
 458   SGVec3<T> dummy;
 459   return intersects(dummy, tri, ray, eps);
 460 }
 461
 462 template<typename T>
 463 inline bool
 464 // FIXME do not use that default argument later. Just for development now
 465 intersects(SGVec3<T>& x, const SGTriangle<T>& tri, const SGLineSegment<T>& lineSegment, T eps = 0)
 466 {
 467   // See Tomas Akeniene - Moeller/Eric Haines: Real Time Rendering
 468
 469   // Method based on the observation that we are looking for a
 470   // point x that can be expressed in terms of the triangle points
 471   //  x = v_0 + u*(v_1 - v_0) + v*(v_2 - v_0)
 472   // with 0 <= u, v and u + v <= 1.
 473   // OTOH it could be expressed in terms of the lineSegment
 474   //  x = o + t*d
 475   // Now we can compute u, v and t.
 476   SGVec3<T> p = cross(lineSegment.getDirection(), tri.getEdge(1));
 477
 478   T denom = dot(p, tri.getEdge(0));
 479   T signDenom = copysign(1, denom);
 480
 481   SGVec3<T> s = lineSegment.getStart() - tri.getBaseVertex();
 482   SGVec3<T> q = cross(s, tri.getEdge(0));
 483   // Now t would read
 484   //   t = 1/denom*dot(q, tri.getEdge(1));
 485   // To avoid an expensive division we multiply by |denom|
 486   T tDenom = signDenom*dot(q, tri.getEdge(1));
 487   if (tDenom < 0)
 488     return false;
 489   // For line segment we would test against
 490   // if (1 < t)
 491   //   return false;
 492   // with the original t. The multiplied test reads
 493   T absDenom = fabs(denom);
 494   if (absDenom < tDenom)
 495     return false;
 496
 497   // take the CPU accuracy in account
 498   T absDenomEps = absDenom*eps;
 499
 500   // T u = 1/denom*dot(p, s);
 501   T u = signDenom*dot(p, s);
 502   if (u < -absDenomEps)
 503     return false;
 504   // T v = 1/denom*dot(q, d);
 505   // if (v < -eps)
 506   //   return false;
 507   T v = signDenom*dot(q, lineSegment.getDirection());
 508   if (v < -absDenomEps)
 509     return false;
 510
 511   if (u + v > absDenom + absDenomEps)
 512     return false;
 513
 514   // return if paralell ??? FIXME what if paralell and in plane?
 515   // may be we are ok below than anyway??
 516   if (absDenom <= SGLimits<T>::min())
 517     return false;
 518
 519   x = lineSegment.getStart();
 520   // if we have survived here it could only happen with denom == 0
 521   // that the point is already in plane. Then return the origin ...
 522   if (SGLimitsd::min() < absDenom)
 523     x += (tDenom/absDenom)*lineSegment.getDirection();
 524
 525   return true;
 526 }
 527
 528 template<typename T>
 529 inline bool
 530 intersects(const SGTriangle<T>& tri, const SGLineSegment<T>& lineSegment, T eps = 0)
 531 {
 532   // FIXME: for now just wrap the othr method. When that has prooven
 533   // well optimized, implement that special case
 534   SGVec3<T> dummy;
 535   return intersects(dummy, tri, lineSegment, eps);
 536 }
 537
 538
 539 template<typename T>
 540 inline bool
 541 intersects(const SGVec3<T>& v, const SGSphere<T>& sphere)
 542 {
 543   if (sphere.empty())
 544     return false;
 545   return distSqr(v, sphere.getCenter()) <= sphere.getRadius2();
 546 }
 547 template<typename T>
 548 inline bool
 549 intersects(const SGSphere<T>& sphere, const SGVec3<T>& v)
 550 { return intersects(v, sphere); }
 551
 552
 553 template<typename T>
 554 inline bool
 555 intersects(const SGBox<T>& box, const SGLineSegment<T>& lineSegment)
 556 {
 557   // See Tomas Akeniene - Moeller/Eric Haines: Real Time Rendering
 558
 559   SGVec3<T> c = lineSegment.getCenter() - box.getCenter();
 560   SGVec3<T> w = 0.5*lineSegment.getDirection();
 561   SGVec3<T> v(fabs(w.x()), fabs(w.y()), fabs(w.z()));
 562   SGVec3<T> h = 0.5*box.getSize();
 563
 564   if (fabs(c[0]) > v[0] + h[0])
 565     return false;
 566   if (fabs(c[1]) > v[1] + h[1])
 567     return false;
 568   if (fabs(c[2]) > v[2] + h[2])
 569     return false;
 570
 571   if (fabs(c[1]*w[2] - c[2]*w[1]) > h[1]*v[2] + h[2]*v[1])
 572     return false;
 573   if (fabs(c[0]*w[2] - c[2]*w[0]) > h[0]*v[2] + h[2]*v[0])
 574     return false;
 575   if (fabs(c[0]*w[1] - c[1]*w[0]) > h[0]*v[1] + h[1]*v[0])
 576     return false;
 577
 578   return true;
 579 }
 580 template<typename T>
 581 inline bool
 582 intersects(const SGLineSegment<T>& lineSegment, const SGBox<T>& box)
 583 { return intersects(box, lineSegment); }
 584
 585 template<typename T>
 586 inline bool
 587 intersects(const SGBox<T>& box, const SGRay<T>& ray)
 588 {
 589   // See Tomas Akeniene - Moeller/Eric Haines: Real Time Rendering
 590
 591   for (unsigned i = 0; i < 3; ++i) {
 592     T cMin = box.getMin()[i];
 593     T cMax = box.getMax()[i];
 594
 595     T cOrigin = ray.getOrigin()[i];
 596
 597     T cDir = ray.getDirection()[i];
 598     if (fabs(cDir) <= SGLimits<T>::min()) {
 599       if (cOrigin < cMin)
 600         return false;
 601       if (cMax < cOrigin)
 602         return false;
 603     }
 604
 605     T nearr = - SGLimits<T>::max();
 606     T farr = SGLimits<T>::max();
 607
 608     T T1 = (cMin - cOrigin) / cDir;
 609     T T2 = (cMax - cOrigin) / cDir;
 610     if (T1 > T2) std::swap (T1, T2);/* since T1 intersection with near plane */
 611     if (T1 > nearr) nearr = T1; /* want largest Tnear */
 612     if (T2 < farr) farr = T2; /* want smallest Tfarr */
 613     if (nearr > farr) // farr box is missed
 614       return false;
 615     if (farr < 0) // box is behind ray
 616       return false;
 617   }
 618
 619   return true;
 620 }
 621 // make it symmetric
 622 template<typename T>
 623 inline bool
 624 intersects(const SGRay<T>& ray, const SGBox<T>& box)
 625 { return intersects(box, ray); }
 626
 627 #endif