3D symbol that draws point cloud geometries as 3D objects using RGB colors in the dataset. More...

#include <qgspointcloud3dsymbol.h>

Inheritance diagram for QgsRgbPointCloud3DSymbol:

[legend]

Public Member Functions
	QgsRgbPointCloud3DSymbol ()

	QgsRgbPointCloud3DSymbol (const QgsRgbPointCloud3DSymbol &other)=delete
	QgsRgbPointCloud3DSymbol cannot be copied - use clone() instead.

QString	blueAttribute () const
	Returns the attribute to use for the blue channel.

QgsContrastEnhancement *	blueContrastEnhancement ()
	Returns the contrast enhancement to use for the blue channel.

unsigned int	byteStride () override
	Returns the byte stride for the geometries used to for the vertex buffer.

QgsAbstract3DSymbol *	clone () const override SIP_FACTORY

void	fillMaterial (QgsMaterial *material) override SIP_SKIP
	Used to fill material object with necessary QParameters (and consequently opengl uniforms)

QString	greenAttribute () const
	Returns the attribute to use for the green channel.

QgsContrastEnhancement *	greenContrastEnhancement ()
	Returns the contrast enhancement to use for the green channel.

QgsRgbPointCloud3DSymbol &	operator= (const QgsRgbPointCloud3DSymbol &other)=delete
	QgsRgbPointCloud3DSymbol cannot be copied - use clone() instead.

void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override

QString	redAttribute () const
	Returns the attribute to use for the red channel.

QgsContrastEnhancement *	redContrastEnhancement ()
	Returns the contrast enhancement to use for the red channel.

void	setBlueAttribute (const QString &attribute)
	Sets the attribute to use for the blue channel.

void	setBlueContrastEnhancement (QgsContrastEnhancement *enhancement SIP_TRANSFER)
	Sets the contrast enhancement to use for the blue channel.

void	setGreenAttribute (const QString &attribute)
	Sets the attribute to use for the green channel.

void	setGreenContrastEnhancement (QgsContrastEnhancement *enhancement SIP_TRANSFER)
	Sets the contrast enhancement to use for the green channel.

void	setRedAttribute (const QString &attribute)
	Sets the attribute to use for the red channel.

void	setRedContrastEnhancement (QgsContrastEnhancement *enhancement SIP_TRANSFER)
	Sets the contrast enhancement to use for the red channel.

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 RGB colors in the dataset.

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 310 of file qgspointcloud3dsymbol.h.

Constructor & Destructor Documentation

◆ QgsRgbPointCloud3DSymbol() [1/2]

QgsRgbPointCloud3DSymbol::QgsRgbPointCloud3DSymbol ( )

Definition at line 278 of file qgspointcloud3dsymbol.cpp.

◆ QgsRgbPointCloud3DSymbol() [2/2]

QgsRgbPointCloud3DSymbol::QgsRgbPointCloud3DSymbol ( const QgsRgbPointCloud3DSymbol & other )

delete

QgsRgbPointCloud3DSymbol cannot be copied - use clone() instead.

Member Function Documentation

◆ blueAttribute()

QString QgsRgbPointCloud3DSymbol::blueAttribute ( ) const

Returns the attribute to use for the blue channel.

See also: greenAttribute(); redAttribute(); setBlueAttribute()

Definition at line 412 of file qgspointcloud3dsymbol.cpp.

◆ blueContrastEnhancement()

QgsContrastEnhancement * QgsRgbPointCloud3DSymbol::blueContrastEnhancement ( )

Returns the contrast enhancement to use for the blue channel.

See also: setBlueContrastEnhancement(); redContrastEnhancement(); greenContrastEnhancement()

Definition at line 442 of file qgspointcloud3dsymbol.cpp.

◆ byteStride()

unsigned int QgsRgbPointCloud3DSymbol::byteStride ( )

inlineoverridevirtual

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

Implements QgsPointCloud3DSymbol.

Definition at line 327 of file qgspointcloud3dsymbol.h.

◆ clone()

QgsAbstract3DSymbol * QgsRgbPointCloud3DSymbol::clone ( ) const

override

Definition at line 288 of file qgspointcloud3dsymbol.cpp.

◆ fillMaterial()

void QgsRgbPointCloud3DSymbol::fillMaterial ( QgsMaterial * material )

overridevirtual

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

Implements QgsPointCloud3DSymbol.

Definition at line 383 of file qgspointcloud3dsymbol.cpp.

◆ greenAttribute()

QString QgsRgbPointCloud3DSymbol::greenAttribute ( ) const

Returns the attribute to use for the green channel.

See also: redAttribute(); blueAttribute(); setGreenAttribute()

Definition at line 402 of file qgspointcloud3dsymbol.cpp.

◆ greenContrastEnhancement()

QgsContrastEnhancement * QgsRgbPointCloud3DSymbol::greenContrastEnhancement ( )

