QGIS API Documentation  2.8.2-Wien
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
QgsPointLocator::Match Struct Reference

#include <qgspointlocator.h>

Public Member Functions

 Match ()
 consruct invalid match
 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)
void edgePoints (QgsPoint &pt1, QgsPoint &pt2) const
 Only for a valid edge match - obtain endpoints of the edge.
QgsFeatureId featureId () const
bool hasArea () const
bool hasEdge () const
bool hasVertex () const
bool isValid () const
QgsVectorLayerlayer () const
 reference vector layer
QgsPoint point () const
 for vertex / edge match coords depending on what class returns it (geom.cache: layer coords, map canvas snapper: dest coords)
Type type () const
int vertexIndex () const
 for vertex / edge match (first vertex of the edge)

Protected Attributes

double mDist
QgsPoint mEdgePoints [2]
QgsFeatureId mFid
QgsVectorLayermLayer
QgsPoint mPoint
Type mType
int mVertexIndex

Detailed Description

Definition at line 71 of file qgspointlocator.h.

Constructor & Destructor Documentation

QgsPointLocator::Match::Match ( )
inline

consruct invalid match

Definition at line 74 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 76 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 95 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 110 of file qgspointlocator.h.

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

Definition at line 107 of file qgspointlocator.h.

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

Definition at line 91 of file qgspointlocator.h.

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

Definition at line 90 of file qgspointlocator.h.

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

Definition at line 89 of file qgspointlocator.h.

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

Definition at line 88 of file qgspointlocator.h.

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

reference vector layer

Definition at line 105 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 99 of file qgspointlocator.h.

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

Definition at line 86 of file qgspointlocator.h.

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

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

Definition at line 102 of file qgspointlocator.h.

Member Data Documentation

double QgsPointLocator::Match::mDist
protected

Definition at line 118 of file qgspointlocator.h.

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

Definition at line 123 of file qgspointlocator.h.

QgsFeatureId QgsPointLocator::Match::mFid
protected

Definition at line 121 of file qgspointlocator.h.

QgsVectorLayer* QgsPointLocator::Match::mLayer
protected

Definition at line 120 of file qgspointlocator.h.

QgsPoint QgsPointLocator::Match::mPoint
protected

Definition at line 119 of file qgspointlocator.h.

Type QgsPointLocator::Match::mType
protected

Definition at line 117 of file qgspointlocator.h.

int QgsPointLocator::Match::mVertexIndex
protected

Definition at line 122 of file qgspointlocator.h.


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