Class: QgsAbstract3DSymbol¶
- class qgis.core.QgsAbstract3DSymbol¶
Bases:
sip.wrapper
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.
Enums
Bases:
enum.IntEnum
Methods
Returns a new instance of the symbol with the same settings
Returns the list of the vector layer geometry types which are compatible with this symbol.
Copies base class settings from this object to a
destination
object.Returns a reference to the symbol layer's property collection, used for data defined overrides.
Returns the symbol layer property definitions.
Reads symbol configuration from the given DOM element
Sets the symbol layer's property collection, used for data defined overrides.
Sets default properties for the symbol based on a layer's configuration.
Returns identifier of symbol type.
Writes symbol configuration to the given DOM element
- class Property(value)¶
Bases:
enum.IntEnum
Data definable properties.
PropertyHeight
: Height (altitude)PropertyExtrusionHeight
: Extrusion height (zero means no extrusion)
- clone(self) QgsAbstract3DSymbol ¶
Returns a new instance of the symbol with the same settings
- Return type:
- compatibleGeometryTypes(self) List[Qgis.GeometryType] ¶
Returns the list of the vector layer geometry types which are compatible with this symbol.
New in version 3.16.
- Return type:
List[Qgis.GeometryType]
- copyBaseSettings(self, destination: QgsAbstract3DSymbol)¶
Copies base class settings from this object to a
destination
object.- Parameters:
destination (QgsAbstract3DSymbol) –
- dataDefinedProperties(self) QgsPropertyCollection ¶
Returns a reference to the symbol layer’s property collection, used for data defined overrides.
- Return type:
- propertyDefinitions() Dict[int, QgsPropertyDefinition] ¶
Returns the symbol layer property definitions.
- Return type:
Dict[int, QgsPropertyDefinition]
- readXml(self, elem: QDomElement, context: QgsReadWriteContext)¶
Reads symbol configuration from the given DOM element
- Parameters:
elem (QDomElement) –
context (QgsReadWriteContext) –
- setDataDefinedProperties(self, collection: QgsPropertyCollection)¶
Sets the symbol layer’s property collection, used for data defined overrides.
- Parameters:
collection (QgsPropertyCollection) –
- setDefaultPropertiesFromLayer(self, layer: QgsVectorLayer)¶
Sets default properties for the symbol based on a layer’s configuration.
New in version 3.26.
- Parameters:
layer (QgsVectorLayer) –
- type(self) str ¶
Returns identifier of symbol type. Each 3D symbol implementation should return a different type.
- Return type:
str
- writeXml(self, elem: QDomElement, context: QgsReadWriteContext)¶
Writes symbol configuration to the given DOM element
- Parameters:
elem (QDomElement) –
context (QgsReadWriteContext) –