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 "qgis_core.h"
#include "qgspoint.h"
#include "qgsrectangle.h"
#include "qgsdataprovider.h"

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

typedef QgsPoint QgsMeshVertex;

typedef QVector<int> QgsMeshFace;

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 QgsMeshDatasetMetadata
{
  public:
    QgsMeshDatasetMetadata() = default;

    QgsMeshDatasetMetadata( bool isScalar,
                            bool isValid,
                            bool isOnVertices,
                            const QMap<QString, QString> &extraOptions );

    QMap<QString, QString> extraOptions() const;

    bool isVector() const;

    bool isScalar() const;

    bool isOnVertices() const;

    bool isValid() const;

  private:
    bool mIsScalar = false;
    bool mIsValid = false;
    bool mIsOnVertices = false;
    QMap<QString, QString> mExtraOptions;
};

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

    virtual int vertexCount() const = 0;

    virtual int faceCount() const = 0;

    virtual QgsMeshVertex vertex( int index ) const = 0;

    virtual QgsMeshFace face( int index ) const = 0;
};

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

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

    virtual int datasetCount() const = 0;

    virtual QgsMeshDatasetMetadata datasetMetadata( int datasetIndex ) const = 0;

    virtual QgsMeshDatasetValue datasetValue( int datasetIndex, int valueIndex ) const = 0;
};


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

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

    QgsRectangle extent() const override;
};

#endif // QGSMESHDATAPROVIDER_H