QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | List of all members
QgsSnappingConfig::IndividualLayerSettings Class Reference

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

#include <qgssnappingconfig.h>

Public Member Functions

 IndividualLayerSettings (bool enabled, QgsSnappingConfig::SnappingType type, double tolerance, QgsTolerance::UnitType units)
 IndividualLayerSettings. More...
 
 IndividualLayerSettings ()=default
 Constructs an invalid setting. More...
 
bool enabled () const
 Returns if snapping is enabled. More...
 
bool operator!= (const QgsSnappingConfig::IndividualLayerSettings &other) const
 Compare this configuration to other. More...
 
bool operator== (const QgsSnappingConfig::IndividualLayerSettings &other) const
 
void setEnabled (bool enabled)
 enables the snapping More...
 
void setTolerance (double tolerance)
 Sets the tolerance. More...
 
void setType (QgsSnappingConfig::SnappingType type)
 define the type of snapping More...
 
void setUnits (QgsTolerance::UnitType units)
 Sets the type of units. More...
 
double tolerance () const
 Returns the tolerance. More...
 
QgsSnappingConfig::SnappingType type () const
 Returns the type (vertices and/or segments) More...
 
QgsTolerance::UnitType units () const
 Returns the type of units. More...
 
bool valid () const
 Returns if settings are valid. More...
 

Detailed Description

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

Since
QGIS 3.0

Definition at line 69 of file qgssnappingconfig.h.

Constructor & Destructor Documentation

◆ IndividualLayerSettings() [1/2]

QgsSnappingConfig::IndividualLayerSettings::IndividualLayerSettings ( bool  enabled,
QgsSnappingConfig::SnappingType  type,
double  tolerance,
QgsTolerance::UnitType  units 
)

IndividualLayerSettings.

Parameters
enabled
type
tolerance
units

Definition at line 28 of file qgssnappingconfig.cpp.

◆ IndividualLayerSettings() [2/2]

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 41 of file qgssnappingconfig.cpp.

◆ operator!=()

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

Compare this configuration to other.

Definition at line 81 of file qgssnappingconfig.cpp.

◆ operator==()

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

Definition at line 90 of file qgssnappingconfig.cpp.

◆ setEnabled()

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

enables the snapping

Definition at line 46 of file qgssnappingconfig.cpp.

◆ setTolerance()

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

Sets the tolerance.

Definition at line 66 of file qgssnappingconfig.cpp.

◆ setType()

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

define the type of snapping

Definition at line 56 of file qgssnappingconfig.cpp.

◆ setUnits()

void QgsSnappingConfig::IndividualLayerSettings::setUnits ( QgsTolerance::UnitType  units)

Sets the type of units.

Definition at line 76 of file qgssnappingconfig.cpp.

◆ tolerance()

double QgsSnappingConfig::IndividualLayerSettings::tolerance ( ) const

Returns the tolerance.

Definition at line 61 of file qgssnappingconfig.cpp.

◆ type()

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

Returns the type (vertices and/or segments)

Definition at line 51 of file qgssnappingconfig.cpp.

◆ units()

QgsTolerance::UnitType QgsSnappingConfig::IndividualLayerSettings::units ( ) const

Returns the type of units.

Definition at line 71 of file qgssnappingconfig.cpp.

◆ valid()

bool QgsSnappingConfig::IndividualLayerSettings::valid ( ) const

Returns if settings are valid.

Definition at line 36 of file qgssnappingconfig.cpp.


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