qgspointcloudlayer.h

Go to the documentation of this file.

/***************************************************************************
                         qgspointcloudlayer.h
                         --------------------
    begin                : October 2020
    copyright            : (C) 2020 by Peter Petrik
    email                : zilolv 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 QGSPOINTCLOUDLAYER_H
#define QGSPOINTCLOUDLAYER_H
 
class QgsPointCloudLayerRenderer;
 
#include <memory>
 
#include "qgis_core.h"
#include "qgsabstractprofilesource.h"
#include "qgsmaplayer.h"
#include "qgspointclouddataprovider.h"
#include "qgspointcloudstatistics.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsPointCloudRenderer;
class QgsPointCloudLayerElevationProperties;
class QgsAbstractPointCloud3DRenderer;

class CORE_EXPORT QgsPointCloudLayer : public QgsMapLayer, public QgsAbstractProfileSource
{
    Q_OBJECT
  public:
    struct LayerOptions
    {
        explicit LayerOptions( const QgsCoordinateTransformContext &transformContext = QgsCoordinateTransformContext() )
          : transformContext( transformContext )
        {}

        QgsCoordinateTransformContext transformContext;

        bool loadDefaultStyle = true;

        bool skipCrsValidation = false;

        bool skipIndexGeneration = false;

        bool skipStatisticsCalculation = false;
    };
 

    enum class PointCloudStatisticsCalculationState : int SIP_ENUM_BASETYPE( IntFlag )
    {
      NotStarted = 0,       
      Calculating = 1 << 0, 
      Calculated = 1 << 1   
    };
    Q_ENUM( PointCloudStatisticsCalculationState )
 
    
    explicit QgsPointCloudLayer(
      const QString &uri = QString(), const QString &baseName = QString(), const QString &providerLib = u"pointcloud"_s, const QgsPointCloudLayer::LayerOptions &options = QgsPointCloudLayer::LayerOptions()
    );
 
    ~QgsPointCloudLayer() override;
 
    QgsPointCloudLayer( const QgsPointCloudLayer &rhs ) = delete;
    QgsPointCloudLayer &operator=( QgsPointCloudLayer const &rhs ) = delete;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsPointCloudLayer: '%1' (%2)>"_s.arg( sipCpp->name(), sipCpp->dataProvider() ? sipCpp->dataProvider()->name() : u"Invalid"_s );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
      QgsPointCloudLayer *clone() const override SIP_FACTORY;
    QgsRectangle extent() const override;
    QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) override SIP_FACTORY;
    QgsAbstractProfileSource *profileSource() override { return this; }
    QString profileSourceId() const override { return id(); }
    QString profileSourceName() const override { return name(); }
    QgsAbstractProfileGenerator *createProfileGenerator( const QgsProfileRequest &request ) override SIP_FACTORY;
 
    QgsPointCloudDataProvider *dataProvider() override;
    const QgsPointCloudDataProvider *dataProvider() const override SIP_SKIP;
 
    bool supportsEditing() const override;
    bool isEditable() const override;
    bool isModified() const override;
 
    bool readXml( const QDomNode &layerNode, QgsReadWriteContext &context ) override;
 
    bool writeXml( QDomNode &layerNode, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
 
    bool readSymbology( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) override;
    bool readStyle( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) final;
 
    bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) const override;
    bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) const final;
 
    void setTransformContext( const QgsCoordinateTransformContext &transformContext ) override;
 
    QString encodedSource( const QString &source, const QgsReadWriteContext &context ) const override;
    QString decodedSource( const QString &source, const QString &dataProvider, const QgsReadWriteContext &context ) const override;
    QString loadDefaultStyle( bool &resultFlag SIP_OUT ) final;
    QString htmlMetadata() const override;
    QgsMapLayerElevationProperties *elevationProperties() override;

    QgsPointCloudAttributeCollection attributes() const;

    qint64 pointCount() const;

    QgsPointCloudRenderer *renderer();

    const QgsPointCloudRenderer *renderer() const SIP_SKIP;

    void setRenderer( QgsPointCloudRenderer *renderer SIP_TRANSFER );

    bool setSubsetString( const QString &subset );

    QString subsetString() const;

    void setSync3DRendererTo2DRenderer( bool sync );

    bool sync3DRendererTo2DRenderer() const;

    bool convertRenderer3DFromRenderer2D();

    const QgsPointCloudStatistics statistics() const { return mStatistics; }

    PointCloudStatisticsCalculationState statisticsCalculationState() const { return mStatisticsCalculationState; }

    bool startEditing();

    bool commitChanges( bool stopEditing = true );

    QString commitError() const;

    bool rollBack();

    bool changeAttributeValue( QgsPointCloudNodeId n, const QVector<int> &points, const QgsPointCloudAttribute &attribute, double value ) SIP_SKIP;

    bool changeAttributeValue( const QHash<int, QHash<QgsPointCloudNodeId, QVector<int>>> &mappedPoints, const QgsPointCloudAttribute &attribute, double value ) SIP_SKIP;

    QgsPointCloudIndex index() const;

    QVector<QgsPointCloudSubIndex> subIndexes() const;

    bool isVpc() const { return mIsVpc; }

    Q_DECL_DEPRECATED QgsPointCloudIndex overview() const SIP_DEPRECATED;

    QVector<QgsPointCloudIndex> overviews() const;
 
  signals:

    void subsetStringChanged();

    void raiseError( const QString &msg );

    void statisticsCalculationStateChanged( QgsPointCloudLayer::PointCloudStatisticsCalculationState state );

    void chunkAttributeValuesChanged( QgsPointCloudNodeId n, const int position );
 
  private slots:
    void onPointCloudIndexGenerationStateChanged( QgsPointCloudDataProvider::PointCloudIndexGenerationState state );
    void setDataSourcePrivate( const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags ) override;
 
  private:
    bool isReadOnly() const override { return true; }
 
    void calculateStatistics();
 
    void resetRenderer();
 
    void loadIndexesForRenderContext( QgsRenderContext &rendererContext ) const;
 
#ifdef SIP_RUN
    QgsPointCloudLayer( const QgsPointCloudLayer &rhs );
#endif
 
    std::unique_ptr<QgsPointCloudDataProvider> mDataProvider;
 
    std::unique_ptr<QgsPointCloudRenderer> mRenderer;
 
    QgsPointCloudLayerElevationProperties *mElevationProperties = nullptr;
 
    LayerOptions mLayerOptions;
 
    bool mSync3DRendererTo2DRenderer = true;
    QgsPointCloudStatistics mStatistics;
    PointCloudStatisticsCalculationState mStatisticsCalculationState = PointCloudStatisticsCalculationState::NotStarted;
    long mStatsCalculationTask = 0;
 
    QgsPointCloudIndex mEditIndex;
    mutable QMap< int, QgsPointCloudIndex > mEditingIndexes;
    bool mIsVpc = false;
    bool mEditable = false;
    QString mCommitError;
 
    friend class TestQgsVirtualPointCloudProvider;
};
 
 
#endif // QGSPOINTCLOUDLAYER_H