GitHub link
Polygon Mesh Processing Library
SurfaceMesh::VertexAroundFaceCirculator Class Reference

this class circulates through the vertices of a face. More...

#include <pmp/SurfaceMesh.h>

Public Member Functions

 VertexAroundFaceCirculator (const SurfaceMesh *m=nullptr, Face f=Face())
 default constructor More...
 
bool operator== (const VertexAroundFaceCirculator &rhs) const
 are two circulators equal? More...
 
bool operator!= (const VertexAroundFaceCirculator &rhs) const
 are two circulators different? More...
 
VertexAroundFaceCirculatoroperator++ ()
 pre-increment (rotates counter-clockwise) More...
 
VertexAroundFaceCirculator operator++ (int)
 post-increment (rotate counter-clockwise) More...
 
VertexAroundFaceCirculatoroperator-- ()
 pre-decrement (rotates clockwise) More...
 
VertexAroundFaceCirculator operator-- (int)
 post-decrement (rotate clockwise) More...
 
Vertex operator* () const
 get the vertex the circulator refers to More...
 

Detailed Description

this class circulates through the vertices of a face.

it also acts as a container-concept for C++11 range-based for loops.

See also
HalfedgeAroundFaceCirculator, vertices(Face)

Constructor & Destructor Documentation

◆ VertexAroundFaceCirculator()

VertexAroundFaceCirculator ( const SurfaceMesh m = nullptr,
Face  f = Face() 
)
inline

default constructor

Member Function Documentation

◆ operator!=()

bool operator!= ( const VertexAroundFaceCirculator rhs) const
inline

are two circulators different?

◆ operator*()

Vertex operator* ( ) const
inline

get the vertex the circulator refers to

◆ operator++() [1/2]

VertexAroundFaceCirculator & operator++ ( )
inline

pre-increment (rotates counter-clockwise)

◆ operator++() [2/2]

VertexAroundFaceCirculator operator++ ( int  )
inline

post-increment (rotate counter-clockwise)

◆ operator--() [1/2]

VertexAroundFaceCirculator & operator-- ( )
inline

pre-decrement (rotates clockwise)

◆ operator--() [2/2]

VertexAroundFaceCirculator operator-- ( int  )
inline

post-decrement (rotate clockwise)

◆ operator==()

bool operator== ( const VertexAroundFaceCirculator rhs) const
inline

are two circulators equal?