Public Types | Public Member Functions | Private Attributes | Friends
pcl::geometry::HalfEdgeIndex Class Reference

Index used to access elements in the half-edge mesh. It is basically just a wrapper around an integer with a few added methods. More...

#include <mesh_indices.h>

List of all members.

Public Types

typedef boost::totally_ordered
< pcl::geometry::HalfEdgeIndex,
boost::unit_steppable
< pcl::geometry::HalfEdgeIndex,
boost::additive
< pcl::geometry::HalfEdgeIndex > > > 
Base
typedef
pcl::geometry::HalfEdgeIndex 
Self

Public Member Functions

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

Private Attributes

int index_
 Stored index.

Friends

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

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 201 of file mesh_indices.h.


Member Typedef Documentation

typedef boost::totally_ordered<pcl::geometry::HalfEdgeIndex, boost::unit_steppable <pcl::geometry::HalfEdgeIndex, boost::additive <pcl::geometry::HalfEdgeIndex> > > pcl::geometry::HalfEdgeIndex::Base

Definition at line 211 of file mesh_indices.h.

Definition at line 212 of file mesh_indices.h.


Constructor & Destructor Documentation

Constructor. Initializes with an invalid index.

Definition at line 215 of file mesh_indices.h.

pcl::geometry::HalfEdgeIndex::HalfEdgeIndex ( const int  index) [inline, explicit]

Constructor.

Parameters:
[in]indexThe integer index.

Definition at line 223 of file mesh_indices.h.


Member Function Documentation

int pcl::geometry::HalfEdgeIndex::get ( ) const [inline]

Get the index.

Definition at line 244 of file mesh_indices.h.

Invalidate the index.

Definition at line 237 of file mesh_indices.h.

bool pcl::geometry::HalfEdgeIndex::isValid ( ) const [inline]

Returns true if the index is valid.

Definition at line 230 of file mesh_indices.h.

Self& pcl::geometry::HalfEdgeIndex::operator++ ( ) [inline]

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

Definition at line 272 of file mesh_indices.h.

Self& pcl::geometry::HalfEdgeIndex::operator+= ( const Self other) [inline]

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

Definition at line 288 of file mesh_indices.h.

Self& pcl::geometry::HalfEdgeIndex::operator-- ( ) [inline]

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

Definition at line 280 of file mesh_indices.h.

Self& pcl::geometry::HalfEdgeIndex::operator-= ( const Self other) [inline]

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

Definition at line 296 of file mesh_indices.h.

bool pcl::geometry::HalfEdgeIndex::operator< ( const Self other) const [inline]

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

Definition at line 258 of file mesh_indices.h.

bool pcl::geometry::HalfEdgeIndex::operator== ( const Self other) const [inline]

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

Definition at line 265 of file mesh_indices.h.

void pcl::geometry::HalfEdgeIndex::set ( const int  index) [inline]

Set the index.

Definition at line 251 of file mesh_indices.h.


Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  is,
pcl::geometry::HalfEdgeIndex index 
) [friend]

istream operator.

Definition at line 320 of file mesh_indices.h.


Member Data Documentation

Stored index.

Definition at line 305 of file mesh_indices.h.


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


pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:43:55