Skip to content

Commit

Permalink
fix sip
Browse files Browse the repository at this point in the history
  • Loading branch information
vcloarec authored and nyalldawson committed Apr 28, 2020
1 parent a6ef994 commit 5691658
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion python/core/auto_generated/mesh/qgsmeshlayer.sip.in
Expand Up @@ -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


Expand Down Expand Up @@ -197,18 +199,23 @@ 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::

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: 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
Expand All @@ -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

Expand All @@ -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;
Expand Down

0 comments on commit 5691658

Please sign in to comment.