QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsTiledSceneLayerElevationProperties Class Reference

Tiled scene layer specific subclass of QgsMapLayerElevationProperties. More...

#include <qgstiledscenelayerelevationproperties.h>

Inheritance diagram for QgsTiledSceneLayerElevationProperties:
Inheritance graph
[legend]

Public Member Functions

 QgsTiledSceneLayerElevationProperties (QObject *parent)
 Constructor for QgsTiledSceneLayerElevationProperties, with the specified parent object.
 
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.
 
QgsTiledSceneLayerElevationPropertiesclone () const override
 Creates a clone of the 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 readXml (const QDomElement &element, const QgsReadWriteContext &context) override
 Reads the elevation properties from a DOM element previously written by writeXml().
 
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.
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the object's property collection, used for data defined overrides.
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the object's property collection, used for data defined overrides.
 
virtual QgsMapLayerElevationProperties::Flags flags () const
 Returns flags associated to the elevation properties.
 
virtual bool isVisibleInZRange (const QgsDoubleRange &range, QgsMapLayer *layer=nullptr) const
 Returns true if the layer should be visible and rendered for the specified z range.
 
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.
 
virtual bool showByDefaultInElevationProfilePlots () const
 Returns true if the layer should be visible by default in newly created elevation profile plots.
 
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< FlagFlags
 
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.
 

Detailed Description

Tiled scene layer specific subclass of QgsMapLayerElevationProperties.

Since
QGIS 3.34

Definition at line 33 of file qgstiledscenelayerelevationproperties.h.

Constructor & Destructor Documentation

◆ QgsTiledSceneLayerElevationProperties()

QgsTiledSceneLayerElevationProperties::QgsTiledSceneLayerElevationProperties ( QObject *  parent)

Constructor for QgsTiledSceneLayerElevationProperties, with the specified parent object.

Definition at line 21 of file qgstiledscenelayerelevationproperties.cpp.

Member Function Documentation

◆ calculateZRange()

QgsDoubleRange QgsTiledSceneLayerElevationProperties::calculateZRange ( QgsMapLayer layer) const
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 64 of file qgstiledscenelayerelevationproperties.cpp.

◆ clone()

QgsTiledSceneLayerElevationProperties * QgsTiledSceneLayerElevationProperties::clone ( ) const
overridevirtual

Creates a clone of the properties.

Since
QGIS 3.26

Implements QgsMapLayerElevationProperties.

Definition at line 48 of file qgstiledscenelayerelevationproperties.cpp.

◆ hasElevation()

bool QgsTiledSceneLayerElevationProperties::hasElevation ( ) const
overridevirtual

Returns true if the layer has an elevation or z component.

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 26 of file qgstiledscenelayerelevationproperties.cpp.

◆ htmlSummary()

QString QgsTiledSceneLayerElevationProperties::htmlSummary ( ) const
overridevirtual

Returns a HTML formatted summary of the properties.

Since
QGIS 3.26

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 56 of file qgstiledscenelayerelevationproperties.cpp.

◆ readXml()

bool QgsTiledSceneLayerElevationProperties::readXml ( const QDomElement &  element,
const QgsReadWriteContext context 
)
overridevirtual

Reads the elevation properties from a DOM element previously written by writeXml().

See also
writeXml()

Implements QgsMapLayerElevationProperties.

Definition at line 40 of file qgstiledscenelayerelevationproperties.cpp.

◆ significantZValues()

QList< double > QgsTiledSceneLayerElevationProperties::significantZValues ( QgsMapLayer layer) const
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.

Since
QGIS 3.38

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 81 of file qgstiledscenelayerelevationproperties.cpp.

◆ writeXml()

QDomElement QgsTiledSceneLayerElevationProperties::writeXml ( QDomElement &  element,
QDomDocument &  doc,
const QgsReadWriteContext context 
)
overridevirtual

Writes the properties to a DOM element, to be used later with readXml().

See also
readXml()

Implements QgsMapLayerElevationProperties.

Definition at line 31 of file qgstiledscenelayerelevationproperties.cpp.


The documentation for this class was generated from the following files: