qgspointcloudclassifiedrenderer.h

Go to the documentation of this file.

/***************************************************************************
                         qgspointcloudclassifiedrenderer.h
                         --------------------
    begin                : October 2020
    copyright            : (C) 2020 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSPOINTCLOUDCLASSIFIEDRENDERER_H
#define QGSPOINTCLOUDCLASSIFIEDRENDERER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgspointcloudrenderer.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsPointCloudCategory
{
  public:
    QgsPointCloudCategory() = default;

    QgsPointCloudCategory( int value, const QColor &color, const QString &label, bool render = true, double pointSize = 0 );

    bool operator==( const QgsPointCloudCategory &other ) const;

    int value() const { return mValue; }

    QColor color() const { return mColor; }

    double pointSize() const { return mPointSize; }

    QString label() const { return mLabel; }

    void setValue( int value ) { mValue = value; }

    void setColor( const QColor &color ) { mColor = color; }

    void setPointSize( double size ) { mPointSize = size; }

    void setLabel( const QString &label ) { mLabel = label; }

    bool renderState() const { return mRender; }

    void setRenderState( bool render ) { mRender = render; }
 
  protected:
    int mValue = 0;
    QColor mColor;
    double mPointSize = 0; // Values <= 0 means "use default layer point size"
    QString mLabel;
    bool mRender = true;
};
 
typedef QList<QgsPointCloudCategory> QgsPointCloudCategoryList;
 
#ifndef SIP_RUN

class CORE_EXPORT QgsPointCloudClassifiedRendererPreparedData : public QgsPreparedPointCloudRendererData
{
  public:
    QSet< QString > usedAttributes() const override;
    bool prepareBlock( const QgsPointCloudBlock *block ) override;
    QColor pointColor( const QgsPointCloudBlock *block, int i, double z ) override SIP_SKIP;
 
    QgsPointCloudAttribute::DataType attributeType;
    QHash< int, QColor > colors;
    QString attributeName;
    int attributeOffset = 0;
};
#endif

class CORE_EXPORT QgsPointCloudClassifiedRenderer : public QgsPointCloudRenderer
{
  public:
    QgsPointCloudClassifiedRenderer( const QString &attributeName = QString(), const QgsPointCloudCategoryList &categories = QgsPointCloudCategoryList() );
 
    QString type() const override;
    QgsPointCloudRenderer *clone() const override;
    void renderBlock( const QgsPointCloudBlock *block, QgsPointCloudRenderContext &context ) override;
    bool willRenderPoint( const QVariantMap &pointAttributes ) override;
    QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const override;
    QSet< QString > usedAttributes( const QgsPointCloudRenderContext &context ) const override;
    QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) override SIP_FACTORY;
    QStringList legendRuleKeys() const override;
    bool legendItemChecked( const QString &key ) override;
    void checkLegendItem( const QString &key, bool state = true ) override;
    std::unique_ptr< QgsPreparedPointCloudRendererData > prepare() override SIP_SKIP;

    static QgsPointCloudRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;

    static QgsPointCloudCategoryList defaultCategories();

    QString attribute() const;

    void setAttribute( const QString &attribute );

    QgsPointCloudCategoryList categories() const;

    void setCategories( const QgsPointCloudCategoryList &categories );

    void addCategory( const QgsPointCloudCategory &category );
 
  private:
    QString mAttribute = u"Classification"_s;
 
    QgsPointCloudCategoryList mCategories;
};
 
#endif // QGSPOINTCLOUDCLASSIFIEDRENDERER_H