QgsRuleBased3DRenderer Class Reference

Rule-based 3D renderer. More...

#include <qgsrulebased3drenderer.h>

Inheritance diagram for QgsRuleBased3DRenderer:

Classes
class	Rule
	A child rule for a QgsRuleBased3DRenderer. More...

Public Types
typedef QList< QgsRuleBased3DRenderer::Rule * >	RuleList
typedef QHash< const QgsRuleBased3DRenderer::Rule *, QgsFeature3DHandler * >	RuleToHandlerMap

Public Member Functions
	QgsRuleBased3DRenderer (QgsRuleBased3DRenderer::Rule *root)
	Construct renderer with the given root rule (takes ownership).
	~QgsRuleBased3DRenderer () override
QgsRuleBased3DRenderer *	clone () const override
	Returns a cloned instance.
Qt3DCore::QEntity *	createEntity (Qgs3DMapSettings *map) const override
	Returns a 3D entity that will be used to show renderer's data in 3D scene.
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
	Reads renderer's properties from given XML element.
QgsRuleBased3DRenderer::Rule *	rootRule ()
	Returns pointer to the root rule.
const Rule *	rootRule () const
	Returns pointer to the root rule.
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.
Public Member Functions inherited from QgsAbstractVectorLayer3DRenderer
	QgsAbstractVectorLayer3DRenderer ()
QgsVectorLayer *	layer () const
	Returns vector layer associated with the renderer.
void	resolveReferences (const QgsProject &project) override
	Resolves references to other objects - second phase of loading - after readXml().
void	setLayer (QgsVectorLayer *layer)
	Sets vector layer associated with the renderer.
void	setTilingSettings (const QgsVectorLayer3DTilingSettings &settings)
	Sets tiling settings of the renderer.
QgsVectorLayer3DTilingSettings	tilingSettings () const
	Returns tiling settings of the renderer.
Public Member Functions inherited from QgsAbstract3DRenderer
virtual	~QgsAbstract3DRenderer ()=default

Additional Inherited Members
Protected Member Functions inherited from QgsAbstractVectorLayer3DRenderer
void	copyBaseProperties (QgsAbstractVectorLayer3DRenderer *r) const
	Copies common properties of this object to another object.
void	readXmlBaseProperties (const QDomElement &elem, const QgsReadWriteContext &context)
	Reads common properties of this object from DOM element.
void	writeXmlBaseProperties (QDomElement &elem, const QgsReadWriteContext &context) const
	Writes common properties of this object to DOM element.
Protected Member Functions inherited from QgsAbstract3DRenderer
	QgsAbstract3DRenderer ()=default

Detailed Description

Rule-based 3D renderer.

Similar to rule-based 2D renderer and rule-based labeling, it allows specification of rules for 3D symbols.

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.6

Definition at line 61 of file qgsrulebased3drenderer.h.

Member Typedef Documentation

RuleList

typedef QList<QgsRuleBased3DRenderer::Rule *> QgsRuleBased3DRenderer::RuleList

Definition at line 65 of file qgsrulebased3drenderer.h.

RuleToHandlerMap

typedef QHash<const QgsRuleBased3DRenderer::Rule *, QgsFeature3DHandler *> QgsRuleBased3DRenderer::RuleToHandlerMap

Definition at line 66 of file qgsrulebased3drenderer.h.

Constructor & Destructor Documentation

QgsRuleBased3DRenderer()

QgsRuleBased3DRenderer::QgsRuleBased3DRenderer

(

QgsRuleBased3DRenderer::Rule *

root

)

Construct renderer with the given root rule (takes ownership).

Definition at line 354 of file qgsrulebased3drenderer.cpp.

~QgsRuleBased3DRenderer()

QgsRuleBased3DRenderer::~QgsRuleBased3DRenderer ( )

override

Definition at line 359 of file qgsrulebased3drenderer.cpp.

Member Function Documentation

clone()

QgsRuleBased3DRenderer * QgsRuleBased3DRenderer::clone ( ) const

overridevirtual

Returns a cloned instance.

Implements QgsAbstract3DRenderer.

Definition at line 364 of file qgsrulebased3drenderer.cpp.

createEntity()

Qt3DCore::QEntity * QgsRuleBased3DRenderer::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 382 of file qgsrulebased3drenderer.cpp.

readXml()

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

overridevirtual

Reads renderer's properties from given XML element.

Implements QgsAbstract3DRenderer.

Definition at line 411 of file qgsrulebased3drenderer.cpp.

rootRule() [1/2]

QgsRuleBased3DRenderer::Rule * QgsRuleBased3DRenderer::rootRule ( )

inline

Returns pointer to the root rule.

Definition at line 301 of file qgsrulebased3drenderer.h.

rootRule() [2/2]

const Rule * QgsRuleBased3DRenderer::rootRule ( ) const

inline

Returns pointer to the root rule.

Definition at line 303 of file qgsrulebased3drenderer.h.

type()

QString QgsRuleBased3DRenderer::type ( ) const

inlineoverridevirtual

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

Implements QgsAbstract3DRenderer.

Definition at line 305 of file qgsrulebased3drenderer.h.

writeXml()

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

overridevirtual

Writes renderer's properties to given XML element.

Implements QgsAbstract3DRenderer.

Definition at line 400 of file qgsrulebased3drenderer.cpp.

---

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

• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/3d/qgsrulebased3drenderer.h
• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/3d/qgsrulebased3drenderer.cpp