QgsAbstract3DRenderer Class Reference

Base class for all renderers that may to participate in 3D view. More...

#include <qgsabstract3drenderer.h>

Inheritance diagram for QgsAbstract3DRenderer:

Public Member Functions
virtual	~QgsAbstract3DRenderer ()=default
virtual QgsAbstract3DRenderer *	clone () const =0
	Returns a cloned instance.
virtual Qt3DCore::QEntity *	createEntity (Qgs3DMapSettings *map) const =0
	Returns a 3D entity that will be used to show renderer's data in 3D scene.
virtual void	readXml (const QDomElement &elem, const QgsReadWriteContext &context)=0
	Reads renderer's properties from given XML element.
virtual void	resolveReferences (const QgsProject &project)
	Resolves references to other objects - second phase of loading - after readXml()
virtual QString	type () const =0
	Returns unique identifier of the renderer class (used to identify subclass)
virtual void	writeXml (QDomElement &elem, const QgsReadWriteContext &context) const =0
	Writes renderer's properties to given XML element.

Protected Member Functions
	QgsAbstract3DRenderer ()=default

Detailed Description

Base class for all renderers that may to participate in 3D view.

3D renderers implement the method createEntity() that returns a new 3D entity - that entity will be added to the 3D scene to represent data in renderer's display style.

Renderers may store some custom properties (e.g. materials, sizes) that are written to and read from XML. It is therefore not recommended to store large amount of data within a renderer (e.g. arrays of vertices).

Definition at line 47 of file qgsabstract3drenderer.h.

Constructor & Destructor Documentation

~QgsAbstract3DRenderer()

virtual QgsAbstract3DRenderer::~QgsAbstract3DRenderer ( )

virtualdefault

QgsAbstract3DRenderer()

QgsAbstract3DRenderer::QgsAbstract3DRenderer ( )

protecteddefault

Member Function Documentation

clone()

virtual QgsAbstract3DRenderer * QgsAbstract3DRenderer::clone ( ) const

pure virtual

Returns a cloned instance.

Implemented in QgsMeshLayer3DRenderer, QgsPointCloudLayer3DRenderer, QgsRuleBased3DRenderer, QgsTiledSceneLayer3DRenderer, and QgsVectorLayer3DRenderer.

createEntity()

virtual Qt3DCore::QEntity * QgsAbstract3DRenderer::createEntity ( Qgs3DMapSettings *  map ) const

pure virtual

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

Implemented in QgsMeshLayer3DRenderer, QgsPointCloudLayer3DRenderer, QgsRuleBased3DRenderer, QgsTiledSceneLayer3DRenderer, and QgsVectorLayer3DRenderer.

readXml()

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

pure virtual

Reads renderer's properties from given XML element.

Implemented in QgsMeshLayer3DRenderer, QgsPointCloudLayer3DRenderer, QgsRuleBased3DRenderer, QgsTiledSceneLayer3DRenderer, and QgsVectorLayer3DRenderer.

resolveReferences()

void QgsAbstract3DRenderer::resolveReferences ( const QgsProject &  project )

virtual

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

Reimplemented in QgsAbstractVectorLayer3DRenderer, QgsMeshLayer3DRenderer, QgsPointCloudLayer3DRenderer, and QgsTiledSceneLayer3DRenderer.

Definition at line 19 of file qgsabstract3drenderer.cpp.

type()

virtual QString QgsAbstract3DRenderer::type ( ) const

pure virtual

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

Implemented in QgsMeshLayer3DRenderer, QgsPointCloudLayer3DRenderer, QgsRuleBased3DRenderer, QgsTiledSceneLayer3DRenderer, and QgsVectorLayer3DRenderer.

writeXml()

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

pure virtual

Writes renderer's properties to given XML element.

Implemented in QgsMeshLayer3DRenderer, QgsPointCloudLayer3DRenderer, QgsRuleBased3DRenderer, QgsTiledSceneLayer3DRenderer, and QgsVectorLayer3DRenderer.

---

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

• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/3d/qgsabstract3drenderer.h
• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/3d/qgsabstract3drenderer.cpp