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


class QgsInvertedPolygonRenderer : QgsMergedFeatureRenderer
{
%Docstring(signature="appended")
:py:class:`QgsInvertedPolygonRenderer` is a polygon-only feature
renderer used to display features inverted, where the exterior is turned
to an interior and where the exterior theoretically spans the entire
plane, allowing to mask the surroundings of some features.

It is designed on top of another feature renderer, which is called
"embedded" Most of the methods are then only proxies to the embedded
renderer.

Features are collected to form one "inverted" polygon during
:py:func:`~renderFeature` and rendered on :py:func:`~stopRender`.
%End

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

    QgsInvertedPolygonRenderer( QgsFeatureRenderer *embeddedRenderer /Transfer/ = 0 );
%Docstring
Constructor

:param embeddedRenderer: optional embeddedRenderer. If ``None``, a
                         default one will be assigned. Ownership will be
                         transferred.
%End


    virtual QgsInvertedPolygonRenderer *clone() const /Factory/;


    virtual QString dump() const;


    static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
%Docstring
Creates a renderer out of an XML, for loading
%End

    virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context );


    bool preprocessingEnabled() const;
%Docstring
:return: ``True`` if the geometries are to be preprocessed (merged with
         an union) before rendering.
%End

    void setPreprocessingEnabled( bool enabled );
%Docstring
:param enabled: enables or disables the preprocessing. When enabled,
                geometries will be merged with an union before being
                rendered. It allows fixing some rendering artifacts
                (when rendering overlapping polygons for instance). This
                will involve some CPU-demanding computations and is thus
                disabled by default.
%End

    static QgsInvertedPolygonRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) /Factory/;
%Docstring
Creates a QgsInvertedPolygonRenderer by a conversion from an existing
renderer.

:return: a new renderer if the conversion was possible, otherwise
         ``None``.
%End

};


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