QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Mesh layer specific subclass of QgsMapLayerElevationProperties. More...
#include <qgsmeshlayerelevationproperties.h>
Public Member Functions | |
QgsMeshLayerElevationProperties (QObject *parent) | |
Constructor for QgsMeshLayerElevationProperties, with the specified parent object. | |
~QgsMeshLayerElevationProperties () override | |
QgsDoubleRange | calculateZRange (QgsMapLayer *layer) const override |
Attempts to calculate the overall elevation or z range for the specified layer, using the settings defined by this elevation properties object. | |
QgsMeshLayerElevationProperties * | clone () const override |
Creates a clone of the properties. | |
double | elevationLimit () const |
Returns the elevation limit, which is used when profileSymbology() is Qgis::ProfileSurfaceSymbology::FillBelow or Qgis::ProfileSurfaceSymbology::FillAbove to limit the fill to a specific elevation range. | |
QgsDoubleRange | fixedRange () const |
Returns the fixed elevation range for the mesh. | |
QMap< int, QgsDoubleRange > | fixedRangePerGroup () const |
Returns the fixed elevation range for each group. | |
QgsMapLayerElevationProperties::Flags | flags () const override |
Returns flags associated to the elevation properties. | |
bool | hasElevation () const override |
Returns true if the layer has an elevation or z component. | |
QString | htmlSummary () const override |
Returns a HTML formatted summary of the properties. | |
bool | isVisibleInZRange (const QgsDoubleRange &range, QgsMapLayer *layer=nullptr) const override |
Returns true if the layer should be visible and rendered for the specified z range. | |
Qgis::MeshElevationMode | mode () const |
Returns the elevation mode. | |
QgsFillSymbol * | profileFillSymbol () const |
Returns the fill symbol used to render the mesh profile in elevation profile plots. | |
QgsLineSymbol * | profileLineSymbol () const |
Returns the line symbol used to render the mesh profile in elevation profile plots. | |
Qgis::ProfileSurfaceSymbology | profileSymbology () const |
Returns the symbology option used to render the mesh profile in elevation profile plots. | |
bool | readXml (const QDomElement &element, const QgsReadWriteContext &context) override |
Reads the elevation properties from a DOM element previously written by writeXml(). | |
void | setElevationLimit (double limit) |
Sets the elevation limit, which is used when profileSymbology() is Qgis::ProfileSurfaceSymbology::FillBelow or Qgis::ProfileSurfaceSymbology::FillAbove to limit the fill to a specific elevation range. | |
void | setFixedRange (const QgsDoubleRange &range) |
Sets the fixed elevation range for the mesh. | |
void | setFixedRangePerGroup (const QMap< int, QgsDoubleRange > &ranges) |
Sets the fixed elevation range for each group. | |
void | setMode (Qgis::MeshElevationMode mode) |
Sets the elevation mode. | |
void | setProfileFillSymbol (QgsFillSymbol *symbol) |
Sets the fill symbol used to render the mesh profile in elevation profile plots. | |
void | setProfileLineSymbol (QgsLineSymbol *symbol) |
Sets the line symbol used to render the mesh profile in elevation profile plots. | |
void | setProfileSymbology (Qgis::ProfileSurfaceSymbology symbology) |
Sets the symbology option used to render the mesh profile in elevation profile plots. | |
bool | showByDefaultInElevationProfilePlots () const override |
Returns true if the layer should be visible by default in newly created elevation profile plots. | |
QList< double > | significantZValues (QgsMapLayer *layer) const override |
Returns a list of significant elevation/z-values for the specified layer, using the settings defined by this elevation properties object. | |
QDomElement | writeXml (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override |
Writes the properties to a DOM element, to be used later with readXml(). | |
Public Member Functions inherited from QgsMapLayerElevationProperties | |
QgsMapLayerElevationProperties (QObject *parent) | |
Constructor for QgsMapLayerElevationProperties, with the specified parent object. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the object's property collection, used for data defined overrides. | |
virtual void | setDefaultsFromLayer (QgsMapLayer *layer) |
Sets default properties based on sensible choices for the given map layer. | |
void | setZOffset (double offset) |
Sets the z offset, which is a fixed offset amount which will be added to z values from the layer. | |
void | setZScale (double scale) |
Sets the z scale, which is a scaling factor which will be applied to z values from the layer. | |
double | zOffset () const |
Returns the z offset, which is a fixed offset amount which should be added to z values from the layer. | |
double | zScale () const |
Returns the z scale, which is a scaling factor which should be applied to z values from the layer. | |
Additional Inherited Members | |
Public Types inherited from QgsMapLayerElevationProperties | |
enum | Flag { FlagDontInvalidateCachedRendersWhenRangeChanges = 1 } |
Flags attached to the elevation property. More... | |
typedef QFlags< Flag > | Flags |
enum class | Property : int { ZOffset , ExtrusionHeight , RasterPerBandLowerElevation , RasterPerBandUpperElevation } |
Data definable properties. More... | |
Signals inherited from QgsMapLayerElevationProperties | |
void | changed () |
Emitted when any of the elevation properties have changed. | |
void | profileGenerationPropertyChanged () |
Emitted when any of the elevation properties which relate solely to generation of elevation profiles have changed. | |
void | profileRenderingPropertyChanged () |
Emitted when any of the elevation properties which relate solely to presentation of elevation results have changed. | |
void | zOffsetChanged () |
Emitted when the z offset changes. | |
void | zScaleChanged () |
Emitted when the z scale changes. | |
Static Public Member Functions inherited from QgsMapLayerElevationProperties | |
static QgsPropertiesDefinition | propertyDefinitions () |
Returns the definitions for data defined properties available for use in elevation properties. | |
Protected Member Functions inherited from QgsMapLayerElevationProperties | |
void | copyCommonProperties (const QgsMapLayerElevationProperties *other) |
Copies common properties from another object. | |
void | readCommonProperties (const QDomElement &element, const QgsReadWriteContext &context) |
Reads common class properties from a DOM element previously written by writeXml(). | |
void | writeCommonProperties (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) |
Writes common class properties to a DOM element, to be used later with readXml(). | |
Protected Attributes inherited from QgsMapLayerElevationProperties | |
QgsPropertyCollection | mDataDefinedProperties |
Property collection for data defined elevation settings. | |
double | mZOffset = 0.0 |
Z offset. | |
double | mZScale = 1.0 |
Z scale. | |
Static Protected Attributes inherited from QgsMapLayerElevationProperties | |
static QgsPropertiesDefinition | sPropertyDefinitions |
Property definitions. | |
Mesh layer specific subclass of QgsMapLayerElevationProperties.
Definition at line 38 of file qgsmeshlayerelevationproperties.h.
QgsMeshLayerElevationProperties::QgsMeshLayerElevationProperties | ( | QObject * | parent | ) |
Constructor for QgsMeshLayerElevationProperties, with the specified parent object.
Definition at line 28 of file qgsmeshlayerelevationproperties.cpp.
|
overridedefault |
|
overridevirtual |
Attempts to calculate the overall elevation or z range for the specified layer, using the settings defined by this elevation properties object.
May return an infinite range if the extent could not be calculated.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 220 of file qgsmeshlayerelevationproperties.cpp.
|
overridevirtual |
Creates a clone of the properties.
Implements QgsMapLayerElevationProperties.
Definition at line 182 of file qgsmeshlayerelevationproperties.cpp.
double QgsMeshLayerElevationProperties::elevationLimit | ( | ) | const |
Returns the elevation limit, which is used when profileSymbology() is Qgis::ProfileSurfaceSymbology::FillBelow or 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.
Definition at line 396 of file qgsmeshlayerelevationproperties.cpp.
QgsDoubleRange QgsMeshLayerElevationProperties::fixedRange | ( | ) | const |
Returns the fixed elevation range for the mesh.
Definition at line 334 of file qgsmeshlayerelevationproperties.cpp.
QMap< int, QgsDoubleRange > QgsMeshLayerElevationProperties::fixedRangePerGroup | ( | ) | const |
Returns the fixed elevation range for each group.
Definition at line 348 of file qgsmeshlayerelevationproperties.cpp.
|
overridevirtual |
Returns flags associated to the elevation properties.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 306 of file qgsmeshlayerelevationproperties.cpp.
|
overridevirtual |
Returns true
if the layer has an elevation or z component.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 38 of file qgsmeshlayerelevationproperties.cpp.
|
overridevirtual |
Returns a HTML formatted summary of the properties.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 156 of file qgsmeshlayerelevationproperties.cpp.
|
overridevirtual |
Returns true
if the layer should be visible and rendered for the specified z range.
Since QGIS 3.38 the layer argument can be used to specify the target layer.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 196 of file qgsmeshlayerelevationproperties.cpp.
Qgis::MeshElevationMode QgsMeshLayerElevationProperties::mode | ( | ) | const |
Returns the elevation mode.
Definition at line 320 of file qgsmeshlayerelevationproperties.cpp.
QgsFillSymbol * QgsMeshLayerElevationProperties::profileFillSymbol | ( | ) | const |
Returns the fill symbol used to render the mesh profile in elevation profile plots.
Definition at line 374 of file qgsmeshlayerelevationproperties.cpp.
QgsLineSymbol * QgsMeshLayerElevationProperties::profileLineSymbol | ( | ) | const |
Returns the line symbol used to render the mesh profile in elevation profile plots.
Definition at line 362 of file qgsmeshlayerelevationproperties.cpp.
|
inline |
Returns the symbology option used to render the mesh profile in elevation profile plots.
Definition at line 163 of file qgsmeshlayerelevationproperties.h.
|
overridevirtual |
Reads the elevation properties from a DOM element previously written by writeXml().
Implements QgsMapLayerElevationProperties.
Definition at line 95 of file qgsmeshlayerelevationproperties.cpp.
void QgsMeshLayerElevationProperties::setElevationLimit | ( | double | limit | ) |
Sets the elevation limit, which is used when profileSymbology() is Qgis::ProfileSurfaceSymbology::FillBelow or Qgis::ProfileSurfaceSymbology::FillAbove to limit the fill to a specific elevation range.
Set to NaN to indicate that there is no elevation limit.
Definition at line 401 of file qgsmeshlayerelevationproperties.cpp.
void QgsMeshLayerElevationProperties::setFixedRange | ( | const QgsDoubleRange & | range | ) |
Sets the fixed elevation range for the mesh.
Definition at line 339 of file qgsmeshlayerelevationproperties.cpp.
void QgsMeshLayerElevationProperties::setFixedRangePerGroup | ( | const QMap< int, QgsDoubleRange > & | ranges | ) |
Sets the fixed elevation range for each group.
Definition at line 353 of file qgsmeshlayerelevationproperties.cpp.
void QgsMeshLayerElevationProperties::setMode | ( | Qgis::MeshElevationMode | mode | ) |
Sets the elevation mode.
Definition at line 325 of file qgsmeshlayerelevationproperties.cpp.
void QgsMeshLayerElevationProperties::setProfileFillSymbol | ( | QgsFillSymbol * | symbol | ) |
Sets the fill symbol used to render the mesh profile in elevation profile plots.
Ownership of symbol is transferred to the plot.
Definition at line 379 of file qgsmeshlayerelevationproperties.cpp.
void QgsMeshLayerElevationProperties::setProfileLineSymbol | ( | QgsLineSymbol * | symbol | ) |
Sets the line symbol used to render the mesh profile in elevation profile plots.
Ownership of symbol is transferred to the plot.
Definition at line 367 of file qgsmeshlayerelevationproperties.cpp.
void QgsMeshLayerElevationProperties::setProfileSymbology | ( | Qgis::ProfileSurfaceSymbology | symbology | ) |
Sets the symbology option used to render the mesh profile in elevation profile plots.
Definition at line 386 of file qgsmeshlayerelevationproperties.cpp.
|
overridevirtual |
Returns true
if the layer should be visible by default in newly created elevation profile plots.
Subclasses should override this with logic which determines whether the layer is likely desirable to be initially checked in these plots.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 301 of file qgsmeshlayerelevationproperties.cpp.
|
overridevirtual |
Returns a list of significant elevation/z-values for the specified layer, using the settings defined by this elevation properties object.
These values will be highlighted in elevation related widgets for the layer.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 264 of file qgsmeshlayerelevationproperties.cpp.
|
overridevirtual |
Writes the properties to a DOM element, to be used later with readXml().
Implements QgsMapLayerElevationProperties.
Definition at line 43 of file qgsmeshlayerelevationproperties.cpp.