QGIS/python/core/auto_generated/pointcloud/qgspointcloudextentrenderer.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

111 lines
3.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/pointcloud/qgspointcloudextentrenderer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsPointCloudExtentRenderer : QgsPointCloudRenderer
{
%Docstring(signature="appended")
A renderer for 2d visualisation of point clouds which shows the
dataset's extents using a fill symbol.
.. versionadded:: 3.18
%End
%TypeHeaderCode
#include "qgspointcloudextentrenderer.h"
%End
public:
QgsPointCloudExtentRenderer( QgsFillSymbol *symbol /Transfer/ = 0 );
%Docstring
Constructor for QgsPointCloudExtentRenderer.
Optionally the ``symbol`` to use for showing the extent can be
specified. If specified, ownership is transferred to the renderer. If no
``symbol`` is specified a default one will be created instead.
%End
~QgsPointCloudExtentRenderer();
virtual QString type() const;
virtual QgsPointCloudRenderer *clone() const;
virtual void renderBlock( const QgsPointCloudBlock *block, QgsPointCloudRenderContext &context );
virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const;
virtual void startRender( QgsPointCloudRenderContext &context );
virtual void stopRender( QgsPointCloudRenderContext &context );
virtual QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) /Factory/;
static QgsPointCloudRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
%Docstring
Creates an extent renderer from an XML ``element``.
%End
void renderExtent( const QgsGeometry &extent, QgsPointCloudRenderContext &context );
%Docstring
Renders a polygon ``extent`` geometry to the specified render
``context``.
%End
static QgsFillSymbol *defaultFillSymbol() /Factory/;
%Docstring
Returns a new instance of the default fill symbol to use for showing
point cloud extents.
%End
QgsFillSymbol *fillSymbol() const;
%Docstring
Returns the symbol used to render the cloud's extent.
.. seealso:: :py:func:`setFillSymbol`
%End
void setFillSymbol( QgsFillSymbol *symbol /Transfer/ );
%Docstring
Sets the ``symbol`` used to render the cloud's extent.
Ownership of ``symbol`` is transferred to the renderer.
.. seealso:: :py:func:`fillSymbol`
%End
void renderLabel( const QRectF &extent, const QString &text, QgsPointCloudRenderContext &context ) const;
%Docstring
Renders a label inside the specified extent rectangle.
The label will be rendered centered horizontally and vertically inside
``extent``. If the label is too large to fit inside this rectangle, it
will not be rendered.
:param extent: rectangle (in painter coordinates) inside which the label
will be rendered
:param text: label text to render
:param context: point cloud rendering context
.. versionadded:: 3.42
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/pointcloud/qgspointcloudextentrenderer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/