QGIS API Documentation 3.27.0-Master (9c08adf5ef)
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...
 
bool applyOpacityByDistanceEffect () const
 Returns true if a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts. 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...
 
QgsPointCloudLayerElevationPropertiesclone () 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 isVisibleInZRange (const QgsDoubleRange &range) const override
 Returns true if the layer should be visible and rendered for the specified z range. More...
 
double maximumScreenError () const
 Returns the maximum screen error allowed when generating elevation profiles for the point cloud. More...
 
QgsUnitTypes::RenderUnit maximumScreenErrorUnit () const
 Returns the unit for the maximum screen error allowed when generating elevation profiles for the point cloud. More...
 
QColor pointColor () const
 Returns the color used drawing points in elevation profile charts. More...
 
double pointSize () const
 Returns the point size used for drawing points in elevation profile charts. More...
 
QgsUnitTypes::RenderUnit pointSizeUnit () const
 Returns the units used for the point size used for drawing points in elevation profile charts. More...
 
Qgis::PointCloudSymbol pointSymbol () const
 Returns the symbol used drawing points in elevation profile charts. More...
 
bool readXml (const QDomElement &element, const QgsReadWriteContext &context) override
 Reads the elevation properties from a DOM element previously written by writeXml(). More...
 
bool respectLayerColors () const
 Returns true if layer coloring should be respected when rendering elevation profile plots. More...
 
void setApplyOpacityByDistanceEffect (bool apply)
 Sets whether a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts. More...
 
void setMaximumScreenError (double error)
 Sets the maximum screen error allowed when generating elevation profiles for the point cloud. More...
 
void setMaximumScreenErrorUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit for the maximum screen error allowed when generating elevation profiles for the point cloud. More...
 
void setPointColor (const QColor &color)
 Sets the color used drawing points in elevation profile charts. More...
 
void setPointSize (double size)
 Sets the point size used for drawing points in elevation profile charts. More...
 
void setPointSizeUnit (const QgsUnitTypes::RenderUnit units)
 Sets the units used for the point size used for drawing points in elevation profile charts. More...
 
void setPointSymbol (Qgis::PointCloudSymbol symbol)
 Sets the symbol used drawing points in elevation profile charts. More...
 
void setRespectLayerColors (bool enabled)
 Sets whether layer coloring should be respected when rendering elevation profile plots. More...
 
bool showByDefaultInElevationProfilePlots () const override
 Returns true if the layer should be visible by default in newly created elevation profile plots. 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 QgsMapLayerElevationPropertiesclone () const =0
 Creates a clone of the properties. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () 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) 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...
 
enum  Property { ZOffset , ExtrusionHeight }
 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

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 24 of file qgspointcloudlayerelevationproperties.cpp.

Member Function Documentation

◆ applyOpacityByDistanceEffect()

bool QgsPointCloudLayerElevationProperties::applyOpacityByDistanceEffect ( ) const
inline

Returns true if a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.

See also
setApplyOpacityByDistanceEffect()
Since
QGIS 3.26

Definition at line 141 of file qgspointcloudlayerelevationproperties.h.

◆ 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 123 of file qgspointcloudlayerelevationproperties.cpp.

◆ clone()

QgsPointCloudLayerElevationProperties * QgsPointCloudLayerElevationProperties::clone ( ) const
overridevirtual

Creates a clone of the properties.

Since
QGIS 3.26

Implements QgsMapLayerElevationProperties.

Definition at line 92 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 39 of file qgspointcloudlayerelevationproperties.cpp.

◆ htmlSummary()

QString QgsPointCloudLayerElevationProperties::htmlSummary ( ) const
overridevirtual

Returns a HTML formatted summary of the properties.

Since
QGIS 3.26

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 109 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 117 of file qgspointcloudlayerelevationproperties.cpp.

◆ maximumScreenError()

double QgsPointCloudLayerElevationProperties::maximumScreenError ( ) const
inline

Returns the maximum screen error allowed when generating elevation profiles for the point cloud.

Larger values result in a faster generation with less points included.

Units are retrieved via maximumScreenErrorUnit().

See also
setMaximumScreenError()
maximumScreenErrorUnit()
Since
QGIS 3.26

Definition at line 66 of file qgspointcloudlayerelevationproperties.h.

◆ maximumScreenErrorUnit()

QgsUnitTypes::RenderUnit QgsPointCloudLayerElevationProperties::maximumScreenErrorUnit ( ) const
inline

Returns the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.

See also
maximumScreenError()
setMaximumScreenErrorUnit()
Since
QGIS 3.26

Definition at line 90 of file qgspointcloudlayerelevationproperties.h.

◆ pointColor()

QColor QgsPointCloudLayerElevationProperties::pointColor ( ) const
inline

Returns the color used drawing points in elevation profile charts.

See also
setPointColor()
Since
QGIS 3.26

