QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
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 <qgsabstractgeometryv2.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 QgsAbstractGeometryV2 *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.

Note
added in QGIS 2.10

Definition at line 403 of file qgsabstractgeometryv2.h.

Member Enumeration Documentation

◆ VertexType

Enumerator
SegmentVertex 
CurveVertex 

Definition at line 405 of file qgsabstractgeometryv2.h.

Constructor & Destructor Documentation

◆ QgsVertexId()

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

Definition at line 411 of file qgsabstractgeometryv2.h.

Member Function Documentation

◆ isValid() [1/2]

bool QgsVertexId::isValid ( ) const
inline

Returns true if the vertex id is valid.

Definition at line 420 of file qgsabstractgeometryv2.h.

◆ isValid() [2/2]

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

Definition at line 442 of file qgsabstractgeometryv2.h.

◆ operator!=()

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

Definition at line 426 of file qgsabstractgeometryv2.h.

◆ operator==()

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

Definition at line 422 of file qgsabstractgeometryv2.h.

◆ partEqual()

bool QgsVertexId::partEqual ( QgsVertexId  o) const
inline

Definition at line 430 of file qgsabstractgeometryv2.h.

◆ ringEqual()

bool QgsVertexId::ringEqual ( QgsVertexId  o) const
inline

Definition at line 434 of file qgsabstractgeometryv2.h.

◆ vertexEqual()

bool QgsVertexId::vertexEqual ( QgsVertexId  o) const
inline

Definition at line 438 of file qgsabstractgeometryv2.h.

Member Data Documentation

◆ part

int QgsVertexId::part

Definition at line 449 of file qgsabstractgeometryv2.h.

◆ ring

int QgsVertexId::ring

Definition at line 450 of file qgsabstractgeometryv2.h.

◆ type

VertexType QgsVertexId::type

Definition at line 452 of file qgsabstractgeometryv2.h.

◆ vertex

int QgsVertexId::vertex

Definition at line 451 of file qgsabstractgeometryv2.h.


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