QGIS/python/core/auto_generated/qgstolerance.sip.in
2024-08-13 20:28:55 +10:00

84 lines
3.0 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgstolerance.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsTolerance
{
%Docstring(signature="appended")
This is the class is providing tolerance value in map unit values.
%End
%TypeHeaderCode
#include "qgstolerance.h"
%End
public:
static const QMetaObject staticMetaObject;
public:
static double vertexSearchRadius( const QgsMapSettings &mapSettings );
%Docstring
Static function to get vertex tolerance value.
The value is read from settings and transformed if necessary.
:return: value of vertex tolerance in map units (not layer units)
%End
static double vertexSearchRadius( QgsMapLayer *layer, const QgsMapSettings &mapSettings );
%Docstring
Static function to get vertex tolerance value for a layer.
The value is read from settings and transformed if necessary.
:return: value of vertex tolerance in layer units
%End
static double defaultTolerance( QgsMapLayer *layer, const QgsMapSettings &mapSettings );
%Docstring
Static function to get default tolerance value for a layer.
The value is read from settings and transformed if necessary.
:return: value of default tolerance in layer units
%End
static double toleranceInProjectUnits( double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, Qgis::MapToolUnit units );
%Docstring
Static function to translate tolerance value into map units
:param tolerance: tolerance value to be translated
:param layer: source layer necessary in case tolerance is in layer units
:param mapSettings: settings of the map
:param units: type of units to be translated
:return: value of tolerance in map units
%End
static double toleranceInMapUnits( double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, Qgis::MapToolUnit units = Qgis::MapToolUnit::Layer );
%Docstring
Static function to translate tolerance value into layer units
:param tolerance: tolerance value to be translated
:param layer: reference layer
:param mapSettings: settings of the map
:param units: type of units to be translated
:return: value of tolerance in layer units
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgstolerance.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/