pal::CandidatePolygonRingDistanceCalculator Class Reference

Calculates distance from a label candidate to nearest polygon ring. More...

#include <costcalculator.h>

Public Member Functions
	CandidatePolygonRingDistanceCalculator (LabelPosition *candidate)
	Constructor for PolygonRingDistanceCalculator, for the specified label candidate.
void	addRing (const pal::PointSet *ring)
	Adds a ring to the calculation, updating the minimumDistance() value if the rings is closer to the candidate then previously added rings.
double	minimumDistance () const
	Returns the minimum distance between the candidate and all added rings.

Detailed Description

Calculates distance from a label candidate to nearest polygon ring.

Note

not available in Python bindings

Since

QGIS 3.12

Definition at line 75 of file costcalculator.h.

Constructor & Destructor Documentation

CandidatePolygonRingDistanceCalculator()

CandidatePolygonRingDistanceCalculator::CandidatePolygonRingDistanceCalculator ( LabelPosition *  candidate )

explicit

Constructor for PolygonRingDistanceCalculator, for the specified label candidate.

Definition at line 262 of file costcalculator.cpp.

Member Function Documentation

addRing()

void CandidatePolygonRingDistanceCalculator::addRing

(

const pal::PointSet *

ring

)

Adds a ring to the calculation, updating the minimumDistance() value if the rings is closer to the candidate then previously added rings.

Definition at line 268 of file costcalculator.cpp.

minimumDistance()

double CandidatePolygonRingDistanceCalculator::minimumDistance

(

)

const

Returns the minimum distance between the candidate and all added rings.

Definition at line 277 of file costcalculator.cpp.

---

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

• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/pal/costcalculator.h
• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/pal/costcalculator.cpp