OpenMesh::PolyMeshT< Kernel > Class Template Reference

Base type for a polygonal mesh. More...

#include <OpenMesh/Mesh/PolyMeshT.hh>

Inheritance diagram for OpenMesh::PolyMeshT< Kernel >:

Collaboration diagram for OpenMesh::PolyMeshT< Kernel >:

Public Types
typedef PolyMeshT< Kernel >	This
	Self type. Used to specify iterators/circulators.
typedef Kernel::VertexHandle	VertexHandle
	Handle for referencing the corresponding item.
typedef Kernel::HalfedgeHandle	HalfedgeHandle
typedef Kernel::EdgeHandle	EdgeHandle
typedef Kernel::FaceHandle	FaceHandle
typedef Kernel::VertexIter	VertexIter
typedef Kernel::HalfedgeIter	HalfedgeIter
typedef Kernel::EdgeIter	EdgeIter
typedef Kernel::FaceIter	FaceIter
typedef Kernel::ConstVertexIter	ConstVertexIter
typedef Kernel::ConstHalfedgeIter	ConstHalfedgeIter
typedef Kernel::ConstEdgeIter	ConstEdgeIter
typedef Kernel::ConstFaceIter	ConstFaceIter
Mesh Items
typedef Kernel::Scalar	Scalar
	Scalar type.
typedef Kernel::Point	Point
	Coordinate type.
typedef Kernel::Normal	Normal
	Normal type.
typedef Kernel::Color	Color
	Color type.
typedef Kernel::TexCoord1D	TexCoord1D
	TexCoord1D type.
typedef Kernel::TexCoord2D	TexCoord2D
	TexCoord2D type.
typedef Kernel::TexCoord3D	TexCoord3D
	TexCoord3D type.
typedef Kernel::Vertex	Vertex
	Vertex type.
typedef Kernel::Halfedge	Halfedge
	Halfedge type.
typedef Kernel::Edge	Edge
	Edge type.
typedef Kernel::Face	Face
	Face type.
Mesh Circulators
Refer to OpenMesh::Mesh::Iterators or Mesh Iterators and Circulators for documentation.
typedef Kernel::VertexVertexIter	VertexVertexIter
	Circulator.
typedef Kernel::VertexOHalfedgeIter	VertexOHalfedgeIter
	Circulator.
typedef Kernel::VertexIHalfedgeIter	VertexIHalfedgeIter
	Circulator.
typedef Kernel::VertexEdgeIter	VertexEdgeIter
	Circulator.
typedef Kernel::VertexFaceIter	VertexFaceIter
	Circulator.
typedef Kernel::FaceVertexIter	FaceVertexIter
	Circulator.
typedef Kernel::FaceHalfedgeIter	FaceHalfedgeIter
	Circulator.
typedef Kernel::FaceEdgeIter	FaceEdgeIter
	Circulator.
typedef Kernel::FaceFaceIter	FaceFaceIter
	Circulator.
typedef Kernel::ConstVertexVertexIter	ConstVertexVertexIter
	Circulator.
typedef Kernel::ConstVertexOHalfedgeIter	ConstVertexOHalfedgeIter
	Circulator.
typedef Kernel::ConstVertexIHalfedgeIter	ConstVertexIHalfedgeIter
	Circulator.
typedef Kernel::ConstVertexEdgeIter	ConstVertexEdgeIter
	Circulator.
typedef Kernel::ConstVertexFaceIter	ConstVertexFaceIter
	Circulator.
typedef Kernel::ConstFaceVertexIter	ConstFaceVertexIter
	Circulator.
typedef Kernel::ConstFaceHalfedgeIter	ConstFaceHalfedgeIter
	Circulator.
typedef Kernel::ConstFaceEdgeIter	ConstFaceEdgeIter
	Circulator.
typedef Kernel::ConstFaceFaceIter	ConstFaceFaceIter
	Circulator.

Public Member Functions
template<typename T >
	PolyMeshT (const T &t)
SmartVertexHandle	new_vertex ()
	Uses default copy and assignment operator. More...
