QGIS API Documentation 3.27.0-Master (95e00c50d2)
Public Member Functions | List of all members
QgsPointCloudLayer3DRenderer Class Reference

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. More...
 
QgsPointCloudLayer3DRendererclone () const override
 Returns a cloned instance. More...
 
bool convertFrom2DRenderer (QgsPointCloudRenderer *renderer) override
 Updates the 3D renderer's symbol to match that of a given QgsPointCloudRenderer. More...
 
Qt3DCore::QEntity * createEntity (const Qgs3DMapSettings &map) const override
 Returns a 3D entity that will be used to show renderer's data in 3D scene. More...
 
QgsPointCloudLayerlayer () const
 Returns point cloud layer associated with the renderer. More...
 
double maximumScreenError () const
 Returns the maximum screen error allowed when rendering the point cloud. More...
 
int pointRenderingBudget () const
 Returns the maximum number of points that will be rendered to the scene. More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
 Reads renderer's properties from given XML element. More...
 
void resolveReferences (const QgsProject &project) override
 Resolves references to other objects - second phase of loading - after readXml() More...
 
void setLayer (QgsPointCloudLayer *layer)
 Sets point cloud layer associated with the renderer. More...
 
void setMaximumScreenError (double error)
 Sets the maximum screen error allowed when rendering the point cloud. More...
 
void setPointRenderingBudget (int budget)
 Sets the maximum number of points to be rendered in the scene. More...
 
void setShowBoundingBoxes (bool showBoundingBoxes)
 Sets whether bounding boxes will be visible when rendering the point cloud. More...
 
void setSymbol (QgsPointCloud3DSymbol *symbol)
 Sets the 3D symbol associated with the renderer. More...
 
bool showBoundingBoxes () const
 Returns whether bounding boxes will be visible when rendering the point cloud. More...
 
const QgsPointCloud3DSymbolsymbol () const
 Returns 3D symbol associated with the renderer. More...
 
QString type () const override
 Returns unique identifier of the renderer class (used to identify subclass) More...
 
void writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
 Writes renderer's properties to given XML element. More...
 
- Public Member Functions inherited from QgsAbstractPointCloud3DRenderer
virtual ~QgsAbstractPointCloud3DRenderer ()=default
 Default destructor. More...
 
virtual bool convertFrom2DRenderer (QgsPointCloudRenderer *renderer)=0
 Updates the 3D renderer's symbol to match that of a given QgsPointCloudRenderer. More...
 
- Public Member Functions inherited from QgsAbstract3DRenderer
virtual ~QgsAbstract3DRenderer ()=default
 
virtual QgsAbstract3DRendererclone () const =0
 Returns a cloned instance. More...
 
virtual Qt3DCore::QEntity * createEntity (const Qgs3DMapSettings &map) const =0
 Returns a 3D entity that will be used to show renderer's data in 3D scene. More...
 
virtual void readXml (const QDomElement &elem, const QgsReadWriteContext &context)=0
 Reads renderer's properties from given XML element. More...
 
virtual void resolveReferences (const QgsProject &project)
 Resolves references to other objects - second phase of loading - after readXml() More...
 
virtual QString type () const =0
 Returns unique identifier of the renderer class (used to identify subclass) More...
 
virtual void writeXml (QDomElement &elem, const QgsReadWriteContext &context) const =0
 Writes renderer's properties to given XML element. More...
 

Additional Inherited Members

- Protected Member Functions inherited from QgsAbstractPointCloud3DRenderer
 QgsAbstractPointCloud3DRenderer ()=default
 Default constructor. More...
 
- Protected Member Functions inherited from QgsAbstract3DRenderer
 QgsAbstract3DRenderer ()=default
 Default constructor. More...
 

Detailed Description

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

Since
QGIS 3.18

Definition at line 230 of file qgspointcloudlayer3drenderer.h.

Constructor & Destructor Documentation

◆ QgsPointCloudLayer3DRenderer()

QgsPointCloudLayer3DRenderer::QgsPointCloudLayer3DRenderer ( )
explicit

Takes ownership of the symbol object.

Definition at line 96 of file qgspointcloudlayer3drenderer.cpp.

Member Function Documentation

◆ clone()

QgsPointCloudLayer3DRenderer * QgsPointCloudLayer3DRenderer::clone ( ) const
overridevirtual

Returns a cloned instance.

Implements QgsAbstract3DRenderer.

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

◆ createEntity()

Qt3DCore::QEntity * QgsPointCloudLayer3DRenderer::createEntity ( const 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 128 of file qgspointcloudlayer3drenderer.cpp.

◆ layer()

QgsPointCloudLayer * QgsPointCloudLayer3DRenderer::layer ( ) const

Returns point cloud layer associated with the renderer.

Definition at line 105 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 200 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 293 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 169 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 195 of file qgspointcloudlayer3drenderer.cpp.

◆ setLayer()

void QgsPointCloudLayer3DRenderer::setLayer ( QgsPointCloudLayer layer)

Sets point cloud layer associated with the renderer.

Definition at line 100 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 205 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 220 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 215 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 144 of file qgspointcloudlayer3drenderer.cpp.

◆ showBoundingBoxes()

bool QgsPointCloudLayer3DRenderer::showBoundingBoxes ( ) const

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

See also
setShowBoundingBoxes()

Definition at line 210 of file qgspointcloudlayer3drenderer.cpp.

◆ symbol()

const QgsPointCloud3DSymbol * QgsPointCloudLayer3DRenderer::symbol ( ) const
inline

Returns 3D symbol associated with the renderer.

Definition at line 252 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 110 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 149 of file qgspointcloudlayer3drenderer.cpp.


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