Definition at line 124 of file qgspointcloudlayerelevationproperties.h.

◆ pointSize()

double QgsPointCloudLayerElevationProperties::pointSize ( ) const
inline

Returns the point size used for drawing points in elevation profile charts.

The point size units are retrieved by calling pointSizeUnit().

See also
setPointSize()
pointSizeUnit()
Since
QGIS 3.26

Definition at line 173 of file qgspointcloudlayerelevationproperties.h.

◆ pointSizeUnit()

QgsUnitTypes::RenderUnit QgsPointCloudLayerElevationProperties::pointSizeUnit ( ) const
inline

Returns the units used for the point size used for drawing points in elevation profile charts.

See also
setPointSizeUnit()
pointSize()
Since
QGIS 3.26

Definition at line 192 of file qgspointcloudlayerelevationproperties.h.

◆ pointSymbol()

Qgis::PointCloudSymbol QgsPointCloudLayerElevationProperties::pointSymbol ( ) const

Returns the symbol used drawing points in elevation profile charts.

See also
setPointSymbol()
Since
QGIS 3.26

Definition at line 169 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 62 of file qgspointcloudlayerelevationproperties.cpp.

◆ respectLayerColors()

bool QgsPointCloudLayerElevationProperties::respectLayerColors ( ) const
inline

Returns true if layer coloring should be respected when rendering elevation profile plots.

See also
setRespectLayerColors()

Definition at line 199 of file qgspointcloudlayerelevationproperties.h.

◆ setApplyOpacityByDistanceEffect()

void QgsPointCloudLayerElevationProperties::setApplyOpacityByDistanceEffect ( bool  apply)

Sets whether a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.

See also
applyOpacityByDistanceEffect()
Since
QGIS 3.26

Definition at line 194 of file qgspointcloudlayerelevationproperties.cpp.

◆ setMaximumScreenError()

void QgsPointCloudLayerElevationProperties::setMaximumScreenError ( double  error)

Sets the maximum screen error allowed when generating elevation profiles for the point cloud.

Larger values result in a faster generation with less points included.

Units are set via setMaximumScreenErrorUnit().

See also
maximumScreenError()
setMaximumScreenErrorUnit()
Since
QGIS 3.26

Definition at line 149 of file qgspointcloudlayerelevationproperties.cpp.

◆ setMaximumScreenErrorUnit()

void QgsPointCloudLayerElevationProperties::setMaximumScreenErrorUnit ( QgsUnitTypes::RenderUnit  unit)

Sets the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.

See also
setMaximumScreenError()
maximumScreenErrorUnit()
Since
QGIS 3.26

Definition at line 159 of file qgspointcloudlayerelevationproperties.cpp.

◆ setPointColor()

void QgsPointCloudLayerElevationProperties::setPointColor ( const QColor &  color)

Sets the color used drawing points in elevation profile charts.

See also
pointColor()
Since
QGIS 3.26

Definition at line 184 of file qgspointcloudlayerelevationproperties.cpp.

◆ setPointSize()

void QgsPointCloudLayerElevationProperties::setPointSize ( double  size)

Sets the point size used for drawing points in elevation profile charts.

Point size units are specified via setPointSizeUnit().

See also
pointSize()
setPointSizeUnit()
Since
QGIS 3.26

Definition at line 209 of file qgspointcloudlayerelevationproperties.cpp.

◆ setPointSizeUnit()

void QgsPointCloudLayerElevationProperties::setPointSizeUnit ( const QgsUnitTypes::RenderUnit  units)

Sets the units used for the point size used for drawing points in elevation profile charts.

See also
setPointSize()
pointSizeUnit()
Since
QGIS 3.26

Definition at line 219 of file qgspointcloudlayerelevationproperties.cpp.

◆ setPointSymbol()

void QgsPointCloudLayerElevationProperties::setPointSymbol ( Qgis::PointCloudSymbol  symbol)

Sets the symbol used drawing points in elevation profile charts.

See also
pointSymbol()
Since
QGIS 3.26

Definition at line 174 of file qgspointcloudlayerelevationproperties.cpp.

◆ setRespectLayerColors()

void QgsPointCloudLayerElevationProperties::setRespectLayerColors ( bool  enabled)

Sets whether layer coloring should be respected when rendering elevation profile plots.

See also
respectLayerColors()

Definition at line 229 of file qgspointcloudlayerelevationproperties.cpp.

◆ showByDefaultInElevationProfilePlots()

bool QgsPointCloudLayerElevationProperties::showByDefaultInElevationProfilePlots ( ) const
overridevirtual

Returns true if the layer should be visible by default in newly created elevation profile plots.

Subclasses should override this with logic which determines whether the layer is likely desirable to be initially checked in these plots.

Since
QGIS 3.26

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 144 of file qgspointcloudlayerelevationproperties.cpp.

◆ 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 44 of file qgspointcloudlayerelevationproperties.cpp.


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