This commit is contained in:
vcloarec 2020-04-27 15:27:40 -04:00 committed by Nyall Dawson
parent a6ef994cd2
commit 56916581e1

View File

@ -158,6 +158,8 @@ Returns the provider type for this layer
Gets native mesh and updates (creates if it doesn't exist) the base triangular mesh
:param transform: Transformation from layer CRS to destination (e.g. map) CRS. With invalid transform, it keeps the native mesh CRS
.. versionadded:: 3.14
%End
@ -197,9 +199,11 @@ Returns (date) time in hours formatted to human readable form
.. versionadded:: 3.8
%End
QgsMeshDatasetValue datasetValue( const QgsMeshDatasetIndex &index, const QgsPointXY &point ) const;
QgsMeshDatasetValue datasetValue( const QgsMeshDatasetIndex &index, const QgsPointXY &point, double searchRadius = 0 ) const;
%Docstring
Interpolates the value on the given point from given dataset.
For 3D datasets, it uses #dataset3dValue \n
For 1D datasets, it uses #dataset1dValue with ``searchRadius``
.. note::
@ -207,8 +211,11 @@ Interpolates the value on the given point from given dataset.
and so if the layer has not been rendered previously
(e.g. when used in a script) it returns NaN value
.. seealso:: :py:func:`updateTriangularMesh`
:param index: dataset index specifying group and dataset to extract value from
:param point: point to query in map coordinates
:param searchRadius: the radius of the search area in map unit
:return: interpolated value at the point. Returns NaN values for values
outside the mesh layer, nodata values and in case triangular mesh was not
@ -228,6 +235,8 @@ Returns the 3d values of stacked 3d mesh defined by the given point
and so if the layer has not been rendered previously
(e.g. when used in a script) it returns NaN value
.. seealso:: :py:func:`updateTriangularMesh`
:param index: dataset index specifying group and dataset to extract value from
:param point: point to query in map coordinates
@ -237,6 +246,29 @@ Returns the 3d values of stacked 3d mesh defined by the given point
.. versionadded:: 3.12
%End
QgsMeshDatasetValue dataset1dValue( const QgsMeshDatasetIndex &index, const QgsPointXY &point, double searchRadius ) const;
%Docstring
Returns the value of 1D mesh dataset defined on edge that are in the search area defined by point ans searchRadius
.. 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
.. seealso:: :py:func:`updateTriangularMesh`
:param index: dataset index specifying group and dataset to extract value from
:param point: the center point of the search area
:param searchRadius: the radius of the searc area in map unit
:return: interpolated value at the projected point. Returns NaN values for values
outside the mesh layer and in case triangular mesh was not previously used for rendering
.. versionadded:: 3.14
%End
QgsMeshDatasetIndex activeScalarDatasetAtTime( const QgsDateTimeRange &timeRange ) const;