Developer Documentation
OpenMesh::SmartFaceHandle Struct Reference
Inheritance diagram for OpenMesh::SmartFaceHandle:
OpenMesh::SmartBaseHandle OpenMesh::FaceHandle OpenMesh::SmartHandleStatusPredicates< SmartFaceHandle > OpenMesh::SmartHandleBoundaryPredicate< SmartFaceHandle > OpenMesh::BaseHandle

Public Member Functions

 SmartFaceHandle (int _idx=-1, const PolyConnectivity *_mesh=nullptr)
 
SmartHalfedgeHandle halfedge () const
 Returns one of the halfedges of the face. More...
 
PolyConnectivity::ConstFaceVertexRange vertices () const
 Returns a range of vertices incident to the face (PolyConnectivity::fv_range()) More...
 
PolyConnectivity::ConstFaceVertexCWRange vertices_cw () const
 Returns a range of vertices incident to the face (PolyConnectivity::fv_cw_range()) More...
 
PolyConnectivity::ConstFaceVertexCCWRange vertices_ccw () const
 Returns a range of vertices incident to the face (PolyConnectivity::fv_ccw_range()) More...
 
PolyConnectivity::ConstFaceHalfedgeRange halfedges () const
 Returns a range of halfedges of the face (PolyConnectivity::fh_range()) More...
 
PolyConnectivity::ConstFaceHalfedgeCWRange halfedges_cw () const
 Returns a range of halfedges of the face (PolyConnectivity::fh_cw_range()) More...
 
PolyConnectivity::ConstFaceHalfedgeCCWRange halfedges_ccw () const
 Returns a range of halfedges of the face (PolyConnectivity::fh_ccw_range()) More...
 
PolyConnectivity::ConstFaceEdgeRange edges () const
 Returns a range of edges of the face (PolyConnectivity::fv_range()) More...
 
PolyConnectivity::ConstFaceEdgeCWRange edges_cw () const
 Returns a range of edges of the face (PolyConnectivity::fv_cw_range()) More...
 
PolyConnectivity::ConstFaceEdgeCCWRange edges_ccw () const
 Returns a range of edges of the face (PolyConnectivity::fv_ccw_range()) More...
 
PolyConnectivity::ConstFaceFaceRange faces () const
 Returns a range adjacent faces of the face (PolyConnectivity::ff_range()) More...
 
PolyConnectivity::ConstFaceFaceCWRange faces_cw () const
 Returns a range adjacent faces of the face (PolyConnectivity::ff_cw_range()) More...
 
PolyConnectivity::ConstFaceFaceCCWRange faces_ccw () const
 Returns a range adjacent faces of the face (PolyConnectivity::ff_ccw_range()) More...
 
uint valence () const
 Returns the valence of the face. More...
 
- Public Member Functions inherited from OpenMesh::SmartBaseHandle
 SmartBaseHandle (const PolyConnectivity *_mesh=nullptr)
 
const PolyConnectivitymesh () const
 Get the underlying mesh of this handle. More...
 
- Public Member Functions inherited from OpenMesh::FaceHandle
 FaceHandle (int _idx=-1)
 
- Public Member Functions inherited from OpenMesh::BaseHandle
 BaseHandle (int _idx=-1)
 
int idx () const
 Get the underlying index of this handle. More...
 
bool is_valid () const
 The handle is valid iff the index is not negative. More...
 
void reset ()
 reset handle to be invalid More...
 
void invalidate ()
 reset handle to be invalid More...
 
bool operator== (const BaseHandle &_rhs) const
 
bool operator!= (const BaseHandle &_rhs) const
 
bool operator< (const BaseHandle &_rhs) const
 
void __increment ()
 
void __decrement ()
 
void __increment (int amount)
 
void __decrement (int amount)
 
- Public Member Functions inherited from OpenMesh::SmartHandleStatusPredicates< SmartFaceHandle >
bool feature () const
 Returns true iff the handle is marked as feature. More...
 
bool selected () const
 Returns true iff the handle is marked as selected. More...
 
bool tagged () const
 Returns true iff the handle is marked as tagged. More...
 
bool tagged2 () const
 Returns true iff the handle is marked as tagged2. More...
 
bool locked () const
 Returns true iff the handle is marked as locked. More...
 
bool hidden () const
 Returns true iff the handle is marked as hidden. More...
 
bool deleted () const
 Returns true iff the handle is marked as deleted. More...
 
- Public Member Functions inherited from OpenMesh::SmartHandleBoundaryPredicate< SmartFaceHandle >
bool is_boundary () const
 Returns true iff the handle is boundary. More...
 

