QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | List of all members
QgsPointCloudLayerElevationProperties Class Reference

Point cloud layer specific subclass of QgsMapLayerElevationProperties. More...

#include <qgspointcloudlayerelevationproperties.h>

Inheritance diagram for QgsPointCloudLayerElevationProperties:
Inheritance graph
[legend]

Public Member Functions

 QgsPointCloudLayerElevationProperties (QObject *parent)
 Constructor for QgsPointCloudLayerElevationProperties, 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...
 
bool hasElevation () const override
 Returns true if the layer has an elevation or z component. More...
 
bool isVisibleInZRange (const QgsDoubleRange &range) const override
 Returns true if the layer should be visible and rendered for the specified z range. More...
 
bool readXml (const QDomElement &element, const QgsReadWriteContext &context) override
 Reads the elevation properties from a DOM element previously written by writeXml(). 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...
 
QDomElement writeXml (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override
 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...
 
- Public Member Functions inherited from QgsMapLayerElevationProperties
 QgsMapLayerElevationProperties (QObject *parent)
 Constructor for QgsMapLayerElevationProperties, with the specified parent object. More...
 
virtual QgsMapLayerElevationProperties::Flags flags () const
 Returns flags associated to the elevation properties. More...
 

Additional Inherited Members

- Public Types inherited from QgsMapLayerElevationProperties
enum  Flag { FlagDontInvalidateCachedRendersWhenRangeChanges = 1 }
 Flags attached to the elevation property. More...
 
- Signals inherited from QgsMapLayerElevationProperties
void changed ()
 Emitted when the elevation properties have changed. More...
 

Detailed Description

Point cloud layer specific subclass of QgsMapLayerElevationProperties.

Since
QGIS 3.18

Definition at line 33 of file qgspointcloudlayerelevationproperties.h.

Constructor & Destructor Documentation

◆ QgsPointCloudLayerElevationProperties()

QgsPointCloudLayerElevationProperties::QgsPointCloudLayerElevationProperties ( QObject *  parent)

Constructor for QgsPointCloudLayerElevationProperties, with the specified parent object.

Definition at line 21 of file qgspointcloudlayerelevationproperties.cpp.

Member Function Documentation

◆ calculateZRange()

QgsDoubleRange QgsPointCloudLayerElevationProperties::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 54 of file qgspointcloudlayerelevationproperties.cpp.

◆ hasElevation()

bool QgsPointCloudLayerElevationProperties::hasElevation ( ) const
overridevirtual

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

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 26 of file qgspointcloudlayerelevationproperties.cpp.

◆ isVisibleInZRange()

bool QgsPointCloudLayerElevationProperties::isVisibleInZRange ( const QgsDoubleRange range) const
overridevirtual

Returns true if the layer should be visible and rendered for the specified z range.

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 48 of file qgspointcloudlayerelevationproperties.cpp.

◆ readXml()

bool QgsPointCloudLayerElevationProperties::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 qgspointcloudlayerelevationproperties.cpp.

◆ setZOffset()

void QgsPointCloudLayerElevationProperties::setZOffset ( double  offset)
inline

Sets the z offset, which is a fixed offset amount which will be added to z values from the layer.

This can be used to correct or manually adjust for incorrect elevation values in a point cloud layer.

Note
Any scaling specified via zScale() is applied before any offset value specified via zOffset()
See also
zOffset()

Definition at line 73 of file qgspointcloudlayerelevationproperties.h.

◆ setZScale()

void QgsPointCloudLayerElevationProperties::setZScale ( double  scale)
inline

Sets the z scale, which is a scaling factor which will be applied to z values from the layer.

This can be used to correct or manually adjust for incorrect elevation values in a point cloud layer, such as conversion of elevation values in feet to meters.

Note
Any scaling specified via zScale() is applied before any offset value specified via zOffset()
See also
zScale()

Definition at line 99 of file qgspointcloudlayerelevationproperties.h.

◆ writeXml()

QDomElement QgsPointCloudLayerElevationProperties::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 qgspointcloudlayerelevationproperties.cpp.

◆ zOffset()

double QgsPointCloudLayerElevationProperties::zOffset ( ) const
inline

Returns the z offset, which is a fixed offset amount which should be added to z values from the layer.

This can be used to correct or manually adjust for incorrect elevation values in a point cloud layer.

Note
Any scaling specified via zScale() is applied before any offset value specified via zOffset()
See also
setZOffset()

Definition at line 61 of file qgspointcloudlayerelevationproperties.h.

◆ zScale()

double QgsPointCloudLayerElevationProperties::zScale ( ) const
inline

Returns the z scale, which is a scaling factor which should be applied to z values from the layer.

This can be used to correct or manually adjust for incorrect elevation values in a point cloud layer, such as conversion of elevation values in feet to meters.

Note
Any scaling specified via zScale() is applied before any offset value specified via zOffset()
See also
setZScale()

Definition at line 86 of file qgspointcloudlayerelevationproperties.h.


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