QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
Point cloud layer specific subclass of QgsMapLayerElevationProperties. More...
#include <qgspointcloudlayerelevationproperties.h>
Public Member Functions | |
QgsPointCloudLayerElevationProperties (QObject *parent) | |
Constructor for QgsPointCloudLayerElevationProperties, with the specified parent object. | |
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. | |
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. | |
QgsPointCloudLayerElevationProperties * | clone () const override |
Creates a clone of the properties. | |
bool | hasElevation () const override |
Returns true if the layer has an elevation or z component. | |
QString | htmlSummary () const override |
Returns a HTML formatted summary of the properties. | |
bool | isVisibleInZRange (const QgsDoubleRange &range, QgsMapLayer *layer=nullptr) const override |
Returns true if the layer should be visible and rendered for the specified z range. | |
double | maximumScreenError () const |
Returns the maximum screen error allowed when generating elevation profiles for the point cloud. | |
Qgis::RenderUnit | maximumScreenErrorUnit () const |
Returns the unit for the maximum screen error allowed when generating elevation profiles for the point cloud. | |
QColor | pointColor () const |
Returns the color used drawing points in elevation profile charts. | |
double | pointSize () const |
Returns the point size used for drawing points in elevation profile charts. | |
Qgis::RenderUnit | pointSizeUnit () const |
Returns the units used for the point size used for drawing points in elevation profile charts. | |
Qgis::PointCloudSymbol | pointSymbol () const |
Returns the symbol used drawing points in elevation profile charts. | |
bool | readXml (const QDomElement &element, const QgsReadWriteContext &context) override |
Reads the elevation properties from a DOM element previously written by writeXml(). | |
bool | respectLayerColors () const |
Returns true if layer coloring should be respected when rendering elevation profile plots. | |
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. | |
void | setMaximumScreenError (double error) |
Sets the maximum screen error allowed when generating elevation profiles for the point cloud. | |
void | setMaximumScreenErrorUnit (Qgis::RenderUnit unit) |
Sets the unit for the maximum screen error allowed when generating elevation profiles for the point cloud. | |
void | setPointColor (const QColor &color) |
Sets the color used drawing points in elevation profile charts. | |
void | setPointSize (double size) |
Sets the point size used for drawing points in elevation profile charts. | |
void | setPointSizeUnit (const Qgis::RenderUnit units) |
Sets the units used for the point size used for drawing points in elevation profile charts. | |
void | setPointSymbol (Qgis::PointCloudSymbol symbol) |
Sets the symbol used drawing points in elevation profile charts. | |
void | setRespectLayerColors (bool enabled) |
Sets whether layer coloring should be respected when rendering elevation profile plots. | |
bool | showByDefaultInElevationProfilePlots () const override |
Returns true if the layer should be visible by default in newly created elevation profile plots. | |
QList< double > | significantZValues (QgsMapLayer *layer) const override |
Returns a list of significant elevation/z-values for the specified layer, using the settings defined by this elevation properties object. | |
QDomElement | writeXml (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override |
Writes the properties to a DOM element, to be used later with readXml(). | |
Public Member Functions inherited from QgsMapLayerElevationProperties | |
QgsMapLayerElevationProperties (QObject *parent) | |
Constructor for QgsMapLayerElevationProperties, with the specified parent object. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. | |
virtual QgsMapLayerElevationProperties::Flags | flags () const |
Returns flags associated to the elevation properties. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the object's property collection, used for data defined overrides. | |
virtual void | setDefaultsFromLayer (QgsMapLayer *layer) |
Sets default properties based on sensible choices for the given map layer. | |
void | setZOffset (double offset) |
Sets the z offset, which is a fixed offset amount which will be added to z values from the layer. | |
void | setZScale (double scale) |
Sets the z scale, which is a scaling factor which will be applied to z values from the layer. | |
double | zOffset () const |
Returns the z offset, which is a fixed offset amount which should be added to z values from the layer. | |
double | zScale () const |
Returns the z scale, which is a scaling factor which should be applied to z values from the layer. | |
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. | |
void | profileGenerationPropertyChanged () |
Emitted when any of the elevation properties which relate solely to generation of elevation profiles have changed. | |
void | profileRenderingPropertyChanged () |
Emitted when any of the elevation properties which relate solely to presentation of elevation results have changed. | |
void | zOffsetChanged () |
Emitted when the z offset changes. | |
void | zScaleChanged () |
Emitted when the z scale changes. | |
Static Public Member Functions inherited from QgsMapLayerElevationProperties | |
static QgsPropertiesDefinition | propertyDefinitions () |
Returns the definitions for data defined properties available for use in elevation properties. | |
Protected Member Functions inherited from QgsMapLayerElevationProperties | |
void | copyCommonProperties (const QgsMapLayerElevationProperties *other) |
Copies common properties from another object. | |
void | readCommonProperties (const QDomElement &element, const QgsReadWriteContext &context) |
Reads common class properties from a DOM element previously written by writeXml(). | |
void | writeCommonProperties (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) |
Writes common class properties to a DOM element, to be used later with readXml(). | |
Protected Attributes inherited from QgsMapLayerElevationProperties | |
QgsPropertyCollection | mDataDefinedProperties |
Property collection for data defined elevation settings. | |
double | mZOffset = 0.0 |
Z offset. | |
double | mZScale = 1.0 |
Z scale. | |
Static Protected Attributes inherited from QgsMapLayerElevationProperties | |
static QgsPropertiesDefinition | sPropertyDefinitions |
Property definitions. | |
Point cloud layer specific subclass of QgsMapLayerElevationProperties.
Definition at line 34 of file qgspointcloudlayerelevationproperties.h.
QgsPointCloudLayerElevationProperties::QgsPointCloudLayerElevationProperties | ( | QObject * | parent | ) |
Constructor for QgsPointCloudLayerElevationProperties, with the specified parent object.
Definition at line 25 of file qgspointcloudlayerelevationproperties.cpp.
|
inline |
Returns true
if a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.
Definition at line 143 of file qgspointcloudlayerelevationproperties.h.
|
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 124 of file qgspointcloudlayerelevationproperties.cpp.
|
overridevirtual |
Creates a clone of the properties.
Implements QgsMapLayerElevationProperties.
Definition at line 93 of file qgspointcloudlayerelevationproperties.cpp.
|
overridevirtual |
Returns true
if the layer has an elevation or z component.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 40 of file qgspointcloudlayerelevationproperties.cpp.
|
overridevirtual |
Returns a HTML formatted summary of the properties.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 110 of file qgspointcloudlayerelevationproperties.cpp.
|
overridevirtual |
Returns true
if the layer should be visible and rendered for the specified z range.
Since QGIS 3.38 the layer argument can be used to specify the target layer.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 118 of file qgspointcloudlayerelevationproperties.cpp.
|
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().
Definition at line 68 of file qgspointcloudlayerelevationproperties.h.
|
inline |
Returns the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.
Definition at line 92 of file qgspointcloudlayerelevationproperties.h.
|
inline |
Returns the color used drawing points in elevation profile charts.
Definition at line 126 of file qgspointcloudlayerelevationproperties.h.
|
inline |
Returns the point size used for drawing points in elevation profile charts.
The point size units are retrieved by calling pointSizeUnit().
Definition at line 175 of file qgspointcloudlayerelevationproperties.h.
|
inline |
Returns the units used for the point size used for drawing points in elevation profile charts.
Definition at line 194 of file qgspointcloudlayerelevationproperties.h.
Qgis::PointCloudSymbol QgsPointCloudLayerElevationProperties::pointSymbol | ( | ) | const |
Returns the symbol used drawing points in elevation profile charts.
Definition at line 181 of file qgspointcloudlayerelevationproperties.cpp.
|
overridevirtual |
Reads the elevation properties from a DOM element previously written by writeXml().
Implements QgsMapLayerElevationProperties.
Definition at line 63 of file qgspointcloudlayerelevationproperties.cpp.
|
inline |
Returns true
if layer coloring should be respected when rendering elevation profile plots.
Definition at line 201 of file qgspointcloudlayerelevationproperties.h.
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.
Definition at line 206 of file qgspointcloudlayerelevationproperties.cpp.
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().
Definition at line 161 of file qgspointcloudlayerelevationproperties.cpp.
void QgsPointCloudLayerElevationProperties::setMaximumScreenErrorUnit | ( | Qgis::RenderUnit | unit | ) |
Sets the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.
Definition at line 171 of file qgspointcloudlayerelevationproperties.cpp.
void QgsPointCloudLayerElevationProperties::setPointColor | ( | const QColor & | color | ) |
Sets the color used drawing points in elevation profile charts.
Definition at line 196 of file qgspointcloudlayerelevationproperties.cpp.
void QgsPointCloudLayerElevationProperties::setPointSize | ( | double | size | ) |
Sets the point size used for drawing points in elevation profile charts.
Point size units are specified via setPointSizeUnit().
Definition at line 221 of file qgspointcloudlayerelevationproperties.cpp.
void QgsPointCloudLayerElevationProperties::setPointSizeUnit | ( | const Qgis::RenderUnit | units | ) |
Sets the units used for the point size used for drawing points in elevation profile charts.
Definition at line 231 of file qgspointcloudlayerelevationproperties.cpp.
void QgsPointCloudLayerElevationProperties::setPointSymbol | ( | Qgis::PointCloudSymbol | symbol | ) |
Sets the symbol used drawing points in elevation profile charts.
Definition at line 186 of file qgspointcloudlayerelevationproperties.cpp.
void QgsPointCloudLayerElevationProperties::setRespectLayerColors | ( | bool | enabled | ) |
Sets whether layer coloring should be respected when rendering elevation profile plots.
Definition at line 241 of file qgspointcloudlayerelevationproperties.cpp.
|
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.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 156 of file qgspointcloudlayerelevationproperties.cpp.
|
overridevirtual |
Returns a list of significant elevation/z-values for the specified layer, using the settings defined by this elevation properties object.
These values will be highlighted in elevation related widgets for the layer.
Reimplemented from QgsMapLayerElevationProperties.
Definition at line 145 of file qgspointcloudlayerelevationproperties.cpp.
|
overridevirtual |
Writes the properties to a DOM element, to be used later with readXml().
Implements QgsMapLayerElevationProperties.
Definition at line 45 of file qgspointcloudlayerelevationproperties.cpp.