QGIS/python/core/auto_generated/qgselevationutils.sip.in
2024-08-13 20:28:55 +10:00

78 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgselevationutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsElevationUtils
{
%Docstring(signature="appended")
Contains utility methods for working with elevation from layers and projects.
.. versionadded:: 3.18
%End
%TypeHeaderCode
#include "qgselevationutils.h"
%End
public:
static QgsDoubleRange calculateZRangeForProject( QgsProject *project );
%Docstring
Calculates the elevation range for a ``project``.
This method considers the elevation (or z) range available from layers contained within the project and
returns the maximal combined elevation range of these layers.
%End
static QList< double > significantZValuesForProject( QgsProject *project );
%Docstring
Returns a list of significant elevation/z-values for the specified ``project``, using
the values from layers contained by the project.
These values will be highlighted in elevation related widgets for the project.
.. versionadded:: 3.38
%End
static QList< double > significantZValuesForLayers( const QList< QgsMapLayer * > &layers );
%Docstring
Returns a list of significant elevation/z-values for the specified ``layers``.
These values will be highlighted in elevation related widgets for the project.
.. versionadded:: 3.38
%End
static bool canEnableElevationForLayer( QgsMapLayer *layer );
%Docstring
Returns ``True`` if elevation can be enabled for a map ``layer``.
.. versionadded:: 3.32
%End
static bool enableElevationForLayer( QgsMapLayer *layer );
%Docstring
Automatically enables elevation for a map ``layer``, using reasonable defaults.
Returns ``True`` if the elevation was enabled successfully.
.. versionadded:: 3.32
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgselevationutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/