Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Types | Public Member Functions | Friends
pcl::geometry::FaceIndex Class Reference

Index used to access elements in the half-edge mesh. More...

#include <pcl/geometry/mesh_indices.h>

+ Inheritance diagram for pcl::geometry::FaceIndex:

Public Types

using Base = boost::totally_ordered< pcl::geometry::FaceIndex, boost::unit_steppable< pcl::geometry::FaceIndex, boost::additive< pcl::geometry::FaceIndex > > >
 
using Self = pcl::geometry::FaceIndex
 

Public Member Functions

 FaceIndex ()
 Constructor. More...
 
 FaceIndex (const int index)
 Constructor. More...
 
bool isValid () const
 Returns true if the index is valid. More...
 
void invalidate ()
 Invalidate the index. More...
 
int get () const
 Get the index. More...
 
void set (const int index)
 Set the index. More...
 
bool operator< (const Self &other) const
 Comparison operators (with boost::operators): < > <= >=. More...
 
bool operator== (const Self &other) const
 Comparison operators (with boost::operators): == !=. More...
 
Selfoperator++ ()
 Increment operators (with boost::operators): ++ (pre and post) More...
 
Selfoperator-- ()
 Decrement operators (with boost::operators): -- (pre and post) More...
 
Selfoperator+= (const Self &other)
 Addition operators (with boost::operators): + +=. More...
 
Selfoperator-= (const Self &other)
 Subtraction operators (with boost::operators): - -=. More...
 

Friends

std::istream & operator>> (std::istream &is, pcl::geometry::FaceIndex &index)
 istream operator. More...
 

Detailed Description

Index used to access elements in the half-edge mesh.

It is basically just a wrapper around an integer with a few added methods.

Author
Martin Saelzle

Definition at line 478 of file mesh_indices.h.

Member Typedef Documentation

◆ Base

using pcl::geometry::FaceIndex::Base = boost::totally_ordered <pcl::geometry::FaceIndex, boost::unit_steppable <pcl::geometry::FaceIndex, boost::additive <pcl::geometry::FaceIndex> > >

Definition at line 488 of file mesh_indices.h.

◆ Self

Definition at line 489 of file mesh_indices.h.

Constructor & Destructor Documentation

◆ FaceIndex() [1/2]

pcl::geometry::FaceIndex::FaceIndex ( )
inline

Constructor.

Initializes with an invalid index.

Definition at line 492 of file mesh_indices.h.

◆ FaceIndex() [2/2]

pcl::geometry::FaceIndex::FaceIndex ( const int  index)
inlineexplicit

Constructor.

Parameters
[in]indexThe integer index.

Definition at line 500 of file mesh_indices.h.

Member Function Documentation

◆ get()

int pcl::geometry::FaceIndex::get ( ) const
inline

◆ invalidate()

void pcl::geometry::FaceIndex::invalidate ( )
inline

Invalidate the index.

Definition at line 514 of file mesh_indices.h.

◆ isValid()

bool pcl::geometry::FaceIndex::isValid ( ) const
inline

Returns true if the index is valid.

Definition at line 507 of file mesh_indices.h.

◆ operator++()

Self& pcl::geometry::FaceIndex::operator++ ( )
inline

Increment operators (with boost::operators): ++ (pre and post)

Definition at line 549 of file mesh_indices.h.

◆ operator+=()

Self& pcl::geometry::FaceIndex::operator+= ( const Self other)
inline

Addition operators (with boost::operators): + +=.

Definition at line 565 of file mesh_indices.h.

References get().

◆ operator--()

Self& pcl::geometry::FaceIndex::operator-- ( )
inline

Decrement operators (with boost::operators): -- (pre and post)

Definition at line 557 of file mesh_indices.h.

◆ operator-=()

Self& pcl::geometry::FaceIndex::operator-= ( const Self other)
inline

Subtraction operators (with boost::operators): - -=.

Definition at line 573 of file mesh_indices.h.

References get(), and pcl::geometry::VertexIndex::operator>>.

◆ operator<()

bool pcl::geometry::FaceIndex::operator< ( const Self other) const
inline

Comparison operators (with boost::operators): < > <= >=.

Definition at line 535 of file mesh_indices.h.

References get().

◆ operator==()

bool pcl::geometry::FaceIndex::operator== ( const Self other) const
inline

Comparison operators (with boost::operators): == !=.

Definition at line 542 of file mesh_indices.h.

References get().

◆ set()

void pcl::geometry::FaceIndex::set ( const int  index)
inline

Set the index.

Definition at line 528 of file mesh_indices.h.

Friends And Related Function Documentation

◆ operator>>

std::istream& operator>> ( std::istream &  is,
pcl::geometry::FaceIndex index 
)
friend

istream operator.

Definition at line 597 of file mesh_indices.h.


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