Class: QgsPointCloudExtentRenderer

class qgis.core.QgsPointCloudExtentRenderer

Bases: QgsPointCloudRenderer

A renderer for 2d visualisation of point clouds which shows the dataset’s extents using a fill symbol.

New in version 3.18.

QgsPointCloudExtentRenderer(symbol: QgsFillSymbol = None) Constructor for QgsPointCloudExtentRenderer.

Optionally the symbol to use for showing the extent can be specified. If specified, ownership is transferred to the renderer. If no symbol is specified a default one will be created instead.

Methods

clone

rtype

QgsPointCloudRenderer

copyCommonProperties

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

create

Creates an extent renderer from an XML element.

createLegendNodes

param nodeLayer

defaultFillSymbol

Returns a new instance of the default fill symbol to use for showing point cloud extents.

drawPoint

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

fillSymbol

Returns the symbol used to render the cloud’s extent.

pointXY

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

pointZ

Retrieves the z value for the point at index i.

renderBlock

param block

renderExtent

Renders a polygon extent geometry to the specified render context.

restoreCommonProperties

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

save

param doc

saveCommonProperties

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

setFillSymbol

Sets the symbol used to render the cloud’s extent.

startRender

param context

stopRender

param context

type

rtype

str

clone(self)QgsPointCloudRenderer
Return type

QgsPointCloudRenderer

copyCommonProperties(self, destination: QgsPointCloudRenderer)

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

create(element: QDomElement, context: QgsReadWriteContext)QgsPointCloudRenderer

Creates an extent renderer from an XML element.

Parameters
Return type

QgsPointCloudRenderer

createLegendNodes(self, nodeLayer: QgsLayerTreeLayer)List[QgsLayerTreeModelLegendNode]
Parameters

nodeLayer (QgsLayerTreeLayer) –

Return type

List[QgsLayerTreeModelLegendNode]

defaultFillSymbol()QgsFillSymbol

Returns a new instance of the default fill symbol to use for showing point cloud extents.

Return type

QgsFillSymbol

drawPoint(self, x: float, y: float, color: Union[QColor, Qt.GlobalColor, QGradient], context: QgsPointCloudRenderContext)

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

fillSymbol(self)QgsFillSymbol

Returns the symbol used to render the cloud’s extent.

See also

setFillSymbol()

Return type

QgsFillSymbol

pointXY(context: QgsPointCloudRenderContext, ptr: str, i: int)Tuple[float, float]

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

pointZ(context: QgsPointCloudRenderContext, ptr: str, i: int)float

Retrieves the z value for the point at index i.

renderBlock(self, block: QgsPointCloudBlock, context: QgsPointCloudRenderContext)
Parameters
renderExtent(self, extent: QgsGeometry, context: QgsPointCloudRenderContext)

Renders a polygon extent geometry to the specified render context.

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

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

save(self, doc: QDomDocument, context: QgsReadWriteContext)QDomElement
Parameters
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.

setFillSymbol(self, symbol: QgsFillSymbol)

Sets the symbol used to render the cloud’s extent.

Ownership of symbol is transferred to the renderer.

See also

fillSymbol()

Parameters

symbol (QgsFillSymbol) –

startRender(self, context: QgsPointCloudRenderContext)
Parameters

context (QgsPointCloudRenderContext) –

stopRender(self, context: QgsPointCloudRenderContext)
Parameters

context (QgsPointCloudRenderContext) –

type(self)str
Return type

str