QuickHull3: Docs Part2

docs/api/math/convexhull/QuickHull3.html

@@ -11,7 +11,7 @@
 		<h1>[name]</h1>
 
 		<div class="desc">
-			QuickHull3 infos
+			General information about the Quickhull algorithm: Dirk Gregorius. March 2014, Game Developers Conference: [link:http://media.steampowered.com/apps/valve/2014/DirkGregorius_ImplementingQuickHull.pdf Implementing QuickHull].
 		</div>
 
 
@@ -71,6 +71,103 @@
 
     <div>Makes this convex hull empty.</div>
 
+    <h3>[method:QuickHull3 addVertexToFace]( [page:Vertex vertex], [page:Face face]  )</h3>
+		[page:Vertex vertex] - The vetex to add.<br /><br />
+		[page:Face face] - The target face.<br /><br />
+
+    <div>Adds a vertex to the 'assigned' list of vertices and assigns it to the given face.</div>
+
+    <h3>[method:QuickHull3 removeVertexFromFace]( [page:Vertex vertex], [page:Face face]  )</h3>
+		[page:Vertex vertex] - The vetex to remove.<br /><br />
+		[page:Face face] - The target face.<br /><br />
+
+    <div>Removes a vertex from the 'assigned' list of vertices and from the given face. It also makes sure that the link from 'face' to the first vertex it sees in 'assigned' is linked correctly after the removal.</div>
+
+		<h3>[method:Vertex removeAllVerticesFromFace]( [page:Face face]  )</h3>
+		[page:Face face] - The given face.<br /><br />
+
+    <div>Removes all the visible vertices that a given face is able to see which are stored in the 'assigned' vertext list.</div>
+
+		<h3>[method:QuickHull3 deleteFaceVertices]( [page:Face face], [page:Face absorbingFace]  )</h3>
+		[page:Face face] - The given face.<br /><br />
+		[page:Face absorbingFace] - An optional face that tries to absorb the vertices of the first face.<br /><br />
+
+    <div>Removes all the visible vertices that 'face' is able to see.
+			<ul>
+				<li>If 'absorbingFace' doesn't exist, then all the removed vertices will be added to the 'unassigned' vertex list.</li>
+				<li>If 'absorbingFace' exists, then this method will assign all the vertices of 'face' that can see 'absorbingFace'.</li>
+				<li>If a vertex cannot see 'absorbingFace', it's added to the 'unassigned' vertex list.</li>
+			</ul>
+		</div>
+
+		<h3>[method:QuickHull3 resolveUnassignedPoints]( [page:Array newFaces]  )</h3>
+		[page:Face newFaces] - An array of new faces.<br /><br />
+
+    <div>Reassigns as many vertices as possible from the unassigned list to the new faces.</div>
+
+		<h3>[method:Object computeExtremes]()</h3>
+
+    <div>Computes the extremes values (min/max vectors) which will be used to compute the inital hull.</div>
+
+		<h3>[method:QuickHull3 computeInitialHull]()</h3>
+
+    <div>Computes the initial simplex assigning to its faces all the points that are candidates to form part of the hull.</div>
+
+		<h3>[method:QuickHull3 reindexFaces]()</h3>
+
+    <div>Removes inactive (e.g. deleted) faces from the internal face list.</div>
+
+		<h3>[method:Vertex nextVertexToAdd]()</h3>
+
+    <div>Finds the next vertex to create faces with the current hull.
+			<ul>
+				<li>Let the initial face be the first face existing in the 'assigned' vertex list.</li>
+				<li>If a face doesn't exist then return since there're no vertices left.</li>
+				<li>Otherwise for each vertex that face sees find the one furthest away from it.</li>
+			</ul>
+		</div>
+
+		<h3>[method:QuickHull3 computeHorizon]( [page:Vector3 eyePoint], [page:HalfEdge crossEdge], [page:Face face], [page:Array horizon]  )</h3>
+		[page:Vector3 eyePoint] - The 3D-coordinates of a point.<br /><br />
+		[page:HalfEdge crossEdge] - The edge used to jump to the current face.<br /><br />
+		[page:Face face] - The current face being tested.<br /><br />
+		[page:Array horizon] - The edges that form part of the horizon in CCW order.<br /><br />
+
+    <div>Computes a chain of half edges in CCW order called the 'horizon'. For an edge to be part of the horizon it must join a face that can see 'eyePoint' and a face that cannot see 'eyePoint'.</div>
+
+		<h3>[method:HalfEdge addAdjoiningFace]( [page:Vertex eyeVertex], [page:HalfEdge horizonEdge] )</h3>
+		[page:Vertex eyeVertex] - The vertex that is added to the hull.<br /><br />
+		[page:HalfEdge horizonEdge] - A single edge of the horizon.<br /><br />
+
+		<div>Creates a face with the vertices 'eyeVertex.point', 'horizonEdge.tail' and 'horizonEdge.head' in CCW order.
+			All the half edges are created in CCW order thus the face is always pointing outside the hull</div>
+
+		<h3>[method:QuickHull3 addNewFaces]( [page:Vertex eyeVertex], [page:HalfEdge horizonEdge] )</h3>
+		[page:Vertex eyeVertex] - The vertex that is added to the hull.<br /><br />
+		[page:HalfEdge horizon] - An array of half-edges that form the horizon.<br /><br />
+
+		<div>Adds 'horizon.length' faces to the hull, each face will be linked with the horizon opposite face and the face on the left/right.</div>
+
+		<h3>[method:QuickHull3 addVertexToHull]( [page:Vertex eyeVertex] )</h3>
+		[page:Vertex eyeVertex] - The vertex that is added to the hull.<br /><br />
+
+		<div>Adds a vertex to the hull with the following algorithm
+			<ul>
+				<li>Compute the 'horizon' which is a chain of half edges. For an edge to belong to this group it must be the edge connecting a face that can see 'eyeVertex' and a face which cannot see 'eyeVertex'.</li>
+				<li>All the faces that can see 'eyeVertex' have its visible vertices removed from the assigned vertex list.</li>
+				<li>A new set of faces is created with each edge of the 'horizon' and 'eyeVertex'. Each face is connected with the opposite horizon face and the face on the left/right.</li>
+				<li>The vertices removed from all the visible faces are assigned to the new faces if possible.</li>
+			</ul>
+		</div>
+
+		<h3>[method:QuickHull3 cleanup]()</h3>
+
+		<div>Cleans up internal properties after computing the convex hull.</div>
+
+		<h3>[method:QuickHull3 compute]()</h3>
+
+		<div>Starts the execution of the quick hull algorithm.</div>
+
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

src/math/convexhull/QuickHull3.js

@@ -9,6 +9,8 @@ import { Visible, Deleted } from '../../constants';
 /**
  * @author Mugen87 / https://github.com/Mugen87
  *
+ * Ported from: https://github.com/maurizzzio/quickhull3d/ by Mauricio Poppe (https://github.com/maurizzzio)
+ *
  */
 
 function QuickHull3() {
@@ -18,6 +20,16 @@ function QuickHull3() {
 	this.faces = []; // the generated faces of the convex hull
 	this.newFaces = []; // this array holds the faces that are generated within a single iteration
 
+	// the vertex lists work as follows:
+	//
+	// let 'a' and 'b' be 'Face' instances
+	// let 'v' be points wrapped as instance of 'Vertex'
+	//
+	//     [v, v, ..., v, v, v, ...]
+	//      ^             ^
+	//      |             |
+	//  a.outside     b.outside
+	//
 	this.assigned = new VertexList();
 	this.unassigned = new VertexList();
 
@@ -119,7 +131,7 @@ Object.assign( QuickHull3.prototype, {
 
 	},
 
-	// Adds a 'vertex' to the 'assigned' list of vertices and assigns it to the given face.
+	// Adds a vertex to the 'assigned' list of vertices and assigns it to the given face
 
 	addVertexToFace: function ( vertex, face ) {
 
@@ -141,8 +153,7 @@ Object.assign( QuickHull3.prototype, {
 
 	},
 
-	// Removes 'vertex' for the 'assigned' list of vertices.
-	// It also makes sure that the link from 'face' to the first vertex it sees in 'assigned' is linked correctly after the removal
+	// Removes a vertex from the 'assigned' list of vertices and from the given face
 
 	removeVertexFromFace: function ( vertex, face ) {
 
@@ -168,9 +179,11 @@ Object.assign( QuickHull3.prototype, {
 
 		this.assigned.remove( vertex );
 
+		return this;
+
 	},
 
-	// Removes all the visible vertices that 'face' is able to see which are stored in the 'assigned' vertext list
+	// Removes all the visible vertices that a given face is able to see which are stored in the 'assigned' vertext list
 
 	removeAllVerticesFromFace: function ( face ) {
 
@@ -202,10 +215,6 @@ Object.assign( QuickHull3.prototype, {
 
 	// Removes all the visible vertices that 'face' is able to see
 
-	// If 'absorbingFace' doesn't exist then all the removed vertices will be added to the 'unassigned' vertex list.
-	// If 'absorbingFace' exists then this method will assign all the vertices of 'face' that can see 'absorbingFace',
-	// if a vertex cannot see 'absorbingFace' it's added to the 'unassigned' vertex list.
-
 	deleteFaceVertices: function ( face, absorbingFace ) {
 
 		var faceVertices = this.removeAllVerticesFromFace( face );
@@ -256,6 +265,8 @@ Object.assign( QuickHull3.prototype, {
 
 		}
 
+		return this;
+
 	},
 
 	// Reassigns as many vertices as possible from the unassigned list to the new faces
@@ -311,9 +322,11 @@ Object.assign( QuickHull3.prototype, {
 
 		}
 
+		return this;
+
 	},
 
-	// Computes the extremes of a tetrahedron which will be the initial hull
+	// Computes the extremes of a simplex which will be the initial hull
 
 	computeExtremes: function () {
 
@@ -582,6 +595,8 @@ Object.assign( QuickHull3.prototype, {
 
 			}
 
+			return this;
+
 		};
 
 	}(),
@@ -606,6 +621,8 @@ Object.assign( QuickHull3.prototype, {
 
 		this.faces = activeFaces;
 
+		return this;
+
 	},
 
 	// Finds the next vertex to create faces with the current hull
@@ -646,14 +663,9 @@ Object.assign( QuickHull3.prototype, {
 
 	},
 
-	// Computes a chain of half edges in ccw order called the 'horizon'.
+	// Computes a chain of half edges in CCW order called the 'horizon'.
 	// For an edge to be part of the horizon it must join a face that can see
 	// 'eyePoint' and a face that cannot see 'eyePoint'.
-	//
-	// - eyePoint: The coordinates of a point
-	// - crossEdge: The edge used to jump to the current 'face'
-	// - face: The current face being tested
-	// - horizon: The edges that form part of the horizon in ccw order
 
 	computeHorizon: function ( eyePoint, crossEdge, face, horizon ) {
 
@@ -705,9 +717,11 @@ Object.assign( QuickHull3.prototype, {
 
 		} while ( edge !== crossEdge );
 
+		return this;
+
 	},
 
-	// Creates a face with the vertices 'eyeVertex.point', 'horizonEdge.tail' and 'horizonEdge.head' in ccw order
+	// Creates a face with the vertices 'eyeVertex.point', 'horizonEdge.tail' and 'horizonEdge.head' in CCW order
 
 	addAdjoiningFace: function ( eyeVertex, horizonEdge ) {
 
@@ -765,6 +779,8 @@ Object.assign( QuickHull3.prototype, {
 
 		firstSideEdge.next.setTwin( previousSideEdge );
 
+		return this;
+
 	},
 
 	// Adds a vertex to the hull
@@ -788,6 +804,8 @@ Object.assign( QuickHull3.prototype, {
 
 	 this.resolveUnassignedPoints( this.newFaces );
 
+	 return this;
+
 	},
 
 	cleanup: function () {
@@ -796,6 +814,8 @@ Object.assign( QuickHull3.prototype, {
 		this.unassigned.clear();
 		this.newFaces = [];
 
+		return this;
+
 	},
 
 	compute: function () {
@@ -816,6 +836,8 @@ Object.assign( QuickHull3.prototype, {
 
 		this.cleanup();
 
+		return this;
+
 	}
 
 } );