mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-22 00:14:55 -05:00
0675c0b697
* MDAL 0.5.90 : support for custom Logger and 1D meshes * [FEATURE] [MESH] Support rendering of 1D meshes, see https://github.com/qgis/QGIS-Enhancement-Proposals/issues/164 1D mesh consist of edges (edge is straight line segment with 2 vertices) and the data that is defined on either vertices or edges. Such data can be loaded by MDAL and rendered as mesh layer in QGIS.
859 lines
20 KiB
Plaintext
859 lines
20 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/mesh/qgsmeshdataprovider.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsMeshDatasetIndex
|
|
{
|
|
%Docstring
|
|
|
|
QgsMeshDatasetIndex is index that identifies the dataset group (e.g. wind speed)
|
|
and a dataset in this group (e.g. magnitude of wind speed in particular time)
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshdataprovider.h"
|
|
%End
|
|
public:
|
|
QgsMeshDatasetIndex( int group = -1, int dataset = -1 );
|
|
%Docstring
|
|
Creates an index. -1 represents invalid group/dataset
|
|
%End
|
|
int group() const;
|
|
%Docstring
|
|
Returns a group index
|
|
%End
|
|
int dataset() const;
|
|
%Docstring
|
|
Returns a dataset index within group()
|
|
%End
|
|
bool isValid() const;
|
|
%Docstring
|
|
Returns whether index is valid, ie at least groups is set
|
|
%End
|
|
bool operator == ( QgsMeshDatasetIndex other ) const;
|
|
bool operator != ( QgsMeshDatasetIndex other ) const;
|
|
};
|
|
|
|
typedef QgsPoint QgsMeshVertex;
|
|
|
|
typedef QVector<int> QgsMeshFace;
|
|
|
|
typedef QPair<int, int> QgsMeshEdge;
|
|
|
|
struct QgsMesh
|
|
{
|
|
|
|
enum ElementType
|
|
{
|
|
Vertex,
|
|
Edge,
|
|
Face
|
|
};
|
|
|
|
bool contains( const ElementType &type ) const;
|
|
%Docstring
|
|
Returns whether the mesh contains at mesh elements of given type
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
int vertexCount() const;
|
|
%Docstring
|
|
Returns number of vertices
|
|
%End
|
|
int faceCount() const;
|
|
%Docstring
|
|
Returns number of faces
|
|
%End
|
|
|
|
int edgeCount() const;
|
|
%Docstring
|
|
Returns number of edge
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
QgsMeshVertex vertex( int index ) const;
|
|
%Docstring
|
|
Returns a vertex at the index
|
|
%End
|
|
QgsMeshFace face( int index ) const;
|
|
%Docstring
|
|
Returns a face at the index
|
|
%End
|
|
|
|
QgsMeshEdge edge( int index ) const;
|
|
%Docstring
|
|
Returns an edge at the index
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
void clear();
|
|
%Docstring
|
|
Remove all vertices, edges and faces
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsMeshDatasetValue
|
|
{
|
|
%Docstring
|
|
|
|
QgsMeshDatasetValue represents single dataset value
|
|
|
|
could be scalar or vector. Nodata values are represented by NaNs.
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshdataprovider.h"
|
|
%End
|
|
public:
|
|
QgsMeshDatasetValue( double x,
|
|
double y );
|
|
%Docstring
|
|
Constructor for vector value
|
|
%End
|
|
|
|
QgsMeshDatasetValue( double scalar );
|
|
%Docstring
|
|
Constructor for scalar value
|
|
%End
|
|
|
|
QgsMeshDatasetValue();
|
|
%Docstring
|
|
Default Ctor, initialize to NaN
|
|
%End
|
|
|
|
~QgsMeshDatasetValue();
|
|
|
|
void set( double scalar );
|
|
%Docstring
|
|
Sets scalar value
|
|
%End
|
|
|
|
void setX( double x );
|
|
%Docstring
|
|
Sets X value
|
|
%End
|
|
|
|
void setY( double y );
|
|
%Docstring
|
|
Sets Y value
|
|
%End
|
|
|
|
double scalar() const;
|
|
%Docstring
|
|
Returns magnitude of vector for vector data or scalar value for scalar data
|
|
%End
|
|
|
|
double x() const;
|
|
%Docstring
|
|
Returns x value
|
|
%End
|
|
|
|
double y() const;
|
|
%Docstring
|
|
Returns y value
|
|
%End
|
|
|
|
bool operator==( QgsMeshDatasetValue other ) const;
|
|
|
|
};
|
|
|
|
class QgsMeshDataBlock
|
|
{
|
|
%Docstring
|
|
|
|
QgsMeshDataBlock is a block of integers/doubles that can be used
|
|
to retrieve:
|
|
active flags (e.g. face's active integer flag)
|
|
scalars (e.g. scalar dataset double values)
|
|
vectors (e.g. vector dataset doubles x,y values)
|
|
|
|
data are implicitly shared, so the class can be quickly copied
|
|
std.numeric_limits<double>.quiet_NaN() represents NODATA value
|
|
|
|
Data can be accessed all at once with values() (faster) or
|
|
value by value (slower) with active() or value()
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshdataprovider.h"
|
|
%End
|
|
public:
|
|
enum DataType
|
|
{
|
|
ActiveFlagInteger,
|
|
ScalarDouble,
|
|
Vector2DDouble,
|
|
};
|
|
|
|
QgsMeshDataBlock();
|
|
%Docstring
|
|
Constructs an invalid block
|
|
%End
|
|
|
|
QgsMeshDataBlock( DataType type, int count );
|
|
%Docstring
|
|
Constructs a new block
|
|
%End
|
|
|
|
DataType type() const;
|
|
%Docstring
|
|
Type of data stored in the block
|
|
%End
|
|
|
|
int count() const;
|
|
%Docstring
|
|
Number of items stored in the block
|
|
%End
|
|
|
|
bool isValid() const;
|
|
%Docstring
|
|
Whether the block is valid
|
|
%End
|
|
|
|
QgsMeshDatasetValue value( int index ) const;
|
|
%Docstring
|
|
Returns a value represented by the index
|
|
For active flag the behavior is undefined
|
|
%End
|
|
|
|
bool active( int index ) const;
|
|
%Docstring
|
|
Returns a value for active flag by the index
|
|
For scalar and vector 2d the behavior is undefined
|
|
%End
|
|
|
|
void setActive( const QVector<int> &vals );
|
|
%Docstring
|
|
Sets active flag values.
|
|
|
|
If the data provider/datasets does not have active
|
|
flag capability (== all values are valid), just
|
|
set block validity by setValid( true )
|
|
|
|
:param vals: value vector with size count()
|
|
|
|
For scalar and vector 2d the behavior is undefined
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
QVector<int> active() const;
|
|
%Docstring
|
|
Returns active flag array
|
|
|
|
Even for active flag valid dataset, the returned array could be empty.
|
|
This means that the data provider/dataset does not support active flag
|
|
capability, so all faces are active by default.
|
|
|
|
For scalar and vector 2d the behavior is undefined
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
QVector<double> values() const;
|
|
%Docstring
|
|
Returns buffer to the array with values
|
|
For vector it is pairs (x1, y1, x2, y2, ... )
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
void setValues( const QVector<double> &vals );
|
|
%Docstring
|
|
Sets values
|
|
|
|
For scalar datasets, it must have size count()
|
|
For vector datasets, it must have size 2 * count()
|
|
For active flag the behavior is undefined
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
void setValid( bool valid );
|
|
%Docstring
|
|
Sets block validity
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsMesh3dDataBlock
|
|
{
|
|
%Docstring
|
|
|
|
QgsMesh3dDataBlock is a block of 3d stacked mesh data related N
|
|
faces defined on base mesh frame.
|
|
|
|
data are implicitly shared, so the class can be quickly copied
|
|
std.numeric_limits<double>.quiet_NaN() represents NODATA value
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshdataprovider.h"
|
|
%End
|
|
public:
|
|
QgsMesh3dDataBlock();
|
|
%Docstring
|
|
Constructs an invalid block
|
|
%End
|
|
|
|
~QgsMesh3dDataBlock();
|
|
|
|
QgsMesh3dDataBlock( int count, bool isVector );
|
|
%Docstring
|
|
Constructs a new block for count faces
|
|
%End
|
|
|
|
void setValid( bool valid );
|
|
%Docstring
|
|
Sets block validity
|
|
%End
|
|
|
|
bool isValid() const;
|
|
%Docstring
|
|
Whether the block is valid
|
|
%End
|
|
|
|
bool isVector() const;
|
|
%Docstring
|
|
Whether we store vector values
|
|
%End
|
|
|
|
int count() const;
|
|
%Docstring
|
|
Number of 2d faces for which the volume data is stored in the block
|
|
%End
|
|
|
|
int firstVolumeIndex() const;
|
|
%Docstring
|
|
Index of the first volume stored in the buffer (absolute)
|
|
%End
|
|
|
|
int lastVolumeIndex() const;
|
|
%Docstring
|
|
Index of the last volume stored in the buffer (absolute)
|
|
%End
|
|
|
|
int volumesCount() const;
|
|
%Docstring
|
|
Returns number of volumes stored in the buffer
|
|
%End
|
|
|
|
QVector<int> verticalLevelsCount() const;
|
|
%Docstring
|
|
Returns number of vertical level above 2d faces
|
|
%End
|
|
|
|
void setVerticalLevelsCount( const QVector<int> &verticalLevelsCount );
|
|
%Docstring
|
|
Sets the vertical level counts
|
|
%End
|
|
|
|
QVector<double> verticalLevels() const;
|
|
%Docstring
|
|
Returns the vertical levels height
|
|
%End
|
|
|
|
void setVerticalLevels( const QVector<double> &verticalLevels );
|
|
%Docstring
|
|
Sets the vertical levels height
|
|
%End
|
|
|
|
QVector<int> faceToVolumeIndex() const;
|
|
%Docstring
|
|
Returns the indexing between faces and volumes
|
|
%End
|
|
|
|
void setFaceToVolumeIndex( const QVector<int> &faceToVolumeIndex );
|
|
%Docstring
|
|
Sets the indexing between faces and volumes
|
|
%End
|
|
|
|
QVector<double> values() const;
|
|
%Docstring
|
|
Returns the values at volume centers
|
|
|
|
For vector datasets the number of values is doubled (x1, y1, x2, y2, ... )
|
|
%End
|
|
|
|
QgsMeshDatasetValue value( int volumeIndex ) const;
|
|
%Docstring
|
|
Returns the value at volume centers
|
|
|
|
:param volumeIndex: volume index relative to firstVolumeIndex()
|
|
|
|
:return: value (scalar or vector)
|
|
%End
|
|
|
|
void setValues( const QVector<double> &doubleBuffer );
|
|
%Docstring
|
|
Sets the values at volume centers
|
|
|
|
For vector datasets the number of values is doubled (x1, y1, x2, y2, ... )
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsMeshDatasetGroupMetadata
|
|
{
|
|
%Docstring
|
|
|
|
QgsMeshDatasetGroupMetadata is a collection of dataset group metadata
|
|
such as whether the data is vector or scalar, name
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshdataprovider.h"
|
|
%End
|
|
public:
|
|
|
|
enum DataType
|
|
{
|
|
DataOnFaces,
|
|
DataOnVertices,
|
|
DataOnVolumes,
|
|
DataOnEdges
|
|
};
|
|
|
|
QgsMeshDatasetGroupMetadata();
|
|
%Docstring
|
|
Constructs an empty metadata object
|
|
%End
|
|
|
|
QgsMeshDatasetGroupMetadata( const QString &name,
|
|
bool isScalar,
|
|
DataType dataType,
|
|
double minimum,
|
|
double maximum,
|
|
int maximumVerticalLevels,
|
|
const QDateTime &referenceTime,
|
|
const QMap<QString, QString> &extraOptions );
|
|
%Docstring
|
|
Constructs a valid metadata object
|
|
|
|
:param name: name of the dataset group
|
|
:param isScalar: dataset contains scalar data, specifically the y-value of QgsMeshDatasetValue is NaN
|
|
:param dataType: where the data are defined on (vertices, faces or volumes)
|
|
:param minimum: minimum value (magnitude for vectors) present among all group's dataset values
|
|
:param maximum: maximum value (magnitude for vectors) present among all group's dataset values
|
|
:param maximumVerticalLevels: maximum number of vertical levels for 3d stacked meshes, 0 for 2d meshes
|
|
:param referenceTime: reference time of the dataset group
|
|
:param extraOptions: dataset's extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, ...
|
|
%End
|
|
|
|
QString name() const;
|
|
%Docstring
|
|
Returns name of the dataset group
|
|
%End
|
|
|
|
QMap<QString, QString> extraOptions() const;
|
|
%Docstring
|
|
Returns extra metadata options, for example description
|
|
%End
|
|
|
|
bool isVector() const;
|
|
%Docstring
|
|
Returns whether dataset group has vector data
|
|
%End
|
|
|
|
bool isScalar() const;
|
|
%Docstring
|
|
Returns whether dataset group has scalar data
|
|
%End
|
|
|
|
DataType dataType() const;
|
|
%Docstring
|
|
Returns whether dataset group data is defined on vertices or faces or volumes
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
double minimum() const;
|
|
%Docstring
|
|
Returns minimum scalar value/vector magnitude present for whole dataset group
|
|
%End
|
|
|
|
double maximum() const;
|
|
%Docstring
|
|
Returns maximum scalar value/vector magnitude present for whole dataset group
|
|
%End
|
|
|
|
int maximumVerticalLevelsCount() const;
|
|
%Docstring
|
|
Returns maximum number of vertical levels for 3d stacked meshes
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
QDateTime referenceTime() const;
|
|
%Docstring
|
|
Returns the reference time
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsMeshDatasetMetadata
|
|
{
|
|
%Docstring
|
|
|
|
QgsMeshDatasetMetadata is a collection of mesh dataset metadata such
|
|
as whether the data is valid or associated time for the dataset
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshdataprovider.h"
|
|
%End
|
|
public:
|
|
QgsMeshDatasetMetadata();
|
|
%Docstring
|
|
Constructs an empty metadata object
|
|
%End
|
|
|
|
QgsMeshDatasetMetadata( double time,
|
|
bool isValid,
|
|
double minimum,
|
|
double maximum,
|
|
int maximumVerticalLevels
|
|
);
|
|
%Docstring
|
|
Constructs a valid metadata object
|
|
|
|
:param time: a time which this dataset represents in the dataset group
|
|
:param isValid: dataset is loadad and valid for fetching the data
|
|
:param minimum: minimum value (magnitude for vectors) present among dataset values
|
|
:param maximum: maximum value (magnitude for vectors) present among dataset values
|
|
:param maximumVerticalLevels: maximum number of vertical levels for 3d stacked meshes, 0 for 2d meshes
|
|
%End
|
|
|
|
double time() const;
|
|
%Docstring
|
|
Returns the time value for this dataset
|
|
%End
|
|
|
|
bool isValid() const;
|
|
%Docstring
|
|
Returns whether dataset is valid
|
|
%End
|
|
|
|
double minimum() const;
|
|
%Docstring
|
|
Returns minimum scalar value/vector magnitude present for the dataset
|
|
%End
|
|
|
|
double maximum() const;
|
|
%Docstring
|
|
Returns maximum scalar value/vector magnitude present for the dataset
|
|
%End
|
|
|
|
int maximumVerticalLevelsCount() const;
|
|
%Docstring
|
|
Returns maximum number of vertical levels for 3d stacked meshes
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsMeshDataSourceInterface /Abstract/
|
|
{
|
|
%Docstring
|
|
|
|
Interface for mesh data sources
|
|
|
|
Mesh is a collection of vertices, edges and faces in 2D or 3D space
|
|
- vertex - XY(Z) point (in the mesh's coordinate reference system)
|
|
- edge - two XY(Z) points (in the mesh's coordinate reference system) representing straight seqment
|
|
- faces - sets of vertices forming a closed shape - typically triangles or quadrilaterals
|
|
|
|
Base on the underlying data provider/format, whole mesh is either stored in memory or
|
|
read on demand
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshdataprovider.h"
|
|
%End
|
|
public:
|
|
virtual ~QgsMeshDataSourceInterface();
|
|
|
|
bool contains( const QgsMesh::ElementType &type ) const;
|
|
%Docstring
|
|
Returns whether the mesh contains at mesh elements of given type
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
virtual int vertexCount() const = 0;
|
|
%Docstring
|
|
Returns number of vertices in the native mesh
|
|
|
|
:return: Number of vertices in the mesh
|
|
%End
|
|
|
|
virtual int faceCount() const = 0;
|
|
%Docstring
|
|
Returns number of faces in the native mesh
|
|
|
|
:return: Number of faces in the mesh
|
|
%End
|
|
|
|
virtual int edgeCount() const = 0;
|
|
%Docstring
|
|
Returns number of edges in the native mesh
|
|
|
|
:return: Number of edges in the mesh
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
virtual void populateMesh( QgsMesh *mesh ) const = 0;
|
|
%Docstring
|
|
Populates the mesh vertices, edges and faces
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
};
|
|
|
|
class QgsMeshDatasetSourceInterface /Abstract/
|
|
{
|
|
%Docstring
|
|
Interface for mesh datasets and dataset groups
|
|
|
|
Dataset is a collection of vector or scalar values on vertices or faces of the mesh.
|
|
Based on the underlying data provider/format, whole dataset is either stored in memory
|
|
or read on demand
|
|
|
|
Datasets are grouped in the dataset groups. A dataset group represents a measured quantity
|
|
(e.g. depth or wind speed), dataset represents values of the quantity in a particular time.
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshdataprovider.h"
|
|
%End
|
|
public:
|
|
virtual ~QgsMeshDatasetSourceInterface();
|
|
|
|
virtual bool addDataset( const QString &uri ) = 0;
|
|
%Docstring
|
|
Associate dataset with the mesh
|
|
|
|
emits dataChanged when successful
|
|
%End
|
|
|
|
virtual QStringList extraDatasets() const = 0;
|
|
%Docstring
|
|
Returns list of additional dataset file URIs added using addDataset() calls.
|
|
%End
|
|
|
|
virtual int datasetGroupCount( ) const = 0;
|
|
%Docstring
|
|
Returns number of datasets groups loaded
|
|
%End
|
|
|
|
virtual int datasetCount( int groupIndex ) const = 0;
|
|
%Docstring
|
|
Returns number of datasets loaded in the group
|
|
%End
|
|
|
|
int datasetCount( QgsMeshDatasetIndex index ) const;
|
|
%Docstring
|
|
Returns number of datasets loaded in the group
|
|
%End
|
|
|
|
virtual QgsMeshDatasetGroupMetadata datasetGroupMetadata( int groupIndex ) const = 0;
|
|
%Docstring
|
|
Returns dataset group metadata
|
|
%End
|
|
|
|
QgsMeshDatasetGroupMetadata datasetGroupMetadata( QgsMeshDatasetIndex index ) const;
|
|
%Docstring
|
|
Returns dataset group metadata
|
|
%End
|
|
|
|
virtual QgsMeshDatasetMetadata datasetMetadata( QgsMeshDatasetIndex index ) const = 0;
|
|
%Docstring
|
|
Returns dataset metadata
|
|
%End
|
|
|
|
virtual QgsMeshDatasetValue datasetValue( QgsMeshDatasetIndex index, int valueIndex ) const = 0;
|
|
%Docstring
|
|
Returns vector/scalar value associated with the index from the dataset
|
|
To read multiple continuous values, use datasetValues()
|
|
|
|
See QgsMeshDatasetMetadata.isVector() or :py:func:`QgsMeshDataBlock.type()`
|
|
to check if the returned value is vector or scalar
|
|
|
|
Returns invalid value for DataOnVolumes
|
|
|
|
.. seealso:: :py:func:`datasetValues`
|
|
%End
|
|
|
|
virtual QgsMeshDataBlock datasetValues( QgsMeshDatasetIndex index, int valueIndex, int count ) const = 0;
|
|
%Docstring
|
|
Returns N vector/scalar values from the index from the dataset
|
|
|
|
See QgsMeshDatasetMetadata.isVector() or :py:func:`QgsMeshDataBlock.type()`
|
|
to check if the returned value is vector or scalar
|
|
|
|
Returns invalid block for DataOnVolumes. Use QgsMeshLayerUtils.datasetValues() if you
|
|
need block for any type of data type
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
virtual QgsMesh3dDataBlock dataset3dValues( QgsMeshDatasetIndex index, int faceIndex, int count ) const = 0;
|
|
%Docstring
|
|
Returns N vector/scalar values from the face index from the dataset for 3d stacked meshes
|
|
|
|
See QgsMeshDatasetMetadata.isVector() to check if the returned value is vector or scalar
|
|
|
|
returns invalid block for DataOnFaces and DataOnVertices.
|
|
|
|
.. seealso:: :py:func:`datasetValues`
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
virtual bool isFaceActive( QgsMeshDatasetIndex index, int faceIndex ) const = 0;
|
|
%Docstring
|
|
Returns whether the face is active for particular dataset
|
|
|
|
For example to represent the situation when F1 and F3 are flooded, but F2 is dry,
|
|
some solvers store water depth on vertices V1-V8 (all non-zero values) and
|
|
set active flag for F2 to ``False``.
|
|
V1 ---- V2 ---- V5-----V7
|
|
| F1 | F2 | F3 |
|
|
V3 ---- V4 ---- V6-----V8
|
|
%End
|
|
|
|
virtual QgsMeshDataBlock areFacesActive( QgsMeshDatasetIndex index, int faceIndex, int count ) const = 0;
|
|
%Docstring
|
|
Returns whether the faces are active for particular dataset
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
virtual bool persistDatasetGroup( const QString &path,
|
|
const QgsMeshDatasetGroupMetadata &meta,
|
|
const QVector<QgsMeshDataBlock> &datasetValues,
|
|
const QVector<QgsMeshDataBlock> &datasetActive,
|
|
const QVector<double> ×
|
|
) = 0;
|
|
%Docstring
|
|
Creates a new dataset group from a data and
|
|
persists it into a destination path
|
|
|
|
On success, the mesh's dataset group count is changed
|
|
|
|
:param path: destination path of the stored file in form DRIVER_NAME:path
|
|
:param meta: new group's metadata
|
|
:param datasetValues: scalar/vector values for all datasets and all faces/vertices in the group
|
|
:param datasetActive: active flag values for all datasets in the group. Empty array represents can be used
|
|
when all faces are active
|
|
:param times: times in hours for all datasets in the group
|
|
|
|
:return: ``True`` on failure, ``False`` on success
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
};
|
|
|
|
|
|
class QgsMeshDataProvider: QgsDataProvider, QgsMeshDataSourceInterface, QgsMeshDatasetSourceInterface
|
|
{
|
|
%Docstring
|
|
Base class for providing data for :py:class:`QgsMeshLayer`
|
|
|
|
Responsible for reading native mesh data
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshdataprovider.h"
|
|
%End
|
|
public:
|
|
QgsMeshDataProvider( const QString &uri, const QgsDataProvider::ProviderOptions &providerOptions );
|
|
%Docstring
|
|
Ctor
|
|
%End
|
|
|
|
signals:
|
|
void datasetGroupsAdded( int count );
|
|
%Docstring
|
|
Emitted when some new dataset groups have been added
|
|
%End
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/mesh/qgsmeshdataprovider.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|