File: qgspointcloudlayer.sip.in

package info (click to toggle)
qgis 3.40.13%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 1,185,160 kB
  • sloc: cpp: 1,615,781; python: 372,865; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,829; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 155
file content (241 lines) | stat: -rw-r--r-- 7,164 bytes parent folder | download | duplicates (8)
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/pointcloud/qgspointcloudlayer.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/







class QgsPointCloudLayer : QgsMapLayer, QgsAbstractProfileSource
{
%Docstring(signature="appended")
Represents a map layer supporting display of point clouds

.. note::

   The API is considered EXPERIMENTAL and can be changed without a notice

.. versionadded:: 3.18
%End

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

    struct LayerOptions
    {

      explicit LayerOptions( const QgsCoordinateTransformContext &transformContext = QgsCoordinateTransformContext( ) );
%Docstring
Constructor for LayerOptions with optional ``transformContext``.
%End

      QgsCoordinateTransformContext transformContext;

      bool loadDefaultStyle;

      bool skipCrsValidation;

      bool skipIndexGeneration;

      bool skipStatisticsCalculation;
    };


    enum class PointCloudStatisticsCalculationState
    {
      NotStarted,
      Calculating,
      Calculated
    };

    explicit QgsPointCloudLayer( const QString &uri = QString(),
                                 const QString &baseName = QString(),
                                 const QString &providerLib = QStringLiteral( "pointcloud" ),
                                 const QgsPointCloudLayer::LayerOptions &options = QgsPointCloudLayer::LayerOptions() );
%Docstring
Constructor - creates a point cloud layer
%End

    ~QgsPointCloudLayer();


    SIP_PYOBJECT __repr__();
%MethodCode
    QString str = QStringLiteral( "<QgsPointCloudLayer: '%1' (%2)>" ).arg( sipCpp->name(), sipCpp->dataProvider() ? sipCpp->dataProvider()->name() : QStringLiteral( "Invalid" ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

    virtual QgsPointCloudLayer *clone() const /Factory/;

    virtual QgsRectangle extent() const;

    virtual QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) /Factory/;

    virtual QgsAbstractProfileGenerator *createProfileGenerator( const QgsProfileRequest &request ) /Factory/;


    virtual QgsPointCloudDataProvider *dataProvider();


    virtual bool readXml( const QDomNode &layerNode, QgsReadWriteContext &context );


    virtual bool writeXml( QDomNode &layerNode, QDomDocument &doc, const QgsReadWriteContext &context ) const;


     virtual bool readSymbology( const QDomNode &node, QString &errorMessage,
                        QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories );
    virtual bool readStyle( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) ${SIP_FINAL};


     virtual bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context,
                         StyleCategories categories = AllStyleCategories ) const;
    virtual bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) const ${SIP_FINAL};


    virtual void setTransformContext( const QgsCoordinateTransformContext &transformContext );


    virtual QString encodedSource( const QString &source, const QgsReadWriteContext &context ) const;

    virtual QString decodedSource( const QString &source, const QString &dataProvider, const QgsReadWriteContext &context ) const;

    virtual QString loadDefaultStyle( bool &resultFlag /Out/ ) ${SIP_FINAL};

    virtual QString htmlMetadata() const;

    virtual QgsMapLayerElevationProperties *elevationProperties();


    QgsPointCloudAttributeCollection attributes() const;
%Docstring
Returns the attributes available from the layer.
%End

    qint64 pointCount() const;
%Docstring
Returns the total number of points available in the layer.
%End

    QgsPointCloudRenderer *renderer();
%Docstring
Returns the 2D renderer for the point cloud.

.. seealso:: :py:func:`setRenderer`
%End


    void setRenderer( QgsPointCloudRenderer *renderer /Transfer/ );
%Docstring
Sets the 2D ``renderer`` for the point cloud.

Ownership of ``renderer`` is transferred to the layer.

.. seealso:: :py:func:`renderer`
%End

    bool setSubsetString( const QString &subset );
%Docstring
Sets the string used to define a subset of the layer

:param subset: The subset string to be used in a
               ``:py:class:`QgsPointCloudExpression```

:return: ``True``, when setting the subset string was successful,
         ``False`` otherwise

.. versionadded:: 3.26
%End

    QString subsetString() const;
%Docstring
Returns the string used to define a subset of the layer.

:return: The subset string or null QString if not implemented by the
         provider

.. versionadded:: 3.26
%End

    void setSync3DRendererTo2DRenderer( bool sync );
%Docstring
Sets whether this layer's 3D renderer should be automatically updated
with changes applied to the layer's 2D renderer

.. versionadded:: 3.26
%End

    bool sync3DRendererTo2DRenderer() const;
%Docstring
Returns whether this layer's 3D renderer should be automatically updated
with changes applied to the layer's 2D renderer

.. versionadded:: 3.26
%End

    bool convertRenderer3DFromRenderer2D();
%Docstring
Updates the layer's 3D renderer's symbol to match that of the layer's 2D
renderer

:return: ``True`` on success, ``False`` otherwise

.. versionadded:: 3.26
%End

    const QgsPointCloudStatistics statistics() const;
%Docstring
Returns the object containing statistics

.. versionadded:: 3.26
%End

    PointCloudStatisticsCalculationState statisticsCalculationState() const;
%Docstring
Returns the status of point cloud statistics calculation

.. versionadded:: 3.26
%End
  signals:

    void subsetStringChanged();
%Docstring
Emitted when the layer's subset string has changed.

.. versionadded:: 3.26
%End

    void raiseError( const QString &msg );
%Docstring
Signals an error related to this point cloud layer.

.. versionadded:: 3.26
%End

    void statisticsCalculationStateChanged( QgsPointCloudLayer::PointCloudStatisticsCalculationState state );
%Docstring
Emitted when statistics calculation state has changed

.. versionadded:: 3.26
%End

  private:
    QgsPointCloudLayer( const QgsPointCloudLayer &rhs );
};


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