Class: QgsPointCloud3DSymbol¶
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.
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: byteStride()
, QgsAbstract3DSymbol.clone()
, QgsAbstract3DSymbol.readXml()
, symbolType()
, QgsAbstract3DSymbol.writeXml()
Class Hierarchy¶
Base classes¶
Abstract base class for 3D symbols that are used by VectorLayer3DRenderer objects. |
Subclasses¶
3D symbol that draws point cloud geometries as 3D objects using classification of the dataset. |
|
3D symbol that draws point cloud geometries as 3D objects using color ramp shader. |
|
3D symbol that draws point cloud geometries as 3D objects using RGB colors in the dataset. |
|
3D symbol that draws point cloud geometries as 3D objects using one color. |
Abstract Methods
Returns the byte stride for the geometries used to for the vertex buffer |
|
Returns a unique string identifier of the symbol type. |
Methods
Returns the threshold horizontal size value for filtering triangles. |
|
Returns whether triangles are filtered by horizontal size for rendering. |
|
Returns the point size of the point cloud |
|
Returns whether points are triangulated to render solid surface |
|
Sets the threshold horizontal size value for filtering triangles. |
|
Sets whether whether triangles are filtered by horizontal size for rendering. |
|
Sets the point size |
|
Sets whether points are triangulated to render solid surface |
|
Sets the threshold vertical height value for filtering triangles. |
|
Sets whether triangles are filtered by vertical height for rendering. |
|
Returns the threshold vertical height value for filtering triangles. |
|
Returns whether triangles are filtered by vertical height for rendering. |
Attributes
- class qgis._3d.QgsPointCloud3DSymbol[source]¶
Bases:
QgsAbstract3DSymbol
- Classification = 4¶
- ColorRamp = 2¶
- NoRendering = 0¶
- class RenderingStyle¶
Bases:
int
- RgbRendering = 3¶
- SingleColor = 1¶
- abstract byteStride(self) int ¶
Returns the byte stride for the geometries used to for the vertex buffer
- Return type:
int
- horizontalFilterThreshold(self) float [source]¶
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()
.Added in version 3.26.
- Return type:
float
- horizontalTriangleFilter(self) bool [source]¶
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()
.Added in version 3.26.
- Return type:
bool
- pointSize(self) float [source]¶
Returns the point size of the point cloud
See also
- Return type:
float
- renderAsTriangles(self) bool [source]¶
Returns whether points are triangulated to render solid surface
Added in version 3.26.
- Return type:
bool
- setHorizontalFilterThreshold(self, horizontalFilterThreshold: float)[source]¶
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()
.Added in version 3.26.
- Parameters:
horizontalFilterThreshold (float)
- setHorizontalTriangleFilter(self, horizontalTriangleFilter: bool)[source]¶
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()
.Added in version 3.26.
- Parameters:
horizontalTriangleFilter (bool)
- setRenderAsTriangles(self, asTriangles: bool)[source]¶
Sets whether points are triangulated to render solid surface
Added in version 3.26.
- Parameters:
asTriangles (bool)
- setVerticalFilterThreshold(self, verticalFilterThreshold: float)[source]¶
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()
.Added in version 3.26.
- Parameters:
verticalFilterThreshold (float)
- setVerticalTriangleFilter(self, verticalTriangleFilter: bool)[source]¶
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()
.Added in version 3.26.
- Parameters:
verticalTriangleFilter (bool)
- abstract symbolType(self) str [source]¶
Returns a unique string identifier of the symbol type.
- Return type:
str
- verticalFilterThreshold(self) float [source]¶
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()
.Added in version 3.26.
- Return type:
float
- verticalTriangleFilter(self) bool [source]¶
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()
.Added in version 3.26.
- Return type:
bool