Class SnappingUtils

ClassList > SnappingUtils

Inherits the following classes: QgsSnappingUtils

Public Properties

Type	Name
property QgsVectorLayer *	currentLayer
property bool	enabled
property QPointF	inputCoordinate
property QgsQuickMapSettings *	mapSettings
property SnappingResult	snappingResult

Public Signals

Type	Name
signal void	currentLayerChanged
signal void	enabledChanged
signal void	indexingFinished
signal void	indexingProgress (int index)
signal void	indexingStarted (int count)
signal void	inputCoordinateChanged
signal void	mapSettingsChanged
signal void	snappingResultChanged

Public Functions

Type	Name
	SnappingUtils (QObject * parent=nullptr)
QgsVectorLayer *	currentLayer () const
bool	enabled () const
QPointF	inputCoordinate () const
QgsQuickMapSettings *	mapSettings () const
void	setCurrentLayer (QgsVectorLayer * currentLayer)
void	setEnabled (bool enabled)
void	setInputCoordinate (const QPointF & inputCoordinate)
void	setMapSettings (QgsQuickMapSettings * settings)
SnappingResult	snappingResult () const

Public Static Functions

Type	Name
Q_INVOKABLE QgsSnappingConfig	emptySnappingConfig ()
QgsPoint	newPoint (const QgsPoint & snappedPoint, const Qgis::WkbType wkbType)

Protected Functions

Type	Name
virtual void	prepareIndexProgress (int index) override
virtual void	prepareIndexStarting (int count) override

Public Properties Documentation

property currentLayer [1/2]

QgsVectorLayer * SnappingUtils::currentLayer;

---

property enabled [1/2]

bool SnappingUtils::enabled;

---

property inputCoordinate [1/2]

QPointF SnappingUtils::inputCoordinate;

---

property mapSettings [1/2]

QgsQuickMapSettings * SnappingUtils::mapSettings;

---

property snappingResult [1/2]

SnappingResult SnappingUtils::snappingResult;

---

Public Signals Documentation

signal currentLayerChanged

void SnappingUtils::currentLayerChanged;

---

signal enabledChanged

void SnappingUtils::enabledChanged;

---

signal indexingFinished

void SnappingUtils::indexingFinished;

---

signal indexingProgress

void SnappingUtils::indexingProgress;

---

signal indexingStarted

void SnappingUtils::indexingStarted;

---

signal inputCoordinateChanged

void SnappingUtils::inputCoordinateChanged;

---

signal mapSettingsChanged

void SnappingUtils::mapSettingsChanged;

---

signal snappingResultChanged

void SnappingUtils::snappingResultChanged;

---

Public Functions Documentation

function SnappingUtils

explicit SnappingUtils::SnappingUtils (
    QObject * parent=nullptr
) 

---

function currentLayer [2/2]

QgsVectorLayer * SnappingUtils::currentLayer () const

---

function enabled [2/2]

bool SnappingUtils::enabled () const

---

function inputCoordinate [2/2]

QPointF SnappingUtils::inputCoordinate () const

---

function mapSettings [2/2]

QgsQuickMapSettings * SnappingUtils::mapSettings () const

---

function setCurrentLayer

void SnappingUtils::setCurrentLayer (
    QgsVectorLayer * currentLayer
) 

---

function setEnabled

void SnappingUtils::setEnabled (
    bool enabled
) 

---

function setInputCoordinate

void SnappingUtils::setInputCoordinate (
    const QPointF & inputCoordinate
) 

---

function setMapSettings

void SnappingUtils::setMapSettings (
    QgsQuickMapSettings * settings
) 

---

function snappingResult [2/2]

SnappingResult SnappingUtils::snappingResult () const

---

Public Static Functions Documentation

function emptySnappingConfig

static inline Q_INVOKABLE QgsSnappingConfig SnappingUtils::emptySnappingConfig () 

Returns an empty snapping configuration object

Note:

This can be used in QML to avoid errors when a parent object pointer goes undefined

---

function newPoint

static QgsPoint SnappingUtils::newPoint (
    const QgsPoint & snappedPoint,
    const Qgis::WkbType wkbType
) 

---

Protected Functions Documentation

function prepareIndexProgress

virtual void SnappingUtils::prepareIndexProgress (
    int index
) override

---

function prepareIndexStarting

virtual void SnappingUtils::prepareIndexStarting (
    int count
) override

---

---

The documentation for this class was generated from the following file src/core/utils/snappingutils.h