Class: QgsPointCloudRenderer

Abstract base class for 2d point cloud renderers.

Added in version 3.18.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: clone(), renderBlock(), save(), type()

Class Hierarchy

Subclasses

QgsPointCloudAttributeByRampRenderer	An RGB renderer for 2d visualisation of point clouds using embedded red, green and blue attributes.
QgsPointCloudClassifiedRenderer	Renders point clouds by a classification attribute.
QgsPointCloudExtentRenderer	A renderer for 2d visualisation of point clouds which shows the dataset’s extents using a fill symbol.
QgsPointCloudRgbRenderer	An RGB renderer for 2d visualisation of point clouds using embedded red, green and blue attributes.

Enums

DrawOrder	alias of PointCloudDrawOrder
PointSymbol	alias of PointCloudSymbol

Abstract Methods

clone	Create a deep copy of this renderer.
renderBlock	Renders a block of point cloud data using the specified render context.
save	Saves the renderer configuration to an XML element.
type	Returns the identifier of the renderer type.

Methods

addPointToTriangulation	Adds a point to the list of points to be triangulated (only used when renderAsTriangles() is enabled)
copyCommonProperties	Copies common point cloud properties (such as point size and screen error) to the destination renderer.
drawOrder2d	Returns the drawing order used by the renderer for drawing points.
drawPoint	Draws a point using a color at the specified x and y (in map coordinates).
horizontalTriangleFilter	Returns whether large triangles will get rendered.
horizontalTriangleFilterThreshold	Returns threshold for filtering of triangles.
horizontalTriangleFilterUnit	Returns units of the threshold for filtering of triangles.
labelTextFormat	Returns the text format renderer is using for rendering labels
maximumScreenError	Returns the maximum screen error allowed when rendering the point cloud.
maximumScreenErrorUnit	Returns the unit for the maximum screen error allowed when rendering the point cloud.
pointSize	Returns the point size.
pointSizeMapUnitScale	Returns the map unit scale used for the point size.
pointSizeUnit	Returns the units used for the point size.
pointSymbol	Returns the symbol used by the renderer for drawing points.
renderAsTriangles	Returns whether points are triangulated to render solid surface
restoreCommonProperties	Restores common renderer properties (such as point size and screen error) from the specified DOM element.
saveCommonProperties	Saves common renderer properties (such as point size and screen error) to the specified DOM element.
setDrawOrder2d	Sets the drawing order used by the renderer for drawing points.
setHorizontalTriangleFilter	Sets whether large triangles will get rendered.
setHorizontalTriangleFilterThreshold	Sets threshold for filtering of triangles.
setHorizontalTriangleFilterUnit	Sets units of the threshold for filtering of triangles.
setLabelTextFormat	Sets the text format renderers should use for rendering labels
setMaximumScreenError	Sets the maximum screen error allowed when rendering the point cloud.
setMaximumScreenErrorUnit	Sets the unit for the maximum screen error allowed when rendering the point cloud.
setPointSize	Sets the point size.
setPointSizeMapUnitScale	Sets the map unit scale used for the point size.
setPointSizeUnit	Sets the units used for the point size.
setPointSymbol	Sets the symbol used by the renderer for drawing points.
setRenderAsTriangles	Sets whether points are triangulated to render solid surface
setShowLabels	Set whether the renderer should also render file labels inside extent
setZoomOutBehavior	Sets the renderer behavior when zoomed out
showLabels	Returns whether the renderer shows file labels inside the extent rectangle
zoomOutBehavior	Returns the renderer behavior when zoomed out

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsPointCloudRenderer. See the FAQ for more details.

checkLegendItem	Called when the check state of the legend item with the specified key is changed.
createLegendNodes	Creates a set of legend nodes representing the renderer.
legendItemChecked	Returns True if the legend item with the specified key is checked.
legendRuleKeys	Returns a list of all rule keys for legend nodes created by the renderer.
startRender	Must be called when a new render cycle is started.
stopRender	Must be called when a render cycle has finished, to allow the renderer to clean up.
usedAttributes	Returns a list of attributes required by this renderer.
willRenderPoint	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 Methods

load	Creates a renderer from an XML element.
pointXY	Retrieves the x and y coordinate for the point at index i.
pointZ	Retrieves the z value for the point at index i.

class qgis.core.QgsPointCloudRenderer

Bases: object

DrawOrder

alias of PointCloudDrawOrder

PointSymbol

alias of PointCloudSymbol

addPointToTriangulation(self, x: float, y: float, z: float, color: QColor | Qt.GlobalColor, context: QgsPointCloudRenderContext)

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

Added in version 3.36.

Parameters:

• x (float)

• y (float)

• z (float)

• color (Union[QColor, Qt.GlobalColor])

• context (QgsPointCloudRenderContext)

virtual checkLegendItem(self, key: str | None, state: bool = True)

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

