Developer Documentation
Loading...
Searching...
No Matches
OpenMesh::BaseHandle Class Reference

Base class for all handle types. More...

#include <OpenFlipper/libs_required/OpenMesh/src/OpenMesh/Core/Mesh/Handles.hh>

Inheritance diagram for OpenMesh::BaseHandle:
OpenMesh::BasePropHandleT< typename Mesh::Point > OpenMesh::BasePropHandleT< OpenMesh::Geometry::QuadricT< double > > OpenMesh::BasePropHandleT< unsigned int > OpenMesh::BasePropHandleT< bool > OpenMesh::BasePropHandleT< float > OpenMesh::BasePropHandleT< Points > OpenMesh::BasePropHandleT< OpenMesh::NormalConeT > OpenMesh::BasePropHandleT< Scalar > OpenMesh::BasePropHandleT< level_t > OpenMesh::BasePropHandleT< StatusInfo > OpenMesh::BasePropHandleT< Point > OpenMesh::BasePropHandleT< Normal > OpenMesh::BasePropHandleT< Color > OpenMesh::BasePropHandleT< TexCoord1D > OpenMesh::BasePropHandleT< TexCoord2D > OpenMesh::BasePropHandleT< TexCoord3D > OpenMesh::BasePropHandleT< TextureIndex > OpenMesh::BasePropHandleT< VertexData > OpenMesh::BasePropHandleT< HalfedgeData > OpenMesh::BasePropHandleT< EdgeData > OpenMesh::BasePropHandleT< FaceData > OpenMesh::BasePropHandleT< HalfedgeHandle > OpenMesh::BasePropHandleT< int > OpenMesh::BasePropHandleT< size_t > OpenMesh::BasePropHandleT< TexCoord > OpenMesh::BasePropHandleT< OpenMesh::Attributes::StatusInfo > OpenMesh::BasePropHandleT< typename Mesh::Normal > OpenMesh::BasePropHandleT< NormalType > OpenMesh::BasePropHandleT< double > OpenMesh::BasePropHandleT< typename MeshType::VertexHandle > OpenMesh::BasePropHandleT< std::pair< typename MeshType::VertexHandle, typename MeshType::VertexHandle > > OpenMesh::BasePropHandleT< typename mesh_t::Point > OpenMesh::BasePropHandleT< typename MeshType::Point > OpenMesh::BasePropHandleT< typename MeshT::Scalar > OpenMesh::BasePropHandleT< T > OpenMesh::EdgeHandle OpenMesh::FaceHandle OpenMesh::HalfedgeHandle OpenMesh::MeshHandle OpenMesh::Subdivider::Adaptive::RuleHandleT< R > OpenMesh::VDPM::VHierarchyNodeHandle OpenMesh::VertexHandle

Public Member Functions

 BaseHandle (int _idx=-1)
 
int idx () const
 Get the underlying index of this handle.
 
bool is_valid () const
 The handle is valid iff the index is not negative.
 
void reset ()
 reset handle to be invalid
 
void invalidate ()
 reset handle to be invalid
 
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)
 

Private Attributes

int idx_
 

Detailed Description

Base class for all handle types.

Definition at line 62 of file Handles.hh.

Constructor & Destructor Documentation

◆ BaseHandle()

OpenMesh::BaseHandle::BaseHandle ( int  _idx = -1)
inlineexplicit

Definition at line 66 of file Handles.hh.

Member Function Documentation

◆ __decrement() [1/2]

void OpenMesh::BaseHandle::__decrement ( )
inline

Definition at line 94 of file Handles.hh.

◆ __decrement() [2/2]

void OpenMesh::BaseHandle::__decrement ( int  amount)
inline

Definition at line 97 of file Handles.hh.

◆ __increment() [1/2]

void OpenMesh::BaseHandle::__increment ( )
inline

Definition at line 93 of file Handles.hh.

◆ __increment() [2/2]

void OpenMesh::BaseHandle::__increment ( int  amount)
inline

Definition at line 96 of file Handles.hh.

◆ idx()

int OpenMesh::BaseHandle::idx ( ) const
inline

Get the underlying index of this handle.

Definition at line 69 of file Handles.hh.

◆ invalidate()

void OpenMesh::BaseHandle::invalidate ( )
inline

reset handle to be invalid

Definition at line 77 of file Handles.hh.

◆ is_valid()

bool OpenMesh::BaseHandle::is_valid ( ) const
inline

The handle is valid iff the index is not negative.

Definition at line 72 of file Handles.hh.

◆ operator!=()

bool OpenMesh::BaseHandle::operator!= ( const BaseHandle _rhs) const
inline

Definition at line 83 of file Handles.hh.

◆ operator<()

bool OpenMesh::BaseHandle::operator< ( const BaseHandle _rhs) const
inline

Definition at line 87 of file Handles.hh.

◆ operator==()

bool OpenMesh::BaseHandle::operator== ( const BaseHandle _rhs) const
inline

Definition at line 79 of file Handles.hh.

◆ reset()

void OpenMesh::BaseHandle::reset ( )
inline

reset handle to be invalid

Definition at line 75 of file Handles.hh.

Member Data Documentation

◆ idx_

int OpenMesh::BaseHandle::idx_
private

Definition at line 101 of file Handles.hh.


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