The facets of a mesh. More...

#include <geogram/mesh/mesh.h>

Inheritance diagram for GEO::MeshFacets:

Public Member Functions
	MeshFacets (Mesh &mesh)
	MeshFacets constructor.

index_t	nb_vertices (index_t f) const
	Gets the number of vertices of a facet.

index_t	vertex (index_t f, index_t lv) const
	Gets a vertex by facet and local vertex index.

template<index_t DIM = 3>
const vecng< DIM, double > &	point (index_t f, index_t lv) const
	Gets a point by facet and local vertex index.

template<index_t DIM = 3>
vecng< DIM, double > &	point (index_t f, index_t lv)
	Gets a point by facet and local vertex index.

void	set_vertex (index_t f, index_t lv, index_t v)
	Sets a vertex by facet and local vertex index.

index_t	find_vertex (index_t f, index_t v) const
	Gets the local index of a vertex in a facet.

index_t	find_common_vertex (index_t f1, index_t f2) const
	finds a common vertex shared by two facets

index_t	adjacent (index_t f, index_t le) const
	Gets an adjacent facet by facet and local edge index.

index_t	find_adjacent (index_t f, index_t f2) const
	Gets the local index of a facet adjacent to another one.

void	set_adjacent (index_t f, index_t le, index_t f2)
	Sets an adjacent facet by facet and local edge index.

index_t	next_corner_around_facet (index_t f, index_t c) const
	Gets the successor of a corner around a facet.

index_t	prev_corner_around_facet (index_t f, index_t c) const
	Gets the predecessor of a corner around a facet.

index_t	find_edge (index_t f, index_t v1, index_t v2) const
	Finds an edge by vertex indices.

void	delete_elements (vector< index_t > &to_delete, bool remove_isolated_vertices=true) override
	Deletes a set of elements.

void	permute_elements (vector< index_t > &permutation) override
	Applies a permutation to the elements and their attributes.

void	clear (bool keep_attributes=true, bool keep_memory=false) override
	Removes all the elements and attributes.

index_t	create_facets (index_t nb_facets, index_t nb_vertices_per_polygon)
	Creates a contiguous chunk of facets.

void	reserve (index_t nb_to_reserve)
	Reserves space for new facets.

index_t	create_triangles (index_t nb_triangles)
	Creates a contiguous chunk of triangles.

index_t	create_quads (index_t nb_quads)
	Creates a contiguous chunk of quads.

index_t	create_triangle (index_t v1, index_t v2, index_t v3)
	Creates a triangle.

index_t	create_quad (index_t v1, index_t v2, index_t v3, index_t v4)
	Creates a quad.

index_t	create_polygon (index_t nb_vertices)
	Creates a polygonal facet.

index_t	create_polygon (index_t nb_vertices, const index_t *vertices)
	Creates a polygonal facet.

index_t	create_polygon (const vector< index_t > &vertices)
	Creates a polygonal facet.

void	connect ()
	Connects the facets.

void	connect (index_t facets_begin, index_t facets_end)
	Connects a contiguous sequence of facets.

void	triangulate ()
	Triangulates the facets.

void	flip (index_t f)
	Flips a facet.

void	compute_borders ()
	Replaces the edges of this mesh with the borders of the surfacic part.

void	assign_triangle_mesh (coord_index_t dim, vector< double > &vertices, vector< index_t > &triangles, bool steal_args)
	Copies a triangle mesh into this Mesh.

void	assign_triangle_mesh (vector< index_t > &triangles, bool steal_args)

void	pop () override
	Removes the last element.

index_range	corners (index_t f) const
	Gets the corners of a facet.

auto	vertices (index_t f) const
	Gets the vertices of a facet.

auto	adjacent (index_t f) const
	Gets the facets adjacent to a given facet.

template<index_t DIM = 3>
auto	points (index_t f) const
	Gets the points associated with the vertices of a facet.

template<index_t DIM = 3>
auto	points (index_t f)
	Gets the points associated with the vertices of a facet.

auto	triangles (index_t f) const
	Decomposes a facet into triangles.

