Class: Qgs3DSymbolRegistry¶
Registry of available 3D symbol classes.
Qgs3DSymbolRegistry is not usually directly created, but rather accessed
through QgsApplication.symbol3DRegistry()
.
Added in version 3.16.
Methods
Registers a new symbol type. |
|
Creates a new instance of a symbol of the specified type. |
|
Creates a new instance of the default 3D symbol for the specified geometry type. |
|
Returns metadata for specified symbol type. |
|
Returns a list of all available symbol types. |
- class qgis.core.Qgs3DSymbolRegistry[source]¶
Bases:
object
- addSymbolType(self, metadata: Qgs3DSymbolAbstractMetadata | None) bool [source]¶
Registers a new symbol type. Takes ownership of the
metadata
instance.- Parameters:
metadata (Optional[Qgs3DSymbolAbstractMetadata])
- Return type:
bool
- createSymbol(self, type: str | None) QgsAbstract3DSymbol | None [source]¶
Creates a new instance of a symbol of the specified
type
.The caller takes ownership of the returned symbol.
Returns
None
if the specified type is not found in the registry.- Parameters:
type (Optional[str])
- Return type:
Optional[QgsAbstract3DSymbol]
- defaultSymbolForGeometryType(self, type: Qgis.GeometryType) QgsAbstract3DSymbol | None [source]¶
Creates a new instance of the default 3D symbol for the specified geometry
type
.The caller takes ownership of the returned symbol.
- Parameters:
type (Qgis.GeometryType)
- Return type:
Optional[QgsAbstract3DSymbol]
- symbolMetadata(self, type: str | None) Qgs3DSymbolAbstractMetadata | None [source]¶
Returns metadata for specified symbol
type
. ReturnsNone
if not found- Parameters:
type (Optional[str])
- Return type:
Optional[Qgs3DSymbolAbstractMetadata]