QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
QgsPointCloudRenderer Class Referenceabstract

Abstract base class for 2d point cloud renderers. More...

#include <qgspointcloudrenderer.h>

Inheritance diagram for QgsPointCloudRenderer:

Public Member Functions

 QgsPointCloudRenderer ()
 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 QgsPointCloudRendererclone () 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.
QgsTextFormat labelTextFormat () const
 Returns the text format renderer is using for rendering labels.
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.
QgsPointCloudRendereroperator= (const QgsPointCloudRenderer &other)=delete
 QgsPointCloudRenderer cannot be copied – use clone() instead.
double pointSize () const
 Returns the point size.
const QgsMapUnitScalepointSizeMapUnitScale () 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< QgsPreparedPointCloudRendererDataprepare ()
 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 setLabelTextFormat (const QgsTextFormat &textFormat)
 Sets the text format renderers should use for rendering labels.
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.
void setShowLabels (const bool show)
 Set whether the renderer should also render file labels inside extent.
void setZoomOutBehavior (const Qgis::PointCloudZoomOutRenderBehavior behavior)
 Sets the renderer behavior when zoomed out.
bool showLabels () const
 Returns whether the renderer shows file labels inside the extent rectangle.
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 ).
Qgis::PointCloudZoomOutRenderBehavior zoomOutBehavior () const
 Returns the renderer behavior when zoomed out.

Static Public Member Functions

