SurfaceMesh::HalfedgeAroundVertexCirculator Class Reference

#include <surface_mesh.h>

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

Detailed Description

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

The follow code shows how to use HalfedgeAroundVertexCirculator:

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

See also

VertexAroundVertexCirculator, FaceAroundVertexCirculator, halfedges()

Examples

Tutorial_105_SurfaceMesh_Connectivity/main.cpp.

Constructor & Destructor Documentation

HalfedgeAroundVertexCirculator()

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

inlineexplicit

Default constructor.

Parameters

m	The surface mesh.
v	The vertex.

Member Function Documentation

begin()

HalfedgeAroundVertexCirculator & begin ( )

inline

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

Returns

Reference to the beginning circulator.

end()

HalfedgeAroundVertexCirculator & 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 HalfedgeAroundVertexCirculator & 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++()

HalfedgeAroundVertexCirculator & operator++ ( )

inline

Pre-increment operator (rotate counter-clockwise).

Returns

Reference to the incremented circulator.

operator--()

HalfedgeAroundVertexCirculator & operator-- ( )

inline

Pre-decrement operator (rotate clockwise).

Returns

Reference to the decremented circulator.

operator==()

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