VCG Library
Static Public Member Functions | List of all members
vcg::tri::Clean< CleanMeshType > Class Template Reference

Class of static functions to clean//restore meshs. More...

#include <clean.h>

Static Public Member Functions

static int RemoveDuplicateVertex (MeshType &m, bool RemoveDegenerateFlag=true)
 
static int RemoveDuplicateFace (MeshType &m)
 
static int RemoveDuplicateEdge (MeshType &m)
 
static int RemoveUnreferencedVertex (MeshType &m, bool DeleteVertexFlag=true)
 
static int RemoveDegenerateVertex (MeshType &m)
 
static int RemoveDegenerateFace (MeshType &m)
 
static int SplitNonManifoldVertex (MeshType &m, ScalarType moveThreshold)
 Removal of faces that were incident on a non manifold edge.
 
static int RemoveNonManifoldFace (MeshType &m)
 Removal of faces that were incident on a non manifold edge.
 
static bool IsBitQuadOnly (const MeshType &m)
 
static bool IsBitTriOnly (const MeshType &m)
 
static bool IsBitTriQuadOnly (const MeshType &m)
 
static int CountBitQuads (const MeshType &m)
 
static int CountBitTris (const MeshType &m)
 
static int CountBitPolygons (const MeshType &m)
 
static int CountBitLargePolygons (MeshType &m)
 
static bool HasConsistentPerFaceFauxFlag (const MeshType &m)
 
static int CountNonManifoldEdgeEE (MeshType &m, bool SelectFlag=false)
 
static int CountNonManifoldEdgeFF (MeshType &m, bool SelectFlag=false)
 
static int CountNonManifoldVertexFF (MeshType &m, bool selectVert=true)
 
static bool IsWaterTight (MeshType &m)
 
static int MeshGenus (int nvert, int nedges, int nfaces, int numholes, int numcomponents)
 
static void IsRegularMesh (MeshType &m, bool &Regular, bool &Semiregular)
 
static void FlipMesh (MeshType &m, bool selected=false)
 Flip the orientation of the whole mesh flipping all the faces (by swapping the first two vertices)
 
static bool FlipNormalOutside (MeshType &m)
 
static bool IsSizeConsistent (MeshType &m)
 
static bool IsFFAdjacencyConsistent (MeshType &m)
 
static bool HasConsistentPerWedgeTexCoord (MeshType &m)
 
static bool HasZeroTexCoordFace (MeshType &m)
 
static bool TestFaceFaceIntersection (FaceType *f0, FaceType *f1)
 
static int MergeCloseVertex (MeshType &m, const ScalarType radius)
 
static std::pair< int, int > RemoveSmallConnectedComponentsDiameter (MeshType &m, ScalarType maxDiameter)
 Remove the connected components smaller than a given diameter.
 
static std::pair< int, int > RemoveHugeConnectedComponentsDiameter (MeshType &m, ScalarType minDiameter)
 Remove the connected components greater than a given diameter.
 
static void SelectFoldedFaceFromOneRingFaces (MeshType &m, ScalarType cosThreshold)
 
static int SelectIntersectingFaces (MeshType &m1, MeshType &m2)
 

Detailed Description

template<class CleanMeshType>
class vcg::tri::Clean< CleanMeshType >

Class of static functions to clean//restore meshs.

Definition at line 99 of file clean.h.

Member Function Documentation

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::CountBitLargePolygons ( MeshType &  m)
inlinestatic

The number of polygonal faces is FN - EN_f (each faux edge hides exactly one triangular face or in other words a polygon of n edges has n-3 faux edges.) In the general case where a The number of polygonal faces is FN - EN_f + VN_f where: EN_f is the number of faux edges. VN_f is the number of faux vertices (e.g vertices completely surrounded by faux edges) as a intuitive proof think to a internal vertex that is collapsed onto a border of a polygon: it deletes 2 faces, 1 faux edges and 1 vertex so to keep the balance you have to add back the removed vertex.

Definition at line 779 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::CountBitPolygons ( const MeshType &  m)
inlinestatic

How many polygons of any kind? (including triangles) it assumes that there are no faux vertexes (e.g vertices completely surrounded by faux edges)

Definition at line 756 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::CountBitQuads ( const MeshType &  m)
inlinestatic

How many quadrilaterals? It assumes that the bits are consistent. In that case we count the tris with a single faux edge and divide by two.

Definition at line 727 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::CountBitTris ( const MeshType &  m)
inlinestatic

How many triangles? (non polygonal faces)

Definition at line 742 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::CountNonManifoldEdgeEE ( MeshType &  m,
bool  SelectFlag = false 
)
inlinestatic

Count the number of non manifold edges in a polylinemesh, e.g. the edges where there are more than 2 incident faces.

