QGIS/python/core/auto_generated/qgsmapclippingutils.sip.in
2020-07-02 12:07:51 +10:00

54 lines
2.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmapclippingutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsMapClippingUtils
{
%Docstring
Utility functions for use when clipping map renders.
.. versionadded:: 3.16
%End
%TypeHeaderCode
#include "qgsmapclippingutils.h"
%End
public:
static QList< QgsMapClippingRegion > collectClippingRegionsForLayer( const QgsRenderContext &context, const QgsMapLayer *layer );
%Docstring
Collects the list of map clipping regions from a ``context`` which apply to a map ``layer``.
%End
static QgsGeometry calculateFeatureRequestGeometry( const QList< QgsMapClippingRegion > &regions, const QgsRenderContext &context, bool &shouldFilter );
%Docstring
Returns the geometry representing the intersection of clipping ``regions`` from ``context``.
The returned geometry will be automatically reprojected into the same CRS as the source layer, ready for use for filtering
a feature request.
:param regions: list of clip regions which apply to the layer
:param context: a render context
:param shouldFilter: will be set to ``True`` if layer's features should be filtered, i.e. one or more clipping regions applies to the layer
:return: combined clipping region for use when filtering features to render
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmapclippingutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/