File: qgsmeshforcebypolylines.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 (127 lines) | stat: -rw-r--r-- 4,175 bytes parent folder | download | duplicates (14)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/mesh/qgsmeshforcebypolylines.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/



class QgsMeshEditForceByLine : QgsMeshAdvancedEditing
{
%Docstring(signature="appended")
Class derived from :py:class:`QgsMeshAdvancedEditing` that forces mesh
based on a line

Forcing lines consist of line that the faces are forced to follow, that
is edges of encountered faces have to be on theses lines.

Caller of this class has to set the line with :py:func:`~setInputLine`
before applying the edition with :py:func:`QgsMeshEditor.advancedEdit()`

Other option has also to be set before calling
:py:func:`QgsMeshEditor.advancedEdit()`

.. versionadded:: 3.22
%End

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

    QgsMeshEditForceByLine();

    void setInputLine( const QgsPoint &pt1, const QgsPoint &pt2, double tolerance, bool newVertexOnIntersection );
%Docstring
Sets the input forcing line in rendering coordinates
%End

    void setTolerance( double tolerance );
%Docstring
Sets the tolerance in redering coordinate system unit
%End

    void setAddVertexOnIntersection( bool addVertex );
%Docstring
Sets whether vertices will be added when the lines will intersect
internal edges of faces, default is ``False``
%End

    void setDefaultZValue( double defaultZValue );
%Docstring
Sets the default value of Z coordinate to use for new vertices, this
value will be used if the Z value
%End

    void setInterpolateZValueOnMesh( bool interpolateZValueOnMesh );
%Docstring
Sets whether the new created vertices will have their value interpolated
from the existing mesh. If not, Z value will be interpolated from the
lines, in case these line are not 3D, the default value will be used
(:py:func:`setDefaultZValue`)
%End

};



class QgsMeshEditForceByPolylines : QgsMeshEditForceByLine
{
%Docstring(signature="appended")
Class derived from :py:class:`QgsMeshEditForceByLine` that forces mesh
based on polyline.

Forcing lines consist of line that the faces are forced to follow, that
is edges of encountered faces have to be on theses lines.

Caller of this class has to add the lines from :py:class:`QgsGeometry`
instances with :py:func:`~addLineFromGeometry` or
:py:func:`~addLinesFromGeometries` before applying the edition with
:py:func:`QgsMeshEditor.advancedEdit()`

.. versionadded:: 3.22
%End

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

    QgsMeshEditForceByPolylines();

    virtual QString text() const;

    virtual bool isFinished() const;


    void addLineFromGeometry( const QgsGeometry &geom );
%Docstring
Adds a input forcing line geometry in rendering coordinates

.. note::

   if the geometry is not 3D, the default Z value will be used for the Z value of the geometry's vertices.
   This default Z value has to be set before adding the geometry (:py:func:`setDefaultZValue`
%End

    void addLinesFromGeometries( const QList<QgsGeometry> geometries );
%Docstring
Adds a list of input forcing lines geometry in rendering coordinates

.. note::

   if the geometry is not 3D, the default Z value will be used for the Z value of the geometry's vertices.
   This default Z value has to be set before adding the geometry (:py:func:`setDefaultZValue`
%End

};

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