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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/pointcloud/qgspointcloudrendererregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsPointCloudRendererAbstractMetadata
{
%Docstring(signature="appended")
Stores metadata about one point cloud renderer class.
.. note::
It's necessary to implement :py:func:`~createRenderer` function.
In C++ you can use :py:class:`QgsPointCloudRendererMetadata` convenience class.
.. versionadded:: 3.18
%End
%TypeHeaderCode
#include "qgspointcloudrendererregistry.h"
%End
public:
QgsPointCloudRendererAbstractMetadata( const QString &name, const QString &visibleName, const QIcon &icon = QIcon() );
%Docstring
Constructor for QgsPointCloudRendererAbstractMetadata, with the
specified ``name``.
The ``visibleName`` argument gives a translated, user friendly string
identifying the renderer type.
The ``icon`` argument can be used to specify an icon representing the
renderer.
%End
virtual ~QgsPointCloudRendererAbstractMetadata();
QString name() const;
%Docstring
Returns the unique name of the renderer. This value is not translated.
.. seealso:: :py:func:`visibleName`
%End
QString visibleName() const;
%Docstring
Returns a friendly display name of the renderer. This value is
translated.
.. seealso:: :py:func:`name`
%End
QIcon icon() const;
%Docstring
Returns an icon representing the renderer.
.. seealso:: :py:func:`setIcon`
%End
void setIcon( const QIcon &icon );
%Docstring
Sets an ``icon`` representing the renderer.
.. seealso:: :py:func:`icon`
%End
virtual QgsPointCloudRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) = 0 /Factory/;
%Docstring
Returns new instance of the renderer given the DOM element. Returns
``None`` on error. Pure virtual function: must be implemented in derived
classes.
%End
protected:
};
class QgsPointCloudRendererMetadata : QgsPointCloudRendererAbstractMetadata
{
%Docstring(signature="appended")
Convenience metadata class that uses static functions to create point
cloud renderer and its widget.
.. versionadded:: 3.18
%End
%TypeHeaderCode
#include "qgspointcloudrendererregistry.h"
%End
public:
virtual QgsPointCloudRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) /Factory/;
protected:
private:
QgsPointCloudRendererMetadata();
};
class QgsPointCloudRendererRegistry
{
%Docstring(signature="appended")
Registry of 2D renderers for point clouds.
:py:class:`QgsPointCloudRendererRegistry` is not usually directly
created, but rather accessed through
:py:func:`QgsApplication.pointCloudRendererRegistry()`.
.. versionadded:: 3.18
%End
%TypeHeaderCode
#include "qgspointcloudrendererregistry.h"
%End
public:
QgsPointCloudRendererRegistry();
~QgsPointCloudRendererRegistry();
bool addRenderer( QgsPointCloudRendererAbstractMetadata *metadata /Transfer/ );
%Docstring
Adds a renderer to the registry. Takes ownership of the metadata object.
:param metadata: renderer metadata
:return: ``True`` if renderer was added successfully, or ``False`` if
renderer could not be added (e.g., a renderer with a duplicate
name already exists)
%End
bool removeRenderer( const QString &rendererName );
%Docstring
Removes a renderer from registry.
:param rendererName: name of renderer to remove from registry
:return: ``True`` if renderer was successfully removed, or ``False`` if
matching renderer could not be found
%End
QgsPointCloudRendererAbstractMetadata *rendererMetadata( const QString &rendererName );
%Docstring
Returns the metadata for a specified renderer. Returns ``None`` if a
matching renderer was not found in the registry.
%End
QStringList renderersList() const;
%Docstring
Returns a list of available renderers.
%End
static QgsPointCloudRenderer *defaultRenderer( const QgsPointCloudLayer *layer ) /Factory/;
%Docstring
Returns a new default point cloud renderer for a specified ``layer``.
Caller takes ownership of the returned renderer.
%End
static QgsPointCloudCategoryList classificationAttributeCategories( const QgsPointCloudLayer *layer );
%Docstring
Returns a list of categories using the available Classification classes
of a specified ``layer``, along with default colors and translated names
for the 19 classes (0-18) of point data record formats 6-10
%End
private:
QgsPointCloudRendererRegistry( const QgsPointCloudRendererRegistry &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/pointcloud/qgspointcloudrendererregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
