3 More...
#include <qgsabstract3dsymbol.h>
Public Types | |
| enum | Property { PropertyHeight = 0 , PropertyExtrusionHeight } |
| Data definable properties. More... | |
Public Member Functions | |
| virtual | ~QgsAbstract3DSymbol ()=default |
| virtual QgsAbstract3DSymbol * | clone () const =0 |
| Returns a new instance of the symbol with the same settings. More... | |
| virtual QList< QgsWkbTypes::GeometryType > | compatibleGeometryTypes () const |
| Returns the list of the vector layer geometry types which are compatible with this symbol. More... | |
| QgsPropertyCollection & | dataDefinedProperties () |
| Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
| const QgsPropertyCollection & | dataDefinedProperties () const |
| Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
| virtual bool | exportGeometries (Qgs3DSceneExporter *exporter, Qt3DCore::QEntity *entity, const QString &objectNamePrefix) const |
| Exports the geometries contained within the hierarchy of entity. More... | |
| virtual void | readXml (const QDomElement &elem, const QgsReadWriteContext &context)=0 |
| Reads symbol configuration from the given DOM element. More... | |
| void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
| Sets the symbol layer's property collection, used for data defined overrides. More... | |
| virtual void | setDefaultPropertiesFromLayer (const QgsVectorLayer *layer) |
| Sets default properties for the symbol based on a layer's configuration. More... | |
| virtual QString | type () const =0 |
| Returns identifier of symbol type. Each 3D symbol implementation should return a different type. More... | |
| virtual void | writeXml (QDomElement &elem, const QgsReadWriteContext &context) const =0 |
| Writes symbol configuration to the given DOM element. More... | |
Static Public Member Functions | |
| static const QgsPropertiesDefinition & | propertyDefinitions () |
| Returns the symbol layer property definitions. More... | |
Protected Member Functions | |
| virtual void | copyBaseSettings (QgsAbstract3DSymbol *destination) const |
| Copies base class settings from this object to a destination object. More... | |
Protected Attributes | |
| QgsPropertyCollection | mDataDefinedProperties |
Detailed Description
3
Abstract base class for 3D symbols that are used by VectorLayer3DRenderer objects.
3D symbol objects define appearance of GIS data.
- 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.
- Note
- Prior to QGIS 3.16 this was available through the QGIS 3D library.
- Since
- QGIS 3.0
Definition at line 46 of file qgsabstract3dsymbol.h.
Member Enumeration Documentation
◆ Property
Data definable properties.
| Enumerator | |
|---|---|
| PropertyHeight | Height (altitude) |
| PropertyExtrusionHeight | Extrusion height (zero means no extrusion) |
Definition at line 69 of file qgsabstract3dsymbol.h.
Constructor & Destructor Documentation
◆ ~QgsAbstract3DSymbol()
|
virtualdefault |
Member Function Documentation
◆ clone()
|
pure virtual |
Returns a new instance of the symbol with the same settings.
Implemented in QgsMesh3DSymbol.
◆ compatibleGeometryTypes()
|
virtual |
Returns the list of the vector layer geometry types which are compatible with this symbol.
- Since
- QGIS 3.16
Definition at line 22 of file qgsabstract3dsymbol.cpp.
◆ copyBaseSettings()
|
protectedvirtual |
Copies base class settings from this object to a destination object.
Definition at line 33 of file qgsabstract3dsymbol.cpp.
◆ dataDefinedProperties() [1/2]
|
inline |
Returns a reference to the symbol layer's property collection, used for data defined overrides.
Definition at line 79 of file qgsabstract3dsymbol.h.
◆ dataDefinedProperties() [2/2]
|
inline |
Returns a reference to the symbol layer's property collection, used for data defined overrides.
Definition at line 82 of file qgsabstract3dsymbol.h.
◆ exportGeometries()
|
virtual |
Exports the geometries contained within the hierarchy of entity.
Returns whether any objects were exported If this function is not overloaded we don't try to export anything
Definition at line 53 of file qgsabstract3dsymbol.cpp.
◆ propertyDefinitions()
|
static |
Returns the symbol layer property definitions.
Definition at line 27 of file qgsabstract3dsymbol.cpp.
◆ readXml()
|
pure virtual |
Reads symbol configuration from the given DOM element.
Implemented in QgsMesh3DSymbol.
◆ setDataDefinedProperties()
|
inline |
Sets the symbol layer's property collection, used for data defined overrides.
Definition at line 85 of file qgsabstract3dsymbol.h.
◆ setDefaultPropertiesFromLayer()
|
virtual |
Sets default properties for the symbol based on a layer's configuration.
- Since
- QGIS 3.26
Definition at line 61 of file qgsabstract3dsymbol.cpp.
◆ type()
|
pure virtual |
Returns identifier of symbol type. Each 3D symbol implementation should return a different type.
Implemented in QgsMesh3DSymbol.
◆ writeXml()
|
pure virtual |
Writes symbol configuration to the given DOM element.
Implemented in QgsMesh3DSymbol.
Member Data Documentation
◆ mDataDefinedProperties
|
protected |
Definition at line 107 of file qgsabstract3dsymbol.h.
The documentation for this class was generated from the following files:
- /build/qgis-3.28.0+99sid/src/core/3d/qgsabstract3dsymbol.h
- /build/qgis-3.28.0+99sid/src/core/3d/qgsabstract3dsymbol.cpp
