qgsmeshlayer.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmeshlayer.h
                         --------------
    begin                : April 2018
    copyright            : (C) 2018 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 QGSMESHLAYER_H
#define QGSMESHLAYER_H

#include <memory>

#include "qgis_core.h"
#include "qgsmaplayer.h"
#include "qgsmeshdataprovider.h"
#include "qgsmeshrenderersettings.h"
#include "qgsmeshtimesettings.h"

class QgsMapLayerRenderer;
struct QgsMeshLayerRendererCache;
class QgsSymbol;
class QgsTriangularMesh;
class QgsRenderContext;
struct QgsMesh;

class CORE_EXPORT QgsMeshLayer : public QgsMapLayer
{
    Q_OBJECT
  public:

    struct LayerOptions
    {

      explicit LayerOptions( const QgsCoordinateTransformContext &transformContext = QgsCoordinateTransformContext( ) )
        : transformContext( transformContext )
      {}

      QgsCoordinateTransformContext transformContext;
    };

    explicit QgsMeshLayer( const QString &path = QString(), const QString &baseName = QString(), const QString &providerLib = QStringLiteral( "mesh_memory" ),
                           const QgsMeshLayer::LayerOptions &options = QgsMeshLayer::LayerOptions() );

    ~QgsMeshLayer() override;

    QgsMeshLayer( const QgsMeshLayer &rhs ) = delete;
    QgsMeshLayer &operator=( QgsMeshLayer const &rhs ) = delete;

    QgsMeshDataProvider *dataProvider() override;
    const QgsMeshDataProvider *dataProvider() const override SIP_SKIP;
    QgsMeshLayer *clone() const override SIP_FACTORY;
    QgsRectangle extent() const override;
    QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) override SIP_FACTORY;
    bool readSymbology( const QDomNode &node, QString &errorMessage,
                        QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) override;
    bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage,
                         const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) const override;
    QString encodedSource( const QString &source, const QgsReadWriteContext &context ) const override;
    QString decodedSource( const QString &source, const QString &provider, const QgsReadWriteContext &context ) const override;
    bool readXml( const QDomNode &layer_node, QgsReadWriteContext &context ) override;
    bool writeXml( QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context ) const override;

    void reload() override;

    QString providerType() const;

    QgsMesh *nativeMesh() SIP_SKIP;

    const QgsMesh *nativeMesh() const SIP_SKIP;

    QgsTriangularMesh *triangularMesh() SIP_SKIP;

    const QgsTriangularMesh *triangularMesh() const SIP_SKIP;

    QgsMeshLayerRendererCache *rendererCache() SIP_SKIP;

    QgsMeshRendererSettings rendererSettings() const;
    void setRendererSettings( const QgsMeshRendererSettings &settings );

    QgsMeshTimeSettings timeSettings() const;

    void setTimeSettings( const QgsMeshTimeSettings &settings );

    QString formatTime( double hours );

    QgsMeshDatasetValue datasetValue( const QgsMeshDatasetIndex &index, const QgsPointXY &point ) const;

  public slots:

    void setTransformContext( const QgsCoordinateTransformContext &transformContext ) override;


  signals:

    void activeScalarDatasetChanged( const QgsMeshDatasetIndex &index );

    void activeVectorDatasetChanged( const QgsMeshDatasetIndex &index );

    void timeSettingsChanged( );

  private: // Private methods

    bool isReadOnly() const override {return true;}

    bool setDataProvider( QString const &provider, const QgsDataProvider::ProviderOptions &options );

#ifdef SIP_RUN
    QgsMeshLayer( const QgsMeshLayer &rhs );
#endif

  private:
    void fillNativeMesh();
    void assignDefaultStyleToDatasetGroup( int groupIndex );
    void setDefaultRendererSettings();

  private slots:
    void onDatasetGroupsAdded( int count );

  private:
    QgsMeshDataProvider *mDataProvider = nullptr;

    std::unique_ptr<QgsMesh> mNativeMesh;

    std::unique_ptr<QgsTriangularMesh> mTriangularMesh;

    std::unique_ptr<QgsMeshLayerRendererCache> mRendererCache;

    QgsMeshRendererSettings mRendererSettings;

    QgsMeshTimeSettings mTimeSettings;

};

#endif //QGSMESHLAYER_H