add some comments

Author: aewallin

GeoCommon.hpp

@@ -21,8 +21,8 @@
 #ifndef GEOCOMMON_H
 #define GEOCOMMON_H
 
-#define UCHAR unsigned char
-#define USHORT unsigned short
+// #define UCHAR unsigned char
+// #define USHORT unsigned short
 
 #define USE_MINIMIZER
 

eigen.cpp

@@ -29,6 +29,7 @@
 #include <assert.h>
 #define ROTATE(a,i,j,k,l) g=a[i][j];h=a[k][l];a[i][j]=g-s*(h+g*tau);a[k][l]=h+s*(g-h*tau);
 
+// used to select solving method in calcPoint()
 int method = 3;
 
 // for reducing two upper triangular systems of equations into 1
@@ -506,62 +507,56 @@ void descent ( float A[][3], float B[], float guess[], BoundingBoxf *box )
 	store [ 1 ] = guess [ 1 ];
 	store [ 2 ] = guess [ 2 ];
 
-	if ( method == 2 || method == 0 )
-	{
+	if ( method == 2 || method == 0 ) {
 
-	i = 0;
-	r [ 0 ] = B [ 0 ] - ( A [ 0 ] [ 0 ] * guess [ 0 ] + A [ 0 ] [ 1 ] * guess [ 1 ] + A [ 0 ] [ 2 ] * guess [ 2 ] );
-	r [ 1 ] = B [ 1 ] - ( A [ 1 ] [ 0 ] * guess [ 0 ] + A [ 1 ] [ 1 ] * guess [ 1 ] + A [ 1 ] [ 2 ] * guess [ 2 ] );
-	r [ 2 ] = B [ 2 ] - ( A [ 2 ] [ 0 ] * guess [ 0 ] + A [ 2 ] [ 1 ] * guess [ 1 ] + A [ 2 ] [ 2 ] * guess [ 2 ] );
+		i = 0;
+		r [ 0 ] = B [ 0 ] - ( A [ 0 ] [ 0 ] * guess [ 0 ] + A [ 0 ] [ 1 ] * guess [ 1 ] + A [ 0 ] [ 2 ] * guess [ 2 ] );
+		r [ 1 ] = B [ 1 ] - ( A [ 1 ] [ 0 ] * guess [ 0 ] + A [ 1 ] [ 1 ] * guess [ 1 ] + A [ 1 ] [ 2 ] * guess [ 2 ] );
+		r [ 2 ] = B [ 2 ] - ( A [ 2 ] [ 0 ] * guess [ 0 ] + A [ 2 ] [ 1 ] * guess [ 1 ] + A [ 2 ] [ 2 ] * guess [ 2 ] );
 
-	delta = r [ 0 ] * r [ 0 ] + r [ 1 ] * r [ 1 ] + r [ 2 ] * r [ 2 ];
-	delta0 = delta * TOLERANCE * TOLERANCE;
+		delta = r [ 0 ] * r [ 0 ] + r [ 1 ] * r [ 1 ] + r [ 2 ] * r [ 2 ];
+		delta0 = delta * TOLERANCE * TOLERANCE;
 
-	while ( i < n && delta > delta0 )
-	{
-		div = r [ 0 ] * ( A [ 0 ] [ 0 ] * r [ 0 ] + A [ 0 ] [ 1 ] * r [ 1 ] + A [ 0 ] [ 2 ] * r [ 2 ] );
-		div += r [ 1 ] * ( A [ 1 ] [ 0 ] * r [ 0 ] + A [ 1 ] [ 1 ] * r [ 1 ] + A [ 1 ] [ 2 ] * r [ 2 ] );
-		div += r [ 2 ] * ( A [ 2 ] [ 0 ] * r [ 0 ] + A [ 2 ] [ 1 ] * r [ 1 ] + A [ 2 ] [ 2 ] * r [ 2 ] );
+		while ( i < n && delta > delta0 ) {
+			div = r [ 0 ] * ( A [ 0 ] [ 0 ] * r [ 0 ] + A [ 0 ] [ 1 ] * r [ 1 ] + A [ 0 ] [ 2 ] * r [ 2 ] );
+			div += r [ 1 ] * ( A [ 1 ] [ 0 ] * r [ 0 ] + A [ 1 ] [ 1 ] * r [ 1 ] + A [ 1 ] [ 2 ] * r [ 2 ] );
+			div += r [ 2 ] * ( A [ 2 ] [ 0 ] * r [ 0 ] + A [ 2 ] [ 1 ] * r [ 1 ] + A [ 2 ] [ 2 ] * r [ 2 ] );
 
-		if ( fabs ( div ) < 0.0000001f )
-		{
-			break;
-		}
+			if ( fabs ( div ) < 0.0000001f )
+				break;
 
-		alpha = delta / div;
+			alpha = delta / div;
 
-		newPoint [ 0 ] = guess [ 0 ] + alpha * r [ 0 ];
-		newPoint [ 1 ] = guess [ 1 ] + alpha * r [ 1 ];
-		newPoint [ 2 ] = guess [ 2 ] + alpha * r [ 2 ];
+			newPoint [ 0 ] = guess [ 0 ] + alpha * r [ 0 ];
+			newPoint [ 1 ] = guess [ 1 ] + alpha * r [ 1 ];
+			newPoint [ 2 ] = guess [ 2 ] + alpha * r [ 2 ];
 
-		guess [ 0 ] = newPoint [ 0 ];
-		guess [ 1 ] = newPoint [ 1 ];
-		guess [ 2 ] = newPoint [ 2 ];
+			guess [ 0 ] = newPoint [ 0 ];
+			guess [ 1 ] = newPoint [ 1 ];
+			guess [ 2 ] = newPoint [ 2 ];
 
-		r [ 0 ] = B [ 0 ] - ( A [ 0 ] [ 0 ] * guess [ 0 ] + A [ 0 ] [ 1 ] * guess [ 1 ] + A [ 0 ] [ 2 ] * guess [ 2 ] );
-		r [ 1 ] = B [ 1 ] - ( A [ 1 ] [ 0 ] * guess [ 0 ] + A [ 1 ] [ 1 ] * guess [ 1 ] + A [ 1 ] [ 2 ] * guess [ 2 ] );
-		r [ 2 ] = B [ 2 ] - ( A [ 2 ] [ 0 ] * guess [ 0 ] + A [ 2 ] [ 1 ] * guess [ 1 ] + A [ 2 ] [ 2 ] * guess [ 2 ] );
+			r [ 0 ] = B [ 0 ] - ( A [ 0 ] [ 0 ] * guess [ 0 ] + A [ 0 ] [ 1 ] * guess [ 1 ] + A [ 0 ] [ 2 ] * guess [ 2 ] );
+			r [ 1 ] = B [ 1 ] - ( A [ 1 ] [ 0 ] * guess [ 0 ] + A [ 1 ] [ 1 ] * guess [ 1 ] + A [ 1 ] [ 2 ] * guess [ 2 ] );
+			r [ 2 ] = B [ 2 ] - ( A [ 2 ] [ 0 ] * guess [ 0 ] + A [ 2 ] [ 1 ] * guess [ 1 ] + A [ 2 ] [ 2 ] * guess [ 2 ] );
 
-		delta = r [ 0 ] * r [ 0 ] + r [ 1 ] * r [ 1 ] + r [ 2 ] * r [ 2 ];
+			delta = r [ 0 ] * r [ 0 ] + r [ 1 ] * r [ 1 ] + r [ 2 ] * r [ 2 ];
 
-		i++;
-	}
+			i++;
+		}
 
-	if ( guess [ 0 ] >= box->begin.x && guess [ 0 ] <= box->end.x && 
-		guess [ 1 ] >= box->begin.y && guess [ 1 ] <= box->end.y &&
-		guess [ 2 ] >= box->begin.z && guess [ 2 ] <= box->end.z )
-	{
-		return;
-	}
-	}
+		if ( guess [ 0 ] >= box->begin.x && guess [ 0 ] <= box->end.x && 
+			guess [ 1 ] >= box->begin.y && guess [ 1 ] <= box->end.y &&
+			guess [ 2 ] >= box->begin.z && guess [ 2 ] <= box->end.z )
+		{
+			return;
+		}
+	} // method 2 or 0
 