template<index_t DIM = 3>
auto	triangle_points (index_t f) const
	Decomposes a facet into triangles.

template<index_t DIM = 3>
auto	triangle_points (index_t f)
	Decomposes a facet into triangles.

Public Member Functions inherited from GEO::MeshFacetsStore
	MeshFacetsStore (Mesh &mesh)

index_t	corners_begin (index_t f) const
	Gets the first element for iterating over the corners of a facet.

index_t	corners_end (index_t f) const
	Gets the upper limit for iterating over the corners of a facet.

index_t	nb_corners (index_t f) const
	Gets the number of corners in a facet.

index_t	corner (index_t f, index_t lv) const
	Gets a corner by facet and local vertex index.

bool	are_simplices () const
	Tests whether all the facets are triangles.

index_t *	corners_begin_ptr (index_t f)
	Gets a pointer to the first element for iterating over the corners of a facet.

const index_t *	corners_begin_ptr (index_t f) const
	Gets a pointer to the first element for iterating over the corners of a facet.

Public Member Functions inherited from GEO::MeshSubElementsStore
	MeshSubElementsStore (Mesh &mesh)
	Constructs a new MeshSubElementStore.

virtual	~MeshSubElementsStore ()
	MeshElementStore destructor.

index_t	nb () const
	Gets the number of (sub-)elements.

AttributesManager &	attributes () const
	Gets the attributes manager.

index_as_iterator	begin () const
	Used by range-based for.

index_as_iterator	end () const
	Used by range-based for.

Protected Member Functions
void	is_simplicial ()
	Indicates that the stored elements are only triangles.

void	is_not_simplicial ()
	Indicates that the stored elements are no longer only triangles.

Protected Member Functions inherited from GEO::MeshFacetsStore
void	clear_store (bool keep_attributes, bool keep_memory=false) override
	Removes all the elements and attributes.

void	resize_store (index_t new_size) override
	Resizes this MeshSubElementsStore.

index_t	create_sub_element ()

index_t	create_sub_elements (index_t nb)

void	copy (const MeshFacetsStore &rhs, bool copy_attributes=true)

Protected Member Functions inherited from GEO::MeshSubElementsStore
void	reserve_store (index_t nb_to_reserve)
	Reserves space for new elements.

index_t	create_sub_elements (index_t nb)
	Creates a contiguous chunk of attributes for sub-elements.

index_t	create_sub_element ()
	Creates attributes for a sub-element.

void	adjust_store ()
	Makes the size of the store tightly match the number of the elements.

void	copy (const MeshSubElementsStore &rhs, bool copy_attributes=true)
	Copies a MeshSubElementsStore into this one.

Protected Attributes
MeshVertices &	vertices_

MeshFacetCornersStore &	facet_corners_

Protected Attributes inherited from GEO::MeshFacetsStore
bool	is_simplicial_

vector< index_t >	facet_ptr_

Protected Attributes inherited from GEO::MeshSubElementsStore
Mesh &	mesh_

AttributesManager	attributes_

index_t	nb_

Friends
class	Mesh

class	GeogramIOHandler

void	tessellate_facets (Mesh &M, index_t max_nb_vertices)
	Subdivides the facets with more than nb_vertices.

Additional Inherited Members
Static Protected Member Functions inherited from GEO::MeshElements
static bool	has_non_zero (const GEO::vector< index_t > &I)
	Tests whether a vector contains a non-zero value.

Detailed Description

The facets of a mesh.

Definition at line 1136 of file mesh.h.

Constructor & Destructor Documentation

◆ MeshFacets()

GEO::MeshFacets::MeshFacets ( Mesh & mesh )

MeshFacets constructor.

Parameters

[in] mesh a reference to the mesh this MeshFacets is attached to

Member Function Documentation

◆ adjacent() [1/2]

auto GEO::MeshFacets::adjacent ( index_t f ) const

inline

Gets the facets adjacent to a given facet.

Parameters

[in] f the index of the facet.

Returns: a range with all the indices of the facets adjacent to this facet. It will output exactly one item per edge of the facet. Edges on the border will output NO_INDEX (no adjacent facet).

