File: qgs3dsymbolregistry.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 (130 lines) | stat: -rw-r--r-- 3,408 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/./3d/qgs3dsymbolregistry.h                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class Qgs3DSymbolAbstractMetadata
{
%Docstring(signature="appended")
Stores metadata about one 3D symbol class.

.. note::

   It's necessary to implement :py:func:`~createSymbol` function.
   In C++ you can use Qgs3DSymbolMetadata convenience class.

.. versionadded:: 3.16
%End

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

    Qgs3DSymbolAbstractMetadata( const QString &type, const QString &visibleName );
%Docstring
Constructor for Qgs3DSymbolAbstractMetadata, with the specified ``type``
and ``visibleName``.
%End

    virtual ~Qgs3DSymbolAbstractMetadata();

    QString type() const;
%Docstring
Returns the unique symbol type string.
%End

    QString visibleName() const;
%Docstring
Returns the symbol's visible (translated) name.
%End

    virtual QgsAbstract3DSymbol *create() = 0 /Factory/;
%Docstring
Creates a new instance of this symbol type.

Caller takes ownership of the returned symbol.
%End


};






class Qgs3DSymbolRegistry
{
%Docstring(signature="appended")
Registry of available 3D symbol classes.

Qgs3DSymbolRegistry is not usually directly created, but rather accessed
through :py:func:`QgsApplication.symbol3DRegistry()`.

.. versionadded:: 3.16
%End

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

    Qgs3DSymbolRegistry();
    ~Qgs3DSymbolRegistry();


    Qgs3DSymbolAbstractMetadata *symbolMetadata( const QString &type ) const;
%Docstring
Returns metadata for specified symbol ``type``. Returns ``None`` if not
found
%End

    QStringList symbolTypes() const;
%Docstring
Returns a list of all available symbol types.
%End

    bool addSymbolType( Qgs3DSymbolAbstractMetadata *metadata /Transfer/ );
%Docstring
Registers a new symbol type. Takes ownership of the ``metadata``
instance.
%End

    QgsAbstract3DSymbol *createSymbol( const QString &type ) const /Factory/;
%Docstring
Creates a new instance of a symbol of the specified ``type``.

The caller takes ownership of the returned symbol.

Returns ``None`` if the specified type is not found in the registry.
%End

    QgsAbstract3DSymbol *defaultSymbolForGeometryType( Qgis::GeometryType type ) /Factory/;
%Docstring
Creates a new instance of the default 3D symbol for the specified
geometry ``type``.

The caller takes ownership of the returned symbol.
%End


  private:
    Qgs3DSymbolRegistry( const Qgs3DSymbolRegistry &rh );
};


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