SurfaceMesh::HalfedgeAroundFaceCirculator Class Reference

#include <surface_mesh.h>

Public Member Functions
	HalfedgeAroundFaceCirculator (const SurfaceMesh *m=nullptr, Face f=Face())
	Default constructor.
bool	operator== (const HalfedgeAroundFaceCirculator &rhs) const
	Equality operator.
bool	operator!= (const HalfedgeAroundFaceCirculator &rhs) const
	Inequality operator.
HalfedgeAroundFaceCirculator &	operator++ ()
	Pre-increment operator (rotate counter-clockwise).
HalfedgeAroundFaceCirculator &	operator-- ()
	Pre-decrement operator (rotate clockwise).
Halfedge	operator* () const
	Get the halfedge the circulator refers to.
HalfedgeAroundFaceCirculator &	begin ()
	Helper for C++11 range-based for-loops.
HalfedgeAroundFaceCirculator &	end ()
	Helper for C++11 range-based for-loops.

Detailed Description

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

The following code shows how to use HalfedgeAroundFaceCirculator:

SurfaceMesh::HalfedgeAroundFaceCirculator cir(mesh, f);
SurfaceMesh::HalfedgeAroundFaceCirculator end = cir;
do {
    SurfaceMesh::Halfedge h = *cir;
    // do something with h
    ++cir;
} while (cir != end);

See also

VertexAroundFaceCirculator, halfedges()

Examples

Tutorial_105_SurfaceMesh_Connectivity/main.cpp.

Constructor & Destructor Documentation

HalfedgeAroundFaceCirculator()

HalfedgeAroundFaceCirculator ( const SurfaceMesh *  m = nullptr, Face  f = Face()  )

inlineexplicit

Default constructor.

Parameters

m	The surface mesh.
f	The face.

Member Function Documentation

begin()

HalfedgeAroundFaceCirculator & begin ( )

inline

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

Returns

Reference to the beginning circulator.

end()

HalfedgeAroundFaceCirculator & end ( )

inline

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

Returns

Reference to the ending circulator.

operator!=()

bool operator!= ( const HalfedgeAroundFaceCirculator &  rhs ) const

inline

Inequality operator.

Parameters

rhs	The other circulator to compare with.

Returns

True if the circulators are different, false otherwise.

operator*()

Halfedge operator* ( ) const

inline

Get the halfedge the circulator refers to.

Returns

The halfedge.

operator++()

HalfedgeAroundFaceCirculator & operator++ ( )

inline

Pre-increment operator (rotate counter-clockwise).

Returns

Reference to the incremented circulator.

operator--()

HalfedgeAroundFaceCirculator & operator-- ( )

inline

Pre-decrement operator (rotate clockwise).

Returns

Reference to the decremented circulator.

operator==()

bool operator== ( const HalfedgeAroundFaceCirculator &  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