Convenience class that turns around a vertex and provides information about faces and vertices. More...

#include <qgstopologicalmesh.h>

Public Member Functions
	QgsMeshVertexCirculator (const QgsTopologicalMesh &topologicalMesh, int vertexIndex)
	Constructor with topologicalMesh and vertexIndex.

	QgsMeshVertexCirculator (const QgsTopologicalMesh::TopologicalFaces &topologicalFaces, int faceIndex, int vertexIndex)
	Constructor with topologicFaces, vertexIndex and the index faceIndex of the face containing the vertex.

	QgsMeshVertexCirculator (const QgsTopologicalMesh::TopologicalFaces &topologicalFaces, int vertexIndex)
	Constructor with topologicFaces, vertexIndex.

QgsMeshFace	currentFace () const
	Returns the current face, empty face if the circulator pass a boundary or circulator is invalid.

int	currentFaceIndex () const
	Returns the current face index, -1 if the circulator has passed a boundary or circulator is invalid.

int	degree () const
	Returns the degree of the vertex, that is the count of other vertices linked.

QList< int >	facesAround () const
	Returns all the faces indexes around the vertex.

bool	goBoundaryClockwise () const
	Sets the circulator on the boundary face turning clockwise, return false is there isn't boundary face.

bool	goBoundaryCounterClockwise () const
	Sets the circulator on the boundary face turning counter clockwise, return false is there isn't boundary face.

bool	isValid () const
	Returns whether the vertex circulator is valid.

int	oppositeVertexClockwise () const
	Returns the opposite vertex of the current face and on the edge on the side turning clockwise.

int	oppositeVertexCounterClockwise () const
	Returns the opposite vertex of the current face and on the edge on the side turning counter clockwise.

int	turnClockwise () const
	Turns counter clockwise around the vertex and returns the new current face, -1 if the circulator pass a boundary or circulator is invalid.

int	turnCounterClockwise () const
	Turns counter clockwise around the vertex and returns the new current face, -1 if the circulator pass a boundary or circulator is invalid.

Detailed Description

Convenience class that turns around a vertex and provides information about faces and vertices.

Note: Not available in Python bindings

Since: QGIS 3.22

Definition at line 434 of file qgstopologicalmesh.h.

Constructor & Destructor Documentation

◆ QgsMeshVertexCirculator() [1/3]

QgsMeshVertexCirculator::QgsMeshVertexCirculator	(	const QgsTopologicalMesh &	topologicalMesh,
		int	vertexIndex
	)

Constructor with topologicalMesh and vertexIndex.

Definition at line 57 of file qgstopologicalmesh.cpp.

◆ QgsMeshVertexCirculator() [2/3]

QgsMeshVertexCirculator::QgsMeshVertexCirculator	(	const QgsTopologicalMesh::TopologicalFaces &	topologicalFaces,
		int	faceIndex,
		int	vertexIndex
	)

Constructor with topologicFaces, vertexIndex and the index faceIndex of the face containing the vertex.

Note: This circulator only concerns faces that are in the same bloc of the face faceIndex. Other faces that could be share only the vertex vertexIndex can't be accessible with this circulator

Definition at line 76 of file qgstopologicalmesh.cpp.

◆ QgsMeshVertexCirculator() [3/3]

QgsMeshVertexCirculator::QgsMeshVertexCirculator	(	const QgsTopologicalMesh::TopologicalFaces &	topologicalFaces,
		int	vertexIndex
	)

Constructor with topologicFaces, vertexIndex.

Note: This circulator only concerns faces that are in the same bloc of the first face linked to the vertex vertexIndex. Other faces that could be share only the vertex vertexIndex can't be accessible with this circulator

Definition at line 88 of file qgstopologicalmesh.cpp.

Member Function Documentation

◆ currentFace()

QgsMeshFace QgsMeshVertexCirculator::currentFace ( ) const

Returns the current face, empty face if the circulator pass a boundary or circulator is invalid.

Definition at line 140 of file qgstopologicalmesh.cpp.

◆ currentFaceIndex()

int QgsMeshVertexCirculator::currentFaceIndex ( ) const

Returns the current face index, -1 if the circulator has passed a boundary or circulator is invalid.

Definition at line 135 of file qgstopologicalmesh.cpp.

◆ degree()

int QgsMeshVertexCirculator::degree ( ) const

Returns the degree of the vertex, that is the count of other vertices linked.

Definition at line 250 of file qgstopologicalmesh.cpp.

◆ facesAround()

QList< int > QgsMeshVertexCirculator::facesAround ( ) const

Returns all the faces indexes around the vertex.

Definition at line 223 of file qgstopologicalmesh.cpp.

◆ goBoundaryClockwise()

bool QgsMeshVertexCirculator::goBoundaryClockwise ( ) const

Sets the circulator on the boundary face turning clockwise, return false is there isn't boundary face.

Definition at line 148 of file qgstopologicalmesh.cpp.

◆ goBoundaryCounterClockwise()

bool QgsMeshVertexCirculator::goBoundaryCounterClockwise ( ) const

Sets the circulator on the boundary face turning counter clockwise, return false is there isn't boundary face.

Definition at line 165 of file qgstopologicalmesh.cpp.

◆ isValid()

bool QgsMeshVertexCirculator::isValid ( ) const

Returns whether the vertex circulator is valid.

Definition at line 218 of file qgstopologicalmesh.cpp.

◆ oppositeVertexClockwise()

int QgsMeshVertexCirculator::oppositeVertexClockwise ( ) const

Returns the opposite vertex of the current face and on the edge on the side turning clockwise.

Definition at line 182 of file qgstopologicalmesh.cpp.

◆ oppositeVertexCounterClockwise()

int QgsMeshVertexCirculator::oppositeVertexCounterClockwise ( ) const

Returns the opposite vertex of the current face and on the edge on the side turning counter clockwise.

Definition at line 200 of file qgstopologicalmesh.cpp.

◆ turnClockwise()

int QgsMeshVertexCirculator::turnClockwise ( ) const

Turns counter clockwise around the vertex and returns the new current face, -1 if the circulator pass a boundary or circulator is invalid.

Definition at line 117 of file qgstopologicalmesh.cpp.

◆ turnCounterClockwise()

int QgsMeshVertexCirculator::turnCounterClockwise ( ) const