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

#include <qgstiledscenelayerelevationproperties.h>

Inheritance diagram for QgsTiledSceneLayerElevationProperties:

Public Member Functions
	QgsTiledSceneLayerElevationProperties (QObject *parent)
	Constructor for QgsTiledSceneLayerElevationProperties, with the specified parent object. More...

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. More...

QgsTiledSceneLayerElevationProperties *	clone () const override
	Creates a clone of the properties. More...

bool	hasElevation () const override
	Returns `true` if the layer has an elevation or z component. More...

QString	htmlSummary () const override
	Returns a HTML formatted summary of the properties. More...

bool	readXml (const QDomElement &element, const QgsReadWriteContext &context) override
	Reads the elevation properties from a DOM element previously written by writeXml(). More...

QDomElement	writeXml (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override
	Writes the properties to a DOM element, to be used later with readXml(). More...

Public Member Functions inherited from QgsMapLayerElevationProperties
	QgsMapLayerElevationProperties (QObject *parent)
	Constructor for QgsMapLayerElevationProperties, with the specified parent object. More...

virtual QgsDoubleRange	calculateZRange (QgsMapLayer *layer) const
	Attempts to calculate the overall elevation or z range for the specified layer, using the settings defined by this elevation properties object. More...

virtual QgsMapLayerElevationProperties *	clone () const =0
	Creates a clone of the properties. More...

QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the object's property collection, used for data defined overrides. More...

const QgsPropertyCollection &	dataDefinedProperties () const
	Returns a reference to the object's property collection, used for data defined overrides. More...

virtual QgsMapLayerElevationProperties::Flags	flags () const
	Returns flags associated to the elevation properties. More...

virtual bool	hasElevation () const
	Returns `true` if the layer has an elevation or z component. More...

virtual QString	htmlSummary () const
	Returns a HTML formatted summary of the properties. More...

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. More...

virtual bool	readXml (const QDomElement &element, const QgsReadWriteContext &context)=0
	Reads the elevation properties from a DOM element previously written by writeXml(). More...

void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the object's property collection, used for data defined overrides. More...

virtual void	setDefaultsFromLayer (QgsMapLayer *layer)
	Sets default properties based on sensible choices for the given map layer. More...

void	setZOffset (double offset)
	Sets the z offset, which is a fixed offset amount which will be added to z values from the layer. More...

void	setZScale (double scale)
	Sets the z scale, which is a scaling factor which will be applied to z values from the layer. More...

virtual bool	showByDefaultInElevationProfilePlots () const
	Returns `true` if the layer should be visible by default in newly created elevation profile plots. More...

virtual QDomElement	writeXml (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context)=0
	Writes the properties to a DOM element, to be used later with readXml(). More...

double	zOffset () const
	Returns the z offset, which is a fixed offset amount which should be added to z values from the layer. More...

double	zScale () const
	Returns the z scale, which is a scaling factor which should be applied to z values from the layer. More...

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. More...

void	profileGenerationPropertyChanged ()
	Emitted when any of the elevation properties which relate solely to generation of elevation profiles have changed. More...

void	profileRenderingPropertyChanged ()
	Emitted when any of the elevation properties which relate solely to presentation of elevation results have changed. More...

void	zOffsetChanged ()
	Emitted when the z offset changes. More...

void	zScaleChanged ()
	Emitted when the z scale changes. More...

Static Public Member Functions inherited from QgsMapLayerElevationProperties
static QgsPropertiesDefinition	propertyDefinitions ()
	Returns the definitions for data defined properties available for use in elevation properties. More...

Protected Member Functions inherited from QgsMapLayerElevationProperties
void	copyCommonProperties (const QgsMapLayerElevationProperties *other)
	Copies common properties from another object. More...

void	readCommonProperties (const QDomElement &element, const QgsReadWriteContext &context)
	Reads common class properties from a DOM element previously written by writeXml(). More...

void	writeCommonProperties (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context)
	Writes common class properties to a DOM element, to be used later with readXml(). More...

Protected Attributes inherited from QgsMapLayerElevationProperties
QgsPropertyCollection	mDataDefinedProperties
	Property collection for data defined elevation settings. More...

double	mZOffset = 0.0
	Z offset. More...

double	mZScale = 1.0
	Z scale. More...

Static Protected Attributes inherited from QgsMapLayerElevationProperties
static QgsPropertiesDefinition	sPropertyDefinitions
	Property definitions. More...

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.

◆ 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:

/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/tiledscene/qgstiledscenelayerelevationproperties.h
/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/tiledscene/qgstiledscenelayerelevationproperties.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsTiledSceneLayerElevationProperties()

Member Function Documentation

◆ calculateZRange()

◆ clone()

◆ hasElevation()

◆ htmlSummary()

◆ readXml()

◆ writeXml()