QgsTolerance Class Reference

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

#include <qgstolerance.h>

Public Types
enum	UnitType { MapUnits, LayerUnits = MapUnits, 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.
static Q_DECL_DEPRECATED double	defaultTolerance (QgsMapLayer *layer, QgsMapRenderer *renderer)
	Static function to get default tolerance value for a layer.
static double	toleranceInMapUnits (double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, UnitType units=LayerUnits)
	Static function to translate tolerance value into layer units.
static Q_DECL_DEPRECATED double	toleranceInMapUnits (double tolerance, QgsMapLayer *layer, QgsMapRenderer *renderer, UnitType units=LayerUnits)
	Static function to translate tolerance value into layer units.
static double	toleranceInProjectUnits (double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, QgsTolerance::UnitType units)
	Static function to translate tolerance value into map units.
static double	vertexSearchRadius (const QgsMapSettings &mapSettings)
	Static function to get vertex tolerance value.
static double	vertexSearchRadius (QgsMapLayer *layer, const QgsMapSettings &mapSettings)
	Static function to get vertex tolerance value for a layer.
static Q_DECL_DEPRECATED double	vertexSearchRadius (QgsMapLayer *layer, QgsMapRenderer *renderer)
	Static function to get vertex tolerance value for a layer.

Detailed Description

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

Definition at line 26 of file qgstolerance.h.

Member Enumeration Documentation

enum QgsTolerance::UnitType

Type of unit of tolerance value from settings.

MapUnits is slightly confusing, because it actually refers to layer units (historically). For map (project) units, use ProjectUnits. Try to avoid using MapUnits value and use LayerUnits instead.

Enumerator:

MapUnits	Layer unit value. Note deprecated: use LayerUnits
LayerUnits	Layer unit value.
Pixels	Pixels unit of tolerance.
ProjectUnits	Map (project) units. Added in 2.8

Definition at line 33 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 98 of file qgstolerance.cpp.

double QgsTolerance::defaultTolerance ( QgsMapLayer *  layer, QgsMapRenderer *  renderer  )

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

Deprecated:

since 2.4 - use override with QgsMapSettings

Definition at line 107 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

tolerance	tolerance value to be translated
layer	reference layer
mapSettings	settings of the map
units	type of units to be translated

Returns

value of tolerance in layer units

Definition at line 51 of file qgstolerance.cpp.

double QgsTolerance::toleranceInMapUnits ( double  tolerance, QgsMapLayer *  layer, QgsMapRenderer *  renderer, UnitType  units = LayerUnits  )

static

Static function to translate tolerance value into layer units.

Parameters

tolerance	tolerance value to be translated
layer	reference layer
renderer	renderer
units	type of units to be translated

Returns

value of tolerance in layer units

Deprecated:

since 2.4 - use the override with QgsMapSettings

Definition at line 70 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

tolerance	tolerance value to be translated
layer	source layer necessary in case tolerance is in layer units
mapSettings	settings of the map
units	type of units to be translated

Returns

value of tolerance in map units

Note

added in 2.8

Definition at line 36 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 75 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 85 of file qgstolerance.cpp.

double QgsTolerance::vertexSearchRadius ( QgsMapLayer *  layer, QgsMapRenderer *  renderer  )

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

Deprecated:

since 2.4 - use override with QgsMapSettings

Definition at line 93 of file qgstolerance.cpp.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgstolerance.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgstolerance.cpp