Definition at line 842 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::CountNonManifoldEdgeFF ( MeshType &  m,
bool  SelectFlag = false 
)
inlinestatic

Count the number of non manifold edges in a mesh, e.g. the edges where there are more than 2 incident faces.

Note that this test is not enough to say that a mesh is two manifold, you have to count also the non manifold vertexes.

Definition at line 880 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::CountNonManifoldVertexFF ( MeshType &  m,
bool  selectVert = true 
)
inlinestatic

Count (and eventually select) non 2-Manifold vertexes of a mesh e.g. the vertices with a non 2-manif. neighbourhood but that do not belong to not 2-manif edges. typical situation two cones connected by one vertex.

Definition at line 932 of file clean.h.

template<class CleanMeshType >
static void vcg::tri::Clean< CleanMeshType >::FlipMesh ( MeshType &  m,
bool  selected = false 
)
inlinestatic

Flip the orientation of the whole mesh flipping all the faces (by swapping the first two vertices)

Definition at line 1292 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::FlipNormalOutside ( MeshType &  m)
inlinestatic

Flip a mesh so that its normals are orented outside. Just for safety it uses a voting scheme. It assumes that mesh has already has coherent normals. mesh is watertight and signle component.

Definition at line 1307 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::HasConsistentPerFaceFauxFlag ( const MeshType &  m)
inlinestatic

Checks that the mesh has consistent per-face faux edges (the ones that merges triangles into larger polygons). A border edge should never be faux, and faux edges should always be reciprocated by another faux edges. It requires FF adjacency.

Definition at line 822 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::HasConsistentPerWedgeTexCoord ( MeshType &  m)
inlinestatic

This function simply test that a mesh has some reasonable tex coord.

Definition at line 1581 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::HasZeroTexCoordFace ( MeshType &  m)
inlinestatic

Simple check that there are no face with all collapsed tex coords.

Definition at line 1599 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::IsBitQuadOnly ( const MeshType &  m)
inlinestatic

Is the mesh only composed by quadrilaterals?

Definition at line 664 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::IsBitTriOnly ( const MeshType &  m)
inlinestatic

Is the mesh only composed by triangles? (non polygonal faces)

Definition at line 695 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::IsBitTriQuadOnly ( const MeshType &  m)
inlinestatic

Is the mesh only composed by quadrilaterals and triangles? (no pentas, etc) It assumes that the bits are consistent. In that case there can be only a single faux edge.

Definition at line 712 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::IsFFAdjacencyConsistent ( MeshType &  m)
inlinestatic

This function simply test that all the faces have a consistent face-face topology relation. useful for checking that a topology modifying algorithm does not mess something.

Definition at line 1565 of file clean.h.

template<class CleanMeshType >
static void vcg::tri::Clean< CleanMeshType >::IsRegularMesh ( MeshType &  m,
bool &  Regular,
bool &  Semiregular 
)
inlinestatic

Check if the given mesh is regular, semi-regular or irregular.

Each vertex of a regular mesh has valence 6 except for border vertices which have valence 4.

A semi-regular mesh is derived from an irregular one applying 1-to-4 subdivision recursively. (not checked for now)

All other meshes are irregular.

Definition at line 1175 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::IsSizeConsistent ( MeshType &  m)
inlinestatic

This function simply test that the vn and fn counters be consistent with the size of the containers and the number of deleted simplexes.

Definition at line 1540 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::IsWaterTight ( MeshType &  m)
inlinestatic

Very simple test of water tightness. No boundary and no non manifold edges. Assume that it is orientable. It could be debated if a closed non orientable surface is watertight or not.

The rationale of not testing orientability here is that it requires FFAdj while this test do not require any adjacency.

Definition at line 990 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::MergeCloseVertex ( MeshType &  m,
const ScalarType  radius 
)
inlinestatic

This function merge all the vertices that are closer than the given radius

Definition at line 1654 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::MeshGenus ( int  nvert,
int  nedges,
int  nfaces,
int  numholes,
int  numcomponents 
)
inlinestatic
  GENUS.

  A topologically invariant property of a surface defined as
  the largest number of non-intersecting simple closed curves that can be
  drawn on the surface without separating it.

Roughly speaking, it is the number of holes in a surface. The genus g of a closed surface, also called the geometric genus, is related to the Euler characteristic by the relation $chi$ by $chi==2-2g$.

The genus of a connected, orientable surface is an integer representing the maximum number of cuttings along closed simple curves without rendering the resultant manifold disconnected. It is equal to the number of handles on it.

For general polyhedra the Euler Formula is:

  V - E + F = 2 - 2G - B

where V is the number of vertices, F is the number of faces, E is the number of edges, G is the genus and B is the number of boundary polygons.

