SurfaceMesh::FaceAroundVertexCirculator Class Reference

#include <surface_mesh.h>

Public Member Functions
	FaceAroundVertexCirculator (const SurfaceMesh *m=nullptr, Vertex v=Vertex())
	Default constructor.
bool	operator== (const FaceAroundVertexCirculator &rhs) const
	Equality operator.
bool	operator!= (const FaceAroundVertexCirculator &rhs) const
	Inequality operator.
FaceAroundVertexCirculator &	operator++ ()
	Pre-increment operator (rotate counter-clockwise).
FaceAroundVertexCirculator &	operator-- ()
	Pre-decrement operator (rotate clockwise).
Face	operator* () const
	Get the face the circulator refers to.
	operator bool () const
	Cast to bool: true if vertex is not isolated.
FaceAroundVertexCirculator &	begin ()
	Helper for C++11 range-based for-loops.
FaceAroundVertexCirculator &	end ()
	Helper for C++11 range-based for-loops.

Detailed Description

This class circulates through all incident faces of a vertex. It also acts as a container-concept for C++11 range-based for loops.

The follow code shows how to use FaceAroundVertexCirculator:

SurfaceMesh::FaceAroundVertexCirculator cir(mesh, v);
SurfaceMesh::FaceAroundVertexCirculator end = cir;
do {
    SurfaceMesh::Face f = *cir;
    // do something with f
    ++cir;
} while (cir != end);

See also

VertexAroundVertexCirculator, HalfedgeAroundVertexCirculator, faces()

Examples

Tutorial_105_SurfaceMesh_Connectivity/main.cpp.

Constructor & Destructor Documentation

FaceAroundVertexCirculator()

FaceAroundVertexCirculator ( const SurfaceMesh *  m = nullptr, Vertex  v = Vertex()  )

inlineexplicit

Default constructor.

Parameters

m	The surface mesh.
v	The vertex (should not be isolated).

Member Function Documentation

begin()

FaceAroundVertexCirculator & begin ( )

inline

Helper for C++11 range-based for-loops.

Returns

Reference to the beginning circulator.

end()

FaceAroundVertexCirculator & end ( )

inline

Helper for C++11 range-based for-loops.

Returns

Reference to the ending circulator.

operator bool()

operator bool ( ) const

inline

Cast to bool: true if vertex is not isolated.

Returns

True if the vertex is not isolated, false otherwise.

operator!=()

bool operator!= ( const FaceAroundVertexCirculator &  rhs ) const

inline

Inequality operator.

Parameters

rhs	The other circulator to compare with.

Returns

True if the circulators are different, false otherwise.

operator*()

Face operator* ( ) const

inline

Get the face the circulator refers to.

Returns

The face.

operator++()

FaceAroundVertexCirculator & operator++ ( )

inline

Pre-increment operator (rotate counter-clockwise).

Returns

Reference to the incremented circulator.

operator--()

FaceAroundVertexCirculator & operator-- ( )

inline

Pre-decrement operator (rotate clockwise).

Returns

Reference to the decremented circulator.

operator==()

bool operator== ( const FaceAroundVertexCirculator &  rhs ) const

inline

Equality operator.

Parameters

rhs	The other circulator to compare with.

Returns

True if the circulators are equal, false otherwise.

---

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

• easy3d/core/surface_mesh.h