QGIS API Documentation  3.8.0-Zanzibar (11aff65)
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsAbstract3DSymbol Class Referenceabstract

3 Abstract base class for 3D symbols that are used by VectorLayer3DRenderer objects. More...

#include <qgsabstract3dsymbol.h>

Inheritance diagram for QgsAbstract3DSymbol:
Inheritance graph
[legend]

Public Types

enum  Property { PropertyHeight = 0, PropertyExtrusionHeight }
 Data definable properties. More...
 

Public Member Functions

virtual ~QgsAbstract3DSymbol ()=default
 
virtual QgsAbstract3DSymbolclone () const =0
 Returns a new instance of the symbol with the same settings. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the symbol layer's property collection, used for data defined overrides. 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 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 QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. 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.
Since
QGIS 3.0

Definition at line 41 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 57 of file qgsabstract3dsymbol.h.

Constructor & Destructor Documentation

◆ ~QgsAbstract3DSymbol()

virtual QgsAbstract3DSymbol::~QgsAbstract3DSymbol ( )
virtualdefault

Member Function Documentation

◆ clone()

virtual QgsAbstract3DSymbol* QgsAbstract3DSymbol::clone ( ) const
pure virtual

Returns a new instance of the symbol with the same settings.

Implemented in QgsMesh3DSymbol, QgsPoint3DSymbol, QgsPolygon3DSymbol, and QgsLine3DSymbol.

◆ dataDefinedProperties() [1/2]

QgsPropertyCollection& QgsAbstract3DSymbol::dataDefinedProperties ( )
inline

Returns a reference to the symbol layer's property collection, used for data defined overrides.

Definition at line 67 of file qgsabstract3dsymbol.h.

◆ dataDefinedProperties() [2/2]

const QgsPropertyCollection& QgsAbstract3DSymbol::dataDefinedProperties ( ) const
inline

Returns a reference to the symbol layer's property collection, used for data defined overrides.

Definition at line 70 of file qgsabstract3dsymbol.h.

◆ propertyDefinitions()

const QgsPropertiesDefinition & QgsAbstract3DSymbol::propertyDefinitions ( )
static

Returns the symbol layer property definitions.

Definition at line 22 of file qgsabstract3dsymbol.cpp.

◆ readXml()

virtual void QgsAbstract3DSymbol::readXml ( const QDomElement &  elem,
const QgsReadWriteContext context 
)
pure virtual

Reads symbol configuration from the given DOM element.

Implemented in QgsMesh3DSymbol, QgsPoint3DSymbol, QgsPolygon3DSymbol, and QgsLine3DSymbol.

◆ setDataDefinedProperties()

void QgsAbstract3DSymbol::setDataDefinedProperties ( const QgsPropertyCollection collection)
inline

Sets the symbol layer's property collection, used for data defined overrides.

Definition at line 73 of file qgsabstract3dsymbol.h.

◆ type()

virtual QString QgsAbstract3DSymbol::type ( ) const
pure virtual

Returns identifier of symbol type. Each 3D symbol implementation should return a different type.

Implemented in QgsMesh3DSymbol, QgsPoint3DSymbol, QgsPolygon3DSymbol, and QgsLine3DSymbol.

◆ writeXml()

virtual void QgsAbstract3DSymbol::writeXml ( QDomElement &  elem,
const QgsReadWriteContext context 
) const
pure virtual

Writes symbol configuration to the given DOM element.

Implemented in QgsMesh3DSymbol, QgsPoint3DSymbol, QgsPolygon3DSymbol, and QgsLine3DSymbol.

Member Data Documentation

◆ mDataDefinedProperties

QgsPropertyCollection QgsAbstract3DSymbol::mDataDefinedProperties
protected

Definition at line 76 of file qgsabstract3dsymbol.h.


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