SmartVertexHandle	new_vertex (const Point &_p)
	Adds a new vertex initialized to a custom position. More...
SmartVertexHandle	new_vertex_dirty (const Point &_p)
	Same as new_vertex(const Point&) but never shrinks, only enlarges the vertex property vectors. More...
SmartVertexHandle	add_vertex (const Point &_p)
	Alias for new_vertex(const Point&).
SmartVertexHandle	add_vertex_dirty (const Point &_p)
	Alias for new_vertex_dirty().
void	calc_edge_vector (EdgeHandle _eh, Normal &_edge_vec) const
	Calculates the edge vector as the vector defined by the halfedge with id #0 (see below)
Normal	calc_edge_vector (EdgeHandle _eh) const
	Calculates the edge vector as the vector defined by the halfedge with id #0 (see below)
void	calc_edge_vector (HalfedgeHandle _heh, Normal &_edge_vec) const
	Calculates the edge vector as the difference of the the points defined by to_vertex_handle() and from_vertex_handle()
Normal	calc_edge_vector (HalfedgeHandle _heh) const
	Calculates the edge vector as the difference of the the points defined by to_vertex_handle() and from_vertex_handle()
Scalar	calc_edge_length (EdgeHandle _eh) const
Scalar	calc_edge_length (HalfedgeHandle _heh) const
	Calculates the length of the edge _heh.
Scalar	calc_edge_sqr_length (EdgeHandle _eh) const
Scalar	calc_edge_sqr_length (HalfedgeHandle _heh) const
Point	calc_edge_midpoint (HalfedgeHandle _heh) const
	Calculates the midpoint of the halfedge _heh, defined by the positions of the two incident vertices.
Point	calc_edge_midpoint (EdgeHandle _eh) const
	Calculates the midpoint of the edge _eh, defined by the positions of the two incident vertices.
Normal	calc_normal (EdgeHandle _eh) const
	calculated and returns the average of the two vertex normals
void	calc_sector_vectors (HalfedgeHandle _in_heh, Normal &_vec0, Normal &_vec1) const
	defines a consistent representation of a sector geometry: the halfedge _in_heh defines the sector orientation the vertex pointed by _in_heh defines the sector center _vec0 and _vec1 are resp. More...
Scalar	calc_sector_angle (HalfedgeHandle _in_heh) const
	calculates the sector angle. More...
void	calc_sector_normal (HalfedgeHandle _in_heh, Normal &_sector_normal) const
	calculates the normal (non-normalized) of the face sector defined by the angle <(_in_heh,next_halfedge(_in_heh))
