Class: QgsPointCloudRgbRenderer

class qgis.core.QgsPointCloudRgbRenderer

Bases: QgsPointCloudRenderer

Constructor for QgsPointCloudRgbRenderer.

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

Methods

blueAttribute

Returns the attribute to use for the blue channel.

blueContrastEnhancement

Returns the contrast enhancement to use for the blue channel.

clone

rtype

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.

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.

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.

startRender

param context

stopRender

param context

type

rtype

str

usedAttributes

param context

blueAttribute(self) → str

Returns the attribute to use for the blue channel.

See also

greenAttribute()

See also

redAttribute()

Return type

str

blueContrastEnhancement(self)QgsContrastEnhancement

Returns the contrast enhancement to use for the blue channel.

Return type

QgsContrastEnhancement

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 RGB renderer from an XML element.

Parameters
Return type

QgsPointCloudRenderer

greenAttribute(self) → str

Returns the attribute to use for the green channel.

See also

redAttribute()

See also

blueAttribute()

Return type

str

greenContrastEnhancement(self)QgsContrastEnhancement

Returns the contrast enhancement to use for the green channel.

Return type

QgsContrastEnhancement

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

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

redAttribute(self) → str

Returns the attribute to use for the red channel.

See also

greenAttribute()

See also

blueAttribute()

Return type

str

redContrastEnhancement(self)QgsContrastEnhancement

Returns the contrast enhancement to use for the red channel.

Return type

QgsContrastEnhancement

renderBlock(self, block: QgsPointCloudBlock, context: QgsPointCloudRenderContext)
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.

setBlueAttribute(self, attribute: str)

Sets the attribute to use for the blue channel.

See also

blueAttribute()

Parameters

attribute (str) –

setBlueContrastEnhancement(self, enhancement: QgsContrastEnhancement)

Sets the contrast enhancement to use for the blue channel.

Ownership of enhancement is transferred.

Parameters

enhancement (QgsContrastEnhancement) –

setGreenAttribute(self, attribute: str)

Sets the attribute to use for the green channel.

See also

greenAttribute()

Parameters

attribute (str) –

setGreenContrastEnhancement(self, enhancement: QgsContrastEnhancement)

Sets the contrast enhancement to use for the green channel.

Ownership of enhancement is transferred.

Parameters

enhancement (QgsContrastEnhancement) –

setRedAttribute(self, attribute: str)

Sets the attribute to use for the red channel.

See also

redAttribute()

Parameters

attribute (str) –

setRedContrastEnhancement(self, enhancement: QgsContrastEnhancement)

Sets the contrast enhancement to use for the red channel.

Ownership of enhancement is transferred.

Parameters

enhancement (QgsContrastEnhancement) –

startRender(self, context: QgsPointCloudRenderContext)
Parameters

context (QgsPointCloudRenderContext) –

stopRender(self, context: QgsPointCloudRenderContext)
Parameters

context (QgsPointCloudRenderContext) –

type(self) → str
Return type

str

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

context (QgsPointCloudRenderContext) –

Return type

Set[str]