QGIS API Documentation  2.10.1-Pisa
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
 
 QgsVertexId (int _part, int _ring, int _vertex, VertexType _type=SegmentVertex)
 
bool isValid () const
 Returns true if the vertex id is valid. More...
 
bool operator!= (const QgsVertexId &other)
 
bool operator== (const QgsVertexId &other)
 

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
this API is not considered stable and may change for 2.12

Definition at line 39 of file qgsabstractgeometryv2.h.

Member Enumeration Documentation

Enumerator
SegmentVertex 
CurveVertex 

Definition at line 41 of file qgsabstractgeometryv2.h.

Constructor & Destructor Documentation

QgsVertexId::QgsVertexId ( )
inline

Definition at line 47 of file qgsabstractgeometryv2.h.

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

Definition at line 48 of file qgsabstractgeometryv2.h.

Member Function Documentation

bool QgsVertexId::isValid ( ) const
inline

Returns true if the vertex id is valid.

Definition at line 53 of file qgsabstractgeometryv2.h.

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

Definition at line 59 of file qgsabstractgeometryv2.h.

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

Definition at line 55 of file qgsabstractgeometryv2.h.

Member Data Documentation

int QgsVertexId::part

Definition at line 64 of file qgsabstractgeometryv2.h.

int QgsVertexId::ring

Definition at line 65 of file qgsabstractgeometryv2.h.

VertexType QgsVertexId::type

Definition at line 67 of file qgsabstractgeometryv2.h.

int QgsVertexId::vertex

Definition at line 66 of file qgsabstractgeometryv2.h.


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