Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgspointcloudextentrenderer.h
       3                 :            :                          --------------------
       4                 :            :     begin                : December 2020
       5                 :            :     copyright            : (C) 2020 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSPOINTCLOUDEXTENTRENDERER_H
      19                 :            : #define QGSPOINTCLOUDEXTENTRENDERER_H
      20                 :            : 
      21                 :            : #include "qgspointcloudrenderer.h"
      22                 :            : #include "qgis_core.h"
      23                 :            : #include "qgis_sip.h"
      24                 :            : 
      25                 :            : #include "qgssymbol.h"
      26                 :            : 
      27                 :            : /**
      28                 :            :  * \ingroup core
      29                 :            :  * \brief A renderer for 2d visualisation of point clouds which shows the dataset's extents using a fill symbol.
      30                 :            :  *
      31                 :            :  * \since QGIS 3.18
      32                 :            :  */
      33                 :          0 : class CORE_EXPORT QgsPointCloudExtentRenderer : public QgsPointCloudRenderer
      34                 :            : {
      35                 :            :   public:
      36                 :            : 
      37                 :            :     /**
      38                 :            :      * Constructor for QgsPointCloudExtentRenderer.
      39                 :            :      *
      40                 :            :      * Optionally the \a symbol to use for showing the extent can be specified. If specified, ownership is
      41                 :            :      * transferred to the renderer. If no \a symbol is specified a default one will be created instead.
      42                 :            :      */
      43                 :            :     QgsPointCloudExtentRenderer( QgsFillSymbol *symbol SIP_TRANSFER = nullptr );
      44                 :            : 
      45                 :            :     QString type() const override;
      46                 :            :     QgsPointCloudRenderer *clone() const override;
      47                 :            :     void renderBlock( const QgsPointCloudBlock *block, QgsPointCloudRenderContext &context ) override;
      48                 :            :     QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const override;
      49                 :            : 
      50                 :            :     void startRender( QgsPointCloudRenderContext &context ) override;
      51                 :            :     void stopRender( QgsPointCloudRenderContext &context ) override;
      52                 :            :     QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) override SIP_FACTORY;
      53                 :            : 
      54                 :            :     /**
      55                 :            :      * Creates an extent renderer from an XML \a element.
      56                 :            :      */
      57                 :            :     static QgsPointCloudRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
      58                 :            : 
      59                 :            :     /**
      60                 :            :      * Renders a polygon \a extent geometry to the specified render \a context.
      61                 :            :      */
      62                 :            :     void renderExtent( const QgsGeometry &extent, QgsPointCloudRenderContext &context );
      63                 :            : 
      64                 :            :     /**
      65                 :            :      * Returns a new instance of the default fill symbol to use for showing point cloud extents.
      66                 :            :      */
      67                 :            :     static QgsFillSymbol *defaultFillSymbol() SIP_FACTORY;
      68                 :            : 
      69                 :            :     /**
      70                 :            :      * Returns the symbol used to render the cloud's extent.
      71                 :            :      *
      72                 :            :      * \see setFillSymbol()
      73                 :            :      */
      74                 :            :     QgsFillSymbol *fillSymbol() const;
      75                 :            : 
      76                 :            :     /**
      77                 :            :      * Sets the \a symbol used to render the cloud's extent.
      78                 :            :      *
      79                 :            :      * Ownership of \a symbol is transferred to the renderer.
      80                 :            :      *
      81                 :            :      * \see fillSymbol()
      82                 :            :      */
      83                 :            :     void setFillSymbol( QgsFillSymbol *symbol SIP_TRANSFER );
      84                 :            : 
      85                 :            :   private:
      86                 :            : 
      87                 :            :     std::unique_ptr< QgsFillSymbol > mFillSymbol;
      88                 :            : 
      89                 :            : };
      90                 :            : 
      91                 :            : #endif // QGSPOINTCLOUDEXTENTRENDERER_H