pcl::geometry::EdgeIndex Class Reference

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

#include <pcl/geometry/mesh_indices.h>

Inheritance diagram for pcl::geometry::EdgeIndex:

Public Types
typedef boost::totally_ordered < pcl::geometry::EdgeIndex, boost::unit_steppable < pcl::geometry::EdgeIndex, boost::additive < pcl::geometry::EdgeIndex > > >	Base
typedef pcl::geometry::EdgeIndex	Self

Public Member Functions
	EdgeIndex ()
	Constructor. More...
	EdgeIndex (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...
Self &	operator++ ()
	Increment operators (with boost::operators): ++ (pre and post) More...
Self &	operator-- ()
	Decrement operators (with boost::operators): -- (pre and post) More...
Self &	operator+= (const Self &other)
	Addition operators (with boost::operators): + +=. More...
Self &	operator-= (const Self &other)
	Subtraction operators (with boost::operators): - -=. More...

Friends
std::istream &	operator>> (std::istream &is, pcl::geometry::EdgeIndex &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 340 of file mesh_indices.h.

Member Typedef Documentation

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

Definition at line 350 of file mesh_indices.h.

typedef pcl::geometry::EdgeIndex pcl::geometry::EdgeIndex::Self

Definition at line 351 of file mesh_indices.h.

Constructor & Destructor Documentation

pcl::geometry::EdgeIndex::EdgeIndex ( )

inline

Constructor.

Initializes with an invalid index.

Definition at line 354 of file mesh_indices.h.

pcl::geometry::EdgeIndex::EdgeIndex ( const int  index)

inlineexplicit

Constructor.

Parameters

[in]

index

The integer index.

Definition at line 362 of file mesh_indices.h.

Member Function Documentation

int pcl::geometry::EdgeIndex::get ( ) const

inline

Get the index.

Definition at line 383 of file mesh_indices.h.

Referenced by pcl::geometry::getBoundBoundaryHalfEdges(), operator+=(), operator-=(), operator<(), pcl::geometry::operator<<(), operator==(), and pcl::geometry::toHalfEdgeIndex().

void pcl::geometry::EdgeIndex::invalidate ( )

inline

Invalidate the index.

Definition at line 376 of file mesh_indices.h.

bool pcl::geometry::EdgeIndex::isValid ( ) const

inline

Returns true if the index is valid.

Definition at line 369 of file mesh_indices.h.

Referenced by pcl::geometry::toHalfEdgeIndex().

Self& pcl::geometry::EdgeIndex::operator++ ( )

inline

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

Definition at line 411 of file mesh_indices.h.

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

inline

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

Definition at line 427 of file mesh_indices.h.

References get().

Self& pcl::geometry::EdgeIndex::operator-- ( )

inline

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

Definition at line 419 of file mesh_indices.h.

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

inline

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

Definition at line 435 of file mesh_indices.h.

References get().

bool pcl::geometry::EdgeIndex::operator< ( const Self &  other) const

inline

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

Definition at line 397 of file mesh_indices.h.

References get().

bool pcl::geometry::EdgeIndex::operator== ( const Self &  other) const

inline

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

Definition at line 404 of file mesh_indices.h.

References get().

void pcl::geometry::EdgeIndex::set ( const int  index)

inline

Set the index.

Definition at line 390 of file mesh_indices.h.

Friends And Related Function Documentation

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

friend

istream operator.

Definition at line 459 of file mesh_indices.h.

---

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

• /root/pcl/geometry/include/pcl/geometry/mesh_indices.h