WebSVN – gelsvn – Diff – /trunk/src/HMesh/Manifold.h

 		std::list<Face> face_db;
 		std::list<HalfEdge> halfedge_db;
 		/** Remove a face if it contains only two edges.
 				This is an auxiliary function called from collapse_halfedge. */
-		void remove_face_if_degenerate(HalfEdgeIter fi);
+		void remove_face_if_degenerate(HalfEdgeIter);
 		/** Empty copy constructor.
 				Copying a manifold will not work, since faces, vertices, and
 				halfedges contain iterators pointing to other faces, vertices,
 				and halfedges. These pointers would need to be changed if the
 				mesh were copied. In other words, we would need to walk the
 				entire mesh. This may be required but it should not be an
 				operation that is easily invoked by calling the copy constructor.
 				Hence, this operator is made private.		*/
-		Manifold(const Manifold& m2) {}
+		Manifold(const Manifold&) {}
 		/** Empty assignment operator.
 				The assignment operator is private for the same reason that the
 				copy constructor is private. */
-		const Manifold& operator=(const Manifold& m2) {}
+		const Manifold& operator=(const Manifold&) {return *this;}
 		public:
 		/// Construct an empty manifold.
 		Manifold() {}
-		/// Return the bounding box of the manifold.
+  	/** Return the bounding box of the manifold. The arguments pmin and pmax
+				will contain the extreme corners of the box when the function returns.
+		 */
-		void get_bbox(CGLA::Vec3f&, CGLA::Vec3f&);
+		void get_bbox(CGLA::Vec3f& pmin, CGLA::Vec3f& pmax);
+		/** Get a bounding sphere. When the function returns c contains the
-		/// Get a bounding sphere
+				centre and r the radius. */
     void get_bsphere(CGLA::Vec3f& c, float& r);
 		/// Clear the manifold - removing all data.
 		void clear()
+		{
 			face_db.clear();
 			halfedge_db.clear();
+		}
 		/// Return the number of faces.
-		int no_faces() const {return face_db.size();}
+		size_t no_faces() const {return face_db.size();}
 		/// Return the number of halfedges.
-		int no_halfedges() const {return halfedge_db.size();}
+		size_t no_halfedges() const {return halfedge_db.size();}
 		/// Return the number of vertices
-		int no_vertices() const {return vertex_db.size();}
+		size_t no_vertices() const {return vertex_db.size();}
-		/// Create a new vertex at a given position.
+		/** Create a new vertex.
+				The argument is the position of the vertex, and the
+				function returns an iterator pointing to the vertex. */
 		VertexIter create_vertex(const CGLA::Vec3f& pos)
+		{
 			vertex_db.push_back(Vertex(pos));
 			return --vertex_db.end();
+		}
-		/// Create a new face
+		/** Create a new face.
+				An iterator to the face is returned. */
 		FaceIter create_face()
+		{
 			face_db.push_back(Face());
 			return --face_db.end();
+		}
-		/// Create a new halfedge.
+  	/** Create a new halfedge. An iterator to the halfedge is returned. */
 		HalfEdgeIter create_halfedge()
+		{
 			halfedge_db.push_back(HalfEdge());
 			return --halfedge_db.end();
+		}
-		/// Erase halfedge. Assumes it is safe to do so. Use with care.
+		/// Erase halfedge h. Assumes it is safe to do so. Use with care.
-		void erase_halfedge(HalfEdgeIter he)
+		void erase_halfedge(HalfEdgeIter h)
+		{
-			halfedge_db.erase(he);
+			halfedge_db.erase(h);
+		}
-		/// Erase vertex. Assumes it is safe to do so. Use with care.
+		/// Erase vertex v. Assumes it is safe to do so. Use with care.
 		void erase_vertex(VertexIter v)
+		{
 			vertex_db.erase(v);
+		}
-		/// Erase face. Assumes it is safe to do so. Use with care.
+		/// Erase face f. Assumes it is safe to do so. Use with care.
 		void erase_face(FaceIter f)
+		{
 			face_db.erase(f);
+		}
 		/// Return iterator pointing to beyond the last face.
 		FaceIter faces_end() { return face_db.end(); }
 		/** \brief HalfEdge collapse precondition.
+				The first argument, v, is the vertex we want to remove. The
+				second, h, is a halfedge pointing away from that vertex.
 				If this function does not return true, it is illegal to collapse
-				the halfedge given as second arg. The reason is that the collapse
+				h. The reason is that the collapse would violate the manifold property
-				would violate the manifold property of the mesh.
+				of the mesh.
 				The test is as follows.
 . For the two vertices adjacent to the edge, we generate
 				a list of all their neighbouring vertices. We then generate a
 . PREVENT MERGING HOLES:
 				We do not want to collapse an edge if its end points are boundary
 				vertices, but its two adjacent faces are not NULL faces, because
 				in that case we create a vertex where two holes meet. A non manifold
 				situation.	*/
