File: qgscadutils.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (159 lines) | stat: -rw-r--r-- 4,494 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgscadutils.h                                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsCadUtils
{
%Docstring(signature="appended")
The :py:class:`QgsCadUtils` class provides routines for CAD editing.
%End

%TypeHeaderCode
#include "qgscadutils.h"
%End
  public:

    class AlignMapPointConstraint
{
%Docstring(signature="appended")
Structure with details of one constraint
%End

%TypeHeaderCode
#include "qgscadutils.h"
%End
      public:

        AlignMapPointConstraint( bool locked = false, bool relative = false, double value = 0 );
%Docstring
Constructor for AlignMapPointConstraint.
%End

        bool locked;
        bool relative;
        double value;
    };

    class AlignMapPointOutput
{
%Docstring(signature="appended")
Structure returned from :py:func:`~QgsCadUtils.alignMapPoint` method
%End

%TypeHeaderCode
#include "qgscadutils.h"
%End
      public:
        bool valid;

        QgsPointXY finalMapPoint;

        QgsPointLocator::Match snapMatch;

        QgsPointLocator::Match edgeMatch;

        double softLockCommonAngle;

        Qgis::LineExtensionSide softLockLineExtension;
        double softLockX;
        double softLockY;
    };

    class AlignMapPointContext
{
%Docstring(signature="appended")
Defines constraints for the :py:func:`QgsCadUtils.alignMapPoint()`
method.
%End

%TypeHeaderCode
#include "qgscadutils.h"
%End
      public:
        QgsSnappingUtils *snappingUtils;
        double mapUnitsPerPixel;

        QgsCadUtils::AlignMapPointConstraint xConstraint;
        QgsCadUtils::AlignMapPointConstraint yConstraint;

        QgsCadUtils::AlignMapPointConstraint zConstraint;

        QgsCadUtils::AlignMapPointConstraint mConstraint;
        QgsCadUtils::AlignMapPointConstraint distanceConstraint;
        QgsCadUtils::AlignMapPointConstraint angleConstraint;
        QgsCadUtils::AlignMapPointConstraint commonAngleConstraint;

        QgsCadUtils::AlignMapPointConstraint lineExtensionConstraint;
        QgsCadUtils::AlignMapPointConstraint xyVertexConstraint;

        bool snappingToFeaturesOverridesCommonAngle;


        QList< QgsPoint > cadPoints() const;
%Docstring
Returns the list of recent CAD points in map coordinates.

These are used to turn relative constraints to absolute. The first point
is the most recent point.

.. seealso:: :py:func:`setCadPoints`

.. versionadded:: 3.22
%End
        void setCadPoints( const QList< QgsPoint > &points );
%Docstring
Sets the list of recent CAD ``points`` (in map coordinates).

.. seealso:: :py:func:`cadPoints`

.. versionadded:: 3.22
%End
        void setCadPoint( int index, const QgsPoint &point );
%Docstring
Sets the recent CAD point at the specified ``index`` to ``point`` (in
map coordinates).

.. seealso:: :py:func:`cadPoint`

.. versionadded:: 3.22
%End
        QgsPoint cadPoint( int index ) const;
%Docstring
Returns the recent CAD point at the specified ``index`` (in map
coordinates).

.. seealso:: :py:func:`setCadPoint`

.. versionadded:: 3.22
%End
%Property( name = cadPointList, get = _cadPointList, set = _setCadPointList )
        void _setCadPointList( const QList< QgsPointXY > &list );
        QList< QgsPointXY > _cadPointList() const;

    };

    static QgsCadUtils::AlignMapPointOutput alignMapPoint( const QgsPointXY &originalMapPoint, const QgsCadUtils::AlignMapPointContext &ctx );
%Docstring
Applies X/Y/angle/distance constraints from the given context to a map
point. Returns a structure containing aligned map point, whether the
constraints are valid and some extra information.
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgscadutils.h                                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/