3D renderer that renders all points from a point cloud layer. More...

#include <qgspointcloudlayer3drenderer.h>

Inheritance diagram for QgsPointCloudLayer3DRenderer:

[legend]

Public Member Functions
	QgsPointCloudLayer3DRenderer ()
	Takes ownership of the symbol object.
QgsPointCloudLayer3DRenderer *	clone () const override
	Returns a cloned instance.
bool	convertFrom2DRenderer (QgsPointCloudRenderer *renderer) override
	Updates the 3D renderer's symbol to match that of a given QgsPointCloudRenderer.
Qt3DCore::QEntity *	createEntity (Qgs3DMapSettings *map) const override
	Returns a 3D entity that will be used to show renderer's data in 3D scene.
QgsPointCloudLayer *	layer () const
	Returns point cloud layer associated with the renderer.
double	maximumScreenError () const
	Returns the maximum screen error allowed when rendering the point cloud.
double	overviewSwitchingScale () const
	Returns the overview switching scale.
int	pointRenderingBudget () const
	Returns the maximum number of points that will be rendered to the scene.
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
	Reads renderer's properties from given XML element.
void	resolveReferences (const QgsProject &project) override
	Resolves references to other objects - second phase of loading - after readXml().
void	setLayer (QgsPointCloudLayer *layer)
	Sets point cloud layer associated with the renderer.
void	setMaximumScreenError (double error)
	Sets the maximum screen error allowed when rendering the point cloud.
void	setOverviewSwitchingScale (double scale)
	Sets the overview switching scale.
void	setPointRenderingBudget (int budget)
	Sets the maximum number of points to be rendered in the scene.
void	setShowBoundingBoxes (bool showBoundingBoxes)
	Sets whether bounding boxes will be visible when rendering the point cloud.
void	setSymbol (QgsPointCloud3DSymbol *symbol)
	Sets the 3D symbol associated with the renderer.
void	setZoomOutBehavior (const Qgis::PointCloudZoomOutRenderBehavior behavior)
	Sets the renderer behavior when zoomed out.
bool	showBoundingBoxes () const
	Returns whether bounding boxes will be visible when rendering the point cloud.
const QgsPointCloud3DSymbol *	symbol () const
	Returns 3D symbol associated with the renderer.
QString	type () const override
	Returns unique identifier of the renderer class (used to identify subclass).
void	writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
	Writes renderer's properties to given XML element.
Qgis::PointCloudZoomOutRenderBehavior	zoomOutBehavior () const
	Returns the renderer behavior when zoomed out.
Public Member Functions inherited from QgsAbstractPointCloud3DRenderer
	~QgsAbstractPointCloud3DRenderer () override=default
Public Member Functions inherited from QgsAbstract3DRenderer
virtual	~QgsAbstract3DRenderer ()=default

Additional Inherited Members
Protected Member Functions inherited from QgsAbstractPointCloud3DRenderer
	QgsAbstractPointCloud3DRenderer ()=default
Protected Member Functions inherited from QgsAbstract3DRenderer
	QgsAbstract3DRenderer ()=default

Detailed Description

3D renderer that renders all points from a point cloud layer.

Since: QGIS 3.18

Definition at line 234 of file qgspointcloudlayer3drenderer.h.

Constructor & Destructor Documentation

◆ QgsPointCloudLayer3DRenderer()

QgsPointCloudLayer3DRenderer::QgsPointCloudLayer3DRenderer ( )

explicit

Takes ownership of the symbol object.

Definition at line 124 of file qgspointcloudlayer3drenderer.cpp.

Member Function Documentation

◆ clone()

QgsPointCloudLayer3DRenderer * QgsPointCloudLayer3DRenderer::clone ( ) const

overridevirtual

Returns a cloned instance.

Implements QgsAbstract3DRenderer.

Definition at line 143 of file qgspointcloudlayer3drenderer.cpp.

◆ convertFrom2DRenderer()

bool QgsPointCloudLayer3DRenderer::convertFrom2DRenderer ( QgsPointCloudRenderer * renderer )

overridevirtual

Updates the 3D renderer's symbol to match that of a given QgsPointCloudRenderer.

Returns: true on success, false otherwise

Implements QgsAbstractPointCloud3DRenderer.

Definition at line 265 of file qgspointcloudlayer3drenderer.cpp.

◆ createEntity()

Qt3DCore::QEntity * QgsPointCloudLayer3DRenderer::createEntity ( Qgs3DMapSettings * map ) const

overridevirtual

Returns a 3D entity that will be used to show renderer's data in 3D scene.

Implements QgsAbstract3DRenderer.

Definition at line 158 of file qgspointcloudlayer3drenderer.cpp.

◆ layer()

QgsPointCloudLayer * QgsPointCloudLayer3DRenderer::layer ( ) const

Returns point cloud layer associated with the renderer.

Definition at line 133 of file qgspointcloudlayer3drenderer.cpp.

◆ maximumScreenError()

double QgsPointCloudLayer3DRenderer::maximumScreenError ( ) const

Returns the maximum screen error allowed when rendering the point cloud.

Larger values result in a faster render with less points rendered.

See also: setMaximumScreenError()

Definition at line 240 of file qgspointcloudlayer3drenderer.cpp.

◆ overviewSwitchingScale()

double QgsPointCloudLayer3DRenderer::overviewSwitchingScale ( ) const

inline

Returns the overview switching scale.

Since: QGIS 4.0

