mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-14 00:07:35 -04:00
15e0d873d9
not working yet, just set the menu entries QgsMapLayerStyle::StyleCategory has moved to QgsMapLayer to avoid making QgsMapLayerStyle a QObject and they are mostly used in QgsMapLayer
227 lines
8.5 KiB
C++
227 lines
8.5 KiB
C++
/***************************************************************************
|
|
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 "qgsrendercontext.h"
|
|
#include "qgsmeshdataprovider.h"
|
|
#include "qgsmeshrenderersettings.h"
|
|
|
|
class QgsMapLayerRenderer;
|
|
class QgsSymbol;
|
|
class QgsTriangularMesh;
|
|
struct QgsMesh;
|
|
|
|
/**
|
|
* \ingroup core
|
|
*
|
|
* Represents a mesh layer supporting display of data on structured or unstructured meshes
|
|
*
|
|
* The QgsMeshLayer is instantiated by specifying the name of a data provider,
|
|
* such as mdal, and url defining the specific data set to connect to.
|
|
* The vector layer constructor in turn instantiates a QgsMeshDataProvider subclass
|
|
* corresponding to the provider type, and passes it the url. The data provider
|
|
* connects to the data source.
|
|
*
|
|
* The QgsMeshLayer provides a common interface to the different data types. It does not
|
|
* yet support editing transactions.
|
|
*
|
|
* The main data providers supported by QGIS are listed below.
|
|
*
|
|
* \section mesh_providers Mesh data providers
|
|
*
|
|
* \subsection mesh_memory Memory data providerType (mesh_memory)
|
|
*
|
|
* The memory data provider is used to construct in memory data, for example scratch
|
|
* data. There is no inherent persistent storage of the data. The data source uri is constructed.
|
|
* Data can be populated by setMesh(const QString &vertices, const QString &faces), where
|
|
* vertices and faces is comma separated coordinates and connections for mesh.
|
|
* E.g. to create mesh with one quad and one triangle
|
|
*
|
|
* \code
|
|
* QString uri(
|
|
* "1.0, 2.0 \n" \
|
|
* "2.0, 2.0 \n" \
|
|
* "3.0, 2.0 \n" \
|
|
* "2.0, 3.0 \n" \
|
|
* "1.0, 3.0 \n" \
|
|
* "---"
|
|
* "0, 1, 3, 4 \n" \
|
|
* "1, 2, 3 \n"
|
|
* );
|
|
* QgsMeshLayer *scratchLayer = new QgsMeshLayer(uri, "My Scratch layer", "memory_mesh");
|
|
* \endcode
|
|
*
|
|
* \subsection mdal MDAL data provider (mdal)
|
|
*
|
|
* Accesses data using the MDAL drivers (https://github.com/lutraconsulting/MDAL). The url
|
|
* is the MDAL connection string. QGIS must be built with MDAL support to allow this provider.
|
|
|
|
* \code
|
|
* QString uri = "test/land.2dm";
|
|
* QgsMeshLayer *scratchLayer = new QgsMeshLayer(uri, "My Scratch Layer", "mdal");
|
|
* \endcode
|
|
*
|
|
* \note The API is considered EXPERIMENTAL and can be changed without a notice
|
|
*
|
|
* \since QGIS 3.2
|
|
*/
|
|
class CORE_EXPORT QgsMeshLayer : public QgsMapLayer
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
|
|
/**
|
|
* Setting options for loading mesh layers.
|
|
*/
|
|
struct LayerOptions
|
|
{
|
|
int unused; //! @todo remove me once there are actual members here (breaks SIP <4.19)
|
|
};
|
|
|
|
/**
|
|
* Constructor - creates a mesh layer
|
|
*
|
|
* The QgsMeshLayer is constructed by instantiating a data provider. The provider
|
|
* interprets the supplied path (url) of the data source to connect to and access the
|
|
* data.
|
|
*
|
|
* \param path The path or url of the parameter. Typically this encodes
|
|
* parameters used by the data provider as url query items.
|
|
* \param baseName The name used to represent the layer in the legend
|
|
* \param providerLib The name of the data provider, e.g., "mesh_memory", "mdal"
|
|
* \param options general mesh layer options
|
|
*/
|
|
explicit QgsMeshLayer( const QString &path = QString(), const QString &baseName = QString(), const QString &providerLib = "mesh_memory",
|
|
const QgsMeshLayer::LayerOptions &options = QgsMeshLayer::LayerOptions() );
|
|
~QgsMeshLayer() override;
|
|
|
|
//! QgsMeshLayer cannot be copied.
|
|
QgsMeshLayer( const QgsMeshLayer &rhs ) = delete;
|
|
//! QgsMeshLayer cannot be copied.
|
|
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::AllCategories ) override;
|
|
bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage,
|
|
const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllCategories ) 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;
|
|
|
|
//! Returns the provider type for this layer
|
|
QString providerType() const;
|
|
|
|
//! Returns native mesh (nullptr before rendering)
|
|
QgsMesh *nativeMesh() SIP_SKIP;
|
|
|
|
//! Returns triangular mesh (nullptr before rendering)
|
|
QgsTriangularMesh *triangularMesh() SIP_SKIP;
|
|
|
|
//! Returns renderer settings
|
|
QgsMeshRendererSettings rendererSettings() const;
|
|
//! Sets new renderer settings
|
|
void setRendererSettings( const QgsMeshRendererSettings &settings );
|
|
|
|
/**
|
|
* Interpolates the value on the given point from given dataset.
|
|
*
|
|
* \note It uses previously cached and indexed triangular mesh
|
|
* and so if the layer has not been rendered previously
|
|
* (e.g. when used in a script) it returns NaN value
|
|
*
|
|
* \param index dataset index specifying group and dataset to extract value from
|
|
* \param point point to query in map coordinates
|
|
* \returns interpolated value at the point. Returns NaN values for values
|
|
* outside the mesh layer, nodata values and in case triangular mesh was not
|
|
* previously used for rendering
|
|
*
|
|
* \since QGIS 3.4
|
|
*/
|
|
QgsMeshDatasetValue datasetValue( const QgsMeshDatasetIndex &index, const QgsPointXY &point ) const;
|
|
|
|
signals:
|
|
|
|
/**
|
|
* Emitted when active scalar dataset is changed
|
|
*
|
|
* \since QGIS 3.4
|
|
*/
|
|
void activeScalarDatasetChanged( const QgsMeshDatasetIndex &index );
|
|
|
|
/**
|
|
* Emitted when active vector dataset is changed
|
|
*
|
|
* \since QGIS 3.4
|
|
*/
|
|
void activeVectorDatasetChanged( const QgsMeshDatasetIndex &index );
|
|
|
|
private: // Private methods
|
|
|
|
/**
|
|
* Returns true if the provider is in read-only mode
|
|
*/
|
|
bool isReadOnly() const override {return true;}
|
|
|
|
/**
|
|
* Binds layer to a specific data provider
|
|
* \param provider provider key string, must match a valid QgsMeshDataProvider key. E.g. "mesh_memory", etc.
|
|
* \param options generic provider options
|
|
*/
|
|
bool setDataProvider( QString const &provider, const QgsDataProvider::ProviderOptions &options );
|
|
|
|
#ifdef SIP_RUN
|
|
QgsMeshLayer( const QgsMeshLayer &rhs );
|
|
#endif
|
|
|
|
private:
|
|
void fillNativeMesh();
|
|
void assignDefaultStyleToDatasetGroup( int groupIndex );
|
|
|
|
private slots:
|
|
void onDatasetGroupsAdded( int count );
|
|
|
|
private:
|
|
//! Pointer to data provider derived from the abastract base class QgsMeshDataProvider
|
|
QgsMeshDataProvider *mDataProvider = nullptr;
|
|
|
|
//! Data provider key
|
|
QString mProviderKey;
|
|
|
|
//! Pointer to native mesh structure, used as cache for rendering
|
|
std::unique_ptr<QgsMesh> mNativeMesh;
|
|
|
|
//! Pointer to derived mesh structure
|
|
std::unique_ptr<QgsTriangularMesh> mTriangularMesh;
|
|
|
|
//! Renderer configuration
|
|
QgsMeshRendererSettings mRendererSettings;
|
|
};
|
|
|
|
#endif //QGSMESHLAYER_H
|