mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
234 lines
6.7 KiB
Plaintext
234 lines
6.7 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/mesh/qgsmeshlayerelevationproperties.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsMeshLayerElevationProperties : QgsMapLayerElevationProperties
|
|
{
|
|
%Docstring(signature="appended")
|
|
Mesh layer specific subclass of
|
|
:py:class:`QgsMapLayerElevationProperties`.
|
|
|
|
.. versionadded:: 3.26
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshlayerelevationproperties.h"
|
|
%End
|
|
public:
|
|
|
|
QgsMeshLayerElevationProperties( QObject *parent /TransferThis/ );
|
|
%Docstring
|
|
Constructor for QgsMeshLayerElevationProperties, with the specified
|
|
``parent`` object.
|
|
%End
|
|
~QgsMeshLayerElevationProperties();
|
|
|
|
virtual bool hasElevation() const;
|
|
|
|
virtual QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context );
|
|
|
|
virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
|
|
|
|
virtual QString htmlSummary() const;
|
|
|
|
virtual QgsMeshLayerElevationProperties *clone() const /Factory/;
|
|
|
|
virtual bool isVisibleInZRange( const QgsDoubleRange &range, QgsMapLayer *layer = 0 ) const;
|
|
|
|
virtual QgsDoubleRange calculateZRange( QgsMapLayer *layer ) const;
|
|
|
|
virtual QList< double > significantZValues( QgsMapLayer *layer ) const;
|
|
|
|
virtual bool showByDefaultInElevationProfilePlots() const;
|
|
|
|
virtual QgsMapLayerElevationProperties::Flags flags() const;
|
|
|
|
|
|
Qgis::MeshElevationMode mode() const;
|
|
%Docstring
|
|
Returns the elevation mode.
|
|
|
|
.. seealso:: :py:func:`setMode`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
void setMode( Qgis::MeshElevationMode mode );
|
|
%Docstring
|
|
Sets the elevation ``mode``.
|
|
|
|
.. seealso:: :py:func:`mode`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
QgsDoubleRange fixedRange() const;
|
|
%Docstring
|
|
Returns the fixed elevation range for the mesh.
|
|
|
|
.. note::
|
|
|
|
This is only considered when :py:func:`~QgsMeshLayerElevationProperties.mode` is :py:class:`Qgis`.MeshElevationMode.FixedElevationRange.
|
|
|
|
.. note::
|
|
|
|
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
|
|
|
|
.. seealso:: :py:func:`setFixedRange`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
void setFixedRange( const QgsDoubleRange &range );
|
|
%Docstring
|
|
Sets the fixed elevation ``range`` for the mesh.
|
|
|
|
.. note::
|
|
|
|
This is only considered when :py:func:`~QgsMeshLayerElevationProperties.mode` is :py:class:`Qgis`.MeshElevationMode.FixedElevationRange.
|
|
|
|
.. note::
|
|
|
|
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
|
|
|
|
.. seealso:: :py:func:`fixedRange`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
QMap<int, QgsDoubleRange> fixedRangePerGroup() const;
|
|
%Docstring
|
|
Returns the fixed elevation range for each group.
|
|
|
|
.. note::
|
|
|
|
This is only considered when :py:func:`~QgsMeshLayerElevationProperties.mode` is :py:class:`Qgis`.MeshElevationMode.FixedRangePerGroup.
|
|
|
|
.. note::
|
|
|
|
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
|
|
|
|
.. seealso:: :py:func:`setFixedRangePerGroup`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
void setFixedRangePerGroup( const QMap<int, QgsDoubleRange> &ranges );
|
|
%Docstring
|
|
Sets the fixed elevation range for each group.
|
|
|
|
.. note::
|
|
|
|
This is only considered when :py:func:`~QgsMeshLayerElevationProperties.mode` is :py:class:`Qgis`.MeshElevationMode.FixedRangePerGroup.
|
|
|
|
.. note::
|
|
|
|
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
|
|
|
|
.. seealso:: :py:func:`fixedRangePerGroup`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
QgsLineSymbol *profileLineSymbol() const;
|
|
%Docstring
|
|
Returns the line symbol used to render the mesh profile in elevation
|
|
profile plots.
|
|
|
|
.. seealso:: :py:func:`setProfileLineSymbol`
|
|
%End
|
|
|
|
void setProfileLineSymbol( QgsLineSymbol *symbol /Transfer/ );
|
|
%Docstring
|
|
Sets the line ``symbol`` used to render the mesh profile in elevation
|
|
profile plots.
|
|
|
|
Ownership of ``symbol`` is transferred to the plot.
|
|
|
|
.. seealso:: :py:func:`profileLineSymbol`
|
|
%End
|
|
|
|
QgsFillSymbol *profileFillSymbol() const;
|
|
%Docstring
|
|
Returns the fill symbol used to render the mesh profile in elevation
|
|
profile plots.
|
|
|
|
.. seealso:: :py:func:`setProfileFillSymbol`
|
|
%End
|
|
|
|
void setProfileFillSymbol( QgsFillSymbol *symbol /Transfer/ );
|
|
%Docstring
|
|
Sets the fill ``symbol`` used to render the mesh profile in elevation
|
|
profile plots.
|
|
|
|
Ownership of ``symbol`` is transferred to the plot.
|
|
|
|
.. seealso:: :py:func:`profileFillSymbol`
|
|
%End
|
|
|
|
Qgis::ProfileSurfaceSymbology profileSymbology() const;
|
|
%Docstring
|
|
Returns the symbology option used to render the mesh profile in
|
|
elevation profile plots.
|
|
|
|
.. seealso:: :py:func:`setProfileSymbology`
|
|
%End
|
|
|
|
void setProfileSymbology( Qgis::ProfileSurfaceSymbology symbology );
|
|
%Docstring
|
|
Sets the ``symbology`` option used to render the mesh profile in
|
|
elevation profile plots.
|
|
|
|
.. seealso:: :py:func:`setProfileSymbology`
|
|
%End
|
|
|
|
double elevationLimit() const;
|
|
%Docstring
|
|
Returns the elevation limit, which is used when
|
|
:py:func:`~QgsMeshLayerElevationProperties.profileSymbology` is
|
|
:py:class:`Qgis`.ProfileSurfaceSymbology.FillBelow or
|
|
:py:class:`Qgis`.ProfileSurfaceSymbology.FillAbove to limit the fill to
|
|
a specific elevation range.
|
|
|
|
By default this is NaN, which indicates that there is no elevation
|
|
limit.
|
|
|
|
.. seealso:: :py:func:`setElevationLimit`
|
|
|
|
.. versionadded:: 3.32
|
|
%End
|
|
|
|
void setElevationLimit( double limit );
|
|
%Docstring
|
|
Sets the elevation ``limit``, which is used when
|
|
:py:func:`~QgsMeshLayerElevationProperties.profileSymbology` is
|
|
:py:class:`Qgis`.ProfileSurfaceSymbology.FillBelow or
|
|
:py:class:`Qgis`.ProfileSurfaceSymbology.FillAbove to limit the fill to
|
|
a specific elevation range.
|
|
|
|
Set to NaN to indicate that there is no elevation limit.
|
|
|
|
.. seealso:: :py:func:`elevationLimit`
|
|
|
|
.. versionadded:: 3.32
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/mesh/qgsmeshlayerelevationproperties.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|