QgsPointLocator::Match Struct Reference

#include <qgspointlocator.h>

Public Member Functions
	Match ()=default
	construct invalid match More...
	Match (QgsPointLocator::Type t, QgsVectorLayer *vl, QgsFeatureId fid, double dist, const QgsPointXY &pt, int vertexIndex=0, QgsPointXY *edgePoints=nullptr)
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 (QgsPointXY &pt1, QgsPointXY &pt2) const
	Only for a valid edge match - obtain endpoints of the edge. More...
QgsFeatureId	featureId () const
	The id of the feature to which the snapped geometry belongs. More...
bool	hasArea () const
bool	hasEdge () const
bool	hasVertex () const
bool	isValid () const
QgsVectorLayer *	layer () const
	The vector layer where the snap occurred. More...
bool	operator== (const QgsPointLocator::Match &other) const
QgsPointXY	point () const
	for vertex / edge match coords depending on what class returns it (geom.cache: layer coords, map canvas snapper: dest coords) More...
QgsPointLocator::Type	type () const
int	vertexIndex () const
	for vertex / edge match (first vertex of the edge) More...

Protected Attributes
double	mDist = 0
QgsPointXY	mEdgePoints [2]
QgsFeatureId	mFid = 0
QgsVectorLayer *	mLayer = nullptr
QgsPointXY	mPoint
Type	mType = Invalid
int	mVertexIndex = 0

Detailed Description

Definition at line 130 of file qgspointlocator.h.

Constructor & Destructor Documentation

QgsPointLocator::Match::Match ( )

default

construct invalid match

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

inline

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

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

inline

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

Definition at line 184 of file qgspointlocator.h.

QgsFeatureId QgsPointLocator::Match::featureId ( ) const

inline

The id of the feature to which the snapped geometry belongs.

Definition at line 181 of file qgspointlocator.h.

bool QgsPointLocator::Match::hasArea ( ) const

inline

Definition at line 155 of file qgspointlocator.h.

bool QgsPointLocator::Match::hasEdge ( ) const

inline

Definition at line 154 of file qgspointlocator.h.

bool QgsPointLocator::Match::hasVertex ( ) const

inline

Definition at line 153 of file qgspointlocator.h.

bool QgsPointLocator::Match::isValid ( ) const

inline

Definition at line 152 of file qgspointlocator.h.

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

inline

The vector layer where the snap occurred.

Will be null if the snap happened on an intersection.

Definition at line 176 of file qgspointlocator.h.

bool QgsPointLocator::Match::operator== ( const QgsPointLocator::Match &  other ) const

inline

Definition at line 190 of file qgspointlocator.h.

QgsPointXY 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 167 of file qgspointlocator.h.

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

inline

Definition at line 150 of file qgspointlocator.h.

int QgsPointLocator::Match::vertexIndex ( ) const

inline

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

Definition at line 170 of file qgspointlocator.h.

Member Data Documentation

double QgsPointLocator::Match::mDist = 0

protected

Definition at line 203 of file qgspointlocator.h.

QgsPointXY QgsPointLocator::Match::mEdgePoints[2]

protected

Definition at line 208 of file qgspointlocator.h.

QgsFeatureId QgsPointLocator::Match::mFid = 0

protected

Definition at line 206 of file qgspointlocator.h.

QgsVectorLayer* QgsPointLocator::Match::mLayer = nullptr

protected

Definition at line 205 of file qgspointlocator.h.

QgsPointXY QgsPointLocator::Match::mPoint

protected

Definition at line 204 of file qgspointlocator.h.

Type QgsPointLocator::Match::mType = Invalid

protected

Definition at line 202 of file qgspointlocator.h.

int QgsPointLocator::Match::mVertexIndex = 0

protected

Definition at line 207 of file qgspointlocator.h.

---

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

• /build/qgis-3.4.15+24xenial/src/core/qgspointlocator.h