mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
92 lines
3.7 KiB
Plaintext
92 lines
3.7 KiB
Plaintext
|
|
class QgsSnappingUtils : QObject
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgssnappingutils.h>
|
|
%End
|
|
|
|
public:
|
|
QgsSnappingUtils( QObject* parent /TransferThis/ = 0 );
|
|
~QgsSnappingUtils();
|
|
|
|
// main actions
|
|
|
|
/** get a point locator for the given layer. If such locator does not exist, it will be created */
|
|
QgsPointLocator* locatorForLayer( QgsVectorLayer* vl );
|
|
|
|
/** snap to map according to the current configuration (mode). Optional filter allows to discard unwanted matches. */
|
|
QgsPointLocator::Match snapToMap( const QPoint& point, QgsPointLocator::MatchFilter* filter = 0 );
|
|
QgsPointLocator::Match snapToMap( const QgsPoint& pointMap, QgsPointLocator::MatchFilter* filter = 0 );
|
|
|
|
/** snap to current layer */
|
|
QgsPointLocator::Match snapToCurrentLayer( const QPoint& point, int type, QgsPointLocator::MatchFilter* filter = 0 );
|
|
|
|
// environment setup
|
|
|
|
/** assign current map settings to the utils - used for conversion between screen coords to map coords */
|
|
void setMapSettings( const QgsMapSettings& settings );
|
|
const QgsMapSettings& mapSettings() const;
|
|
|
|
/** set current layer so that if mode is SnapCurrentLayer we know which layer to use */
|
|
void setCurrentLayer( QgsVectorLayer* layer );
|
|
QgsVectorLayer* currentLayer() const;
|
|
|
|
|
|
// configuration
|
|
|
|
//! modes for "snap to background"
|
|
enum SnapToMapMode
|
|
{
|
|
SnapCurrentLayer, //!< snap just to current layer (tolerance and type from defaultSettings())
|
|
SnapAllLayers, //!< snap to all rendered layers (tolerance and type from defaultSettings())
|
|
SnapAdvanced, //!< snap according to the configuration set in setLayers()
|
|
};
|
|
|
|
/** Set how the snapping to map is done */
|
|
void setSnapToMapMode( SnapToMapMode mode );
|
|
/** Find out how the snapping to map is done */
|
|
SnapToMapMode snapToMapMode() const;
|
|
|
|
enum IndexingStrategy
|
|
{
|
|
IndexAlwaysFull, //!< For all layers build index of full extent. Uses more memory, but queries are faster.
|
|
IndexNeverFull, //!< For all layers only create temporary indexes of small extent. Low memory usage, slower queries.
|
|
IndexHybrid //!< For "big" layers using IndexNeverFull, for the rest IndexAlwaysFull. Compromise between speed and memory usage.
|
|
};
|
|
|
|
/** Set a strategy for indexing geometry data - determines how fast and memory consuming the data structures will be */
|
|
void setIndexingStrategy( IndexingStrategy strategy );
|
|
/** Find out which strategy is used for indexing - by default hybrid indexing is used */
|
|
IndexingStrategy indexingStrategy() const;
|
|
|
|
/** configure options used when the mode is snap to current layer */
|
|
void setDefaultSettings( int type, double tolerance, QgsTolerance::UnitType unit );
|
|
/** query options used when the mode is snap to current layer */
|
|
void defaultSettings( int& type /Out/, double& tolerance /Out/, QgsTolerance::UnitType& unit /Out/ );
|
|
|
|
struct LayerConfig
|
|
{
|
|
LayerConfig( QgsVectorLayer* l, int t, double tol, QgsTolerance::UnitType u );
|
|
|
|
QgsVectorLayer* layer;
|
|
int type;
|
|
double tolerance;
|
|
QgsTolerance::UnitType unit;
|
|
};
|
|
|
|
/** Set layers which will be used for snapping */
|
|
void setLayers( const QList<QgsSnappingUtils::LayerConfig>& layers );
|
|
/** Query layers used for snapping */
|
|
QList<QgsSnappingUtils::LayerConfig> layers() const;
|
|
|
|
/** Set whether to consider intersections of nearby segments for snapping */
|
|
void setSnapOnIntersections( bool enabled );
|
|
/** Query whether to consider intersections of nearby segments for snapping */
|
|
bool snapOnIntersections() const;
|
|
|
|
public slots:
|
|
/** Read snapping configuration from the project */
|
|
void readConfigFromProject();
|
|
|
|
};
|