#include <qgspointlocator.h>

Public Member Functions
	Match ()=default
	construct invalid match
	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)
void	edgePoints (QgsPointXY &pt1, QgsPointXY &pt2) const
	Only for a valid edge match - obtain endpoints of the edge.
QgsFeatureId	featureId () const
	The id of the feature to which the snapped geometry belongs.
bool	hasArea () const
	Returns `true` if the Match is an area.
bool	hasCentroid () const
	Returns `true` if the Match is a centroid.
bool	hasEdge () const
	Returns `true` if the Match is an edge.
bool	hasLineEndpoint () const
	Returns `true` if the Match is a line endpoint (start or end vertex).
bool	hasMiddleSegment () const
	Returns `true` if the Match is the middle of a segment.
bool	hasVertex () const
	Returns `true` if the Match is a vertex.
QgsPoint	interpolatedPoint (const QgsCoordinateReferenceSystem &destinationCrs=QgsCoordinateReferenceSystem()) const
	Convenient method to return a point on an edge with linear interpolation of the Z value.
bool	isValid () const
QgsVectorLayer *	layer () const
	The vector layer where the snap occurred.
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)
QgsPointLocator::Type	type () const
int	vertexIndex () const
	for vertex / edge match (first vertex of the edge)

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

Detailed Description

Definition at line 185 of file qgspointlocator.h.

Constructor & Destructor Documentation

◆ Match() [1/2]

QgsPointLocator::Match::Match ( )

default

construct invalid match

◆ Match() [2/2]

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

Member Function Documentation

◆ distance()

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

◆ edgePoints()

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

inline

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

Definition at line 253 of file qgspointlocator.h.

◆ featureId()

QgsFeatureId QgsPointLocator::Match::featureId ( ) const

inline

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

Definition at line 250 of file qgspointlocator.h.

◆ hasArea()

bool QgsPointLocator::Match::hasArea ( ) const

inline

Returns true if the Match is an area.

Definition at line 215 of file qgspointlocator.h.

◆ hasCentroid()

bool QgsPointLocator::Match::hasCentroid ( ) const

inline

Returns true if the Match is a centroid.

Definition at line 213 of file qgspointlocator.h.

◆ hasEdge()

bool QgsPointLocator::Match::hasEdge ( ) const

inline

Returns true if the Match is an edge.

Definition at line 211 of file qgspointlocator.h.

◆ hasLineEndpoint()

bool QgsPointLocator::Match::hasLineEndpoint ( ) const

inline

Returns true if the Match is a line endpoint (start or end vertex).

Since: QGIS 3.20

Definition at line 224 of file qgspointlocator.h.

◆ hasMiddleSegment()

bool QgsPointLocator::Match::hasMiddleSegment ( ) const

inline

Returns true if the Match is the middle of a segment.

Definition at line 217 of file qgspointlocator.h.

◆ hasVertex()

bool QgsPointLocator::Match::hasVertex ( ) const

inline

Returns true if the Match is a vertex.

Definition at line 209 of file qgspointlocator.h.

◆ interpolatedPoint()

QgsPoint QgsPointLocator::Match::interpolatedPoint ( const QgsCoordinateReferenceSystem & destinationCrs = QgsCoordinateReferenceSystem() ) const

inline

Convenient method to return a point on an edge with linear interpolation of the Z value.

The parameter destinationCrs depends of where the instance of this Match is created (geom.cache: layer CRS, map canvas snapper: dest CRS)

Since: QGIS 3.10

Definition at line 265 of file qgspointlocator.h.

◆ isValid()

bool QgsPointLocator::Match::isValid ( ) const

inline

Definition at line 207 of file qgspointlocator.h.

◆ layer()

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

inline

The vector layer where the snap occurred.

Will be nullptr if the snap happened on an intersection.

Definition at line 245 of file qgspointlocator.h.

◆ operator==()

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

inline

Definition at line 319 of file qgspointlocator.h.

◆ point()

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

◆ type()

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

inline

Definition at line 205 of file qgspointlocator.h.

◆ vertexIndex()

int QgsPointLocator::Match::vertexIndex ( ) const

inline

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

Definition at line 239 of file qgspointlocator.h.

Member Data Documentation

◆ mCentroid

QgsPointXY QgsPointLocator::Match::mCentroid

protected

Definition at line 341 of file qgspointlocator.h.

◆ mDist

double QgsPointLocator::Match::mDist = 0

protected

Definition at line 335 of file qgspointlocator.h.

◆ mEdgePoints

QgsPointXY QgsPointLocator::Match::mEdgePoints[2]

protected

Definition at line 340 of file qgspointlocator.h.

◆ mFid

QgsFeatureId QgsPointLocator::Match::mFid = 0

protected

Definition at line 338 of file qgspointlocator.h.

◆ mLayer

QgsVectorLayer* QgsPointLocator::Match::mLayer = nullptr

protected

Definition at line 337 of file qgspointlocator.h.

◆ mMiddleOfSegment

QgsPointXY QgsPointLocator::Match::mMiddleOfSegment

protected

Definition at line 342 of file qgspointlocator.h.

◆ mPoint

QgsPointXY QgsPointLocator::Match::mPoint

protected

Definition at line 336 of file qgspointlocator.h.

◆ mType

Type QgsPointLocator::Match::mType = Invalid

protected

Definition at line 334 of file qgspointlocator.h.

◆ mVertexIndex

int QgsPointLocator::Match::mVertexIndex = 0

protected

Definition at line 339 of file qgspointlocator.h.

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

/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/qgspointlocator.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Match() [1/2]

◆ Match() [2/2]

Member Function Documentation

◆ distance()

◆ edgePoints()

◆ featureId()

◆ hasArea()

◆ hasCentroid()

◆ hasEdge()

◆ hasLineEndpoint()

◆ hasMiddleSegment()

◆ hasVertex()

◆ interpolatedPoint()

◆ isValid()

◆ layer()

◆ operator==()

◆ point()

◆ type()

◆ vertexIndex()

Member Data Documentation

◆ mCentroid

◆ mDist

◆ mEdgePoints

◆ mFid

◆ mLayer

◆ mMiddleOfSegment

◆ mPoint

◆ mType

◆ mVertexIndex