QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsPointCloudLayer3DRenderer Class Reference
core library

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

#include <qgspointcloudlayer3drenderer.h>

Inheritance diagram for QgsPointCloudLayer3DRenderer:
Inheritance graph
[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.
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 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 120 of file qgspointcloudlayer3drenderer.cpp.

Member Function Documentation

◆ clone()

QgsPointCloudLayer3DRenderer * QgsPointCloudLayer3DRenderer::clone ( ) const
overridevirtual

Returns a cloned instance.

Implements QgsAbstract3DRenderer.

Definition at line 139 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 258 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 153 of file qgspointcloudlayer3drenderer.cpp.

◆ layer()

QgsPointCloudLayer * QgsPointCloudLayer3DRenderer::layer ( ) const

Returns point cloud layer associated with the renderer.

Definition at line 129 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 233 of file qgspointcloudlayer3drenderer.cpp.

◆ 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 201 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 228 of file qgspointcloudlayer3drenderer.cpp.

◆ setLayer()

void QgsPointCloudLayer3DRenderer::setLayer ( QgsPointCloudLayer * layer)

Sets point cloud layer associated with the renderer.

Definition at line 124 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 238 of file qgspointcloudlayer3drenderer.cpp.

◆ setPointRenderingBudget()

void QgsPointCloudLayer3DRenderer::setPointRenderingBudget ( int budget)

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

Definition at line 253 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 248 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 175 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 243 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 134 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 180 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:
Generated on for QGIS API Documentation by doxygen 1.15.0