Definition at line 1588 of file mesh.h.

◆ adjacent() [2/2]

index_t GEO::MeshFacets::adjacent	(	index_t	f,
		index_t	le
	)		const

inline

Gets an adjacent facet by facet and local edge index.

Parameters

[in]	f	the facet
[in]	le	the local index of an edge in facet `f`

Returns: the facet incident to f along edge le or NO_FACET if le is on the border

Definition at line 1245 of file mesh.h.

◆ assign_triangle_mesh()

void GEO::MeshFacets::assign_triangle_mesh	(	coord_index_t	dim,
		vector< double > &	vertices,
		vector< index_t > &	triangles,
		bool	steal_args
	)

Copies a triangle mesh into this Mesh.

Facet adjacence are not computed. Facet and corner attributes are zeroed.

Parameters

[in]	dim	dimension of the vertices
[in]	vertices	coordinates of the vertices
[in]	triangles	facet to vertex links
[in]	steal_args	if set, vertices and triangles are 'stolen' from the arguments (using vector::swap).

◆ clear()

void GEO::MeshFacets::clear	(	bool	keep_attributes = `true`,
		bool	keep_memory = `false`
	)

overridevirtual

Removes all the elements and attributes.

Parameters

[in]	keep_attributes	if true, then all the existing attribute names / bindings are kept (but they are cleared). If false, they are destroyed.
[in]	keep_memory	if true, then memory is kept and can be reused by subsequent mesh element creations.

Implements GEO::MeshElements.

◆ connect() [1/2]

void GEO::MeshFacets::connect ( )

Connects the facets.

Finds the adjacent_facet() links based on vertex indices

◆ connect() [2/2]

void GEO::MeshFacets::connect	(	index_t	facets_begin,
		index_t	facets_end
	)

Connects a contiguous sequence of facets.

Finds the adjacent_facet() links based on vertex indices

Parameters

[in]	facets_begin	first facet to connect
[in]	facets_end	one position past the last facet to connect

◆ corners()

index_range GEO::MeshFacets::corners ( index_t f ) const

inline

Gets the corners of a facet.

Parameters

[in] f the index of the facet.

Returns: a range with all the corners of the facet.

Definition at line 1557 of file mesh.h.

◆ create_facets()

index_t GEO::MeshFacets::create_facets	(	index_t	nb_facets,
		index_t	nb_vertices_per_polygon
	)

inline

Creates a contiguous chunk of facets.

Parameters

[in]	nb_facets	number of facets to create
[in]	nb_vertices_per_polygon	number of vertices in each facet

Returns: the index of the first facet

Definition at line 1340 of file mesh.h.

◆ create_polygon() [1/3]

index_t GEO::MeshFacets::create_polygon ( const vector< index_t > & vertices )

inline

Creates a polygonal facet.

Parameters

[in] vertices a const reference to a vector that contains the vertices

Returns: the index of the created facet

Definition at line 1481 of file mesh.h.

◆ create_polygon() [2/3]

index_t GEO::MeshFacets::create_polygon ( index_t nb_vertices )

inline

Creates a polygonal facet.

Parameters

[in] nb_vertices number of vertices of the facet

Returns: the index of the created facet

Definition at line 1437 of file mesh.h.

◆ create_polygon() [3/3]

index_t GEO::MeshFacets::create_polygon	(	index_t	nb_vertices,
		const index_t *	vertices
	)

inline

Creates a polygonal facet.

Parameters

[in]	nb_vertices	number of vertices of the facet
[in]	vertices	a const pointer to the `nb_vertices` vertices

Returns: the index of the created facet

Definition at line 1459 of file mesh.h.

◆ create_quad()

index_t GEO::MeshFacets::create_quad	(	index_t	v1,
		index_t	v2,
		index_t	v3,
		index_t	v4
	)

inline

Creates a quad.

Parameters

[in] v1,v2,v3,v4 the vertices of the quad

Returns: the index of the created quad

Definition at line 1419 of file mesh.h.

◆ create_quads()

index_t GEO::MeshFacets::create_quads ( index_t nb_quads )

inline