See also

legendItemChecked()

Parameters:

• key (Optional[str])

• state (bool = True)

abstract clone(self) → QgsPointCloudRenderer | None

Create a deep copy of this renderer. Should be implemented by all subclasses and generate a proper subclass.

Return type:

Optional[QgsPointCloudRenderer]

copyCommonProperties(self, destination: QgsPointCloudRenderer | None)

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

Parameters:

destination (Optional[QgsPointCloudRenderer])

virtual createLegendNodes(self, nodeLayer: QgsLayerTreeLayer | None) → List[QgsLayerTreeModelLegendNode]

Creates a set of legend nodes representing the renderer.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])

Return type:

List[QgsLayerTreeModelLegendNode]

drawOrder2d(self) → Qgis.PointCloudDrawOrder

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

See also

setDrawOrder2d()

Added in version 3.24.

Return type:

Qgis.PointCloudDrawOrder

drawPoint(self, x: float, y: float, color: QColor | Qt.GlobalColor, context: QgsPointCloudRenderContext)

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

Parameters:

• x (float)

• y (float)

• color (Union[QColor, Qt.GlobalColor])

• context (QgsPointCloudRenderContext)

drawPoint(self, x: float, y: float, color: QColor | Qt.GlobalColor, width: int, context: QgsPointCloudRenderContext)

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

Added in version 3.36.

Parameters:

• x (float)

• y (float)

• color (Union[QColor, Qt.GlobalColor])

• width (int)

• context (QgsPointCloudRenderContext)

horizontalTriangleFilter(self) → bool

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

See also

horizontalTriangleFilterUnit()

See also

setHorizontalTriangleFilter()

Added in version 3.36.

Return type:

bool

horizontalTriangleFilterThreshold(self) → float

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

See also

horizontalTriangleFilterUnit()

See also

setHorizontalTriangleFilterThreshold()

Added in version 3.36.

Return type:

float

horizontalTriangleFilterUnit(self) → Qgis.RenderUnit

Returns units of the threshold for filtering of triangles. This only applies when renderAsTriangles() and horizontalTriangleFilter() are both enabled.

See also

horizontalTriangleFilter()

See also

horizontalTriangleFilterThreshold()

See also

setHorizontalTriangleFilterUnit()

Added in version 3.36.

Return type:

Qgis.RenderUnit

labelTextFormat(self) → QgsTextFormat

Returns the text format renderer is using for rendering labels

Added in version 3.42.

Return type:

QgsTextFormat

virtual legendItemChecked(self, key: str | None) → bool

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

See also

checkLegendItem()

Parameters:

key (Optional[str])

Return type:

bool

virtual legendRuleKeys(self) → List[str]

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

Return type:

List[str]

static load(element: QDomElement, context: QgsReadWriteContext) → QgsPointCloudRenderer | None

Creates a renderer from an XML element.

Caller takes ownership of the returned renderer.

See also

save()

Parameters:

• element (QDomElement)

• context (QgsReadWriteContext)

Return type:

Optional[QgsPointCloudRenderer]

maximumScreenError(self) → float

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

See also

maximumScreenErrorUnit()

Return type:

float

maximumScreenErrorUnit(self) → Qgis.RenderUnit

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

See also

maximumScreenError()

See also

setMaximumScreenErrorUnit()

Return type:

Qgis.RenderUnit

pointSize(self) → float

Returns the point size.

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

See also

setPointSize()

See also

pointSizeUnit()

See also

pointSizeMapUnitScale()

Return type:

float

pointSizeMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale used for the point size.

See also

setPointSizeMapUnitScale()

See also

pointSizeUnit()

See also

pointSize()

Return type:

QgsMapUnitScale

pointSizeUnit(self) → Qgis.RenderUnit

Returns the units used for the point size.

See also

setPointSizeUnit()

See also

pointSize()

See also

pointSizeMapUnitScale()

Return type:

Qgis.RenderUnit

pointSymbol(self) → Qgis.PointCloudSymbol

Returns the symbol used by the renderer for drawing points.

See also

setPointSymbol()

Return type:

Qgis.PointCloudSymbol

static pointXY(context: QgsPointCloudRenderContext, ptr: str | None, i: int)

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

Parameters:

• context (QgsPointCloudRenderContext)

• ptr (Optional[str])

• i (int) -> (float)

static pointZ(context: QgsPointCloudRenderContext, ptr: str | None, i: int) → float

Retrieves the z value for the point at index i.

Parameters:

• context (QgsPointCloudRenderContext)

• ptr (Optional[str])

• i (int)

Return type:

float

renderAsTriangles(self) → bool

Returns whether points are triangulated to render solid surface

Added in version 3.36.

Return type:

bool

abstract renderBlock(self, block: QgsPointCloudBlock | None, context: QgsPointCloudRenderContext)

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

Parameters:

