Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgspointcloudattributebyramprenderer.h
       3                 :            :                          --------------------
       4                 :            :     begin                : October 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 QGSPOINTCLOUDATTRIBUTEBYRAMPRENDERER_H
      19                 :            : #define QGSPOINTCLOUDATTRIBUTEBYRAMPRENDERER_H
      20                 :            : 
      21                 :            : #include "qgspointcloudrenderer.h"
      22                 :            : #include "qgis_core.h"
      23                 :            : #include "qgis_sip.h"
      24                 :            : #include "qgscolorrampshader.h"
      25                 :            : 
      26                 :            : /**
      27                 :            :  * \ingroup core
      28                 :            :  * \brief An RGB renderer for 2d visualisation of point clouds using embedded red, green and blue attributes.
      29                 :            :  *
      30                 :            :  * \since QGIS 3.18
      31                 :            :  */
      32                 :          0 : class CORE_EXPORT QgsPointCloudAttributeByRampRenderer : public QgsPointCloudRenderer
      33                 :            : {
      34                 :            :   public:
      35                 :            : 
      36                 :            :     /**
      37                 :            :      * Constructor for QgsPointCloudAttributeByRampRenderer.
      38                 :            :      */
      39                 :            :     QgsPointCloudAttributeByRampRenderer();
      40                 :            : 
      41                 :            :     QString type() const override;
      42                 :            :     QgsPointCloudRenderer *clone() const override;
      43                 :            :     void renderBlock( const QgsPointCloudBlock *block, QgsPointCloudRenderContext &context ) override;
      44                 :            :     QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const override;
      45                 :            :     QSet< QString > usedAttributes( const QgsPointCloudRenderContext &context ) const override;
      46                 :            :     QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) override SIP_FACTORY;
      47                 :            : 
      48                 :            :     /**
      49                 :            :      * Creates an RGB renderer from an XML \a element.
      50                 :            :      */
      51                 :            :     static QgsPointCloudRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
      52                 :            : 
      53                 :            :     /**
      54                 :            :      * Returns the attribute to use for the renderer.
      55                 :            :      *
      56                 :            :      * \see setAttribute()
      57                 :            :      */
      58                 :            :     QString attribute() const;
      59                 :            : 
      60                 :            :     /**
      61                 :            :      * Sets the \a attribute to use for the renderer.
      62                 :            :      *
      63                 :            :      * \see attribute()
      64                 :            :      */
      65                 :            :     void setAttribute( const QString &attribute );
      66                 :            : 
      67                 :            :     /**
      68                 :            :      * Returns the color ramp shader function used to visualize the attribute.
      69                 :            :      *
      70                 :            :      * \see setColorRampShader()
      71                 :            :      */
      72                 :            :     QgsColorRampShader colorRampShader() const;
      73                 :            : 
      74                 :            :     /**
      75                 :            :      * Sets the color ramp \a shader function used to visualize the attribute.
      76                 :            :      *
      77                 :            :      * \see colorRampShader()
      78                 :            :      */
      79                 :            :     void setColorRampShader( const QgsColorRampShader &shader );
      80                 :            : 
      81                 :            :     /**
      82                 :            :      * Returns the minimum value for attributes which will be used by the color ramp shader.
      83                 :            :      *
      84                 :            :      * \see setMinimum()
      85                 :            :      * \see maximum()
      86                 :            :      */
      87                 :            :     double minimum() const;
      88                 :            : 
      89                 :            :     /**
      90                 :            :      * Sets the \a minimum value for attributes which will be used by the color ramp shader.
      91                 :            :      *
      92                 :            :      * \see minimum()
      93                 :            :      * \see setMaximum()
      94                 :            :      */
      95                 :            :     void setMinimum( double minimum );
      96                 :            : 
      97                 :            :     /**
      98                 :            :      * Returns the maximum value for attributes which will be used by the color ramp shader.
      99                 :            :      *
     100                 :            :      * \see setMaximum()
     101                 :            :      * \see minimum()
     102                 :            :      */
     103                 :            :     double maximum() const;
     104                 :            : 
     105                 :            :     /**
     106                 :            :      * Sets the \a maximum value for attributes which will be used by the color ramp shader.
     107                 :            :      *
     108                 :            :      * \see maximum()
     109                 :            :      * \see setMinimum()
     110                 :            :      */
     111                 :            :     void setMaximum( double maximum );
     112                 :            : 
     113                 :            :   private:
     114                 :            : 
     115                 :            :     double mMin = 0;
     116                 :            :     double mMax = 100;
     117                 :            : 
     118                 :          0 :     QString mAttribute = QStringLiteral( "Intensity" );
     119                 :            :     QgsColorRampShader mColorRampShader;
     120                 :            : 
     121                 :            : };
     122                 :            : 
     123                 :            : #endif // QGSPOINTCLOUDATTRIBUTEBYRAMPRENDERER_H