-	if ( method == 0 || method == 1 )
-	{
+	if ( method == 0 || method == 1 ) {
 		c = A [ 0 ] [ 0 ] + A [ 1 ] [ 1 ] + A [ 2 ] [ 2 ];
 		if ( c == 0 )
-		{
 			return;
-		}
+
 		c = ( 0.75f / c );
 
 		guess [ 0 ] = store [ 0 ];
@@ -572,8 +567,7 @@ void descent ( float A[][3], float B[], float guess[], BoundingBoxf *box )
 		r [ 1 ] = B [ 1 ] - ( A [ 1 ] [ 0 ] * guess [ 0 ] + A [ 1 ] [ 1 ] * guess [ 1 ] + A [ 1 ] [ 2 ] * guess [ 2 ] );
 		r [ 2 ] = B [ 2 ] - ( A [ 2 ] [ 0 ] * guess [ 0 ] + A [ 2 ] [ 1 ] * guess [ 1 ] + A [ 2 ] [ 2 ] * guess [ 2 ] );
 
-		for ( i = 0; i < n; i++ )
-		{
+		for ( i = 0; i < n; i++ ) {
 			guess [ 0 ] = guess [ 0 ] + c * r [ 0 ];
 			guess [ 1 ] = guess [ 1 ] + c * r [ 1 ];
 			guess [ 2 ] = guess [ 2 ] + c * r [ 2 ];
@@ -617,9 +611,9 @@ float calcPoint ( float halfA[], float b[], float btb, float midpoint[], float r
 	a [ 2 ] [ 1 ] = halfA [ 4 ];
 	a [ 2 ] [ 2 ] = halfA [ 5 ];
 
-	switch ( method )
+	switch ( method ) // by default method = 3
 	{
-	case 0:
+	case 0: 
 	case 1:
 	case 2:
 		rvalue [ 0 ] = midpoint [ 0 ];
@@ -630,13 +624,10 @@ float calcPoint ( float halfA[], float b[], float btb, float midpoint[], float r
 		return calcError ( a, b, btb, rvalue );
 		break;
 	case 3:
-		matInverse ( a, midpoint, inv, w, u );
-
-
+		matInverse( a, midpoint, inv, w, u );
 		newB [ 0 ] = b [ 0 ] - a [ 0 ] [ 0 ] * midpoint [ 0 ] - a [ 0 ] [ 1 ] * midpoint [ 1 ] - a [ 0 ] [ 2 ] * midpoint [ 2 ];
 		newB [ 1 ] = b [ 1 ] - a [ 1 ] [ 0 ] * midpoint [ 0 ] - a [ 1 ] [ 1 ] * midpoint [ 1 ] - a [ 1 ] [ 2 ] * midpoint [ 2 ];
 		newB [ 2 ] = b [ 2 ] - a [ 2 ] [ 0 ] * midpoint [ 0 ] - a [ 2 ] [ 1 ] * midpoint [ 1 ] - a [ 2 ] [ 2 ] * midpoint [ 2 ];
-
 		rvalue [ 0 ] = inv [ 0 ] [ 0 ] * newB [ 0 ] + inv [ 1 ] [ 0 ] * newB [ 1 ] + inv [ 2 ] [ 0 ] * newB [ 2 ] + midpoint [ 0 ];
 		rvalue [ 1 ] = inv [ 0 ] [ 1 ] * newB [ 0 ] + inv [ 1 ] [ 1 ] * newB [ 1 ] + inv [ 2 ] [ 1 ] * newB [ 2 ] + midpoint [ 1 ];
 		rvalue [ 2 ] = inv [ 0 ] [ 2 ] * newB [ 0 ] + inv [ 1 ] [ 2 ] * newB [ 1 ] + inv [ 2 ] [ 2 ] * newB [ 2 ] + midpoint [ 2 ];
@@ -768,7 +759,7 @@ float calcPoint ( float halfA[], float b[], float btb, float midpoint[], float r
 		return ret;
 
 		break;
-	case 5:
+	case 5: // do nothing, return midpoint
 		rvalue [ 0 ] = midpoint [ 0 ];
 		rvalue [ 1 ] = midpoint [ 1 ];
 		rvalue [ 2 ] = midpoint [ 2 ];

octree.hpp

@@ -63,8 +63,7 @@ class LeafNode : public OctreeNode {
     char height; // depth
 	float mp[3]; // this is the minimizer point of the QEF
 	int index; // ?
-	// QEF data
-	float ata[6], atb[3], btb ;
+	float ata[6], atb[3], btb; // QEF data
 
 	// Construction
 	LeafNode( int ht, unsigned char sg, float coord[3] )  {
@@ -86,7 +85,7 @@ class LeafNode : public OctreeNode {
 	// Construction by QEF
 	// each edge of the cube can have an intersection point
 	// so we can give up to 12 intersection points with 12 normal-vectors
-	// specify numner of intersections in numint
+	// specify number of intersections in numint
 	//
 	// st is the minimum bounding-box point
 	// st + (1,1,1)*len is the maximum bounding-box point
@@ -144,7 +143,11 @@ class LeafNode : public OctreeNode {
 
 			// eigen.hpp
 			// calculate minimizer point, and return error
+			// QEF: ata, atb, btb
+			// pt is the average of the intersection points
 			// mp is the result
+			// box is a bounding-box for this node
+			// mat is storage for calcPoint() ?
 			float error = calcPoint( ata, atb, btb, pt, mp, box, mat ) ;
 
 #ifdef CLAMP // Clamp all minimizers to be inside the cell
@@ -175,15 +178,10 @@ class PseudoLeafNode : public OctreeNode {
 	unsigned char signs;
 public:
 	char height ;
-
 	float mp[3]; // Minimizer
 	int index;
-
-	// QEF
-	float ata[6], atb[3], btb ;
-
-	// Children 
-	OctreeNode * child[8] ;
+	float ata[6], atb[3], btb ; // QEF
+	OctreeNode * child[8] ; // Children 
 
 	// Construction, without QEF
 	PseudoLeafNode ( int ht, unsigned char sg, float coord[3] )  {
@@ -295,9 +293,9 @@ const int dirEdge[3][4] = {
 class Octree {
 public:
 	OctreeNode* root ;
-	int dimen; 	/// Length of grid
+	int dimen; 	   // Length of grid
 	int maxDepth;
-	int hasQEF;  // Has QEF? why not bool? used in simplify()
+	int hasQEF;    // Has QEF? why not bool? used in simplify()
 	int faceVerts, edgeVerts, actualTris ;
 	int founds, news ;
 public: