QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Abstract base class for 2d point cloud renderers. More...
#include <qgspointcloudrenderer.h>
Public Member Functions | |
QgsPointCloudRenderer ()=default | |
QgsPointCloudRenderer (const QgsPointCloudRenderer &other)=delete | |
QgsPointCloudRenderer cannot be copied – use clone() instead. | |
virtual | ~QgsPointCloudRenderer ()=default |
virtual void | checkLegendItem (const QString &key, bool state=true) |
Called when the check state of the legend item with the specified key is changed. | |
virtual QgsPointCloudRenderer * | clone () const =0 |
Create a deep copy of this renderer. | |
virtual QList< QgsLayerTreeModelLegendNode * > | createLegendNodes (QgsLayerTreeLayer *nodeLayer) |
Creates a set of legend nodes representing the renderer. | |
Qgis::PointCloudDrawOrder | drawOrder2d () const |
Returns the drawing order used by the renderer for drawing points. | |
bool | horizontalTriangleFilter () const |
Returns whether large triangles will get rendered. | |
double | horizontalTriangleFilterThreshold () const |
Returns threshold for filtering of triangles. | |
Qgis::RenderUnit | horizontalTriangleFilterUnit () const |
Returns units of the threshold for filtering of triangles. | |
QVector< QVariantMap > | identify (QgsPointCloudLayer *layer, const QgsRenderContext &context, const QgsGeometry &geometry, double toleranceForPointIdentification=0) |
Returns the list of visible points of the point cloud layer layer and an extent defined by a geometry in the 2D plane geometry. | |
virtual bool | legendItemChecked (const QString &key) |
Returns true if the legend item with the specified key is checked. | |
virtual QStringList | legendRuleKeys () const |
Returns a list of all rule keys for legend nodes created by the renderer. | |
double | maximumScreenError () const |
Returns the maximum screen error allowed when rendering the point cloud. | |
Qgis::RenderUnit | maximumScreenErrorUnit () const |
Returns the unit for the maximum screen error allowed when rendering the point cloud. | |
QgsPointCloudRenderer & | operator= (const QgsPointCloudRenderer &other)=delete |
QgsPointCloudRenderer cannot be copied – use clone() instead. | |
double | pointSize () const |
Returns the point size. | |
const QgsMapUnitScale & | pointSizeMapUnitScale () const |
Returns the map unit scale used for the point size. | |
Qgis::RenderUnit | pointSizeUnit () const |
Returns the units used for the point size. | |
Qgis::PointCloudSymbol | pointSymbol () const |
Returns the symbol used by the renderer for drawing points. | |
virtual std::unique_ptr< QgsPreparedPointCloudRendererData > | prepare () |
Returns prepared data container for bulk point color retrieval. | |
bool | renderAsTriangles () const |
Returns whether points are triangulated to render solid surface. | |
virtual void | renderBlock (const QgsPointCloudBlock *block, QgsPointCloudRenderContext &context)=0 |
Renders a block of point cloud data using the specified render context. | |
virtual QDomElement | save (QDomDocument &doc, const QgsReadWriteContext &context) const =0 |
Saves the renderer configuration to an XML element. | |
void | setDrawOrder2d (Qgis::PointCloudDrawOrder order) |
Sets the drawing order used by the renderer for drawing points. | |
void | setHorizontalTriangleFilter (bool enabled) |
Sets whether large triangles will get rendered. | |
void | setHorizontalTriangleFilterThreshold (double threshold) |
Sets threshold for filtering of triangles. | |
void | setHorizontalTriangleFilterUnit (Qgis::RenderUnit unit) |
Sets units of the threshold for filtering of triangles. | |
void | setMaximumScreenError (double error) |
Sets the maximum screen error allowed when rendering the point cloud. | |
void | setMaximumScreenErrorUnit (Qgis::RenderUnit unit) |
Sets the unit for the maximum screen error allowed when rendering the point cloud. | |
void | setPointSize (double size) |
Sets the point size. | |
void | setPointSizeMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale used for the point size. | |
void | setPointSizeUnit (const Qgis::RenderUnit units) |
Sets the units used for the point size. | |
void | setPointSymbol (Qgis::PointCloudSymbol symbol) |
Sets the symbol used by the renderer for drawing points. | |
void | setRenderAsTriangles (bool asTriangles) |
Sets whether points are triangulated to render solid surface. | |
virtual void | startRender (QgsPointCloudRenderContext &context) |
Must be called when a new render cycle is started. | |
virtual void | stopRender (QgsPointCloudRenderContext &context) |
Must be called when a render cycle has finished, to allow the renderer to clean up. | |
virtual QString | type () const =0 |
Returns the identifier of the renderer type. | |
virtual QSet< QString > | usedAttributes (const QgsPointCloudRenderContext &context) const |
Returns a list of attributes required by this renderer. | |
virtual bool | willRenderPoint (const QMap< QString, QVariant > &pointAttributes) |
Checks whether the point holding pointAttributes attributes will be rendered By default if not overridden in the subclass renderer will return true ( the renderer is responsible for the filtering behavior ) | |
Static Public Member Functions | |
static QgsPointCloudRenderer * | load (QDomElement &element, const QgsReadWriteContext &context) |
Creates a renderer from an XML element. | |
Protected Member Functions | |
void | addPointToTriangulation (double x, double y, double z, const QColor &color, QgsPointCloudRenderContext &context) |
Adds a point to the list of points to be triangulated (only used when renderAsTriangles() is enabled) | |
void | copyCommonProperties (QgsPointCloudRenderer *destination) const |
Copies common point cloud properties (such as point size and screen error) to the destination renderer. | |
void | drawPoint (double x, double y, const QColor &color, int width, QgsPointCloudRenderContext &context) const |
Draws a point using a color and painter width at the specified x and y (in map coordinates). | |
void | drawPoint (double x, double y, const QColor &color, QgsPointCloudRenderContext &context) const |
Draws a point using a color at the specified x and y (in map coordinates). | |
void | drawPointToElevationMap (double x, double y, double z, int width, QgsPointCloudRenderContext &context) const |
Draws a point at the elevation z using at the specified x and y (in map coordinates) and painter width on the elevation map. | |
void | drawPointToElevationMap (double x, double y, double z, QgsPointCloudRenderContext &context) const |
Draws a point at the elevation z using at the specified x and y (in map coordinates) on the elevation map. | |
void | restoreCommonProperties (const QDomElement &element, const QgsReadWriteContext &context) |
Restores common renderer properties (such as point size and screen error) from the specified DOM element. | |
void | saveCommonProperties (QDomElement &element, const QgsReadWriteContext &context) const |
Saves common renderer properties (such as point size and screen error) to the specified DOM element. | |
Static Protected Member Functions | |
static void | pointXY (QgsPointCloudRenderContext &context, const char *ptr, int i, double &x, double &y) |
Retrieves the x and y coordinate for the point at index i. | |
static double | pointZ (QgsPointCloudRenderContext &context, const char *ptr, int i) |
Retrieves the z value for the point at index i. | |
Abstract base class for 2d point cloud renderers.
Definition at line 320 of file qgspointcloudrenderer.h.
|
default |
|
virtualdefault |
|
delete |
QgsPointCloudRenderer cannot be copied – use clone() instead.
|
inlineprotected |
Adds a point to the list of points to be triangulated (only used when renderAsTriangles() is enabled)
Definition at line 759 of file qgspointcloudrenderer.h.
|
virtual |
Called when the check state of the legend item with the specified key is changed.
Reimplemented in QgsPointCloudClassifiedRenderer.
Definition at line 129 of file qgspointcloudrenderer.cpp.
|
pure virtual |
Create a deep copy of this renderer.
Should be implemented by all subclasses and generate a proper subclass.
Implemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, QgsPointCloudExtentRenderer, and QgsPointCloudRgbRenderer.
|
protected |
Copies common point cloud properties (such as point size and screen error) to the destination renderer.
Definition at line 194 of file qgspointcloudrenderer.cpp.
|
virtual |
Creates a set of legend nodes representing the renderer.
Reimplemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, and QgsPointCloudExtentRenderer.
Definition at line 154 of file qgspointcloudrenderer.cpp.
Qgis::PointCloudDrawOrder QgsPointCloudRenderer::drawOrder2d | ( | ) | const |
Returns the drawing order used by the renderer for drawing points.
Definition at line 254 of file qgspointcloudrenderer.cpp.
|
inlineprotected |
Draws a point using a color and painter width at the specified x and y (in map coordinates).
Definition at line 717 of file qgspointcloudrenderer.h.
|
inlineprotected |
Draws a point using a color at the specified x and y (in map coordinates).
Definition at line 707 of file qgspointcloudrenderer.h.
|
protected |
Draws a point at the elevation z using at the specified x and y (in map coordinates) and painter width on the elevation map.
Definition at line 169 of file qgspointcloudrenderer.cpp.
|
protected |
Draws a point at the elevation z using at the specified x and y (in map coordinates) on the elevation map.
Definition at line 164 of file qgspointcloudrenderer.cpp.
|
inline |
Returns whether large triangles will get rendered.
This only applies when renderAsTriangles() is enabled. When the triangle filtering is enabled, triangles where at least one side is horizontally longer than the threshold in horizontalTriangleFilterThreshold() do not get rendered.
Definition at line 606 of file qgspointcloudrenderer.h.
|
inline |
Returns threshold for filtering of triangles.
This only applies when renderAsTriangles() and horizontalTriangleFilter() are both enabled. If any edge of a triangle is horizontally longer than the threshold, such triangle will not get rendered. Units of the threshold value are given by horizontalTriangleFilterUnits().
Definition at line 631 of file qgspointcloudrenderer.h.
|
inline |
Returns units of the threshold for filtering of triangles.
This only applies when renderAsTriangles() and horizontalTriangleFilter() are both enabled.
Definition at line 655 of file qgspointcloudrenderer.h.
QVector< QVariantMap > QgsPointCloudRenderer::identify | ( | QgsPointCloudLayer * | layer, |
const QgsRenderContext & | context, | ||
const QgsGeometry & | geometry, | ||
double | toleranceForPointIdentification = 0 |
||
) |
Returns the list of visible points of the point cloud layer layer and an extent defined by a geometry in the 2D plane geometry.
The toleranceForPointIdentification argument can be used to specify a minimum tolerance allowable when identify from a point geometry value. This must be specified in the map units associated with the render context.
Definition at line 264 of file qgspointcloudrenderer.cpp.
|
virtual |
Returns true
if the legend item with the specified key is checked.
Reimplemented in QgsPointCloudClassifiedRenderer.
Definition at line 124 of file qgspointcloudrenderer.cpp.
|
virtual |
Returns a list of all rule keys for legend nodes created by the renderer.
Reimplemented in QgsPointCloudClassifiedRenderer.
Definition at line 159 of file qgspointcloudrenderer.cpp.
|
static |
Creates a renderer from an XML element.
Caller takes ownership of the returned renderer.
Definition at line 64 of file qgspointcloudrenderer.cpp.
double QgsPointCloudRenderer::maximumScreenError | ( | ) | const |
Returns the maximum screen error allowed when rendering the point cloud.
Larger values result in a faster render with less points rendered.
Units are retrieved via maximumScreenErrorUnit().
Definition at line 134 of file qgspointcloudrenderer.cpp.
Qgis::RenderUnit QgsPointCloudRenderer::maximumScreenErrorUnit | ( | ) | const |
Returns the unit for the maximum screen error allowed when rendering the point cloud.
Definition at line 144 of file qgspointcloudrenderer.cpp.
|
delete |
QgsPointCloudRenderer cannot be copied – use clone() instead.
|
inline |
Returns the point size.
The point size units are retrieved by calling pointSizeUnit().
Definition at line 477 of file qgspointcloudrenderer.h.
|
inline |
Returns the map unit scale used for the point size.
Definition at line 510 of file qgspointcloudrenderer.h.
|
inline |
Returns the units used for the point size.
Definition at line 494 of file qgspointcloudrenderer.h.
Qgis::PointCloudSymbol QgsPointCloudRenderer::pointSymbol | ( | ) | const |
Returns the symbol used by the renderer for drawing points.
Definition at line 244 of file qgspointcloudrenderer.cpp.
|
inlinestaticprotected |
Retrieves the x and y coordinate for the point at index i.
Definition at line 683 of file qgspointcloudrenderer.h.
|
inlinestaticprotected |
Retrieves the z value for the point at index i.
Definition at line 696 of file qgspointcloudrenderer.h.
|
virtual |
Returns prepared data container for bulk point color retrieval.
Reimplemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, and QgsPointCloudRgbRenderer.
Definition at line 85 of file qgspointcloudrenderer.cpp.
|
inline |
Returns whether points are triangulated to render solid surface.
Definition at line 587 of file qgspointcloudrenderer.h.
|
pure virtual |
Renders a block of point cloud data using the specified render context.
Implemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, QgsPointCloudExtentRenderer, and QgsPointCloudRgbRenderer.
|
protected |
Restores common renderer properties (such as point size and screen error) from the specified DOM element.
Definition at line 210 of file qgspointcloudrenderer.cpp.
|
pure virtual |
Saves the renderer configuration to an XML element.
Implemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, QgsPointCloudExtentRenderer, and QgsPointCloudRgbRenderer.
|
protected |
Saves common renderer properties (such as point size and screen error) to the specified DOM element.
Definition at line 227 of file qgspointcloudrenderer.cpp.
void QgsPointCloudRenderer::setDrawOrder2d | ( | Qgis::PointCloudDrawOrder | order | ) |
Sets the drawing order used by the renderer for drawing points.
Definition at line 259 of file qgspointcloudrenderer.cpp.
|
inline |
Sets whether large triangles will get rendered.
This only applies when renderAsTriangles() is enabled. When the triangle filtering is enabled, triangles where at least one side is horizontally longer than the threshold in horizontalTriangleFilterThreshold() do not get rendered.
Definition at line 618 of file qgspointcloudrenderer.h.
|
inline |
Sets threshold for filtering of triangles.
This only applies when renderAsTriangles() and horizontalTriangleFilter() are both enabled. If any edge of a triangle is horizontally longer than the threshold, such triangle will not get rendered. Units of the threshold value are given by horizontalTriangleFilterUnits().
Definition at line 644 of file qgspointcloudrenderer.h.
|
inline |
Sets units of the threshold for filtering of triangles.
This only applies when renderAsTriangles() and horizontalTriangleFilter() are both enabled.
Definition at line 666 of file qgspointcloudrenderer.h.
void QgsPointCloudRenderer::setMaximumScreenError | ( | double | error | ) |
Sets the maximum screen error allowed when rendering the point cloud.
Larger values result in a faster render with less points rendered.
Units are set via setMaximumScreenErrorUnit().
Definition at line 139 of file qgspointcloudrenderer.cpp.
void QgsPointCloudRenderer::setMaximumScreenErrorUnit | ( | Qgis::RenderUnit | unit | ) |
Sets the unit for the maximum screen error allowed when rendering the point cloud.
Definition at line 149 of file qgspointcloudrenderer.cpp.
|
inline |
Sets the point size.
Point size units are specified via setPointSizeUnit().
Definition at line 466 of file qgspointcloudrenderer.h.
|
inline |
Sets the map unit scale used for the point size.
Definition at line 502 of file qgspointcloudrenderer.h.
|
inline |
Sets the units used for the point size.
Definition at line 486 of file qgspointcloudrenderer.h.
void QgsPointCloudRenderer::setPointSymbol | ( | Qgis::PointCloudSymbol | symbol | ) |
Sets the symbol used by the renderer for drawing points.
Definition at line 249 of file qgspointcloudrenderer.cpp.
|
inline |
Sets whether points are triangulated to render solid surface.
Definition at line 594 of file qgspointcloudrenderer.h.
|
virtual |
Must be called when a new render cycle is started.
A call to startRender() must always be followed by a corresponding call to stopRender() after all features have been rendered.
Reimplemented in QgsPointCloudExtentRenderer.
Definition at line 90 of file qgspointcloudrenderer.cpp.
|
virtual |
Must be called when a render cycle has finished, to allow the renderer to clean up.
Calls to stopRender() must always be preceded by a call to startRender().
Reimplemented in QgsPointCloudExtentRenderer.
Definition at line 117 of file qgspointcloudrenderer.cpp.
|
pure virtual |
Returns the identifier of the renderer type.
Implemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, QgsPointCloudExtentRenderer, and QgsPointCloudRgbRenderer.
|
virtual |
Returns a list of attributes required by this renderer.
Attributes not listed in here may not be requested from the provider at rendering time.
Reimplemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, and QgsPointCloudRgbRenderer.
Definition at line 80 of file qgspointcloudrenderer.cpp.
|
inlinevirtual |
Checks whether the point holding pointAttributes attributes will be rendered By default if not overridden in the subclass renderer will return true ( the renderer is responsible for the filtering behavior )
Definition at line 385 of file qgspointcloudrenderer.h.