Creates a contiguous chunk of quads.

Parameters

[in] nb_quads number of quads to create

Returns: the index of the first quad

Definition at line 1389 of file mesh.h.

◆ create_triangle()

index_t GEO::MeshFacets::create_triangle	(	index_t	v1,
		index_t	v2,
		index_t	v3
	)

inline

Creates a triangle.

Parameters

[in] v1,v2,v3 the vertices of the triangle

Returns: the index of the created triangle

Definition at line 1398 of file mesh.h.

◆ create_triangles()

index_t GEO::MeshFacets::create_triangles ( index_t nb_triangles )

inline

Creates a contiguous chunk of triangles.

Parameters

[in] nb_triangles number of triangles to create

Returns: the index of the first triangle

Definition at line 1380 of file mesh.h.

◆ delete_elements()

void GEO::MeshFacets::delete_elements	(	vector< index_t > &	to_delete,
		bool	remove_isolated_vertices = `true`
	)

overridevirtual

Deletes a set of elements.

Parameters

[in]	to_delete	a vector of size nb(). If to_delete[e] is different from 0, then element e will be destroyed, else it will be kept. On exit, to_delete is modified (it is used for internal bookkeeping).
[in]	remove_isolated_vertices	if true, then the vertices that are no longer incident to any element are deleted.

Implements GEO::MeshElements.

◆ find_adjacent()

index_t GEO::MeshFacets::find_adjacent	(	index_t	f,
		index_t	f2
	)		const

inline

Gets the local index of a facet adjacent to another one.

Parameters

[in]	f	a facet
[in]	f2	another facet

Returns: le such that adjacent(f,le) == f2 or NO_INDEX if f and f2 are not adjacent.

Definition at line 1256 of file mesh.h.

◆ find_common_vertex()

index_t GEO::MeshFacets::find_common_vertex	(	index_t	f1,
		index_t	f2
	)		const

inline

finds a common vertex shared by two facets

Parameters

[in] f1,f2 the two facets

Returns: the local index in f1 of a vertex present in f2, or NO_VERTEX if there is no such vertex.

Definition at line 1228 of file mesh.h.

◆ find_edge()

index_t GEO::MeshFacets::find_edge	(	index_t	f,
		index_t	v1,
		index_t	v2
	)		const

inline

Finds an edge by vertex indices.

Parameters

[in]	f	a facet
[in]	v1,v2	two vertex indices

Returns: the edge le such that vertex(f,le) = v1 and vertex(f, (le+1)nb_vertices(f)) == v2

Definition at line 1309 of file mesh.h.

◆ find_vertex()

index_t GEO::MeshFacets::find_vertex	(	index_t	f,
		index_t	v
	)		const

inline

Gets the local index of a vertex in a facet.

Parameters

[in]	f	a facet
[in]	v	a vertex

Returns: lv such that vertex(f,lv) == v or NO_VERTE if f is not incident to v

Definition at line 1213 of file mesh.h.

◆ flip()

void GEO::MeshFacets::flip ( index_t f )

Flips a facet.

The order of the corners is reversed

Parameters

[in] f the facet to be flipped

◆ is_not_simplicial()

void GEO::MeshFacets::is_not_simplicial ( )

inlineprotected

Indicates that the stored elements are no longer only triangles.

Creates the facet pointers for the pre-existing triangles if any.

Definition at line 1724 of file mesh.h.

◆ is_simplicial()

void GEO::MeshFacets::is_simplicial ( )

inlineprotected

Indicates that the stored elements are only triangles.

Definition at line 1710 of file mesh.h.

◆ nb_vertices()

index_t GEO::MeshFacets::nb_vertices ( index_t f ) const

inline

Gets the number of vertices of a facet.

Parameters

[in] f the facet

Returns: the number of vertices of facet f

Definition at line 1151 of file mesh.h.

◆ next_corner_around_facet()

index_t GEO::MeshFacets::next_corner_around_facet	(	index_t	f,
		index_t	c
	)		const

inline

Gets the successor of a corner around a facet.

Parameters

[in]	f	the facet
[in]	c	the corner

