QgsAbstract3DSymbol Class Reference

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

#include <qgsabstract3dsymbol.h>

Inheritance diagram for QgsAbstract3DSymbol:

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 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
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 45 of file qgsabstract3dsymbol.h.

Member Enumeration Documentation

Property

enum QgsAbstract3DSymbol::Property

Data definable properties.

Enumerator
PropertyHeight	Height (altitude)
PropertyExtrusionHeight	Extrusion height (zero means no extrusion)

Definition at line 68 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.

compatibleGeometryTypes()

QList< QgsWkbTypes::GeometryType > QgsAbstract3DSymbol::compatibleGeometryTypes ( ) const

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()

void QgsAbstract3DSymbol::copyBaseSettings ( QgsAbstract3DSymbol *  destination ) const

protected

Copies base class settings from this object to a destination object.

Definition at line 33 of file qgsabstract3dsymbol.cpp.

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 78 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 81 of file qgsabstract3dsymbol.h.

exportGeometries()

bool QgsAbstract3DSymbol::exportGeometries ( Qgs3DSceneExporter *  exporter, Qt3DCore::QEntity *  entity, const QString &  objectNamePrefix  ) const

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()

const QgsPropertiesDefinition & QgsAbstract3DSymbol::propertyDefinitions ( )

static

Returns the symbol layer property definitions.

Definition at line 27 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.

setDataDefinedProperties()

void QgsAbstract3DSymbol::setDataDefinedProperties ( const QgsPropertyCollection &  collection )

inline

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

Definition at line 84 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.

writeXml()

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

pure virtual

Writes symbol configuration to the given DOM element.

Implemented in QgsMesh3DSymbol.

Member Data Documentation

mDataDefinedProperties

QgsPropertyCollection QgsAbstract3DSymbol::mDataDefinedProperties

protected

Definition at line 99 of file qgsabstract3dsymbol.h.

---

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

• /build/qgis-3.16.0+99unstable/src/core/3d/qgsabstract3dsymbol.h
• /build/qgis-3.16.0+99unstable/src/core/3d/qgsabstract3dsymbol.cpp