QGIS API Documentation 3.37.0-Master (684a802617f)
Loading...
Searching...
No Matches
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 setElevationFilterRangeSize (double size)
 Sets the fixed size for elevation range filtering in the project, used when interactively filtering by elevation.
 
void setElevationRange (const QgsDoubleRange &range)
 Sets the project's elevation range, which indicates the upper and lower elevation limits associated with the project.
 
void setInvertElevationFilter (bool invert)
 Sets whether the elevation range filter slider should be inverted for this project.
 

Signals

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

Public Member Functions

 QgsProjectElevationProperties (QObject *parent=nullptr)
 Constructor for QgsProjectElevationProperties with the specified parent object.
 
 ~QgsProjectElevationProperties () override
 
double elevationFilterRangeSize () const
 Returns the fixed size for elevation range filtering in the project, used when interactively filtering by elevation.
 
QgsDoubleRange elevationRange () const
 Returns the project's elevation range, which indicates the upper and lower elevation limits associated with the project.
 
bool invertElevationFilter () const
 Returns true if the elevation range filter slider should be inverted for this project.
 
bool readXml (const QDomElement &element, const QgsReadWriteContext &context)
 Reads the property state from a DOM element.
 
void reset ()
 Resets the properties to a default state.
 
void resolveReferences (const QgsProject *project)
 Resolves reference to layers from stored layer ID.
 
void setTerrainProvider (QgsAbstractTerrainProvider *provider)
 Sets the project's terrain provider.
 
QgsAbstractTerrainProviderterrainProvider ()
 Returns the project's terrain provider.
 
QDomElement writeXml (QDomDocument &document, const QgsReadWriteContext &context) const
 Returns a DOM element representing the properties.
 

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.

◆ elevationFilterRangeSize()

double QgsProjectElevationProperties::elevationFilterRangeSize ( ) const
inline

Returns the fixed size for elevation range filtering in the project, used when interactively filtering by elevation.

Returns -1 if no fixed elevation range size is desired.

A fixed size forces the selected elevation range to have a matching difference between the upper and lower elevation.

See also
setElevationFilterRangeSize()
Since
QGIS 3.38

Definition at line 115 of file qgsprojectelevationproperties.h.

◆ 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

◆ invertElevationFilter()

bool QgsProjectElevationProperties::invertElevationFilter ( ) const
inline

Returns true if the elevation range filter slider should be inverted for this project.

See also
setInvertElevationFilter()
Since
QGIS 3.38

Definition at line 124 of file qgsprojectelevationproperties.h.

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

◆ setElevationFilterRangeSize

void QgsProjectElevationProperties::setElevationFilterRangeSize ( double  size)
slot

Sets the fixed size for elevation range filtering in the project, used when interactively filtering by elevation.

Set to -1 if no fixed elevation range size is desired.

A fixed size forces the selected elevation range to have a matching difference between the upper and lower elevation.

See also
elevationFilterRangeSize()
Since
QGIS 3.38

Definition at line 133 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 151 of file qgsprojectelevationproperties.cpp.

◆ setInvertElevationFilter

void QgsProjectElevationProperties::setInvertElevationFilter ( bool  invert)
slot

Sets whether the elevation range filter slider should be inverted for this project.

See also
invertElevationFilter()
Since
QGIS 3.38

Definition at line 142 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 121 of file qgsprojectelevationproperties.cpp.

◆ terrainProvider()

QgsAbstractTerrainProvider * QgsProjectElevationProperties::terrainProvider ( )

Returns the project's terrain provider.

See also
setTerrainProvider()

Definition at line 116 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 90 of file qgsprojectelevationproperties.cpp.


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