QGIS API Documentation 3.35.0-Master (f6e073f0eed)
Loading...
Searching...
No Matches
qgscadutils.h
Go to the documentation of this file.
1/***************************************************************************
2 qgscadutils.h
3 -------------------
4 begin : September 2017
5 copyright : (C) 2017 by Martin Dobias
6 email : wonder dot sk at gmail dot com
7 ***************************************************************************/
8/***************************************************************************
9 * *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
14 * *
15 ***************************************************************************/
16
17#ifndef QGSCADUTILS_H
18#define QGSCADUTILS_H
19
20#include <QQueue>
21
22#include "qgis_core.h"
23#include "qgspointlocator.h"
24
25
27
33class CORE_EXPORT QgsCadUtils
34{
35 public:
36
42 {
43 public:
44
48 AlignMapPointConstraint( bool locked = false, bool relative = false, double value = 0 )
49 : locked( locked )
50 , relative( relative )
51 , value( value )
52 {}
53
55 bool locked;
59 double value;
60 };
61
94
100 {
101 public:
103 QgsSnappingUtils *snappingUtils = nullptr;
106
111
117
129
132
137 bool snappingToFeaturesOverridesCommonAngle = false;
138
143 SIP_SKIP void dump() const;
144
154 QList< QgsPoint > cadPoints() const { return mCadPointList; } ;
155
162 void setCadPoints( const QList< QgsPoint > &points ) { mCadPointList = points; };
163
170 void setCadPoint( int index, const QgsPoint &point ) { mCadPointList[index] = point; };
171
178 QgsPoint cadPoint( int index ) const { return mCadPointList[index]; };
179
188 void setLockedSnapVertices( const QQueue< QgsPointLocator::Match > &lockedSnapVertices ) { mLockedSnapVertices = lockedSnapVertices; } SIP_SKIP;
189
196 QQueue< QgsPointLocator::Match > lockedSnapVertices() const { return mLockedSnapVertices; } SIP_SKIP;
197
198
199#ifdef SIP_RUN
200 SIP_PROPERTY( name = cadPointList, get = _cadPointList, set = _setCadPointList )
201#endif
203 void _setCadPointList( const QList< QgsPointXY > &list ) { mCadPointList.clear(); for ( const auto &pointxy : list ) { mCadPointList.append( QgsPoint( pointxy ) );} }
204 QList< QgsPointXY > _cadPointList() const { QList< QgsPointXY> list; for ( const auto &point : mCadPointList ) { list.append( QgsPointXY( point.x(), point.y() ) ); }; return list; }
206
207 private:
208
214 QList<QgsPoint> mCadPointList;
215 QQueue< QgsPointLocator::Match > mLockedSnapVertices;
216
217 };
218
224 static QgsCadUtils::AlignMapPointOutput alignMapPoint( const QgsPointXY &originalMapPoint, const QgsCadUtils::AlignMapPointContext &ctx );
225
226};
227
228#endif // QGSCADUTILS_H
LineExtensionSide
Designates whether the line extension constraint is currently soft locked with the previous or next v...
Definition qgis.h:3254
Structure with details of one constraint.
Definition qgscadutils.h:42
AlignMapPointConstraint(bool locked=false, bool relative=false, double value=0)
Constructor for AlignMapPointConstraint.
Definition qgscadutils.h:48
bool locked
Whether the constraint is active, i.e. should be considered.
Definition qgscadutils.h:55
double value
Numeric value of the constraint (coordinate/distance in map units or angle in degrees)
Definition qgscadutils.h:59
bool relative
Whether the value is relative to previous value.
Definition qgscadutils.h:57
Defines constraints for the QgsCadUtils::alignMapPoint() method.
QgsCadUtils::AlignMapPointConstraint xyVertexConstraint
QgsCadUtils::AlignMapPointConstraint yConstraint
Constraint for Y coordinate.
QgsCadUtils::AlignMapPointConstraint xConstraint
Constraint for X coordinate.
double mapUnitsPerPixel
Map units/pixel ratio from map canvas.
void setCadPoints(const QList< QgsPoint > &points)
Sets the list of recent CAD points (in map coordinates).
void setLockedSnapVertices(const QQueue< QgsPointLocator::Match > &lockedSnapVertices)
Sets the queue of locked vertices.
QgsCadUtils::AlignMapPointConstraint mConstraint
Constraint for M coordinate.
QgsPoint cadPoint(int index) const
Returns the recent CAD point at the specified index (in map coordinates).
void setCadPoint(int index, const QgsPoint &point)
Sets the recent CAD point at the specified index to point (in map coordinates).
QgsCadUtils::AlignMapPointConstraint distanceConstraint
Constraint for distance.
QgsCadUtils::AlignMapPointConstraint zConstraint
Constraint for Z coordinate.
QgsCadUtils::AlignMapPointConstraint commonAngleConstraint
Constraint for soft lock to a common angle.
QQueue< QgsPointLocator::Match > lockedSnapVertices() const
Returns the queue of point locator matches that contain the locked vertices.
QgsCadUtils::AlignMapPointConstraint lineExtensionConstraint
QList< QgsPoint > cadPoints() const
Returns the list of recent CAD points in map coordinates.
QgsCadUtils::AlignMapPointConstraint angleConstraint
Constraint for angle.
Structure returned from alignMapPoint() method.
Definition qgscadutils.h:67
Qgis::LineExtensionSide softLockLineExtension
Definition qgscadutils.h:90
QgsPointXY finalMapPoint
map point aligned according to the constraints
Definition qgscadutils.h:73
bool valid
Whether the combination of constraints is actually valid.
Definition qgscadutils.h:70
QgsPointLocator::Match snapMatch
Snapped point - only valid if actually used for something.
Definition qgscadutils.h:79
QgsPointLocator::Match edgeMatch
Snapped segment - only valid if actually used for something.
Definition qgscadutils.h:85
double softLockCommonAngle
Angle (in degrees) to which we have soft-locked ourselves (if not set it is -1)
Definition qgscadutils.h:88
The QgsCadUtils class provides routines for CAD editing.
Definition qgscadutils.h:34
A class to represent a 2D point.
Definition qgspointxy.h:60
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
This class has all the configuration of snapping and can return answers to snapping queries.
#define SIP_PROPERTY(name, getter, setter)
Definition qgis_sip.h:283
#define SIP_SKIP
Definition qgis_sip.h:126