mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-15 00:02:52 -04:00
192 lines
5.1 KiB
Plaintext
192 lines
5.1 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/project/qgsprojectelevationproperties.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsProjectElevationProperties : QObject
|
|
{
|
|
%Docstring(signature="appended")
|
|
Contains elevation properties for a :py:class:`QgsProject`.
|
|
|
|
.. versionadded:: 3.26
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsprojectelevationproperties.h"
|
|
%End
|
|
public:
|
|
|
|
QgsProjectElevationProperties( QObject *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsProjectElevationProperties with the specified
|
|
``parent`` object.
|
|
%End
|
|
|
|
~QgsProjectElevationProperties();
|
|
|
|
void reset();
|
|
%Docstring
|
|
Resets the properties to a default state.
|
|
%End
|
|
|
|
void resolveReferences( const QgsProject *project );
|
|
%Docstring
|
|
Resolves reference to layers from stored layer ID.
|
|
%End
|
|
|
|
bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
|
|
%Docstring
|
|
Reads the property state from a DOM ``element``.
|
|
|
|
.. seealso:: :py:func:`writeXml`
|
|
%End
|
|
|
|
QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const;
|
|
%Docstring
|
|
Returns a DOM element representing the properties.
|
|
|
|
.. seealso:: :py:func:`readXml`
|
|
%End
|
|
|
|
QgsAbstractTerrainProvider *terrainProvider();
|
|
%Docstring
|
|
Returns the project's terrain provider.
|
|
|
|
.. seealso:: :py:func:`setTerrainProvider`
|
|
%End
|
|
|
|
void setTerrainProvider( QgsAbstractTerrainProvider *provider /Transfer/ );
|
|
%Docstring
|
|
Sets the project's terrain ``provider``.
|
|
|
|
Ownership of ``provider`` is transferred to this object.
|
|
|
|
.. seealso:: :py:func:`terrainProvider`
|
|
%End
|
|
|
|
QgsDoubleRange elevationRange() const;
|
|
%Docstring
|
|
Returns the project's elevation range, which indicates the upper and
|
|
lower elevation limits associated with the project.
|
|
|
|
.. note::
|
|
|
|
This is a manual, use-set property, and does not necessarily
|
|
coincide with the elevation ranges for individual layers in the project.
|
|
|
|
.. seealso:: :py:func:`setElevationRange`
|
|
|
|
.. seealso:: :py:func:`elevationRangeChanged`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
double elevationFilterRangeSize() const;
|
|
%Docstring
|
|
Returns the fixed size for elevation range filtering in the project,
|
|
used when interactively filtering by elevation.
|
|
|
|
Returns -1 if no fixed elevation range size is desired.
|
|
|
|
A fixed size forces the selected elevation range to have a matching
|
|
difference between the upper and lower elevation.
|
|
|
|
.. seealso:: :py:func:`setElevationFilterRangeSize`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
bool invertElevationFilter() const;
|
|
%Docstring
|
|
Returns ``True`` if the elevation range filter slider should be inverted
|
|
for this project.
|
|
|
|
.. seealso:: :py:func:`setInvertElevationFilter`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
public slots:
|
|
|
|
void setElevationRange( const QgsDoubleRange &range );
|
|
%Docstring
|
|
Sets the project's elevation ``range``, which indicates the upper and
|
|
lower elevation limits associated with the project.
|
|
|
|
.. note::
|
|
|
|
This is a manual, use-set property, and does not necessarily
|
|
coincide with the elevation ranges for individual layers in the project.
|
|
|
|
.. seealso:: :py:func:`elevationRange`
|
|
|
|
.. seealso:: :py:func:`elevationRangeChanged`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
void setElevationFilterRangeSize( double size );
|
|
%Docstring
|
|
Sets the fixed size for elevation range filtering in the project, used
|
|
when interactively filtering by elevation.
|
|
|
|
Set to -1 if no fixed elevation range size is desired.
|
|
|
|
A fixed size forces the selected elevation range to have a matching
|
|
difference between the upper and lower elevation.
|
|
|
|
.. seealso:: :py:func:`elevationFilterRangeSize`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
void setInvertElevationFilter( bool invert );
|
|
%Docstring
|
|
Sets whether the elevation range filter slider should be inverted for
|
|
this project.
|
|
|
|
.. seealso:: :py:func:`invertElevationFilter`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
signals:
|
|
|
|
void changed();
|
|
%Docstring
|
|
Emitted when the elevation properties change.
|
|
%End
|
|
|
|
void elevationRangeChanged( const QgsDoubleRange &range );
|
|
%Docstring
|
|
Emitted when the project's elevation ``is`` changed.
|
|
|
|
.. note::
|
|
|
|
This is a manual, use-set property, and does not necessarily
|
|
coincide with the elevation ranges for individual layers in the project.
|
|
|
|
.. seealso:: :py:func:`elevationRange`
|
|
|
|
.. seealso:: :py:func:`setElevationRange`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/project/qgsprojectelevationproperties.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|