QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Classes | Public Types | Public Member Functions | List of all members
QgsRuleBased3DRenderer Class Reference

3 More...

#include <qgsrulebased3drenderer.h>

Inheritance diagram for QgsRuleBased3DRenderer:
Inheritance graph
[legend]

Classes

class  Rule
 3 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) More...
 
 ~QgsRuleBased3DRenderer () override
 
QgsRuleBased3DRendererclone () const override
 Returns a cloned instance. 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...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
 Reads renderer's properties from given XML element. More...
 
QgsRuleBased3DRenderer::RulerootRule ()
 Returns pointer to the root rule. More...
 
const RulerootRule () const
 Returns pointer to the root rule. 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 QgsAbstractVectorLayer3DRenderer
 QgsAbstractVectorLayer3DRenderer ()
 
QgsVectorLayerlayer () const
 Returns vector layer associated with the renderer. More...
 
void resolveReferences (const QgsProject &project) override
 Resolves references to other objects - second phase of loading - after readXml() More...
 
void setLayer (QgsVectorLayer *layer)
 Sets vector layer associated with the renderer. More...
 
void setTilingSettings (const QgsVectorLayer3DTilingSettings &settings)
 Sets tiling settings of the renderer. More...
 
QgsVectorLayer3DTilingSettings tilingSettings () const
 Returns tiling settings of the renderer. 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 QgsAbstractVectorLayer3DRenderer
void copyBaseProperties (QgsAbstractVectorLayer3DRenderer *r) const
 Copies common properties of this object to another object. More...
 
void readXmlBaseProperties (const QDomElement &elem, const QgsReadWriteContext &context)
 Reads common properties of this object from DOM element. More...
 
void writeXmlBaseProperties (QDomElement &elem, const QgsReadWriteContext &context) const
 Writes common properties of this object to DOM element. More...
 
- Protected Member Functions inherited from QgsAbstract3DRenderer
 QgsAbstract3DRenderer ()=default
 Default constructor. More...
 

Detailed Description

3

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

Definition at line 66 of file qgsrulebased3drenderer.h.

◆ RuleToHandlerMap

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

Definition at line 67 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 356 of file qgsrulebased3drenderer.cpp.

◆ ~QgsRuleBased3DRenderer()

QgsRuleBased3DRenderer::~QgsRuleBased3DRenderer ( )
override

Definition at line 361 of file qgsrulebased3drenderer.cpp.

Member Function Documentation

◆ clone()

QgsRuleBased3DRenderer * QgsRuleBased3DRenderer::clone ( ) const
overridevirtual

Returns a cloned instance.

Implements QgsAbstract3DRenderer.

Definition at line 366 of file qgsrulebased3drenderer.cpp.

◆ createEntity()

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

◆ rootRule() [1/2]

QgsRuleBased3DRenderer::Rule * QgsRuleBased3DRenderer::rootRule ( )
inline

Returns pointer to the root rule.

Definition at line 300 of file qgsrulebased3drenderer.h.

◆ rootRule() [2/2]

const Rule * QgsRuleBased3DRenderer::rootRule ( ) const
inline

Returns pointer to the root rule.

Definition at line 302 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 304 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 402 of file qgsrulebased3drenderer.cpp.


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