QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Slots | Signals | Public Member Functions | List of all members
QgsProjectElevationProperties Class Reference

Contains elevation properties for a QgsProject. More...

#include <qgsprojectelevationproperties.h>

Inheritance diagram for QgsProjectElevationProperties:
Inheritance graph
[legend]

Public Slots

void setElevationRange (const QgsDoubleRange &range)
 Sets the project's elevation range, which indicates the upper and lower elevation limits associated with the project. More...
 

Signals

void changed ()
 Emitted when the elevation properties change. More...
 
void elevationRangeChanged (const QgsDoubleRange &range)
 Emitted when the project's elevation is changed. More...
 

Public Member Functions

 QgsProjectElevationProperties (QObject *parent=nullptr)
 Constructor for QgsProjectElevationProperties with the specified parent object. More...
 
 ~QgsProjectElevationProperties () override
 
QgsDoubleRange elevationRange () const
 Returns the project's elevation range, which indicates the upper and lower elevation limits associated with the project. More...
 
bool readXml (const QDomElement &element, const QgsReadWriteContext &context)
 Reads the property state from a DOM element. More...
 
void reset ()
 Resets the properties to a default state. More...
 
void resolveReferences (const QgsProject *project)
 Resolves reference to layers from stored layer ID. More...
 
void setTerrainProvider (QgsAbstractTerrainProvider *provider)
 Sets the project's terrain provider. More...
 
QgsAbstractTerrainProviderterrainProvider ()
 Returns the project's terrain provider. More...
 
QDomElement writeXml (QDomDocument &document, const QgsReadWriteContext &context) const
 Returns a DOM element representing the properties. More...
 

Detailed Description

Contains elevation properties for a QgsProject.

Since
QGIS 3.26

Definition at line 38 of file qgsprojectelevationproperties.h.

Constructor & Destructor Documentation

◆ QgsProjectElevationProperties()

QgsProjectElevationProperties::QgsProjectElevationProperties ( QObject *  parent = nullptr)

Constructor for QgsProjectElevationProperties with the specified parent object.

Definition at line 23 of file qgsprojectelevationproperties.cpp.

◆ ~QgsProjectElevationProperties()

QgsProjectElevationProperties::~QgsProjectElevationProperties ( )
overridedefault

Member Function Documentation

◆ changed

void QgsProjectElevationProperties::changed ( )
signal

Emitted when the elevation properties change.

◆ elevationRange()

QgsDoubleRange QgsProjectElevationProperties::elevationRange ( ) const
inline

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.
See also
setElevationRange()
elevationRangeChanged()
Since
QGIS 3.38

Definition at line 101 of file qgsprojectelevationproperties.h.

◆ elevationRangeChanged

void QgsProjectElevationProperties::elevationRangeChanged ( const QgsDoubleRange range)
signal

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.
See also
elevationRange()
setElevationRange()
Since
QGIS 3.38

◆ readXml()

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

Reads the property state from a DOM element.

See also
writeXml()

Definition at line 46 of file qgsprojectelevationproperties.cpp.

◆ reset()

void QgsProjectElevationProperties::reset ( )

Resets the properties to a default state.

Definition at line 32 of file qgsprojectelevationproperties.cpp.

◆ resolveReferences()

void QgsProjectElevationProperties::resolveReferences ( const QgsProject project)

Resolves reference to layers from stored layer ID.

Definition at line 40 of file qgsprojectelevationproperties.cpp.

◆ setElevationRange

void QgsProjectElevationProperties::setElevationRange ( const QgsDoubleRange range)
slot

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.
See also
elevationRange()
elevationRangeChanged()
Since
QGIS 3.38

Definition at line 118 of file qgsprojectelevationproperties.cpp.

◆ setTerrainProvider()

void QgsProjectElevationProperties::setTerrainProvider ( QgsAbstractTerrainProvider provider)

Sets the project's terrain provider.

Ownership of provider is transferred to this object.

See also
terrainProvider()

Definition at line 109 of file qgsprojectelevationproperties.cpp.

◆ terrainProvider()

QgsAbstractTerrainProvider * QgsProjectElevationProperties::terrainProvider ( )

Returns the project's terrain provider.

See also
setTerrainProvider()

Definition at line 104 of file qgsprojectelevationproperties.cpp.

◆ writeXml()

QDomElement QgsProjectElevationProperties::writeXml ( QDomDocument &  document,
const QgsReadWriteContext context 
) const

Returns a DOM element representing the properties.

See also
readXml()

Definition at line 84 of file qgsprojectelevationproperties.cpp.


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