• block (Optional[QgsPointCloudBlock])

• context (QgsPointCloudRenderContext)

restoreCommonProperties(self, element: QDomElement, context: QgsReadWriteContext)

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

See also

saveCommonProperties()

Parameters:

• element (QDomElement)

• context (QgsReadWriteContext)

abstract save(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement

Saves the renderer configuration to an XML element.

See also

load()

Parameters:

• doc (QDomDocument)

• context (QgsReadWriteContext)

Return type:

QDomElement

saveCommonProperties(self, element: QDomElement, context: QgsReadWriteContext)

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

See also

restoreCommonProperties()

Parameters:

• element (QDomElement)

• context (QgsReadWriteContext)

setDrawOrder2d(self, order: Qgis.PointCloudDrawOrder)

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

See also

drawOrder2d()

Added in version 3.24.

Parameters:

order (Qgis.PointCloudDrawOrder)

setHorizontalTriangleFilter(self, enabled: bool)

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

See also

setHorizontalTriangleFilterUnit()

See also

horizontalTriangleFilter()

Added in version 3.36.

Parameters:

enabled (bool)

setHorizontalTriangleFilterThreshold(self, threshold: float)

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

See also

horizontalTriangleFilterUnit()

See also

horizontalTriangleFilterThreshold()

Added in version 3.36.

Parameters:

threshold (float)

setHorizontalTriangleFilterUnit(self, unit: Qgis.RenderUnit)

Sets units of the threshold for filtering of triangles. This only applies when renderAsTriangles() and horizontalTriangleFilter() are both enabled.

See also

horizontalTriangleFilter()

See also

horizontalTriangleFilterThreshold()

See also

horizontalTriangleFilterUnit()

Added in version 3.36.

Parameters:

unit (Qgis.RenderUnit)

setLabelTextFormat(self, textFormat: QgsTextFormat)

Sets the text format renderers should use for rendering labels

Added in version 3.42.

Parameters:

textFormat (QgsTextFormat)

setMaximumScreenError(self, error: float)

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

See also

setMaximumScreenErrorUnit()

Parameters:

error (float)

setMaximumScreenErrorUnit(self, unit: Qgis.RenderUnit)

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

See also

setMaximumScreenError()

See also

maximumScreenErrorUnit()

Parameters:

unit (Qgis.RenderUnit)

setPointSize(self, size: float)

Sets the point size. Point size units are specified via setPointSizeUnit().

See also

pointSize()

See also

setPointSizeUnit()

See also

setPointSizeMapUnitScale()

Parameters:

size (float)

setPointSizeMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale used for the point size.

See also

pointSizeMapUnitScale()

See also

setPointSize()

See also

setPointSizeUnit()

Parameters:

scale (QgsMapUnitScale)

setPointSizeUnit(self, units: Qgis.RenderUnit)

Sets the units used for the point size.

See also

setPointSize()

See also

pointSizeUnit()

See also

setPointSizeMapUnitScale()

Parameters:

units (Qgis.RenderUnit)

setPointSymbol(self, symbol: Qgis.PointCloudSymbol)

Sets the symbol used by the renderer for drawing points.

See also

pointSymbol()

Parameters:

symbol (Qgis.PointCloudSymbol)

setRenderAsTriangles(self, asTriangles: bool)

Sets whether points are triangulated to render solid surface

Added in version 3.36.

Parameters:

asTriangles (bool)

setShowLabels(self, show: bool)

Set whether the renderer should also render file labels inside extent

Added in version 3.42.

Parameters:

show (bool)

setZoomOutBehavior(self, behavior: Qgis.PointCloudZoomOutRenderBehavior)

Sets the renderer behavior when zoomed out

Added in version 3.42.

Parameters:

behavior (Qgis.PointCloudZoomOutRenderBehavior)

showLabels(self) → bool

Returns whether the renderer shows file labels inside the extent rectangle

Added in version 3.42.

Return type:

bool

virtual startRender(self, context: QgsPointCloudRenderContext)

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.

Parameters:

context (QgsPointCloudRenderContext)

virtual stopRender(self, context: QgsPointCloudRenderContext)

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

Parameters:

context (QgsPointCloudRenderContext)

abstract type(self) → str

Returns the identifier of the renderer type.

Return type:

str

virtual usedAttributes(self, context: QgsPointCloudRenderContext) → Set[str]

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.

Parameters:

context (QgsPointCloudRenderContext)

Return type:

Set[str]

virtual willRenderPoint(self, pointAttributes: Dict[str | None, Any]) → bool

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 )

Parameters:

pointAttributes (Dict[Optional[str], Any])

Return type:

bool

zoomOutBehavior(self) → Qgis.PointCloudZoomOutRenderBehavior

Returns the renderer behavior when zoomed out

Added in version 3.42.

Return type:

Qgis.PointCloudZoomOutRenderBehavior