QGIS/python/core/auto_generated/3d/qgsabstract3dsymbol.sip.in
2024-08-13 20:28:55 +10:00

111 lines
3.3 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/./3d/qgsabstract3dsymbol.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsAbstract3DSymbol
{
%Docstring(signature="appended")
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.
%End
%TypeHeaderCode
#include "qgsabstract3dsymbol.h"
%End
public:
virtual ~QgsAbstract3DSymbol();
virtual QString type() const = 0;
%Docstring
Returns identifier of symbol type. Each 3D symbol implementation should return a different type.
%End
virtual QgsAbstract3DSymbol *clone() const = 0 /Factory/;
%Docstring
Returns a new instance of the symbol with the same settings
%End
virtual void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const = 0;
%Docstring
Writes symbol configuration to the given DOM element
%End
virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) = 0;
%Docstring
Reads symbol configuration from the given DOM element
%End
virtual QList< Qgis::GeometryType > compatibleGeometryTypes() const;
%Docstring
Returns the list of the vector layer geometry types which are compatible with this symbol.
.. versionadded:: 3.16
%End
enum class Property
{
Height,
ExtrusionHeight,
};
static const QgsPropertiesDefinition &propertyDefinitions();
%Docstring
Returns the symbol layer property definitions.
%End
QgsPropertyCollection &dataDefinedProperties();
%Docstring
Returns a reference to the symbol layer's property collection, used for data defined overrides.
%End
void setDataDefinedProperties( const QgsPropertyCollection &collection );
%Docstring
Sets the symbol layer's property collection, used for data defined overrides.
%End
virtual void setDefaultPropertiesFromLayer( const QgsVectorLayer *layer );
%Docstring
Sets default properties for the symbol based on a layer's configuration.
.. versionadded:: 3.26
%End
protected:
virtual void copyBaseSettings( QgsAbstract3DSymbol *destination ) const;
%Docstring
Copies base class settings from this object to a ``destination`` object.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/./3d/qgsabstract3dsymbol.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/