QGIS API Documentation  2.99.0-Master (c558d51)
Public Types | Static Public Member Functions | List of all members
QgsTolerance Class Reference

This is the class is providing tolerance value in map unit values. More...

#include <qgstolerance.h>

Public Types

enum  UnitType { LayerUnits, Pixels, ProjectUnits }
 Type of unit of tolerance value from settings. More...
 

Static Public Member Functions

static double defaultTolerance (QgsMapLayer *layer, const QgsMapSettings &mapSettings)
 Static function to get default tolerance value for a layer. More...
 
static double toleranceInMapUnits (double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, UnitType units=LayerUnits)
 Static function to translate tolerance value into layer units. More...
 
static double toleranceInProjectUnits (double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, QgsTolerance::UnitType units)
 Static function to translate tolerance value into map units. More...
 
static double vertexSearchRadius (const QgsMapSettings &mapSettings)
 Static function to get vertex tolerance value. More...
 
static double vertexSearchRadius (QgsMapLayer *layer, const QgsMapSettings &mapSettings)
 Static function to get vertex tolerance value for a layer. More...
 

Detailed Description

This is the class is providing tolerance value in map unit values.

Definition at line 28 of file qgstolerance.h.

Member Enumeration Documentation

Type of unit of tolerance value from settings.

For map (project) units, use ProjectUnits.

Enumerator
LayerUnits 

Layer unit value.

Pixels 

Pixels unit of tolerance.

ProjectUnits 

Map (project) units. Added in 2.8.

Definition at line 35 of file qgstolerance.h.

Member Function Documentation

double QgsTolerance::defaultTolerance ( QgsMapLayer layer,
const QgsMapSettings mapSettings 
)
static

Static function to get default tolerance value for a layer.

The value is read from settings and transformed if necessary.

Returns
value of default tolerance in layer units

Definition at line 89 of file qgstolerance.cpp.

double QgsTolerance::toleranceInMapUnits ( double  tolerance,
QgsMapLayer layer,
const QgsMapSettings mapSettings,
QgsTolerance::UnitType  units = LayerUnits 
)
static

Static function to translate tolerance value into layer units.

Parameters
tolerancetolerance value to be translated
layerreference layer
mapSettingssettings of the map
unitstype of units to be translated
Returns
value of tolerance in layer units

Definition at line 52 of file qgstolerance.cpp.

double QgsTolerance::toleranceInProjectUnits ( double  tolerance,
QgsMapLayer layer,
const QgsMapSettings mapSettings,
QgsTolerance::UnitType  units 
)
static

Static function to translate tolerance value into map units.

Parameters
tolerancetolerance value to be translated
layersource layer necessary in case tolerance is in layer units
mapSettingssettings of the map
unitstype of units to be translated
Returns
value of tolerance in map units
Note
added in 2.8

Definition at line 37 of file qgstolerance.cpp.

double QgsTolerance::vertexSearchRadius ( const QgsMapSettings mapSettings)
static

Static function to get vertex tolerance value.

The value is read from settings and transformed if necessary.

Returns
value of vertex tolerance in map units (not layer units)
Note
added in 2.8

Definition at line 71 of file qgstolerance.cpp.

double QgsTolerance::vertexSearchRadius ( QgsMapLayer layer,
const QgsMapSettings mapSettings 
)
static

Static function to get vertex tolerance value for a layer.

The value is read from settings and transformed if necessary.

Returns
value of vertex tolerance in layer units

Definition at line 81 of file qgstolerance.cpp.


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