Changeset 863 for GTP/trunk/Lib/Vis/Preprocessing/src/AxisAlignedBox3.h

Timestamp:

04/29/06 19:11:23 (18 years ago)

Author:

mattausch

Message:

working on preprocessor integration
added iv stuff

File:

• GTP/trunk/Lib/Vis/Preprocessing/src/AxisAlignedBox3.h (modified) (9 diffs)

GTP/trunk/Lib/Vis/Preprocessing/src/AxisAlignedBox3.h

@@ -8 +8 @@
 #include "Containers.h"
 
+namespace GtpVisibilityPreprocessor {
+
 class Ray;
 class Polygon3;
 class Mesh;
 
-// --------------------------------------------------------
-// CAABox class.
-//  This is a box in 3-space, defined by min and max
-//  corner vectors.  Many useful operations are defined
-//  on this
-// --------------------------------------------------------
+/**
+        CAABox class.
+        This is a box in 3-space, defined by min and max
+        corner vectors.  Many useful operations are defined
+        on this
+*/
 class AxisAlignedBox3
 {
 protected:
-  Vector3 mMin, mMax;
+        Vector3 mMin, mMax;
 public:
   // Constructors.
@@ -34 +36 @@
   //                                                  max(center + Vector3(radius)) {}
 
-  // initialization to the non existing bounding box
+  /** initialization to the non existing bounding box
+  */
   void Initialize() {
     mMin = Vector3(MAXFLOAT);
@@ -40 +43 @@
   }
 
-  // The center of the box
+  /** The center of the box
+  */
   Vector3 Center() const { return 0.5 * (mMin + mMax); }
   
-  // The diagonal of the box
+  /** The diagonal of the box
+  */
   Vector3 Diagonal() const { return (mMax -mMin); }
 
@@ -110 +115 @@
   void Include (const PolygonContainer &polys);
   void Include(Mesh *mesh);
-  // Expand the axis-aligned box to include given values in particular axis
+
+  /** Expand the axis-aligned box to include given values in particular axis.
+  */
   void Include(const int &axis, const float &newBound);
 
@@ -123 +130 @@
   friend inline bool OverlapS(const AxisAlignedBox3 &,const AxisAlignedBox3 &);
 
-  // Overlap returns 1 if the two axis-aligned boxes overlap for a given
-  // epsilon. If eps > 0.0, then the boxes has to have the real intersection
-  // box, if eps < 0.0, then the boxes need not intersect really, they
-  // can be at eps distance in the projection
+  /** Overlap returns 1 if the two axis-aligned boxes overlap for a given
+          epsilon. If eps > 0.0, then the boxes has to have the real intersection
+          box, if eps < 0.0, then the boxes need not intersect really, they
+          can be at eps distance in the projection.
+          */
   friend inline bool Overlap(const AxisAlignedBox3 &,
-                             const AxisAlignedBox3 &,
-                             float eps);
-
-  // Includes returns true if a includes b (completely
+                                                         const AxisAlignedBox3 &,
+                                                         float eps);
+
+  /** Returns 'factor' of overlap of first box with the second box. i.e., a number
+        between 0 (no overlap) and 1 (same box).
+  */
+  friend inline float FactorOfOverlap(const AxisAlignedBox3 &, const AxisAlignedBox3 &);
+
+  /** Includes returns true if a includes b (completely)
+  */
   bool Includes(const AxisAlignedBox3 &b) const;
 
   virtual int IsInside(const Vector3 &v) const;
   
-  // Test if the box is really sensefull
+  /** Test if the box makes sense.
+  */
   virtual bool IsCorrect();
 
-  // To answer true requires the box of real volume of non-zero value
+  /** To answer true requires the box of real volume of non-zero value.
+  */
   bool IsSingularOrIncorrect() const;
 
-  // When the box is not of non-zero or negative surface area
+  /** When the box is not of non-zero or negative surface area.
+  */
   bool IsCorrectAndNotPoint() const;
 
-  // Returns true when the box degenerates to a point
+  /** Returns true when the box degenerates to a point.
+  */
   bool IsPoint() const;
 
+  /** Scales the box with the factor.
+  */
   void Scale(const float scale) {
         Vector3 newSize = Size()*(scale*0.5f);
@@ -155 +175 @@
   }
   
+  /** Returns the square of the minimal and maximal distance to 
+        a point on the box.
+        */
   void
   GetSqrDistances(const Vector3 &point,
@@ -348 +371 @@
           @returns true if ray hits the bounding box.
   */
-  bool GetRaySegment(const Ray &ray, 
-                                float &minT, 
-                                float &maxT) const;
+  bool GetRaySegment(const Ray &ray, float &minT, float &maxT) const;
 
   /** If the boxes are intersecting on a common face, this function 
@@ -519 +540 @@
 }
 
+inline float FactorOfOverlap(const AxisAlignedBox3 &box1, const AxisAlignedBox3 &box2)
+{
+        const AxisAlignedBox3 isect = Intersect(box1, box2);
+        return isect.GetVolume() / box1.GetVolume();
+}
 
 inline int operator==(const AxisAlignedBox3 &A, const AxisAlignedBox3 &B)
@@ -526 +552 @@
 
   
-
+}