Scalar	calc_sector_area (HalfedgeHandle _in_heh) const
	calculates the area of the face sector defined by the angle <(_in_heh,next_halfedge(_in_heh)) NOTE: special cases (e.g. More...
Scalar	calc_dihedral_angle_fast (HalfedgeHandle _heh) const
	calculates the dihedral angle on the halfedge _heh More...
Scalar	calc_dihedral_angle_fast (EdgeHandle _eh) const
	calculates the dihedral angle on the edge _eh More...
Scalar	calc_dihedral_angle (HalfedgeHandle _heh) const
Scalar	calc_dihedral_angle (EdgeHandle _eh) const
unsigned int	find_feature_edges (Scalar _angle_tresh=OpenMesh::deg_to_rad(44.0))
	tags an edge as a feature if its dihedral angle is larger than _angle_tresh returns the number of the found feature edges, requires edge_status property
void	split (FaceHandle _fh, const Point &_p)
	Face split (= 1-to-n split)
void	split (FaceHandle _fh, VertexHandle _vh)
void	split (EdgeHandle _eh, const Point &_p)
void	split (EdgeHandle _eh, VertexHandle _vh)
Normal vector computation
void	update_normals ()
	Compute normals for all primitives. More...
void	update_normal (FaceHandle _fh)
	Update normal for face _fh.
void	update_face_normals ()
	Update normal vectors for all faces. More...
virtual Normal	calc_face_normal (FaceHandle _fh) const
	Calculate normal vector for face _fh. More...
Normal	calc_face_normal (const Point &_p0, const Point &_p1, const Point &_p2) const
	Calculate normal vector for face (_p0, _p1, _p2). More...
Normal	calc_normal (FaceHandle _fh) const
	same as calc_face_normal
void	calc_face_centroid (FaceHandle _fh, Point &_pt) const
	calculates the average of the vertices defining _fh
Point	calc_face_centroid (FaceHandle _fh) const
	Computes and returns the average of the vertices defining _fh.
Point	calc_centroid (FaceHandle _fh) const
	Computes and returns the average of the vertices defining _fh (same as calc_face_centroid)
Point	calc_centroid (EdgeHandle _eh) const
	Computes and returns the average of the vertices defining _eh (same as calc_edge_midpoint)
Point	calc_centroid (HalfedgeHandle _heh) const
	Computes and returns the average of the vertices defining _heh (same as calc_edge_midpoint for edge of halfedge)
Point	calc_centroid (VertexHandle _vh) const
	Returns the point of _vh.
Point	calc_centroid (MeshHandle _mh) const
	Computes and returns the average of the vertices defining the mesh.
void	update_normal (HalfedgeHandle _heh, const double _feature_angle=0.8)
	Update normal for halfedge _heh.
void	update_halfedge_normals (const double _feature_angle=0.8)
	Update normal vectors for all halfedges. More...
virtual Normal	calc_halfedge_normal (HalfedgeHandle _heh, const double _feature_angle=0.8) const
	Calculate halfedge normal for one specific halfedge. More...
Normal	calc_normal (HalfedgeHandle, const double _feature_angle=0.8) const
	same as calc_halfedge_normal
bool	is_estimated_feature_edge (HalfedgeHandle _heh, const double _feature_angle) const
	identifies feature edges w.r.t. More...
void	update_normal (VertexHandle _vh)
	Update normal for vertex _vh.
void	update_vertex_normals ()
	Update normal vectors for all vertices. More...
Normal	calc_vertex_normal (VertexHandle _vh) const
	Calculate vertex normal for one specific vertex. More...
void	calc_vertex_normal_fast (VertexHandle _vh, Normal &_n) const
	Different methods for calculation of the normal at _vh: More...
void	calc_vertex_normal_correct (VertexHandle _vh, Normal &_n) const
	Compute normals for all primitives. More...
void	calc_vertex_normal_loop (VertexHandle _vh, Normal &_n) const
	Compute normals for all primitives. More...
Normal	calc_normal (VertexHandle _vh) const
	same as calc_vertex_normal_correct
enum	{ IsPolyMesh = 1 }
	Determine whether this is a PolyMeshT or TriMeshT (This function does not check the per face vertex count! It only checks if the datatype is PolyMeshT or TriMeshT)
enum	{ IsTriMesh = 0 }
	Determine whether this is a PolyMeshT or TriMeshT (This function does not check the per face vertex count! It only checks if the datatype is PolyMeshT or TriMeshT)
using	ConnectivityTag = PolyConnectivityTag
	Determine whether this is a PolyMeshT or TriMeshT (This function does not check the per face vertex count! It only checks if the datatype is PolyMeshT or TriMeshT)
static constexpr bool	is_polymesh ()
	Determine whether this is a PolyMeshT or TriMeshT (This function does not check the per face vertex count! It only checks if the datatype is PolyMeshT or TriMeshT)
static constexpr bool	is_trimesh ()
	Determine whether this is a PolyMeshT or TriMeshT (This function does not check the per face vertex count! It only checks if the datatype is PolyMeshT or TriMeshT)

Detailed Description

template<class Kernel>
class OpenMesh::PolyMeshT< Kernel >

Base type for a polygonal mesh.

This is the base class for a polygonal mesh. It is parameterized by a mesh kernel that is given as a template argument. This class inherits all methods from its mesh kernel.

Parameters

Kernel

template argument for the mesh kernel

Note

You should use the predefined mesh-kernel combinations in Predefined Mesh Types

See also

Specifying your MyMesh

Member Function Documentation

calc_dihedral_angle_fast() [1/2]

template<class Kernel>

Scalar OpenMesh::PolyMeshT< Kernel >::calc_dihedral_angle_fast ( HalfedgeHandle  _heh ) const

inline

calculates the dihedral angle on the halfedge _heh

Attention

Needs the Attributes::Normal attribute for faces

calc_dihedral_angle_fast() [2/2]

template<class Kernel>

Scalar OpenMesh::PolyMeshT< Kernel >::calc_dihedral_angle_fast ( EdgeHandle  _eh ) const

inline

calculates the dihedral angle on the edge _eh

Attention

Needs the Attributes::Normal attribute for faces

calc_face_normal() [1/2]

template<class Kernel >

PolyMeshT< Kernel >::Normal OpenMesh::PolyMeshT< Kernel >::calc_face_normal ( FaceHandle  _fh ) const

virtual

Calculate normal vector for face _fh.

Reimplemented in OpenMesh::TriMeshT< Kernel >.

calc_face_normal() [2/2]

template<class Kernel >

PolyMeshT< Kernel >::Normal OpenMesh::PolyMeshT< Kernel >::calc_face_normal	(	const Point &	_p0,
		const Point &	_p1,
		const Point &	_p2
	)		const

Calculate normal vector for face (_p0, _p1, _p2).

calc_halfedge_normal()

template<class Kernel >

PolyMeshT< Kernel >::Normal OpenMesh::PolyMeshT< Kernel >::calc_halfedge_normal ( HalfedgeHandle  _heh, const double  _feature_angle = 0.8  ) const

virtual

Calculate halfedge normal for one specific halfedge.

Calculate normal vector for halfedge _heh.

Note

Face normals have to be computed first!

Attention

Needs the Attributes::Normal attribute for faces and vertices. Call request_face_normals() and request_halfedge_normals() before using it!

Parameters

_heh	Handle of the halfedge
_feature_angle	If the dihedral angle across this edge is greater than this value, the edge is considered as a feature edge (angle in radians)

calc_sector_angle()

template<class Kernel>

Scalar OpenMesh::PolyMeshT< Kernel >::calc_sector_angle ( HalfedgeHandle  _in_heh ) const

inline

calculates the sector angle.

The vertex pointed by _in_heh defines the sector center The angle will be calculated between the given halfedge and the next halfedge.
Seen from the center vertex this will be the next halfedge in clockwise direction.
NOTE: only boundary concave sectors are treated correctly

calc_sector_area()

template<class Kernel>

Scalar OpenMesh::PolyMeshT< Kernel >::calc_sector_area ( HalfedgeHandle  _in_heh ) const

inline

calculates the area of the face sector defined by the angle <(_in_heh,next_halfedge(_in_heh)) NOTE: special cases (e.g.

concave sectors) are not handled correctly

calc_sector_vectors()

template<class Kernel>

void OpenMesh::PolyMeshT< Kernel >::calc_sector_vectors ( HalfedgeHandle  _in_heh, Normal &  _vec0, Normal &  _vec1  ) const

inline

defines a consistent representation of a sector geometry: the halfedge _in_heh defines the sector orientation the vertex pointed by _in_heh defines the sector center _vec0 and _vec1 are resp.

the first and the second vectors defining the sector

calc_vertex_normal()

template<class Kernel >

PolyMeshT< Kernel >::Normal OpenMesh::PolyMeshT< Kernel >::calc_vertex_normal

(

VertexHandle

_vh

)

const

Calculate vertex normal for one specific vertex.

Calculate normal vector for vertex _vh by averaging normals of adjacent faces.

Note

Face normals have to be computed first!

Attention

Needs the Attributes::Normal attribute for faces and vertices. Call request_face_normals() and request_vertex_normals() before using it!

Parameters

_vh	Handle of the vertex

calc_vertex_normal_correct()

template<class Kernel >

void OpenMesh::PolyMeshT< Kernel >::calc_vertex_normal_correct	(	VertexHandle	_vh,
		Normal &	_n
	)		const

Compute normals for all primitives.

Calls update_face_normals() , update_halfedge_normals() and update_vertex_normals() if the normals (i.e. the properties) exist.

Note

Face normals are required to compute vertex and halfedge normals!

calc_vertex_normal_fast()

template<class Kernel >

void OpenMesh::PolyMeshT< Kernel >::calc_vertex_normal_fast	(	VertexHandle	_vh,
		Normal &	_n
	)		const

Different methods for calculation of the normal at _vh:

• ..._fast - the default one - the same as calc vertex_normal()
  • needs the Attributes::Normal attribute for faces
• ..._correct - works properly for non-triangular meshes
  • does not need any attributes
• ..._loop - calculates loop surface normals
  • does not need any attributes

calc_vertex_normal_loop()

template<class Kernel >

void OpenMesh::PolyMeshT< Kernel >::calc_vertex_normal_loop	(	VertexHandle	_vh,
		Normal &	_n
	)		const

Compute normals for all primitives.

Calls update_face_normals() , update_halfedge_normals() and update_vertex_normals() if the normals (i.e. the properties) exist.

Note

Face normals are required to compute vertex and halfedge normals!

is_estimated_feature_edge()

template<class Kernel >

bool OpenMesh::PolyMeshT< Kernel >::is_estimated_feature_edge	(	HalfedgeHandle	_heh,
		const double	_feature_angle
	)		const

identifies feature edges w.r.t.

the minimal dihedral angle for feature edges (in radians) and the status feature tag

new_vertex() [1/2]

template<class Kernel>

SmartVertexHandle OpenMesh::PolyMeshT< Kernel >::new_vertex ( )

inline

Uses default copy and assignment operator.

Use them to assign two meshes of equal type. If the mesh types vary, use PolyMeshT::assign() instead. Adds a new default-initialized vertex.

See also

new_vertex(const Point&), new_vertex_dirty()

new_vertex() [2/2]

template<class Kernel>

SmartVertexHandle OpenMesh::PolyMeshT< Kernel >::new_vertex ( const Point &  _p )

inline

Adds a new vertex initialized to a custom position.

See also

new_vertex(), new_vertex_dirty()

new_vertex_dirty()

template<class Kernel>

SmartVertexHandle OpenMesh::PolyMeshT< Kernel >::new_vertex_dirty ( const Point &  _p )

inline

Same as new_vertex(const Point&) but never shrinks, only enlarges the vertex property vectors.

If you are rebuilding a mesh that you erased with ArrayKernel::clean() or ArrayKernel::clean_keep_reservation() using this method instead of new_vertex(const Point &) saves reallocation and reinitialization of property memory.

See also

new_vertex(const Point &)

update_face_normals()

template<class Kernel >

void OpenMesh::PolyMeshT< Kernel >::update_face_normals

(

)

Update normal vectors for all faces.

Attention

Needs the Attributes::Normal attribute for faces. Call request_face_normals() before using it!

update_halfedge_normals()

template<class Kernel >

void OpenMesh::PolyMeshT< Kernel >::update_halfedge_normals

(

const double

_feature_angle = 0.8

)

Update normal vectors for all halfedges.

Uses the existing face normals to compute halfedge normals

Note

Face normals have to be computed first!

Attention

Needs the Attributes::Normal attribute for faces and halfedges. Call request_face_normals() and request_halfedge_normals() before using it!

update_normals()

template<class Kernel >

void OpenMesh::PolyMeshT< Kernel >::update_normals

(

)

Compute normals for all primitives.

Calls update_face_normals() , update_halfedge_normals() and update_vertex_normals() if the normals (i.e. the properties) exist.

Note

Face normals are required to compute vertex and halfedge normals!

update_vertex_normals()

template<class Kernel >

void OpenMesh::PolyMeshT< Kernel >::update_vertex_normals

(

)

Update normal vectors for all vertices.

Uses existing face normals to calculate new vertex normals.

Note

Face normals have to be computed first!

Attention

Needs the Attributes::Normal attribute for faces and vertices. Call request_face_normals() and request_vertex_normals() before using it!

---

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

• OpenMesh/Core/Mesh/PolyMeshT.hh
• OpenMesh/Core/Mesh/PolyMeshT_impl.hh