QGIS API Documentation 4.3.0-Master (901db8dfa85)
Loading...
Searching...
No Matches
QgsVectorLayer3DRenderer Class Reference

3D renderer that renders all features of a vector layer with the same 3D symbol. More...

#include <qgsvectorlayer3drenderer.h>

Inheritance diagram for QgsVectorLayer3DRenderer:

Public Member Functions

 QgsVectorLayer3DRenderer (QgsAbstract3DSymbol *s=nullptr)
 Takes ownership of the symbol object.
QgsVectorLayer3DRenderer * 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.
void setSymbol (QgsAbstract3DSymbol *symbol)
 Sets 3D symbol associated with the renderer. Takes ownership of the symbol.
const QgsAbstract3DSymbol * 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.
Public Member Functions inherited from QgsAbstractVectorLayer3DRenderer
 QgsAbstractVectorLayer3DRenderer ()
void copyBaseProperties (QgsAbstractVectorLayer3DRenderer *r) const
 Copies common properties of this object to another object.
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

Static Public Member Functions

static std::unique_ptr< QgsVectorLayer3DRenderer > convertFromRenderer (const QgsAbstractVectorLayer3DRenderer *renderer, QgsVectorLayer *layer=nullptr)
 Creates a new QgsVectorLayer3DRenderer from an existing renderer.

Additional Inherited Members

Protected Member Functions inherited from QgsAbstractVectorLayer3DRenderer
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

3D renderer that renders all features of a vector layer with the same 3D symbol.

The appearance is completely defined by the symbol.

Definition at line 53 of file qgsvectorlayer3drenderer.h.

Constructor & Destructor Documentation

◆ QgsVectorLayer3DRenderer()

QgsVectorLayer3DRenderer::QgsVectorLayer3DRenderer ( QgsAbstract3DSymbol * s = nullptr)
explicit

Takes ownership of the symbol object.

Definition at line 45 of file qgsvectorlayer3drenderer.cpp.

Member Function Documentation

◆ clone()

QgsVectorLayer3DRenderer * QgsVectorLayer3DRenderer::clone ( ) const
overridevirtual

Returns a cloned instance.

Implements QgsAbstract3DRenderer.

Definition at line 49 of file qgsvectorlayer3drenderer.cpp.

◆ convertFromRenderer()

std::unique_ptr< QgsVectorLayer3DRenderer > QgsVectorLayer3DRenderer::convertFromRenderer ( const QgsAbstractVectorLayer3DRenderer * renderer,
QgsVectorLayer * layer = nullptr )
static

Creates a new QgsVectorLayer3DRenderer from an existing renderer.

Returns
a new renderer if the conversion was possible, otherwise nullptr.
Since
QGIS 4.2

Definition at line 102 of file qgsvectorlayer3drenderer.cpp.

◆ createEntity()

Qt3DCore::QEntity * QgsVectorLayer3DRenderer::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 66 of file qgsvectorlayer3drenderer.cpp.

◆ readXml()

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

Reads renderer's properties from given XML element.

Implements QgsAbstract3DRenderer.

Definition at line 91 of file qgsvectorlayer3drenderer.cpp.

◆ setSymbol()

void QgsVectorLayer3DRenderer::setSymbol ( QgsAbstract3DSymbol * symbol)

Sets 3D symbol associated with the renderer. Takes ownership of the symbol.

Definition at line 56 of file qgsvectorlayer3drenderer.cpp.

◆ symbol()

const QgsAbstract3DSymbol * QgsVectorLayer3DRenderer::symbol ( ) const

Returns 3D symbol associated with the renderer.

Definition at line 61 of file qgsvectorlayer3drenderer.cpp.

◆ type()

QString QgsVectorLayer3DRenderer::type ( ) const
inlineoverridevirtual

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

Implements QgsAbstract3DRenderer.

Definition at line 64 of file qgsvectorlayer3drenderer.h.

◆ writeXml()

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

Writes renderer's properties to given XML element.

Implements QgsAbstract3DRenderer.

Definition at line 76 of file qgsvectorlayer3drenderer.cpp.


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