qgspointcloud3dsymbol.h

Go to the documentation of this file.

/***************************************************************************
  qgspointcloud3dsymbol.h
  ------------------------------
  Date                 : November 2020
  Copyright            : (C) 2020 by Nedjima Belgacem
  Email                : belgacem dot nedjima 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 QGSPOINTCLOUD3DSYMBOL_H
#define QGSPOINTCLOUD3DSYMBOL_H
 
#include "qgis_3d.h"
#include "qgsabstract3dsymbol.h"
#include "qgscolorrampshader.h"
#include "qgscontrastenhancement.h"
#include "qgspointcloudclassifiedrenderer.h"
 
#include <QString>
 
class QgsMaterial;
 
using namespace Qt::StringLiterals;

class _3D_EXPORT QgsPointCloud3DSymbol : public QgsAbstract3DSymbol SIP_ABSTRACT
{
  public:
    enum RenderingStyle
    {
      // Do not render anything
      NoRendering = 0,
      SingleColor,
      ColorRamp,
      RgbRendering,
      Classification
    };
 
    QgsPointCloud3DSymbol();
    ~QgsPointCloud3DSymbol() override;
 
    QString type() const override { return "pointcloud"; }
    QgsPointCloud3DSymbol *clone() const override = 0 SIP_FACTORY;

    virtual QString symbolType() const = 0;

    float pointSize() const { return mPointSize; }

    void setPointSize( float size );

    virtual unsigned int byteStride() = 0;
    virtual void fillMaterial( QgsMaterial *material ) SIP_SKIP = 0;

    bool renderAsTriangles() const;

    void setRenderAsTriangles( bool asTriangles );

    bool horizontalTriangleFilter() const;

    void setHorizontalTriangleFilter( bool horizontalTriangleFilter );

    float horizontalFilterThreshold() const;

    void setHorizontalFilterThreshold( float horizontalFilterThreshold );

    bool verticalTriangleFilter() const;

    void setVerticalTriangleFilter( bool verticalTriangleFilter );

    float verticalFilterThreshold() const;

    void setVerticalFilterThreshold( float verticalFilterThreshold );
 
    void copyBaseSettings( QgsAbstract3DSymbol *destination ) const override;

    void setMaterialSettings( QgsAbstractMaterialSettings *materialSettings SIP_TRANSFER ) override SIP_SKIP;
 
  protected:
    float mPointSize = 3.0;
    bool mRenderAsTriangles = false;
    bool mHorizontalTriangleFilter = false;
    float mHorizontalFilterThreshold = 10.0;
    bool mVerticalTriangleFilter = false;
    float mVerticalFilterThreshold = 10.0;

    void writeBaseXml( QDomElement &elem, const QgsReadWriteContext &context ) const;

    void readBaseXml( const QDomElement &elem, const QgsReadWriteContext &context );
};

class _3D_EXPORT QgsSingleColorPointCloud3DSymbol : public QgsPointCloud3DSymbol
{
  public:
    QgsSingleColorPointCloud3DSymbol();
 
    QString symbolType() const override;
    QgsSingleColorPointCloud3DSymbol *clone() const override SIP_FACTORY;
 
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;

    QColor singleColor() const { return mSingleColor; }

    void setSingleColor( QColor color );
 
    unsigned int byteStride() override { return 3 * sizeof( float ); }
    void fillMaterial( QgsMaterial *material ) override SIP_SKIP;
 
 
  private:
    QColor mSingleColor = QColor( 0, 0, 255 );
};

class _3D_EXPORT QgsColorRampPointCloud3DSymbol : public QgsPointCloud3DSymbol
{
  public:
    QgsColorRampPointCloud3DSymbol();
 
    QgsColorRampPointCloud3DSymbol *clone() const override SIP_FACTORY;
    QString symbolType() const override;
 
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;

    QString attribute() const;

    void setAttribute( const QString &attribute );

    QgsColorRampShader colorRampShader() const;

    void setColorRampShader( const QgsColorRampShader &colorRampShader );

    double colorRampShaderMin() const { return mColorRampShaderMin; }

    double colorRampShaderMax() const { return mColorRampShaderMax; }

    void setColorRampShaderMinMax( double min, double max );
 
    unsigned int byteStride() override { return 4 * sizeof( float ); }
    void fillMaterial( QgsMaterial *material ) override SIP_SKIP;
 
  private:
    QString mRenderingParameter;
    QgsColorRampShader mColorRampShader;
    double mColorRampShaderMin = 0.0;
    double mColorRampShaderMax = 1.0;
};

class _3D_EXPORT QgsRgbPointCloud3DSymbol : public QgsPointCloud3DSymbol
{
  public:
    QgsRgbPointCloud3DSymbol();

    QgsRgbPointCloud3DSymbol( const QgsRgbPointCloud3DSymbol &other ) = delete;

    QgsRgbPointCloud3DSymbol &operator=( const QgsRgbPointCloud3DSymbol &other ) = delete;
 
    QString symbolType() const override;
    QgsRgbPointCloud3DSymbol *clone() const override SIP_FACTORY;
 
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;
 
    unsigned int byteStride() override { return 6 * sizeof( float ); }
    void fillMaterial( QgsMaterial *material ) override SIP_SKIP;

    QString redAttribute() const;

    void setRedAttribute( const QString &attribute );

    QString greenAttribute() const;

    void setGreenAttribute( const QString &attribute );

    QString blueAttribute() const;

    void setBlueAttribute( const QString &attribute );

    QgsContrastEnhancement *redContrastEnhancement();

    void setRedContrastEnhancement( QgsContrastEnhancement *enhancement SIP_TRANSFER );

    QgsContrastEnhancement *greenContrastEnhancement();

    void setGreenContrastEnhancement( QgsContrastEnhancement *enhancement SIP_TRANSFER );

    QgsContrastEnhancement *blueContrastEnhancement();

    void setBlueContrastEnhancement( QgsContrastEnhancement *enhancement SIP_TRANSFER );
 
  private:
#ifdef SIP_RUN
    QgsRgbPointCloud3DSymbol( const QgsRgbPointCloud3DSymbol &other );
#endif
 
    QString mRedAttribute = u"Red"_s;
    QString mGreenAttribute = u"Green"_s;
    QString mBlueAttribute = u"Blue"_s;
 
    std::unique_ptr<QgsContrastEnhancement> mRedContrastEnhancement;
    std::unique_ptr<QgsContrastEnhancement> mGreenContrastEnhancement;
    std::unique_ptr<QgsContrastEnhancement> mBlueContrastEnhancement;
};

class _3D_EXPORT QgsClassificationPointCloud3DSymbol : public QgsPointCloud3DSymbol
{
  public:
    QgsClassificationPointCloud3DSymbol();
 
    QgsClassificationPointCloud3DSymbol *clone() const override SIP_FACTORY;
    QString symbolType() const override;
 
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;

    QString attribute() const;

    void setAttribute( const QString &attribute );

    QgsPointCloudCategoryList categoriesList() const { return mCategoriesList; }

    void setCategoriesList( const QgsPointCloudCategoryList &categories );

    QgsPointCloudCategoryList getFilteredOutCategories() const;
 
    unsigned int byteStride() override { return 5 * sizeof( float ); }
    void fillMaterial( QgsMaterial *material ) override SIP_SKIP;
 
  private:
    QString mRenderingParameter;
    QgsPointCloudCategoryList mCategoriesList;
 
    QgsColorRampShader colorRampShader() const;
};
 
#endif // QGSPOINTCLOUD3DSYMBOL_H