Returns: the successor of corner c around facet f

Precondition: c >= corners_begin(f) && c < corners_end(f)

Definition at line 1283 of file mesh.h.

◆ permute_elements()

void GEO::MeshFacets::permute_elements ( vector< index_t > & permutation )

overridevirtual

Applies a permutation to the elements and their attributes.

On exit, permutation is modified (used for internal bookkeeping). Applying a permutation permutation is equivalent to:

for(i=0; i<permutation.size(); i++) {
   data2[i] = data[permutation[i]]
}
data = data2 ;

Implements GEO::MeshElements.

◆ point() [1/2]

template<index_t DIM = 3>

vecng< DIM, double > & GEO::MeshFacets::point	(	index_t	f,
		index_t	lv
	)

inline

Gets a point by facet and local vertex index.

Parameters

[in]	f	the facet
[in]	lv	the local vertex index in `f`

Returns: a reference to the point corresponding to the lvth vertex of facet f

Precondition: lv < nb_vertices(f)

Definition at line 1189 of file mesh.h.

◆ point() [2/2]

template<index_t DIM = 3>

const vecng< DIM, double > & GEO::MeshFacets::point	(	index_t	f,
		index_t	lv
	)		const

inline

Gets a point by facet and local vertex index.

Parameters

[in]	f	the facet
[in]	lv	the local vertex index in `f`

Returns: a const reference to the point corresponding to the lvth vertex of facet f

Precondition: lv < nb_vertices(f)

Definition at line 1175 of file mesh.h.

◆ points() [1/2]

template<index_t DIM = 3>

auto GEO::MeshFacets::points ( index_t f )

inline

Gets the points associated with the vertices of a facet.

Parameters

[in] f the index of the facet.

Returns: a range with the points that correspond to the vertices of the facet, returned as modifiable references.

Definition at line 1620 of file mesh.h.

◆ points() [2/2]

template<index_t DIM = 3>

auto GEO::MeshFacets::points ( index_t f ) const

inline

Gets the points associated with the vertices of a facet.

Parameters

[in] f the index of the facet.

Returns: a range with the points that correspond to the vertices of the facet, returned as const references.

Definition at line 1603 of file mesh.h.

◆ pop()

void GEO::MeshFacets::pop ( )

overridevirtual

Removes the last element.

Implements GEO::MeshElements.

◆ prev_corner_around_facet()

index_t GEO::MeshFacets::prev_corner_around_facet	(	index_t	f,
		index_t	c
	)		const

inline

Gets the predecessor of a corner around a facet.

Parameters

[in]	f	the facet
[in]	c	the corner

Returns: the predecessor of corner c around facet f

Precondition: c >= corners_begin(f) && c < corners_end(f)

Definition at line 1296 of file mesh.h.

◆ reserve()

void GEO::MeshFacets::reserve ( index_t nb_to_reserve )

inline

Reserves space for new facets.

Parameters

[in] nb_to_reserve the number of facets to reserve

Does not change size

Definition at line 1370 of file mesh.h.

◆ set_adjacent()

void GEO::MeshFacets::set_adjacent	(	index_t	f,
		index_t	le,
		index_t	f2
	)

inline

Sets an adjacent facet by facet and local edge index.

Parameters

[in]	f	the facet
[in]	le	the local index of an edge in facet `f`
[in]	f2	specifies the facet incident to `f` along edge `le` or NO_FACET if `le` is on the border

Definition at line 1272 of file mesh.h.

◆ set_vertex()

void GEO::MeshFacets::set_vertex	(	index_t	f,
		index_t	lv,
		index_t	v
	)

inline

Sets a vertex by facet and local vertex index.

Parameters

[in]	f	the facet
[in]	lv	the local vertex index in `f`
[in]	v	specifies the `lvth` vertex of facet `f`

Precondition: lv < nb_vertices(f)

Definition at line 1202 of file mesh.h.

◆ triangle_points() [1/2]

template<index_t DIM = 3>

auto GEO::MeshFacets::triangle_points ( index_t f )

inline

Decomposes a facet into triangles.

Parameters

[in] f the index of the facet.

