QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | List of all members
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. More...
 
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. More...
 
double minimumDistance () const
 Returns the minimum distance between the candidate and all added rings. More...
 

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 74 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: