Class: QgsPointCloudRgbRenderer¶

class qgis.core.QgsPointCloudRgbRenderer¶

Bases: QgsPointCloudRenderer

An RGB renderer for 2d visualisation of point clouds using embedded red, green and blue attributes.

Added in version 3.18.

QgsPointCloudRgbRenderer() Constructor for QgsPointCloudRgbRenderer.

Methods

blueAttribute

Returns the attribute to use for the blue channel.

blueContrastEnhancement

Returns the contrast enhancement to use for the blue channel.

clone

rtype:

Optional[QgsPointCloudRenderer]

copyCommonProperties

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

create

Creates an RGB renderer from an XML element.

drawPoint

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

greenAttribute

Returns the attribute to use for the green channel.

greenContrastEnhancement

Returns the contrast enhancement to use for the green channel.

pointXY

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

pointZ

Retrieves the z value for the point at index i.

redAttribute

Returns the attribute to use for the red channel.

redContrastEnhancement

Returns the contrast enhancement to use for the red channel.

renderBlock

param block:

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.

setBlueAttribute

Sets the attribute to use for the blue channel.

setBlueContrastEnhancement

Sets the contrast enhancement to use for the blue channel.

setGreenAttribute

Sets the attribute to use for the green channel.

setGreenContrastEnhancement

Sets the contrast enhancement to use for the green channel.

setRedAttribute

Sets the attribute to use for the red channel.

setRedContrastEnhancement

Sets the contrast enhancement to use for the red channel.

type

rtype:

str

usedAttributes

param context:

blueAttribute(self) → str¶

Returns the attribute to use for the blue channel.

See also

greenAttribute()

See also

redAttribute()

See also

setBlueAttribute()

Return type:: str

blueContrastEnhancement(self) → QgsContrastEnhancement | None¶

Returns the contrast enhancement to use for the blue channel.

See also

setBlueContrastEnhancement()

See also

redContrastEnhancement()

See also

greenContrastEnhancement()

Return type:: Optional[QgsContrastEnhancement]

clone(self) → QgsPointCloudRenderer | None¶

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.

create(element: QDomElement, context: QgsReadWriteContext) → QgsPointCloudRenderer | None¶

Creates an RGB renderer from an XML element.

Parameters:

element (QDomElement)
context (QgsReadWriteContext)

Return type:

Optional[QgsPointCloudRenderer]

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

greenAttribute(self) → str¶

Returns the attribute to use for the green channel.

See also

redAttribute()

See also

blueAttribute()

See also

setGreenAttribute()

Return type:: str

greenContrastEnhancement(self) → QgsContrastEnhancement | None¶

Returns the contrast enhancement to use for the green channel.

See also

setGreenContrastEnhancement()

See also

redContrastEnhancement()

See also

blueContrastEnhancement()

Return type:: Optional[QgsContrastEnhancement]

pointXY(context: QgsPointCloudRenderContext, ptr: str | None, i: int)¶: Retrieves the x and y coordinate for the point at index i.

pointZ(context: QgsPointCloudRenderContext, ptr: str | None, i: int) → float¶: Retrieves the z value for the point at index i.

redAttribute(self) → str¶

Returns the attribute to use for the red channel.

See also

greenAttribute()

See also

blueAttribute()

See also

setRedAttribute()

Return type:: str

redContrastEnhancement(self) → QgsContrastEnhancement | None¶

Returns the contrast enhancement to use for the red channel.

See also

setRedContrastEnhancement()

See also

greenContrastEnhancement()

See also

blueContrastEnhancement()

Return type:: Optional[QgsContrastEnhancement]

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

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

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

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