The above formula is valid for a mesh with one single connected component. By considering multiple connected components the formula becomes:

  V - E + F = 2C - 2Gs - B   ->   2Gs = - ( V-E+F +B -2C)

where C is the number of connected components and Gs is the sum of the genus of all connected components.

Note that in the case of a mesh with boundaries the intuitive meaning of Genus is less intuitive that it could seem. A closed sphere, a sphere with one hole (e.g. a disk) and a sphere with two holes (e.g. a tube) all of them have Genus == 0

Definition at line 1147 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::RemoveDegenerateFace ( MeshType &  m)
inlinestatic

Degenerate faces are faces that are Topologically degenerate, i.e. have two or more vertex reference that link the same vertex (and not only two vertexes with the same coordinates). All Degenerate faces are zero area faces BUT not all zero area faces are degenerate. We do not take care of topology because when we have degenerate faces the topology calculation functions crash.

Definition at line 389 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::RemoveDegenerateVertex ( MeshType &  m)
inlinestatic

Degenerate vertices are vertices that have coords with invalid floating point values, All the faces incident on deleted vertices are also deleted

Definition at line 352 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::RemoveDuplicateEdge ( MeshType &  m)
inlinestatic

This function removes all duplicate faces of the mesh by looking only at their vertex reference. So it should be called after unification of vertices. Note that it does not update any topology relation that could be affected by this like the VT or TT relation. the reason this function is usually performed BEFORE building any topology information.

Definition at line 285 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::RemoveDuplicateFace ( MeshType &  m)
inlinestatic

This function removes all duplicate faces of the mesh by looking only at their vertex reference. So it should be called after unification of vertices. Note that it does not update any topology relation that could be affected by this like the VT or TT relation. the reason this function is usually performed BEFORE building any topology information.

Definition at line 256 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::RemoveDuplicateVertex ( MeshType &  m,
bool  RemoveDegenerateFlag = true 
)
inlinestatic

This function removes all duplicate vertices of the mesh by looking only at their spatial positions. Note that it does not update any topology relation that could be affected by this like the VT or TT relation. the reason this function is usually performed BEFORE building any topology information.

Definition at line 135 of file clean.h.

template<class CleanMeshType >
static std::pair<int,int> vcg::tri::Clean< CleanMeshType >::RemoveHugeConnectedComponentsDiameter ( MeshType &  m,
ScalarType  minDiameter 
)
inlinestatic

Remove the connected components greater than a given diameter.

Definition at line 1755 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::RemoveNonManifoldFace ( MeshType &  m)
inlinestatic

Removal of faces that were incident on a non manifold edge.

Definition at line 598 of file clean.h.

template<class CleanMeshType >
static std::pair<int,int> vcg::tri::Clean< CleanMeshType >::RemoveSmallConnectedComponentsDiameter ( MeshType &  m,
ScalarType  maxDiameter 
)
inlinestatic

Remove the connected components smaller than a given diameter.

Definition at line 1725 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::RemoveUnreferencedVertex ( MeshType &  m,
bool  DeleteVertexFlag = true 
)
inlinestatic

This function removes that are not referenced by any face or by any edge.

Parameters
mThe mesh
DeleteVertexFlagif false prevent the vertex deletion and just count it.
Returns
The number of removed vertices

Definition at line 318 of file clean.h.

template<class CleanMeshType >
static void vcg::tri::Clean< CleanMeshType >::SelectFoldedFaceFromOneRingFaces ( MeshType &  m,
ScalarType  cosThreshold 
)
inlinestatic

Select the folded faces using an angle threshold on the face normal. The face is selected if the dot product between the face normal and the normal of the plane fitted using the vertices of the one ring faces is below the cosThreshold. The cosThreshold requires a negative cosine value (a positive value is clamp to zero).

Definition at line 1791 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::SelectIntersectingFaces ( MeshType &  m1,
MeshType &  m2 
)
inlinestatic

Select the faces on the first mesh that intersect the second mesh. It uses a grid for querying so a face::mark should be added.

Definition at line 1848 of file clean.h.

template<class CleanMeshType >
static int vcg::tri::Clean< CleanMeshType >::SplitNonManifoldVertex ( MeshType &  m,
ScalarType  moveThreshold 
)
inlinestatic

Removal of faces that were incident on a non manifold edge.

Definition at line 529 of file clean.h.

template<class CleanMeshType >
static bool vcg::tri::Clean< CleanMeshType >::TestFaceFaceIntersection ( FaceType *  f0,
FaceType *  f1 
)
inlinestatic

This function test if two triangular faces of a mesh intersect. It assumes that the faces (as storage) are different (e.g different address) If the two faces are different but coincident (same set of vertexes) return true. if the faces share an edge no test is done. if the faces share only a vertex, the opposite edge is tested against the face

Definition at line 1619 of file clean.h.


The documentation for this class was generated from the following file: