qgsmeshdataprovider.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmeshdataprovider.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 QGSMESHDATAPROVIDER_H
#define QGSMESHDATAPROVIDER_H

#include <QVector>
#include <QString>
#include <QMap>
#include <limits>

#include "qgis_core.h"
#include "qgspoint.h"
#include "qgsdataprovider.h"

class QgsRectangle;

class CORE_EXPORT QgsMeshDatasetIndex
{
  public:
    QgsMeshDatasetIndex( int group = -1, int dataset = -1 );
    int group() const;
    int dataset() const;
    bool isValid() const;
    bool operator == ( const QgsMeshDatasetIndex &other ) const;
    bool operator != ( const QgsMeshDatasetIndex &other ) const;
  private:
    int mGroupIndex = -1;
    int mDatasetIndex = -1;
};

typedef QgsPoint QgsMeshVertex;

typedef QVector<int> QgsMeshFace;

struct CORE_EXPORT QgsMesh
{
  int vertexCount() const;
  int faceCount() const;

  QgsMeshVertex vertex( int index ) const;
  QgsMeshFace face( int index ) const;

  QVector<QgsMeshVertex> vertices SIP_SKIP;
  QVector<QgsMeshFace> faces SIP_SKIP;
};

class CORE_EXPORT QgsMeshDatasetValue
{
  public:
    QgsMeshDatasetValue( double x,
                         double y );

    QgsMeshDatasetValue( double scalar );

    QgsMeshDatasetValue() = default;

    ~QgsMeshDatasetValue() = default;

    void set( double scalar );

    void setX( double x );

    void setY( double y ) ;

    double scalar() const;

    double x() const;

    double y() const;

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

  private:
    double mX  = std::numeric_limits<double>::quiet_NaN();
    double mY  = std::numeric_limits<double>::quiet_NaN();
};

class CORE_EXPORT QgsMeshDataBlock
{
  public:
    enum DataType
    {
      ActiveFlagInteger, 
      ScalarDouble, 
      Vector2DDouble, 
    };

    QgsMeshDataBlock();

    QgsMeshDataBlock( DataType type, int count );

    DataType type() const;

    int count() const;

    bool isValid() const;

    QgsMeshDatasetValue value( int index ) const;

    bool active( int index ) const;

    void *buffer() SIP_SKIP;

    const void *constBuffer() const SIP_SKIP;

  private:
    QVector<double> mDoubleBuffer;
    QVector<int> mIntegerBuffer;
    DataType mType;
};

class CORE_EXPORT QgsMeshDatasetGroupMetadata
{
  public:

    enum DataType
    {
      DataOnFaces, 
      DataOnVertices 
    };

    QgsMeshDatasetGroupMetadata() = default;

    QgsMeshDatasetGroupMetadata( const QString &name,
                                 bool isScalar,
                                 bool isOnVertices,
                                 double minimum,
                                 double maximum,
                                 const QMap<QString, QString> &extraOptions );

    QString name() const;

    QMap<QString, QString> extraOptions() const;

    bool isVector() const;

    bool isScalar() const;

    DataType dataType() const;

    double minimum() const;

    double maximum() const;

  private:
    QString mName;
    bool mIsScalar = false;
    bool mIsOnVertices = false;
    double mMinimumValue = std::numeric_limits<double>::quiet_NaN();
    double mMaximumValue = std::numeric_limits<double>::quiet_NaN();
    QMap<QString, QString> mExtraOptions;
};

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

    QgsMeshDatasetMetadata( double time,
                            bool isValid,
                            double minimum,
                            double maximum
                          );

    double time() const;

    bool isValid() const;

    double minimum() const;

    double maximum() const;

  private:
    double mTime = std::numeric_limits<double>::quiet_NaN();
    bool mIsValid = false;
    double mMinimumValue = std::numeric_limits<double>::quiet_NaN();
    double mMaximumValue = std::numeric_limits<double>::quiet_NaN();
};

class CORE_EXPORT QgsMeshDataSourceInterface SIP_ABSTRACT
{
  public:
    virtual ~QgsMeshDataSourceInterface() = default;

    virtual int vertexCount() const = 0;

    virtual int faceCount() const = 0;

    virtual void populateMesh( QgsMesh *mesh ) const = 0;
};

class CORE_EXPORT QgsMeshDatasetSourceInterface SIP_ABSTRACT
{
  public:
    virtual ~QgsMeshDatasetSourceInterface() = default;

    virtual bool addDataset( const QString &uri ) = 0;

    virtual QStringList extraDatasets() const = 0;

    virtual int datasetGroupCount( ) const = 0;

    virtual int datasetCount( int groupIndex ) const = 0;

    int datasetCount( QgsMeshDatasetIndex index ) const;

    virtual QgsMeshDatasetGroupMetadata datasetGroupMetadata( int groupIndex ) const = 0;

    QgsMeshDatasetGroupMetadata datasetGroupMetadata( QgsMeshDatasetIndex index ) const;

    virtual QgsMeshDatasetMetadata datasetMetadata( QgsMeshDatasetIndex index ) const = 0;

    virtual QgsMeshDatasetValue datasetValue( QgsMeshDatasetIndex index, int valueIndex ) const = 0;

    virtual QgsMeshDataBlock datasetValues( QgsMeshDatasetIndex index, int valueIndex, int count ) const = 0;

    virtual bool isFaceActive( QgsMeshDatasetIndex index, int faceIndex ) const = 0;

    virtual QgsMeshDataBlock areFacesActive( QgsMeshDatasetIndex index, int faceIndex, int count ) const = 0;

    virtual bool persistDatasetGroup( const QString &path,
                                      const QgsMeshDatasetGroupMetadata &meta,
                                      const QVector<QgsMeshDataBlock> &datasetValues,
                                      const QVector<QgsMeshDataBlock> &datasetActive,
                                      const QVector<double> &times
                                    ) = 0;
};


class CORE_EXPORT QgsMeshDataProvider: public QgsDataProvider, public QgsMeshDataSourceInterface, public QgsMeshDatasetSourceInterface
{
    Q_OBJECT

  public:
    QgsMeshDataProvider( const QString &uri, const QgsDataProvider::ProviderOptions &options );

  signals:
    void datasetGroupsAdded( int count );
};

#endif // QGSMESHDATAPROVIDER_H