This is a container of advanced configuration (per layer) of the snapping of the project. More...

#include <qgssnappingconfig.h>

Public Member Functions
	IndividualLayerSettings ()=default
	Constructs an invalid setting.

	IndividualLayerSettings (bool enabled, Qgis::SnappingTypes type, double tolerance, Qgis::MapToolUnit units, double minScale=0.0, double maxScale=0.0)
	IndividualLayerSettings.

Q_DECL_DEPRECATED	IndividualLayerSettings (bool enabled, SnappingType type, double tolerance, Qgis::MapToolUnit units)
	IndividualLayerSettings.

bool	enabled () const
	Returns if snapping is enabled.

double	maximumScale () const
	Returns max scale on which snapping is limited.

double	minimumScale () const
	Returns minimum scale on which snapping is limited.

bool	operator!= (const QgsSnappingConfig::IndividualLayerSettings &other) const

bool	operator== (const QgsSnappingConfig::IndividualLayerSettings &other) const

void	setEnabled (bool enabled)
	enables the snapping

void	setMaximumScale (double maxScale)
	Sets the max scale value on which snapping is used, 0.0 disable scale limit.

void	setMinimumScale (double minScale)
	Sets the min scale value on which snapping is used, 0.0 disable scale limit.

void	setTolerance (double tolerance)
	Sets the tolerance.

Q_DECL_DEPRECATED void	setType (SnappingType type)
	define the type of snapping

void	setTypeFlag (Qgis::SnappingTypes type)
	define the type of snapping

void	setUnits (Qgis::MapToolUnit units)
	Sets the type of units.

double	tolerance () const
	Returns the tolerance.

Q_DECL_DEPRECATED QgsSnappingConfig::SnappingType	type () const
	Returns the flags type (vertices \| segments \| area \| centroid \| middle)

Qgis::SnappingTypes	typeFlag () const
	Returns the flags type (vertices \| segments \| area \| centroid \| middle)

Qgis::MapToolUnit	units () const
	Returns the type of units.

bool	valid () const
	Returns if settings are valid.

Detailed Description

This is a container of advanced configuration (per layer) of the snapping of the project.

Definition at line 107 of file qgssnappingconfig.h.

Constructor & Destructor Documentation

◆ IndividualLayerSettings() [1/3]

QgsSnappingConfig::IndividualLayerSettings::IndividualLayerSettings	(	bool	enabled,
		SnappingType	type,
		double	tolerance,
		Qgis::MapToolUnit	units
	)

IndividualLayerSettings.

Parameters

enabled
type
tolerance
units

Deprecated:: QGIS 3.12. Use the method with Qgis::SnappingTypes instead.

Definition at line 41 of file qgssnappingconfig.cpp.

◆ IndividualLayerSettings() [2/3]

QgsSnappingConfig::IndividualLayerSettings::IndividualLayerSettings	(	bool	enabled,
		Qgis::SnappingTypes	type,
		double	tolerance,
		Qgis::MapToolUnit	units,
		double	minScale = `0.0`,
		double	maxScale = `0.0`
	)

IndividualLayerSettings.

Parameters

enabled
type
tolerance
units
minScale	0.0 disable scale limit
maxScale	0.0 disable scale limit

Since: QGIS 3.12

Definition at line 31 of file qgssnappingconfig.cpp.

◆ IndividualLayerSettings() [3/3]

QgsSnappingConfig::IndividualLayerSettings::IndividualLayerSettings ( )

default

Constructs an invalid setting.

Member Function Documentation

◆ enabled()

bool QgsSnappingConfig::IndividualLayerSettings::enabled ( ) const

Returns if snapping is enabled.

Definition at line 57 of file qgssnappingconfig.cpp.

◆ maximumScale()

double QgsSnappingConfig::IndividualLayerSettings::maximumScale ( ) const

Returns max scale on which snapping is limited.

Since: QGIS 3.14

Definition at line 137 of file qgssnappingconfig.cpp.

◆ minimumScale()

double QgsSnappingConfig::IndividualLayerSettings::minimumScale ( ) const

Returns minimum scale on which snapping is limited.

Since: QGIS 3.14

Definition at line 127 of file qgssnappingconfig.cpp.

◆ operator!=()

bool QgsSnappingConfig::IndividualLayerSettings::operator!= ( const QgsSnappingConfig::IndividualLayerSettings & other ) const

Definition at line 147 of file qgssnappingconfig.cpp.

◆ operator==()

bool QgsSnappingConfig::IndividualLayerSettings::operator== ( const QgsSnappingConfig::IndividualLayerSettings & other ) const

Definition at line 158 of file qgssnappingconfig.cpp.

◆ setEnabled()

void QgsSnappingConfig::IndividualLayerSettings::setEnabled ( bool enabled )

enables the snapping

Definition at line 62 of file qgssnappingconfig.cpp.

◆ setMaximumScale()

void QgsSnappingConfig::IndividualLayerSettings::setMaximumScale ( double maxScale )

Sets the max scale value on which snapping is used, 0.0 disable scale limit.

Since: QGIS 3.14

Definition at line 142 of file qgssnappingconfig.cpp.

◆ setMinimumScale()

void QgsSnappingConfig::IndividualLayerSettings::setMinimumScale ( double minScale )

Sets the min scale value on which snapping is used, 0.0 disable scale limit.

Since: QGIS 3.14

Definition at line 132 of file qgssnappingconfig.cpp.

◆ setTolerance()

void QgsSnappingConfig::IndividualLayerSettings::setTolerance ( double tolerance )

Sets the tolerance.

Definition at line 112 of file qgssnappingconfig.cpp.

◆ setType()

void QgsSnappingConfig::IndividualLayerSettings::setType ( QgsSnappingConfig::SnappingType type )

define the type of snapping

Deprecated:: QGIS 3.12. Use setTypeFlag() instead.

Definition at line 84 of file qgssnappingconfig.cpp.

◆ setTypeFlag()

void QgsSnappingConfig::IndividualLayerSettings::setTypeFlag ( Qgis::SnappingTypes type )

define the type of snapping

Since: QGIS 3.12

Definition at line 102 of file qgssnappingconfig.cpp.

◆ setUnits()

void QgsSnappingConfig::IndividualLayerSettings::setUnits ( Qgis::MapToolUnit units )

Sets the type of units.

Definition at line 122 of file qgssnappingconfig.cpp.

◆ tolerance()

double QgsSnappingConfig::IndividualLayerSettings::tolerance ( ) const

Returns the tolerance.

Definition at line 107 of file qgssnappingconfig.cpp.

◆ type()

QgsSnappingConfig::SnappingType QgsSnappingConfig::IndividualLayerSettings::type ( ) const

Returns the flags type (vertices | segments | area | centroid | middle)

Deprecated:: QGIS 3.12. Use typeFlag() instead.

Definition at line 72 of file qgssnappingconfig.cpp.

◆ typeFlag()

Qgis::SnappingTypes QgsSnappingConfig::IndividualLayerSettings::typeFlag ( ) const

Returns the flags type (vertices | segments | area | centroid | middle)

Since: QGIS 3.12

Definition at line 67 of file qgssnappingconfig.cpp.

◆ units()

Qgis::MapToolUnit QgsSnappingConfig::IndividualLayerSettings::units ( ) const

Returns the type of units.

Definition at line 117 of file qgssnappingconfig.cpp.

◆ valid()

bool QgsSnappingConfig::IndividualLayerSettings::valid ( ) const

Returns if settings are valid.

Definition at line 52 of file qgssnappingconfig.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/qgssnappingconfig.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/qgssnappingconfig.cpp

Public Member Functions