Detailed Description

Definition at line 227 of file SmartHandles.hh.

Constructor & Destructor Documentation

◆ SmartFaceHandle()

OpenMesh::SmartFaceHandle::SmartFaceHandle ( int  _idx = -1,
const PolyConnectivity _mesh = nullptr 
)
inlineexplicit

Definition at line 229 of file SmartHandles.hh.

Member Function Documentation

◆ edges()

PolyConnectivity::ConstFaceEdgeRange OpenMesh::SmartFaceHandle::edges ( ) const
inline

Returns a range of edges of the face (PolyConnectivity::fv_range())

Definition at line 1014 of file PolyConnectivity_inline_impl.hh.

◆ edges_ccw()

PolyConnectivity::ConstFaceEdgeCCWRange OpenMesh::SmartFaceHandle::edges_ccw ( ) const
inline

Returns a range of edges of the face (PolyConnectivity::fv_ccw_range())

Definition at line 1016 of file PolyConnectivity_inline_impl.hh.

◆ edges_cw()

PolyConnectivity::ConstFaceEdgeCWRange OpenMesh::SmartFaceHandle::edges_cw ( ) const
inline

Returns a range of edges of the face (PolyConnectivity::fv_cw_range())

Definition at line 1015 of file PolyConnectivity_inline_impl.hh.

◆ faces()

PolyConnectivity::ConstFaceFaceRange OpenMesh::SmartFaceHandle::faces ( ) const
inline

Returns a range adjacent faces of the face (PolyConnectivity::ff_range())

Definition at line 1018 of file PolyConnectivity_inline_impl.hh.

◆ faces_ccw()

PolyConnectivity::ConstFaceFaceCCWRange OpenMesh::SmartFaceHandle::faces_ccw ( ) const
inline

Returns a range adjacent faces of the face (PolyConnectivity::ff_ccw_range())

Definition at line 1020 of file PolyConnectivity_inline_impl.hh.

◆ faces_cw()

PolyConnectivity::ConstFaceFaceCWRange OpenMesh::SmartFaceHandle::faces_cw ( ) const
inline

Returns a range adjacent faces of the face (PolyConnectivity::ff_cw_range())

Definition at line 1019 of file PolyConnectivity_inline_impl.hh.

◆ halfedge()

SmartHalfedgeHandle OpenMesh::SmartFaceHandle::halfedge ( ) const
inline

Returns one of the halfedges of the face.

Definition at line 468 of file SmartHandles.hh.

◆ halfedges()

PolyConnectivity::ConstFaceHalfedgeRange OpenMesh::SmartFaceHandle::halfedges ( ) const
inline

Returns a range of halfedges of the face (PolyConnectivity::fh_range())

Definition at line 1010 of file PolyConnectivity_inline_impl.hh.

◆ halfedges_ccw()

PolyConnectivity::ConstFaceHalfedgeCCWRange OpenMesh::SmartFaceHandle::halfedges_ccw ( ) const
inline

Returns a range of halfedges of the face (PolyConnectivity::fh_ccw_range())

Definition at line 1012 of file PolyConnectivity_inline_impl.hh.

◆ halfedges_cw()

PolyConnectivity::ConstFaceHalfedgeCWRange OpenMesh::SmartFaceHandle::halfedges_cw ( ) const
inline

Returns a range of halfedges of the face (PolyConnectivity::fh_cw_range())

Definition at line 1011 of file PolyConnectivity_inline_impl.hh.

◆ valence()

uint OpenMesh::SmartFaceHandle::valence ( ) const
inline

Returns the valence of the face.

Definition at line 474 of file SmartHandles.hh.

◆ vertices()

PolyConnectivity::ConstFaceVertexRange OpenMesh::SmartFaceHandle::vertices ( ) const
inline

Returns a range of vertices incident to the face (PolyConnectivity::fv_range())

Definition at line 1006 of file PolyConnectivity_inline_impl.hh.

◆ vertices_ccw()

PolyConnectivity::ConstFaceVertexCCWRange OpenMesh::SmartFaceHandle::vertices_ccw ( ) const
inline

Returns a range of vertices incident to the face (PolyConnectivity::fv_ccw_range())

Definition at line 1008 of file PolyConnectivity_inline_impl.hh.

◆ vertices_cw()

PolyConnectivity::ConstFaceVertexCWRange OpenMesh::SmartFaceHandle::vertices_cw ( ) const
inline

Returns a range of vertices incident to the face (PolyConnectivity::fv_cw_range())

Definition at line 1007 of file PolyConnectivity_inline_impl.hh.


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