QGIS API Documentation  3.14.0-Pi (9f7028fd23)
Public Types | Public Member Functions | Public Attributes | List of all members
QgsVertexId Class Reference

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

#include <qgsabstractgeometry.h>

Public Types

enum  VertexType { SegmentVertex = 1, CurveVertex }
 

Public Member Functions

 QgsVertexId (int _part=-1, int _ring=-1, int _vertex=-1, VertexType _type=SegmentVertex)
 
bool isValid () const
 Returns true if the vertex id is valid. More...
 
bool isValid (const QgsAbstractGeometry *geom) const
 
bool operator!= (QgsVertexId other) const
 
bool operator== (QgsVertexId other) const
 
bool partEqual (QgsVertexId o) const
 
bool ringEqual (QgsVertexId o) const
 
bool vertexEqual (QgsVertexId o) const
 

Public Attributes

int part
 
int ring
 
VertexType type
 
int vertex
 

Detailed Description

Utility class for identifying a unique vertex within a geometry.

Since
QGIS 2.10

Definition at line 1033 of file qgsabstractgeometry.h.

Member Enumeration Documentation

◆ VertexType

Enumerator
SegmentVertex 
CurveVertex 

Definition at line 1035 of file qgsabstractgeometry.h.

Constructor & Destructor Documentation

◆ QgsVertexId()

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

Definition at line 1041 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 1051 of file qgsabstractgeometry.h.

◆ isValid() [2/2]

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

Definition at line 1073 of file qgsabstractgeometry.h.

◆ operator!=()

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

Definition at line 1057 of file qgsabstractgeometry.h.

◆ operator==()

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

Definition at line 1053 of file qgsabstractgeometry.h.

◆ partEqual()

bool QgsVertexId::partEqual ( QgsVertexId  o) const
inline

Definition at line 1061 of file qgsabstractgeometry.h.

◆ ringEqual()

bool QgsVertexId::ringEqual ( QgsVertexId  o) const
inline

Definition at line 1065 of file qgsabstractgeometry.h.

◆ vertexEqual()

bool QgsVertexId::vertexEqual ( QgsVertexId  o) const
inline

Definition at line 1069 of file qgsabstractgeometry.h.

Member Data Documentation

◆ part

int QgsVertexId::part

Definition at line 1080 of file qgsabstractgeometry.h.

◆ ring

int QgsVertexId::ring

Definition at line 1081 of file qgsabstractgeometry.h.

◆ type

VertexType QgsVertexId::type

Definition at line 1083 of file qgsabstractgeometry.h.

◆ vertex

int QgsVertexId::vertex

Definition at line 1082 of file qgsabstractgeometry.h.


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