Returns: a range with a decomposition of the facet into triangles, returned as std::tuple<vecn&, vecn&, vecn&> where vecn can be vec2, vec3, vec4 ... depending on the DIM template argument

Definition at line 1687 of file mesh.h.

◆ triangle_points() [2/2]

template<index_t DIM = 3>

auto GEO::MeshFacets::triangle_points ( index_t f ) const

inline

Decomposes a facet into triangles.

Parameters

[in] f the index of the facet.

Returns: a range with a decomposition of the facet into triangles, returned as std::tuple<const vecn&, const vecn&, const vecn&> where vecn can be vec2, vec3, vec4 ... depending on the DIM template argument

Definition at line 1663 of file mesh.h.

◆ triangles()

auto GEO::MeshFacets::triangles ( index_t f ) const

inline

Decomposes a facet into triangles.

Parameters

[in] f the index of the facet.

Returns: a range with a decomposition of the facet into triangles, returned as std::tuple<index_t, index_t, index_t>

Definition at line 1637 of file mesh.h.

◆ triangulate()

void GEO::MeshFacets::triangulate ( )

Triangulates the facets.

Note: Attributes are zeroed

◆ vertex()

index_t GEO::MeshFacets::vertex	(	index_t	f,
		index_t	lv
	)		const

inline

Gets a vertex by facet and local vertex index.

Parameters

[in]	f	the facet
[in]	lv	the local vertex index in `f`

Returns: the lvth vertex of facet f

Precondition: lv < nb_vertices(f)

Definition at line 1162 of file mesh.h.

◆ vertices()

auto GEO::MeshFacets::vertices ( index_t f ) const

inline

Gets the vertices of a facet.

Parameters

[in] f the index of the facet.

Returns: a range with all the vertices indices of the facet.

Definition at line 1572 of file mesh.h.

Friends And Related Symbol Documentation

◆ GeogramIOHandler

friend class GeogramIOHandler

friend

Definition at line 1738 of file mesh.h.

◆ Mesh

friend class Mesh

friend

Definition at line 1737 of file mesh.h.

◆ tessellate_facets

void tessellate_facets	(	Mesh &	M,
		index_t	max_nb_vertices
	)

friend

Subdivides the facets with more than nb_vertices.

Parameters

[in]	M	a reference to a surface mesh.
[in]	max_nb_vertices	maximum number of vertices in a facet.

Member Data Documentation

◆ facet_corners_

MeshFacetCornersStore& GEO::MeshFacets::facet_corners_

protected

Definition at line 1736 of file mesh.h.

◆ vertices_

MeshVertices& GEO::MeshFacets::vertices_

protected

Definition at line 1735 of file mesh.h.

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

geogram/mesh/mesh.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MeshFacets()

Member Function Documentation

◆ adjacent() [1/2]

◆ adjacent() [2/2]

◆ assign_triangle_mesh()

◆ clear()

◆ connect() [1/2]

◆ connect() [2/2]

◆ corners()

◆ create_facets()

◆ create_polygon() [1/3]

◆ create_polygon() [2/3]

◆ create_polygon() [3/3]

◆ create_quad()

◆ create_quads()

◆ create_triangle()

◆ create_triangles()

◆ delete_elements()

◆ find_adjacent()

◆ find_common_vertex()

◆ find_edge()

◆ find_vertex()

◆ flip()

◆ is_not_simplicial()

◆ is_simplicial()

◆ nb_vertices()

◆ next_corner_around_facet()

◆ permute_elements()

◆ point() [1/2]

◆ point() [2/2]

◆ points() [1/2]

◆ points() [2/2]

◆ pop()

◆ prev_corner_around_facet()

◆ reserve()

◆ set_adjacent()

◆ set_vertex()

◆ triangle_points() [1/2]

◆ triangle_points() [2/2]

◆ triangles()

◆ triangulate()

◆ vertex()

◆ vertices()

Friends And Related Symbol Documentation

◆ GeogramIOHandler

◆ Mesh

◆ tessellate_facets

Member Data Documentation

◆ facet_corners_

◆ vertices_