Definition at line 333 of file qgspointcloudlayer3drenderer.h.

◆ pointRenderingBudget()

int QgsPointCloudLayer3DRenderer::pointRenderingBudget ( ) const

inline

Returns the maximum number of points that will be rendered to the scene.

Definition at line 297 of file qgspointcloudlayer3drenderer.h.

◆ readXml()

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

overridevirtual

Reads renderer's properties from given XML element.

Implements QgsAbstract3DRenderer.

Definition at line 207 of file qgspointcloudlayer3drenderer.cpp.

◆ resolveReferences()

void QgsPointCloudLayer3DRenderer::resolveReferences ( const QgsProject & project )

overridevirtual

Resolves references to other objects - second phase of loading - after readXml().

Reimplemented from QgsAbstract3DRenderer.

Definition at line 235 of file qgspointcloudlayer3drenderer.cpp.

◆ setLayer()

void QgsPointCloudLayer3DRenderer::setLayer ( QgsPointCloudLayer * layer )

Sets point cloud layer associated with the renderer.

Definition at line 128 of file qgspointcloudlayer3drenderer.cpp.

◆ setMaximumScreenError()

void QgsPointCloudLayer3DRenderer::setMaximumScreenError ( double error )

Sets the maximum screen error allowed when rendering the point cloud.

Larger values result in a faster render with less points rendered.

See also: maximumScreenError()

Definition at line 245 of file qgspointcloudlayer3drenderer.cpp.

◆ setOverviewSwitchingScale()

void QgsPointCloudLayer3DRenderer::setOverviewSwitchingScale ( double scale )

inline

Sets the overview switching scale.

Used to determine when point clouds switch from rendering bounding boxes to displaying full point data. The value is compared against screen space error (SSE) calculated from camera distance and node size.

Since: QGIS 4.0

Definition at line 327 of file qgspointcloudlayer3drenderer.h.

◆ setPointRenderingBudget()

void QgsPointCloudLayer3DRenderer::setPointRenderingBudget ( int budget )

Sets the maximum number of points to be rendered in the scene.

Definition at line 260 of file qgspointcloudlayer3drenderer.cpp.

◆ setShowBoundingBoxes()

void QgsPointCloudLayer3DRenderer::setShowBoundingBoxes ( bool showBoundingBoxes )

Sets whether bounding boxes will be visible when rendering the point cloud.

See also: showBoundingBoxes()

Definition at line 255 of file qgspointcloudlayer3drenderer.cpp.

◆ setSymbol()

void QgsPointCloudLayer3DRenderer::setSymbol ( QgsPointCloud3DSymbol * symbol )

Sets the 3D symbol associated with the renderer.

Ownership of symbol is transferred to the renderer.

See also: symbol()

Definition at line 180 of file qgspointcloudlayer3drenderer.cpp.

◆ setZoomOutBehavior()

void QgsPointCloudLayer3DRenderer::setZoomOutBehavior ( const Qgis::PointCloudZoomOutRenderBehavior behavior )

inline

Sets the renderer behavior when zoomed out.

Since: QGIS 3.42

Definition at line 310 of file qgspointcloudlayer3drenderer.h.

◆ showBoundingBoxes()

bool QgsPointCloudLayer3DRenderer::showBoundingBoxes ( ) const

Returns whether bounding boxes will be visible when rendering the point cloud.

See also: setShowBoundingBoxes()

Definition at line 250 of file qgspointcloudlayer3drenderer.cpp.

◆ symbol()

const QgsPointCloud3DSymbol * QgsPointCloudLayer3DRenderer::symbol ( ) const

inline

Returns 3D symbol associated with the renderer.

Definition at line 256 of file qgspointcloudlayer3drenderer.h.

◆ type()

QString QgsPointCloudLayer3DRenderer::type ( ) const

overridevirtual

Returns unique identifier of the renderer class (used to identify subclass).

Implements QgsAbstract3DRenderer.

Definition at line 138 of file qgspointcloudlayer3drenderer.cpp.

◆ writeXml()

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

overridevirtual

Writes renderer's properties to given XML element.

Implements QgsAbstract3DRenderer.

Definition at line 185 of file qgspointcloudlayer3drenderer.cpp.

◆ zoomOutBehavior()

Qgis::PointCloudZoomOutRenderBehavior QgsPointCloudLayer3DRenderer::zoomOutBehavior ( ) const

inline

Returns the renderer behavior when zoomed out.

Since: QGIS 3.42

Definition at line 316 of file qgspointcloudlayer3drenderer.h.

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

/build/qgis-3.99.0+git20260209+8e76e220402+99sid/src/3d/qgspointcloudlayer3drenderer.h
/build/qgis-3.99.0+git20260209+8e76e220402+99sid/src/3d/qgspointcloudlayer3drenderer.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsPointCloudLayer3DRenderer()

Member Function Documentation

◆ clone()

◆ convertFrom2DRenderer()

◆ createEntity()

◆ layer()

◆ maximumScreenError()

◆ overviewSwitchingScale()

◆ pointRenderingBudget()

◆ readXml()

◆ resolveReferences()

◆ setLayer()

◆ setMaximumScreenError()

◆ setOverviewSwitchingScale()

◆ setPointRenderingBudget()

◆ setShowBoundingBoxes()

◆ setSymbol()

◆ setZoomOutBehavior()

◆ showBoundingBoxes()

◆ symbol()

◆ type()

◆ writeXml()

◆ zoomOutBehavior()