QGIS API Documentation  2.12.0-Lyon
Public Member Functions | Protected Attributes | List of all members
QgsPointLocator::Match Struct Reference

#include <qgspointlocator.h>

Public Member Functions

 Match ()
 consruct invalid match More...
 
 Match (Type t, QgsVectorLayer *vl, QgsFeatureId fid, double dist, const QgsPoint &pt, int vertexIndex=0, QgsPoint *edgePoints=0)
 
double distance () const
 for vertex / edge match units depending on what class returns it (geom.cache: layer units, map canvas snapper: dest crs units) More...
 
void edgePoints (QgsPoint &pt1, QgsPoint &pt2) const
 Only for a valid edge match - obtain endpoints of the edge. More...
 
QgsFeatureId featureId () const
 
bool hasArea () const
 
bool hasEdge () const
 
bool hasVertex () const
 
bool isValid () const
 
QgsVectorLayer * layer () const
 reference vector layer More...
 
QgsPoint point () const
 for vertex / edge match coords depending on what class returns it (geom.cache: layer coords, map canvas snapper: dest coords) More...
 
Type type () const
 
int vertexIndex () const
 for vertex / edge match (first vertex of the edge) More...
 

Protected Attributes

double mDist
 
QgsPoint mEdgePoints [2]
 
QgsFeatureId mFid
 
QgsVectorLayer * mLayer
 
QgsPoint mPoint
 
Type mType
 
int mVertexIndex
 

Detailed Description

Definition at line 80 of file qgspointlocator.h.

Constructor & Destructor Documentation

QgsPointLocator::Match::Match ( )
inline

consruct invalid match

Definition at line 83 of file qgspointlocator.h.

QgsPointLocator::Match::Match ( Type  t,
QgsVectorLayer *  vl,
QgsFeatureId  fid,
double  dist,
const QgsPoint &  pt,
int  vertexIndex = 0,
QgsPoint *  edgePoints = 0 
)
inline

Definition at line 85 of file qgspointlocator.h.

Member Function Documentation

double QgsPointLocator::Match::distance ( ) const
inline

for vertex / edge match units depending on what class returns it (geom.cache: layer units, map canvas snapper: dest crs units)

Definition at line 104 of file qgspointlocator.h.

void QgsPointLocator::Match::edgePoints ( QgsPoint &  pt1,
QgsPoint &  pt2 
) const
inline

Only for a valid edge match - obtain endpoints of the edge.

Definition at line 119 of file qgspointlocator.h.

QgsFeatureId QgsPointLocator::Match::featureId ( ) const
inline

Definition at line 116 of file qgspointlocator.h.

bool QgsPointLocator::Match::hasArea ( ) const
inline

Definition at line 100 of file qgspointlocator.h.

bool QgsPointLocator::Match::hasEdge ( ) const
inline

Definition at line 99 of file qgspointlocator.h.

bool QgsPointLocator::Match::hasVertex ( ) const
inline

Definition at line 98 of file qgspointlocator.h.

bool QgsPointLocator::Match::isValid ( ) const
inline

Definition at line 97 of file qgspointlocator.h.

QgsVectorLayer* QgsPointLocator::Match::layer ( ) const
inline

reference vector layer

Definition at line 114 of file qgspointlocator.h.

QgsPoint QgsPointLocator::Match::point ( ) const
inline

for vertex / edge match coords depending on what class returns it (geom.cache: layer coords, map canvas snapper: dest coords)

Definition at line 108 of file qgspointlocator.h.

Type QgsPointLocator::Match::type ( ) const
inline

Definition at line 95 of file qgspointlocator.h.

int QgsPointLocator::Match::vertexIndex ( ) const
inline

for vertex / edge match (first vertex of the edge)

Definition at line 111 of file qgspointlocator.h.

Member Data Documentation

double QgsPointLocator::Match::mDist
protected

Definition at line 127 of file qgspointlocator.h.

QgsPoint QgsPointLocator::Match::mEdgePoints[2]
protected

Definition at line 132 of file qgspointlocator.h.

QgsFeatureId QgsPointLocator::Match::mFid
protected

Definition at line 130 of file qgspointlocator.h.

QgsVectorLayer* QgsPointLocator::Match::mLayer
protected

Definition at line 129 of file qgspointlocator.h.

QgsPoint QgsPointLocator::Match::mPoint
protected

Definition at line 128 of file qgspointlocator.h.

Type QgsPointLocator::Match::mType
protected

Definition at line 126 of file qgspointlocator.h.

int QgsPointLocator::Match::mVertexIndex
protected

Definition at line 131 of file qgspointlocator.h.


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