static QgsPointCloudRendererload (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.

Detailed Description

Abstract base class for 2d point cloud renderers.

Since
QGIS 3.18

Definition at line 320 of file qgspointcloudrenderer.h.

Constructor & Destructor Documentation

◆ QgsPointCloudRenderer() [1/2]

QgsPointCloudRenderer::QgsPointCloudRenderer ( )

Definition at line 66 of file qgspointcloudrenderer.cpp.

◆ ~QgsPointCloudRenderer()

virtual QgsPointCloudRenderer::~QgsPointCloudRenderer ( )
virtualdefault

◆ QgsPointCloudRenderer() [2/2]

QgsPointCloudRenderer::QgsPointCloudRenderer ( const QgsPointCloudRenderer & other)
delete

QgsPointCloudRenderer cannot be copied – use clone() instead.

Member Function Documentation

◆ addPointToTriangulation()

void QgsPointCloudRenderer::addPointToTriangulation ( double x,
double y,
double z,
const QColor & color,
QgsPointCloudRenderContext & context )
inlineprotected

Adds a point to the list of points to be triangulated (only used when renderAsTriangles() is enabled).

Since
QGIS 3.36

Definition at line 796 of file qgspointcloudrenderer.h.

◆ checkLegendItem()

void QgsPointCloudRenderer::checkLegendItem ( const QString & key,
bool state = true )
virtual

Called when the check state of the legend item with the specified key is changed.

See also
legendItemChecked()

Reimplemented in QgsPointCloudClassifiedRenderer.

Definition at line 141 of file qgspointcloudrenderer.cpp.

◆ clone()

virtual QgsPointCloudRenderer * QgsPointCloudRenderer::clone ( ) const
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.

◆ copyCommonProperties()

void QgsPointCloudRenderer::copyCommonProperties ( QgsPointCloudRenderer * destination) const
protected

Copies common point cloud properties (such as point size and screen error) to the destination renderer.

Definition at line 206 of file qgspointcloudrenderer.cpp.

◆ createLegendNodes()

QList< QgsLayerTreeModelLegendNode * > QgsPointCloudRenderer::createLegendNodes ( QgsLayerTreeLayer * nodeLayer)
virtual

Creates a set of legend nodes representing the renderer.

Reimplemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, and QgsPointCloudExtentRenderer.

Definition at line 166 of file qgspointcloudrenderer.cpp.

◆ drawOrder2d()

Qgis::PointCloudDrawOrder QgsPointCloudRenderer::drawOrder2d ( ) const

Returns the drawing order used by the renderer for drawing points.

See also
setDrawOrder2d()
Since
QGIS 3.24

Definition at line 288 of file qgspointcloudrenderer.cpp.

◆ drawPoint() [1/2]

void QgsPointCloudRenderer::drawPoint ( double x,
double y,
const QColor & color,
int width,
QgsPointCloudRenderContext & context ) const
inlineprotected

Draws a point using a color and painter width at the specified x and y (in map coordinates).

Since
QGIS 3.36

Definition at line 754 of file qgspointcloudrenderer.h.

◆ drawPoint() [2/2]

void QgsPointCloudRenderer::drawPoint ( double x,
double y,
const QColor & color,
QgsPointCloudRenderContext & context ) const
inlineprotected

Draws a point using a color at the specified x and y (in map coordinates).

Definition at line 744 of file qgspointcloudrenderer.h.

◆ drawPointToElevationMap() [1/2]

void QgsPointCloudRenderer::drawPointToElevationMap ( double x,
double y,
double z,
int width,
QgsPointCloudRenderContext & context ) const
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.

Since
QGIS 3.36

Definition at line 181 of file qgspointcloudrenderer.cpp.

◆ drawPointToElevationMap() [2/2]

void QgsPointCloudRenderer::drawPointToElevationMap ( double x,
double y,
double z,
QgsPointCloudRenderContext & context ) const
protected

Draws a point at the elevation z using at the specified x and y (in map coordinates) on the elevation map.

Since
QGIS 3.28

Definition at line 176 of file qgspointcloudrenderer.cpp.

◆ horizontalTriangleFilter()

bool QgsPointCloudRenderer::horizontalTriangleFilter ( ) const
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.

See also
horizontalTriangleFilterThreshold()
horizontalTriangleFilterUnit()
setHorizontalTriangleFilter()
Since
QGIS 3.36

Definition at line 606 of file qgspointcloudrenderer.h.

◆ horizontalTriangleFilterThreshold()

double QgsPointCloudRenderer::horizontalTriangleFilterThreshold ( ) const
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().

See also
horizontalTriangleFilter()
horizontalTriangleFilterUnit()
setHorizontalTriangleFilterThreshold()
Since
QGIS 3.36

Definition at line 631 of file qgspointcloudrenderer.h.

◆ horizontalTriangleFilterUnit()

Qgis::RenderUnit QgsPointCloudRenderer::horizontalTriangleFilterUnit ( ) const
inline

Returns units of the threshold for filtering of triangles.

This only applies when renderAsTriangles() and horizontalTriangleFilter() are both enabled.

See also
horizontalTriangleFilter()
horizontalTriangleFilterThreshold()
setHorizontalTriangleFilterUnit()
Since
QGIS 3.36

Definition at line 655 of file qgspointcloudrenderer.h.

◆ identify()

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.

Warning
The geometry value must be specified in the render context's destination CRS, not the layer's native CRS!

Definition at line 298 of file qgspointcloudrenderer.cpp.

◆ labelTextFormat()

QgsTextFormat QgsPointCloudRenderer::labelTextFormat ( ) const
inline

Returns the text format renderer is using for rendering labels.

Since
QGIS 3.42

Definition at line 701 of file qgspointcloudrenderer.h.

◆ legendItemChecked()

bool QgsPointCloudRenderer::legendItemChecked ( const QString & key)
virtual

Returns true if the legend item with the specified key is checked.

See also
checkLegendItem()

Reimplemented in QgsPointCloudClassifiedRenderer.

Definition at line 136 of file qgspointcloudrenderer.cpp.

◆ legendRuleKeys()

QStringList QgsPointCloudRenderer::legendRuleKeys ( ) const
virtual

Returns a list of all rule keys for legend nodes created by the renderer.

Reimplemented in QgsPointCloudClassifiedRenderer.

Definition at line 171 of file qgspointcloudrenderer.cpp.

◆ load()

QgsPointCloudRenderer * QgsPointCloudRenderer::load ( QDomElement & element,
const QgsReadWriteContext & context )
static

Creates a renderer from an XML element.

Caller takes ownership of the returned renderer.

See also
save()

Definition at line 76 of file qgspointcloudrenderer.cpp.

◆ maximumScreenError()

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().

See also
setMaximumScreenError()
maximumScreenErrorUnit()

Definition at line 146 of file qgspointcloudrenderer.cpp.

◆ maximumScreenErrorUnit()

Qgis::RenderUnit QgsPointCloudRenderer::maximumScreenErrorUnit ( ) const

Returns the unit for the maximum screen error allowed when rendering the point cloud.

See also
maximumScreenError()
setMaximumScreenErrorUnit()

Definition at line 156 of file qgspointcloudrenderer.cpp.

◆ operator=()

QgsPointCloudRenderer & QgsPointCloudRenderer::operator= ( const QgsPointCloudRenderer & other)
delete

QgsPointCloudRenderer cannot be copied – use clone() instead.

◆ pointSize()

double QgsPointCloudRenderer::pointSize ( ) const
inline

Returns the point size.

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

See also
setPointSize()
pointSizeUnit()
pointSizeMapUnitScale()

Definition at line 477 of file qgspointcloudrenderer.h.

◆ pointSizeMapUnitScale()

const QgsMapUnitScale & QgsPointCloudRenderer::pointSizeMapUnitScale ( ) const
inline

Returns the map unit scale used for the point size.

See also
setPointSizeMapUnitScale()
pointSizeUnit()
pointSize()

Definition at line 510 of file qgspointcloudrenderer.h.

◆ pointSizeUnit()

Qgis::RenderUnit QgsPointCloudRenderer::pointSizeUnit ( ) const
inline

Returns the units used for the point size.

See also
setPointSizeUnit()
pointSize()
pointSizeMapUnitScale()

Definition at line 494 of file qgspointcloudrenderer.h.

◆ pointSymbol()

Qgis::PointCloudSymbol QgsPointCloudRenderer::pointSymbol ( ) const

Returns the symbol used by the renderer for drawing points.

See also
setPointSymbol()

Definition at line 278 of file qgspointcloudrenderer.cpp.

◆ pointXY()

void QgsPointCloudRenderer::pointXY ( QgsPointCloudRenderContext & context,
const char * ptr,
int i,
double & x,
double & y )
inlinestaticprotected

Retrieves the x and y coordinate for the point at index i.

Definition at line 720 of file qgspointcloudrenderer.h.

◆ pointZ()

double QgsPointCloudRenderer::pointZ ( QgsPointCloudRenderContext & context,
const char * ptr,
int i )
inlinestaticprotected

Retrieves the z value for the point at index i.

Definition at line 733 of file qgspointcloudrenderer.h.

◆ prepare()

std::unique_ptr< QgsPreparedPointCloudRendererData > QgsPointCloudRenderer::prepare ( )
virtual

Returns prepared data container for bulk point color retrieval.

Note
Not available in Python bindings.
Since
QGIS 3.26

Reimplemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, and QgsPointCloudRgbRenderer.

Definition at line 97 of file qgspointcloudrenderer.cpp.

◆ renderAsTriangles()

bool QgsPointCloudRenderer::renderAsTriangles ( ) const
inline

Returns whether points are triangulated to render solid surface.

Since
QGIS 3.36

Definition at line 587 of file qgspointcloudrenderer.h.

◆ renderBlock()

virtual void QgsPointCloudRenderer::renderBlock ( const QgsPointCloudBlock * block,
QgsPointCloudRenderContext & context )
pure virtual

Renders a block of point cloud data using the specified render context.

Implemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, QgsPointCloudExtentRenderer, and QgsPointCloudRgbRenderer.

◆ restoreCommonProperties()

void QgsPointCloudRenderer::restoreCommonProperties ( const QDomElement & element,
const QgsReadWriteContext & context )
protected

Restores common renderer properties (such as point size and screen error) from the specified DOM element.

See also
saveCommonProperties()

Definition at line 226 of file qgspointcloudrenderer.cpp.

◆ save()

virtual QDomElement QgsPointCloudRenderer::save ( QDomDocument & doc,
const QgsReadWriteContext & context ) const
pure virtual

Saves the renderer configuration to an XML element.

See also
load()

Implemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, QgsPointCloudExtentRenderer, and QgsPointCloudRgbRenderer.

◆ saveCommonProperties()

void QgsPointCloudRenderer::saveCommonProperties ( QDomElement & element,
const QgsReadWriteContext & context ) const
protected

Saves common renderer properties (such as point size and screen error) to the specified DOM element.

See also
restoreCommonProperties()

Definition at line 251 of file qgspointcloudrenderer.cpp.

◆ setDrawOrder2d()

void QgsPointCloudRenderer::setDrawOrder2d ( Qgis::PointCloudDrawOrder order)

Sets the drawing order used by the renderer for drawing points.

See also
drawOrder2d()
Since
QGIS 3.24

Definition at line 293 of file qgspointcloudrenderer.cpp.

◆ setHorizontalTriangleFilter()

void QgsPointCloudRenderer::setHorizontalTriangleFilter ( bool enabled)
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.

See also
setHorizontalTriangleFilterThreshold()
setHorizontalTriangleFilterUnit()
horizontalTriangleFilter()
Since
QGIS 3.36

Definition at line 618 of file qgspointcloudrenderer.h.

◆ setHorizontalTriangleFilterThreshold()

void QgsPointCloudRenderer::setHorizontalTriangleFilterThreshold ( double threshold)
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().

See also
horizontalTriangleFilter()
horizontalTriangleFilterUnit()
horizontalTriangleFilterThreshold()
Since
QGIS 3.36

Definition at line 644 of file qgspointcloudrenderer.h.

◆ setHorizontalTriangleFilterUnit()

void QgsPointCloudRenderer::setHorizontalTriangleFilterUnit ( Qgis::RenderUnit unit)
inline

Sets units of the threshold for filtering of triangles.

This only applies when renderAsTriangles() and horizontalTriangleFilter() are both enabled.

See also
horizontalTriangleFilter()
horizontalTriangleFilterThreshold()
horizontalTriangleFilterUnit()
Since
QGIS 3.36

Definition at line 666 of file qgspointcloudrenderer.h.

◆ setLabelTextFormat()

void QgsPointCloudRenderer::setLabelTextFormat ( const QgsTextFormat & textFormat)
inline

Sets the text format renderers should use for rendering labels.

Since
QGIS 3.42

Definition at line 695 of file qgspointcloudrenderer.h.

◆ setMaximumScreenError()

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().

See also
maximumScreenError()
setMaximumScreenErrorUnit()

Definition at line 151 of file qgspointcloudrenderer.cpp.

◆ setMaximumScreenErrorUnit()

void QgsPointCloudRenderer::setMaximumScreenErrorUnit ( Qgis::RenderUnit unit)

Sets the unit for the maximum screen error allowed when rendering the point cloud.

See also
setMaximumScreenError()
maximumScreenErrorUnit()

Definition at line 161 of file qgspointcloudrenderer.cpp.

◆ setPointSize()

void QgsPointCloudRenderer::setPointSize ( double size)
inline

Sets the point size.

Point size units are specified via setPointSizeUnit().

See also
pointSize()
setPointSizeUnit()
setPointSizeMapUnitScale()

Definition at line 466 of file qgspointcloudrenderer.h.

◆ setPointSizeMapUnitScale()

void QgsPointCloudRenderer::setPointSizeMapUnitScale ( const QgsMapUnitScale & scale)
inline

Sets the map unit scale used for the point size.

See also
pointSizeMapUnitScale()
setPointSize()
setPointSizeUnit()

Definition at line 502 of file qgspointcloudrenderer.h.

◆ setPointSizeUnit()

void QgsPointCloudRenderer::setPointSizeUnit ( const Qgis::RenderUnit units)
inline

Sets the units used for the point size.

See also
setPointSize()
pointSizeUnit()
setPointSizeMapUnitScale()

Definition at line 486 of file qgspointcloudrenderer.h.

◆ setPointSymbol()

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

Sets the symbol used by the renderer for drawing points.

See also
pointSymbol()

Definition at line 283 of file qgspointcloudrenderer.cpp.

◆ setRenderAsTriangles()

void QgsPointCloudRenderer::setRenderAsTriangles ( bool asTriangles)
inline

Sets whether points are triangulated to render solid surface.

Since
QGIS 3.36

Definition at line 594 of file qgspointcloudrenderer.h.

◆ setShowLabels()

void QgsPointCloudRenderer::setShowLabels ( const bool show)
inline

Set whether the renderer should also render file labels inside extent.

Since
QGIS 3.42

Definition at line 682 of file qgspointcloudrenderer.h.

◆ setZoomOutBehavior()

void QgsPointCloudRenderer::setZoomOutBehavior ( const Qgis::PointCloudZoomOutRenderBehavior behavior)
inline

Sets the renderer behavior when zoomed out.

Since
QGIS 3.42

Definition at line 707 of file qgspointcloudrenderer.h.

◆ showLabels()

bool QgsPointCloudRenderer::showLabels ( ) const
inline

Returns whether the renderer shows file labels inside the extent rectangle.

Since
QGIS 3.42

Definition at line 689 of file qgspointcloudrenderer.h.

◆ startRender()

void QgsPointCloudRenderer::startRender ( QgsPointCloudRenderContext & context)
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.

See also
stopRender()
Warning
This method is not thread safe. Before calling startRender() in a non-main thread, the renderer should instead be cloned and startRender()/stopRender() called on the clone.

Reimplemented in QgsPointCloudExtentRenderer.

Definition at line 102 of file qgspointcloudrenderer.cpp.

◆ stopRender()

void QgsPointCloudRenderer::stopRender ( QgsPointCloudRenderContext & context)
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().

Warning
This method is not thread safe. Before calling startRender() in a non-main thread, the renderer should instead be cloned and startRender()/stopRender() called on the clone.
See also
startRender()

Reimplemented in QgsPointCloudExtentRenderer.

Definition at line 129 of file qgspointcloudrenderer.cpp.

◆ type()

virtual QString QgsPointCloudRenderer::type ( ) const
pure virtual

◆ usedAttributes()

QSet< QString > QgsPointCloudRenderer::usedAttributes ( const QgsPointCloudRenderContext & context) const
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.

Note
the "X" and "Y" attributes will always be fetched and do not need to be explicitly returned here.

Reimplemented in QgsPointCloudAttributeByRampRenderer, QgsPointCloudClassifiedRenderer, and QgsPointCloudRgbRenderer.

Definition at line 92 of file qgspointcloudrenderer.cpp.

◆ willRenderPoint()

virtual bool QgsPointCloudRenderer::willRenderPoint ( const QMap< QString, QVariant > & pointAttributes)
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.

◆ zoomOutBehavior()

Qgis::PointCloudZoomOutRenderBehavior QgsPointCloudRenderer::zoomOutBehavior ( ) const
inline

Returns the renderer behavior when zoomed out.

Since
QGIS 3.42

Definition at line 713 of file qgspointcloudrenderer.h.


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