mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-26 00:04:03 -04:00
92 lines
3.3 KiB
Plaintext
92 lines
3.3 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/symbology/qgsinvertedpolygonrenderer.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
class QgsInvertedPolygonRenderer : QgsMergedFeatureRenderer
|
|
{
|
|
%Docstring
|
|
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`.
|
|
|
|
.. versionadded:: 2.4
|
|
%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/;
|
|
|
|
%Docstring
|
|
Direct copies are forbidden. Use :py:func:`~QgsInvertedPolygonRenderer.clone` instead.
|
|
%End
|
|
|
|
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``.
|
|
|
|
.. versionadded:: 2.5
|
|
%End
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/symbology/qgsinvertedpolygonrenderer.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|