QGIS API Documentation  3.17.0-Master (a84647cf30)
qgsabstract3dsymbol.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsabstract3dsymbol.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 QGSABSTRACT3DSYMBOL_H
17 #define QGSABSTRACT3DSYMBOL_H
18 
19 #include "qgis_core.h"
20 #include "qgis_sip.h"
21 
22 #include "qgspropertycollection.h"
23 
24 class QDomElement;
25 class QString;
26 
28 class Qgs3DSceneExporter;
29 namespace Qt3DCore { class QEntity; } SIP_SKIP
30 
31 
45 class CORE_EXPORT QgsAbstract3DSymbol
46 {
47  public:
48  virtual ~QgsAbstract3DSymbol() = default;
49 
51  virtual QString type() const = 0;
53  virtual QgsAbstract3DSymbol *clone() const = 0 SIP_FACTORY;
54 
56  virtual void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const = 0;
58  virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) = 0;
59 
65  virtual QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const;
66 
68  enum Property
69  {
70  PropertyHeight = 0,
72  };
73 
75  static const QgsPropertiesDefinition &propertyDefinitions();
76 
78  QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
79 
81  const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } SIP_SKIP
82 
84  void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
85 
91  virtual bool exportGeometries( Qgs3DSceneExporter *exporter, Qt3DCore::QEntity *entity, const QString &objectNamePrefix ) const SIP_SKIP;
92 
93  protected:
94 
98  void copyBaseSettings( QgsAbstract3DSymbol *destination ) const;
100 
101  private:
102  static void initPropertyDefinitions();
103 
105  static QgsPropertiesDefinition sPropertyDefinitions;
106 };
107 
108 
109 #endif // QGSABSTRACT3DSYMBOL_H
The class is used as a container of context for various read/write operations on other objects...
const QgsPropertyCollection & dataDefinedProperties() const
Returns a reference to the symbol layer&#39;s property collection, used for data defined overrides...
QgsPropertyCollection mDataDefinedProperties
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the symbol layer&#39;s property collection, used for data defined overrides...
Extrusion height (zero means no extrusion)
The Qgs3DSceneExporter class Entity that handles the exporting of 3D scene.
3 Abstract base class for 3D symbols that are used by VectorLayer3DRenderer objects.
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_FACTORY
Definition: qgis_sip.h:76
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
void setDataDefinedProperties(const QgsPropertyCollection &collection)
Sets the symbol layer&#39;s property collection, used for data defined overrides.
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
Property
Data definable properties.