QgsVertexId Class Reference

Utility class for identifying a unique vertex within a geometry. More...

#include <qgsvertexid.h>

Public Member Functions
	QgsVertexId (int _part=-1, int _ring=-1, int _vertex=-1, Qgis::VertexType _type=Qgis::VertexType::Segment) SIP_HOLDGIL
	Constructor for QgsVertexId. More...
bool	isValid () const SIP_HOLDGIL
	Returns true if the vertex id is valid. More...
bool	isValid (const QgsAbstractGeometry *geom) const SIP_HOLDGIL
	Returns true if this vertex ID is valid for the specified geom. More...
bool	operator!= (QgsVertexId other) const SIP_HOLDGIL
bool	operator== (QgsVertexId other) const SIP_HOLDGIL
bool	partEqual (QgsVertexId o) const SIP_HOLDGIL
	Returns true if this vertex ID belongs to the same part as another vertex ID. More...
bool	ringEqual (QgsVertexId o) const SIP_HOLDGIL
	Returns true if this vertex ID belongs to the same ring as another vertex ID (i.e. More...
bool	vertexEqual (QgsVertexId o) const SIP_HOLDGIL
	Returns true if this vertex ID corresponds to the same vertex as another vertex ID (i.e. More...

Public Attributes
int	part = -1
	Part number. More...
int	ring = -1
	Ring number. More...
Qgis::VertexType	type = Qgis::VertexType::Segment
	Vertex type. More...
int	vertex = -1
	Vertex number. More...

Detailed Description

Utility class for identifying a unique vertex within a geometry.

Since

QGIS 2.10

Definition at line 30 of file qgsvertexid.h.

Constructor & Destructor Documentation

QgsVertexId()

QgsVertexId::QgsVertexId ( int  _part = -1, int  _ring = -1, int  _vertex = -1, Qgis::VertexType  _type = Qgis::VertexType::Segment  )

inlineexplicit

Constructor for QgsVertexId.

Definition at line 36 of file qgsvertexid.h.

Member Function Documentation

isValid() [1/2]

bool QgsVertexId::isValid ( ) const

inline

Returns true if the vertex id is valid.

Definition at line 46 of file qgsvertexid.h.

isValid() [2/2]

bool QgsVertexId::isValid

(

const QgsAbstractGeometry *

geom

)

const

Returns true if this vertex ID is valid for the specified geom.

Definition at line 19 of file qgsvertexid.cpp.

operator!=()

bool QgsVertexId::operator!= ( QgsVertexId  other ) const

inline

Definition at line 52 of file qgsvertexid.h.

operator==()

bool QgsVertexId::operator== ( QgsVertexId  other ) const

inline

Definition at line 48 of file qgsvertexid.h.

partEqual()

bool QgsVertexId::partEqual ( QgsVertexId  o ) const

inline

Returns true if this vertex ID belongs to the same part as another vertex ID.

Definition at line 60 of file qgsvertexid.h.

ringEqual()

bool QgsVertexId::ringEqual ( QgsVertexId  o ) const

inline

Returns true if this vertex ID belongs to the same ring as another vertex ID (i.e.

the part and ring number are equal).

Definition at line 69 of file qgsvertexid.h.

vertexEqual()

bool QgsVertexId::vertexEqual ( QgsVertexId  o ) const

inline

Returns true if this vertex ID corresponds to the same vertex as another vertex ID (i.e.

the part, ring number and vertex number are equal).

Definition at line 78 of file qgsvertexid.h.

Member Data Documentation

part

int QgsVertexId::part = -1

Part number.

Definition at line 89 of file qgsvertexid.h.

ring

int QgsVertexId::ring = -1

Ring number.

Definition at line 92 of file qgsvertexid.h.

type

Qgis::VertexType QgsVertexId::type = Qgis::VertexType::Segment

Vertex type.

Definition at line 98 of file qgsvertexid.h.

vertex

int QgsVertexId::vertex = -1

Vertex number.

Definition at line 95 of file qgsvertexid.h.

---

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

• /build/qgis-3.28.0+99sid/src/core/geometry/qgsvertexid.h
• /build/qgis-3.28.0+99sid/src/core/geometry/qgsvertexid.cpp