Returns the contrast enhancement to use for the green channel.

See also: setGreenContrastEnhancement(); redContrastEnhancement(); blueContrastEnhancement()

Definition at line 432 of file qgspointcloud3dsymbol.cpp.

◆ operator=()

QgsRgbPointCloud3DSymbol & QgsRgbPointCloud3DSymbol::operator= ( const QgsRgbPointCloud3DSymbol & other )

delete

QgsRgbPointCloud3DSymbol cannot be copied - use clone() instead.

◆ readXml()

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

override

Definition at line 344 of file qgspointcloud3dsymbol.cpp.

◆ redAttribute()

QString QgsRgbPointCloud3DSymbol::redAttribute ( ) const

Returns the attribute to use for the red channel.

See also: greenAttribute(); blueAttribute(); setRedAttribute()

Definition at line 392 of file qgspointcloud3dsymbol.cpp.

◆ redContrastEnhancement()

QgsContrastEnhancement * QgsRgbPointCloud3DSymbol::redContrastEnhancement ( )

Returns the contrast enhancement to use for the red channel.

See also: setRedContrastEnhancement(); greenContrastEnhancement(); blueContrastEnhancement()

Definition at line 422 of file qgspointcloud3dsymbol.cpp.

◆ setBlueAttribute()

void QgsRgbPointCloud3DSymbol::setBlueAttribute ( const QString & attribute )

Sets the attribute to use for the blue channel.

See also: setRedAttribute(); setGreenAttribute(); blueAttribute()

Definition at line 417 of file qgspointcloud3dsymbol.cpp.

◆ setBlueContrastEnhancement()

void QgsRgbPointCloud3DSymbol::setBlueContrastEnhancement ( QgsContrastEnhancement *enhancement SIP_TRANSFER )

Sets the contrast enhancement to use for the blue channel.

Ownership of enhancement is transferred.

See also: blueContrastEnhancement(); setRedContrastEnhancement(); setGreenContrastEnhancement()

Definition at line 447 of file qgspointcloud3dsymbol.cpp.

◆ setGreenAttribute()

void QgsRgbPointCloud3DSymbol::setGreenAttribute ( const QString & attribute )

Sets the attribute to use for the green channel.

See also: setRedAttribute(); setBlueAttribute(); greenAttribute()

Definition at line 407 of file qgspointcloud3dsymbol.cpp.

◆ setGreenContrastEnhancement()

void QgsRgbPointCloud3DSymbol::setGreenContrastEnhancement ( QgsContrastEnhancement *enhancement SIP_TRANSFER )

Sets the contrast enhancement to use for the green channel.

Ownership of enhancement is transferred.

See also: greenContrastEnhancement(); setRedContrastEnhancement(); setBlueContrastEnhancement()

Definition at line 437 of file qgspointcloud3dsymbol.cpp.

◆ setRedAttribute()

void QgsRgbPointCloud3DSymbol::setRedAttribute ( const QString & attribute )

Sets the attribute to use for the red channel.

See also: setGreenAttribute(); setBlueAttribute(); redAttribute()

Definition at line 397 of file qgspointcloud3dsymbol.cpp.

◆ setRedContrastEnhancement()

void QgsRgbPointCloud3DSymbol::setRedContrastEnhancement ( QgsContrastEnhancement *enhancement SIP_TRANSFER )

Sets the contrast enhancement to use for the red channel.

Ownership of enhancement is transferred.

See also: redContrastEnhancement(); setGreenContrastEnhancement(); setBlueContrastEnhancement()

Definition at line 427 of file qgspointcloud3dsymbol.cpp.

◆ symbolType()

QString QgsRgbPointCloud3DSymbol::symbolType ( ) const

overridevirtual

Returns a unique string identifier of the symbol type.

Implements QgsPointCloud3DSymbol.

Definition at line 283 of file qgspointcloud3dsymbol.cpp.

◆ writeXml()

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

override

Definition at line 311 of file qgspointcloud3dsymbol.cpp.

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

/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/3d/symbols/qgspointcloud3dsymbol.h
/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/3d/symbols/qgspointcloud3dsymbol.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsRgbPointCloud3DSymbol() [1/2]

◆ QgsRgbPointCloud3DSymbol() [2/2]

Member Function Documentation

◆ blueAttribute()

◆ blueContrastEnhancement()

◆ byteStride()

◆ clone()

◆ fillMaterial()

◆ greenAttribute()

◆ greenContrastEnhancement()

◆ operator=()

◆ readXml()

◆ redAttribute()

◆ redContrastEnhancement()

◆ setBlueAttribute()

◆ setBlueContrastEnhancement()

◆ setGreenAttribute()

◆ setGreenContrastEnhancement()

◆ setRedAttribute()

◆ setRedContrastEnhancement()

◆ symbolType()

◆ writeXml()