-		bool collapse_precond(VertexIter, HalfEdgeIter);
+		bool collapse_precond(VertexIter v, HalfEdgeIter h);
-		/** Collapse the halfedge given as second argument.
+		/** Collapse the halfedge h.
-				The first argument is the vertex that is being removed. The
+				The first argument, v, is the vertex that is being removed. The
-				second is a halfedge pointing away from that vertex.
+				second, h, is a halfedge pointing away from that vertex.
 				The final argument is a boolean indicating whether the vertex
 				that survives the collapse should have a position which is the
 				average of its own position and the vertex that is removed.
 				By default false.
 				This function is not guaranteed to keep the mesh sane unless,
 				collapse_precond has returned true.
 		*/
-		void collapse_halfedge(VertexIter, HalfEdgeIter, bool=false);
+		void collapse_halfedge(VertexIter v, HalfEdgeIter h, bool=false);
 		/** Split a face.
-		    The face given as first argument is split by connecting two
+		    The face, f, is split by connecting two
-				vertices (the next two arguments). */
+				vertices v0 and v1 (the next two arguments). The vertices of
+				the old face between v0 and v1 (in counter clockwise order)
+				continue to belong to f. The vertices between v1 and
+				v0 belong to the new face. An iterator to the new face is
+				returned. */
-		FaceIter split_face(FaceIter, VertexIter, VertexIter);
+		FaceIter split_face(FaceIter f, VertexIter v0, VertexIter v1);
-		/** Insert a new vertex on the halfedge given as argument.
+		/** Insert a new vertex on halfedge h.
-				The new halfedge is insterted as the previous edge to the one
+				The new halfedge is insterted as the previous edge to h.
-				given as argument.
+				An iterator to the inserted vertex is	returned. */
-		*/
 		VertexIter Manifold::split_edge(HalfEdgeIter h);
 		/** Triangulate a polygonal face by repeatedly calling split_face.
 				Triangulate iteratively splits triangles off a polygon. The first
 				triangle split off is the one connecting f->last->vert and
 				f->last->next->next->vert.
 		*/
-		void triangulate(FaceIter);
+		void triangulate(FaceIter f);
-		/** Triangulate a polygon by inserting a vertex at the barycenter and
+		/** Triangulate a polygon, f, by inserting a vertex at the barycenter.
-				connecting all vertices to this vertex.
+				All vertices in f are connected to the new vertex.
 				The word "safe" means that it is less likely to create flipped
 				triangles than the normal triangulate. On the other hand, it
 				introduces more vertices and probably makes the triangles more
-				acute.
+				acute. This function simply calls face_insert_point.
-				This function simply calls face_insert_point.
+				The inserted vertex is returned.
 		*/
 		VertexIter safe_triangulate(FaceIter f);
-		/** Insert a new vertex (second arg.) in a face (first arg.).
+		/** Insert a new vertex, v, in a face, f.
 				This operation splits an N-gon into N triangles.
 				In the current implementation the original face is erased.
 				This means that the iterator is not valid after the function
 				returns.
 		*/
-		void face_insert_point(FaceIter f, VertexIter);
+		void face_insert_point(FaceIter f, VertexIter v);
-		/** Merges two faces into a single polygon. The first face is the first
+		/** Merges two faces into a single polygon. The first face is f.  The
-				argument. The second face is adjacent to the first along the
+				second face is adjacent to f along the halfedge h. This function
+				returns true if the merging was possible and false
+				otherwise. Currently merge only fails if the mesh is already
-				halfedge given as second argument. */
+				illegal. Thus it should, in fact, never fail. */
 		bool merge_faces(FaceIter f, HalfEdgeIter h);
-		/** Flip an edge. Returns false if flipping cannot be performed.
+		/** Flip an edge h. Returns false if flipping cannot be performed.
 				This is either because one of the two adjacent faces is not
 				a triangle, or because either end point has valency three or
 				because the vertices that will be connected already are. */
-		bool flip(HalfEdgeIter);
+		bool flip(HalfEdgeIter h);
 		/** Performs a series of tests to check that this is a valid manifold.
 				This function is not rigorously constructed but seems to catch
+				all problems so far. The function returns true if the mesh is
-				all problems so far. */
+				valid and false otherwise.
+		*/
 		bool is_valid();
 		/** Give each vertex a unique id corresponding to its iterator
 				position */
 		void enumerate_vertices();

Subversion Repositories gelsvn

(root)/trunk/src/HMesh/Manifold.h – Rev 133 → 136