QGIS API Documentation  3.21.0-Master (564c892cfd)
qgsabstract3drenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsabstract3drenderer.h
3  --------------------------------------
4  Date : July 2017
5  Copyright : (C) 2017 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSABSTRACT3DRENDERER_H
17 #define QGSABSTRACT3DRENDERER_H
18 
19 #include "qgis_core.h"
20 #include "qgis_sip.h"
21 
22 #include <QString>
23 
24 class QDomElement;
25 class QgsProject;
27 class Qgs3DMapSettings;
28 
29 #ifndef SIP_RUN
30 namespace Qt3DCore
31 {
32  class QEntity;
33 }
34 #endif
35 
49 {
50  public:
51  virtual ~QgsAbstract3DRenderer() = default;
52 
54  virtual QString type() const = 0;
56  virtual QgsAbstract3DRenderer *clone() const = 0 SIP_FACTORY;
58  virtual Qt3DCore::QEntity *createEntity( const Qgs3DMapSettings &map ) const = 0 SIP_SKIP;
59 
61  virtual void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const = 0;
63  virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) = 0;
65  virtual void resolveReferences( const QgsProject &project );
66 
67  protected:
69  QgsAbstract3DRenderer() = default;
70 
71  private:
72 #ifdef SIP_RUN
74  QgsAbstract3DRenderer &operator=( const QgsAbstract3DRenderer & );
75 #endif
76 
77  Q_DISABLE_COPY( QgsAbstract3DRenderer )
78 };
79 
80 
81 #endif // QGSABSTRACT3DRENDERER_H
Base class for all renderers that may to participate in 3D view.
QgsAbstract3DRenderer()=default
Default constructor.
virtual ~QgsAbstract3DRenderer()=default
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.
virtual void readXml(const QDomElement &elem, const QgsReadWriteContext &context)=0
Reads renderer's properties from given XML element.
virtual QgsAbstract3DRenderer * clone() const =0
Returns a cloned instance.
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.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition: qgsproject.h:99
The class is used as a container of context for various read/write operations on other objects.
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_ABSTRACT
Definition: qgis_sip.h:199
#define SIP_FACTORY
Definition: qgis_sip.h:76