3D symbol that draws point cloud geometries as 3D objects using color ramp shader. More...

#include <qgspointcloud3dsymbol.h>

Inheritance diagram for QgsColorRampPointCloud3DSymbol:

[legend]

Public Member Functions
	QgsColorRampPointCloud3DSymbol ()
QString	attribute () const
	Returns the attribute used to select the color of the point cloud.
unsigned int	byteStride () override
	Returns the byte stride for the geometries used to for the vertex buffer.
QgsColorRampPointCloud3DSymbol *	clone () const override SIP_FACTORY
QgsColorRampShader	colorRampShader () const
	Returns the color ramp shader used to render the color.
double	colorRampShaderMax () const
	Returns the maximum value used when classifying colors in the color ramp shader.
double	colorRampShaderMin () const
	Returns the minimum value used when classifying colors in the color ramp shader.
void	fillMaterial (QgsMaterial *material) override SIP_SKIP
	Used to fill material object with necessary QParameters (and consequently opengl uniforms).
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
void	setAttribute (const QString &attribute)
	Sets the attribute used to select the color of the point cloud.
void	setColorRampShader (const QgsColorRampShader &colorRampShader)
	Sets the color ramp shader used to render the point cloud.
void	setColorRampShaderMinMax (double min, double max)
	Sets the minimum and maximum values used when classifying colors in the color ramp shader.
QString	symbolType () const override
	Returns a unique string identifier of the symbol type.
void	writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
Public Member Functions inherited from QgsPointCloud3DSymbol
	QgsPointCloud3DSymbol ()
	~QgsPointCloud3DSymbol () override
void	copyBaseSettings (QgsAbstract3DSymbol *destination) const override
float	horizontalFilterThreshold () const
	Returns the threshold horizontal size value for filtering triangles.
bool	horizontalTriangleFilter () const
	Returns whether triangles are filtered by horizontal size for rendering.
float	pointSize () const
	Returns the point size of the point cloud.
bool	renderAsTriangles () const
	Returns whether points are triangulated to render solid surface.
void	setHorizontalFilterThreshold (float horizontalFilterThreshold)
	Sets the threshold horizontal size value for filtering triangles.
void	setHorizontalTriangleFilter (bool horizontalTriangleFilter)
	Sets whether whether triangles are filtered by horizontal size for rendering.
void	setPointSize (float size)
	Sets the point size.
void	setRenderAsTriangles (bool asTriangles)
	Sets whether points are triangulated to render solid surface.
void	setVerticalFilterThreshold (float verticalFilterThreshold)
	Sets the threshold vertical height value for filtering triangles.
void	setVerticalTriangleFilter (bool verticalTriangleFilter)
	Sets whether triangles are filtered by vertical height for rendering.
QString	type () const override
float	verticalFilterThreshold () const
	Returns the threshold vertical height value for filtering triangles.
bool	verticalTriangleFilter () const
	Returns whether triangles are filtered by vertical height for rendering.

Additional Inherited Members
Public Types inherited from QgsPointCloud3DSymbol
enum	RenderingStyle { NoRendering = 0 , SingleColor , ColorRamp , RgbRendering , Classification }
	How to render the point cloud. More...
Protected Member Functions inherited from QgsPointCloud3DSymbol
void	readBaseXml (const QDomElement &elem, const QgsReadWriteContext &context)
	Reads symbol configuration of this class from the given DOM element.
void	writeBaseXml (QDomElement &elem, const QgsReadWriteContext &context) const
	Writes symbol configuration of this class to the given DOM element.
Protected Attributes inherited from QgsPointCloud3DSymbol
float	mHorizontalFilterThreshold = 10.0
bool	mHorizontalTriangleFilter = false
float	mPointSize = 3.0
bool	mRenderAsTriangles = false
float	mVerticalFilterThreshold = 10.0
bool	mVerticalTriangleFilter = false

Detailed Description

3D symbol that draws point cloud geometries as 3D objects using color ramp shader.

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.

Since: QGIS 3.18

Definition at line 236 of file qgspointcloud3dsymbol.h.

Constructor & Destructor Documentation

◆ QgsColorRampPointCloud3DSymbol()

QgsColorRampPointCloud3DSymbol::QgsColorRampPointCloud3DSymbol ( )

Definition at line 179 of file qgspointcloud3dsymbol.cpp.

