SurfaceMesh::VertexAroundFaceCirculator Class Reference

#include <surface_mesh.h>

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

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.

The follow code shows how to use VertexAroundFaceCirculator:

SurfaceMesh::VertexAroundFaceCirculator cir = mesh->vertices(f);
SurfaceMesh::VertexAroundFaceCirculator end = cir;
do {
    SurfaceMesh::Vertex v = *cir;
    // do something with v
    ++cir;
} while (cir != end);

See also

HalfedgeAroundFaceCirculator, vertices()

Examples

Tutorial_105_SurfaceMesh_Connectivity/main.cpp.

Constructor & Destructor Documentation

VertexAroundFaceCirculator()

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

inlineexplicit

Default constructor.

Parameters

m	The surface mesh.
f	The face.

Member Function Documentation

begin()

VertexAroundFaceCirculator & begin ( )

inline

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

Returns

Reference to the beginning circulator.

end()

VertexAroundFaceCirculator & end ( )

inline

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

Returns

Reference to the ending circulator.

operator!=()

bool operator!= ( const VertexAroundFaceCirculator & rhs ) const

inline

Inequality operator.

Parameters

rhs	The other circulator to compare with.

Returns

True if the circulators are different, false otherwise.

operator*()

Vertex operator* ( ) const

inline

Get the vertex the circulator refers to.

Returns

The vertex.

operator++()

VertexAroundFaceCirculator & operator++ ( )

inline

Pre-increment operator (rotate counter-clockwise).

Returns

Reference to the incremented circulator.

operator--()

VertexAroundFaceCirculator & operator-- ( )

inline

Pre-decrement operator (rotate clockwise).

Returns

Reference to the decremented circulator.

operator==()

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

• G:/3_code/Easy3D/easy3d/core/surface_mesh.h