Class QfSnappingUtils

ClassList > QfSnappingUtils

Inherits the following classes: QgsSnappingUtils

Public Properties

Type	Name
property QgsVectorLayer *	currentLayer
property bool	enabled
property QPointF	inputCoordinate
property QgsQuickMapSettings *	mapSettings
property QfSnappingResult	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
	QfSnappingUtils (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)
QfSnappingResult	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 * QfSnappingUtils::currentLayer;

---

property enabled [1/2]

bool QfSnappingUtils::enabled;

---

property inputCoordinate [1/2]

QPointF QfSnappingUtils::inputCoordinate;

---

property mapSettings [1/2]

QgsQuickMapSettings * QfSnappingUtils::mapSettings;

---

property snappingResult [1/2]

QfSnappingResult QfSnappingUtils::snappingResult;

---

Public Signals Documentation

signal currentLayerChanged

void QfSnappingUtils::currentLayerChanged;

---

signal enabledChanged

void QfSnappingUtils::enabledChanged;

---

signal indexingFinished

void QfSnappingUtils::indexingFinished;

---

signal indexingProgress

void QfSnappingUtils::indexingProgress;

---

signal indexingStarted

void QfSnappingUtils::indexingStarted;

---

signal inputCoordinateChanged

void QfSnappingUtils::inputCoordinateChanged;

---

signal mapSettingsChanged

void QfSnappingUtils::mapSettingsChanged;

---

signal snappingResultChanged

void QfSnappingUtils::snappingResultChanged;

---

Public Functions Documentation

function QfSnappingUtils

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

---

function currentLayer [2/2]

QgsVectorLayer * QfSnappingUtils::currentLayer () const

---

function enabled [2/2]

bool QfSnappingUtils::enabled () const

---

function inputCoordinate [2/2]

QPointF QfSnappingUtils::inputCoordinate () const

---

function mapSettings [2/2]

QgsQuickMapSettings * QfSnappingUtils::mapSettings () const

---

function setCurrentLayer

void QfSnappingUtils::setCurrentLayer (
    QgsVectorLayer * currentLayer
) 

---

function setEnabled

void QfSnappingUtils::setEnabled (
    bool enabled
) 

---

function setInputCoordinate

void QfSnappingUtils::setInputCoordinate (
    const QPointF & inputCoordinate
) 

---

function setMapSettings

void QfSnappingUtils::setMapSettings (
    QgsQuickMapSettings * settings
) 

---

function snappingResult [2/2]

QfSnappingResult QfSnappingUtils::snappingResult () const

---

Public Static Functions Documentation

function emptySnappingConfig

static inline Q_INVOKABLE QgsSnappingConfig QfSnappingUtils::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 QfSnappingUtils::newPoint (
    const QgsPoint & snappedPoint,
    const Qgis::WkbType wkbType
) 

---

Protected Functions Documentation

function prepareIndexProgress

virtual void QfSnappingUtils::prepareIndexProgress (
    int index
) override

---

function prepareIndexStarting

virtual void QfSnappingUtils::prepareIndexStarting (
    int count
) override

---

---

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