QgsVertexId Class Reference

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

#include <qgsabstractgeometry.h>

Public Types
enum	VertexType { SegmentVertex = 1, CurveVertex }
	Type of vertex. More...

Public Member Functions
	QgsVertexId (int _part=-1, int _ring=-1, int _vertex=-1, VertexType _type=SegmentVertex) 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...
VertexType	type = SegmentVertex
	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 1058 of file qgsabstractgeometry.h.

Member Enumeration Documentation

VertexType

enum QgsVertexId::VertexType

Type of vertex.

Enumerator
SegmentVertex	The actual start or end point of a segment.
CurveVertex	An intermediate point on a segment defining the curvature of the segment.

Definition at line 1064 of file qgsabstractgeometry.h.

Constructor & Destructor Documentation

QgsVertexId()

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

inlineexplicit

Constructor for QgsVertexId.

Definition at line 1073 of file qgsabstractgeometry.h.

Member Function Documentation

isValid() [1/2]

bool QgsVertexId::isValid ( ) const

inline

Returns true if the vertex id is valid.

Definition at line 1083 of file qgsabstractgeometry.h.

isValid() [2/2]

bool QgsVertexId::isValid ( const QgsAbstractGeometry *  geom ) const

inline

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

Definition at line 1123 of file qgsabstractgeometry.h.

operator!=()

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

inline

Definition at line 1089 of file qgsabstractgeometry.h.

operator==()

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

inline

Definition at line 1085 of file qgsabstractgeometry.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 1097 of file qgsabstractgeometry.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 1106 of file qgsabstractgeometry.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 1115 of file qgsabstractgeometry.h.

Member Data Documentation

part

int QgsVertexId::part = -1

Part number.

Definition at line 1131 of file qgsabstractgeometry.h.

ring

int QgsVertexId::ring = -1

Ring number.

Definition at line 1134 of file qgsabstractgeometry.h.

type

VertexType QgsVertexId::type = SegmentVertex

Vertex type.

Definition at line 1140 of file qgsabstractgeometry.h.

vertex

int QgsVertexId::vertex = -1

Vertex number.

Definition at line 1137 of file qgsabstractgeometry.h.

---

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

• /build/qgis-3.16.0+99unstable/src/core/geometry/qgsabstractgeometry.h