Member Function Documentation

◆ attribute()

QString QgsColorRampPointCloud3DSymbol::attribute ( ) const

Returns the attribute used to select the color of the point cloud.

See also: setAttribute()

Definition at line 224 of file qgspointcloud3dsymbol.cpp.

◆ byteStride()

unsigned int QgsColorRampPointCloud3DSymbol::byteStride ( )

inlineoverridevirtual

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

Implements QgsPointCloud3DSymbol.

Definition at line 290 of file qgspointcloud3dsymbol.h.

◆ clone()

QgsColorRampPointCloud3DSymbol * QgsColorRampPointCloud3DSymbol::clone ( ) const

overridevirtual

Implements QgsPointCloud3DSymbol.

Definition at line 184 of file qgspointcloud3dsymbol.cpp.

◆ colorRampShader()

QgsColorRampShader QgsColorRampPointCloud3DSymbol::colorRampShader ( ) const

Returns the color ramp shader used to render the color.

See also: setColorRampShader( const QgsColorRampShader &colorRampShader )

Definition at line 234 of file qgspointcloud3dsymbol.cpp.

◆ colorRampShaderMax()

double QgsColorRampPointCloud3DSymbol::colorRampShaderMax ( ) const

inline

Returns the maximum value used when classifying colors in the color ramp shader.

See also: setColorRampShaderMinMax( double min, double max )

Definition at line 281 of file qgspointcloud3dsymbol.h.

◆ colorRampShaderMin()

double QgsColorRampPointCloud3DSymbol::colorRampShaderMin ( ) const

inline

Returns the minimum value used when classifying colors in the color ramp shader.

See also: setColorRampShaderMinMax( double min, double max )

Definition at line 275 of file qgspointcloud3dsymbol.h.

◆ fillMaterial()

void QgsColorRampPointCloud3DSymbol::fillMaterial ( QgsMaterial * material )

overridevirtual

Used to fill material object with necessary QParameters (and consequently opengl uniforms).

Implements QgsPointCloud3DSymbol.

Definition at line 250 of file qgspointcloud3dsymbol.cpp.

◆ readXml()

void QgsColorRampPointCloud3DSymbol::readXml	(	const QDomElement &	elem,
		const QgsReadWriteContext &	context )

override

Definition at line 213 of file qgspointcloud3dsymbol.cpp.

◆ setAttribute()

void QgsColorRampPointCloud3DSymbol::setAttribute ( const QString & attribute )

Sets the attribute used to select the color of the point cloud.

See also: attribute()

Definition at line 229 of file qgspointcloud3dsymbol.cpp.

◆ setColorRampShader()

void QgsColorRampPointCloud3DSymbol::setColorRampShader ( const QgsColorRampShader & colorRampShader )

Sets the color ramp shader used to render the point cloud.

See also: colorRampShader()

Definition at line 239 of file qgspointcloud3dsymbol.cpp.

◆ setColorRampShaderMinMax()

void QgsColorRampPointCloud3DSymbol::setColorRampShaderMinMax	(	double	min,
		double	max )

Sets the minimum and maximum values used when classifying colors in the color ramp shader.

See also: colorRampShaderMin(); colorRampShaderMax()

Definition at line 244 of file qgspointcloud3dsymbol.cpp.

◆ symbolType()

QString QgsColorRampPointCloud3DSymbol::symbolType ( ) const

overridevirtual

Returns a unique string identifier of the symbol type.

Implements QgsPointCloud3DSymbol.

Definition at line 195 of file qgspointcloud3dsymbol.cpp.

◆ writeXml()

void QgsColorRampPointCloud3DSymbol::writeXml	(	QDomElement &	elem,
		const QgsReadWriteContext &	context ) const

override

Definition at line 200 of file qgspointcloud3dsymbol.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/3d/symbols/qgspointcloud3dsymbol.h
/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/3d/symbols/qgspointcloud3dsymbol.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsColorRampPointCloud3DSymbol()

Member Function Documentation

◆ attribute()

◆ byteStride()

◆ clone()

◆ colorRampShader()

◆ colorRampShaderMax()

◆ colorRampShaderMin()

◆ fillMaterial()

◆ readXml()

◆ setAttribute()

◆ setColorRampShader()

◆ setColorRampShaderMinMax()

◆ symbolType()

◆ writeXml()