Class: QgsPointCloud3DSymbol

class qgis.3d.QgsPointCloud3DSymbol

Bases: QgsAbstract3DSymbol

3D symbol that draws point cloud geometries as 3D objects.

Warning

This is not considered stable API, and may change in future QGIS releases. It is exposed to the Python bindings as a tech preview only.

New in version 3.18.

QgsPointCloud3DSymbol() Constructor for QgsPointCloud3DSymbol

QgsPointCloud3DSymbol(QgsPointCloud3DSymbol)

Methods

byteStride

Returns the byte stride for the geometries used to for the vertex buffer

copyBaseSettings

param destination

horizontalFilterThreshold

Returns the threshold horizontal size value for filtering triangles.

horizontalTriangleFilter

Returns whether triangles are filtered by horizontal size for rendering.

pointSize

Returns the point size of the point cloud

renderAsTriangles

Returns whether points are triangulated to render solid surface

setHorizontalFilterThreshold

Sets the threshold horizontal size value for filtering triangles.

setHorizontalTriangleFilter

Sets whether whether triangles are filtered by horizontal size for rendering.

setPointSize

Sets the point size

setRenderAsTriangles

Sets whether points are triangulated to render solid surface

setVerticalFilterThreshold

Sets the threshold vertical height value for filtering triangles.

setVerticalTriangleFilter

Sets whether triangles are filtered by vertical height for rendering.

symbolType

Returns a unique string identifier of the symbol type.

type

rtype

str

verticalFilterThreshold

Returns the threshold vertical height value for filtering triangles.

verticalTriangleFilter

Returns whether triangles are filtered by vertical height for rendering.

Attributes

Classification

ColorRamp

NoRendering

RgbRendering

SingleColor

Classification = 4
ColorRamp = 2
NoRendering = 0
class RenderingStyle

Bases: int

RgbRendering = 3
SingleColor = 1
byteStride(self) int

Returns the byte stride for the geometries used to for the vertex buffer

Return type

int

copyBaseSettings(self, destination: QgsAbstract3DSymbol)
Parameters

destination (QgsAbstract3DSymbol) –

horizontalFilterThreshold(self) float

Returns the threshold horizontal size value for filtering triangles. If the triangles are horizontally filtered by size, triangles with a horizontal side size greater than a threshold value will not be rendered, see horizontalTriangleFilter().

New in version 3.26.

Return type

float

horizontalTriangleFilter(self) bool

Returns whether triangles are filtered by horizontal size for rendering. If the triangles are horizontally filtered by size, triangles with a horizontal side size greater than a threshold value will not be rendered, see horizontalFilterThreshold().

New in version 3.26.

Return type

bool

pointSize(self) float

Returns the point size of the point cloud

See also

setPointSize()

Return type

float

renderAsTriangles(self) bool

Returns whether points are triangulated to render solid surface

New in version 3.26.

Return type

bool

setHorizontalFilterThreshold(self, horizontalFilterThreshold: float)

Sets the threshold horizontal size value for filtering triangles. If the triangles are horizontally filtered by size, triangles with a horizontal side size greater than a threshold value will not be rendered, see setHorizontalTriangleFilter().

New in version 3.26.

Parameters

horizontalFilterThreshold (float) –

setHorizontalTriangleFilter(self, horizontalTriangleFilter: bool)

Sets whether whether triangles are filtered by horizontal size for rendering. If the triangles are horizontally filtered by size, triangles with a horizontal side size greater than a threshold value will not be rendered, see setHorizontalFilterThreshold().

New in version 3.26.

Parameters

horizontalTriangleFilter (bool) –

setPointSize(self, size: float)

Sets the point size

See also

pointSize()

Parameters

size (float) –

setRenderAsTriangles(self, asTriangles: bool)

Sets whether points are triangulated to render solid surface

New in version 3.26.

Parameters

asTriangles (bool) –

setVerticalFilterThreshold(self, verticalFilterThreshold: float)

Sets the threshold vertical height value for filtering triangles. If the triangles are filtered vertically, triangles with a vertical height greater than this threshold value will not be rendered, see setVerticalTriangleFilter().

New in version 3.26.

Parameters

verticalFilterThreshold (float) –

setVerticalTriangleFilter(self, verticalTriangleFilter: bool)

Sets whether triangles are filtered by vertical height for rendering. If the triangles are vertically filtered, triangles with a vertical height greater than a threshold value will not be rendered, see setVerticalFilterThreshold().

New in version 3.26.

Parameters

verticalTriangleFilter (bool) –

symbolType(self) str

Returns a unique string identifier of the symbol type.

Return type

str

type(self) str
Return type

str

verticalFilterThreshold(self) float

Returns the threshold vertical height value for filtering triangles. If the triangles are filtered vertically, triangles with a vertical height greater than this threshold value will not be rendered, see verticalTriangleFilter().

New in version 3.26.

Return type

float

verticalTriangleFilter(self) bool

Returns whether triangles are filtered by vertical height for rendering. If the triangles are vertically filtered, triangles with a vertical height greater than a threshold value will not be rendered, see verticalFilterThreshold().

New in version 3.26.

Return type

bool