Class: Qgs3DSymbolRegistry¶
- class qgis.core.Qgs3DSymbolRegistry¶
Bases:
sip.wrapper
Registry of available 3D symbol classes.
Qgs3DSymbolRegistry is not usually directly created, but rather accessed through
QgsApplication.symbol3DRegistry()
.New 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.
- addSymbolType(self, metadata: Qgs3DSymbolAbstractMetadata) bool ¶
Registers a new symbol type. Takes ownership of the
metadata
instance.- Parameters
metadata (Qgs3DSymbolAbstractMetadata) –
- Return type
bool
- createSymbol(self, type: str) QgsAbstract3DSymbol ¶
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 (str) –
- Return type
- defaultSymbolForGeometryType(self, type: QgsWkbTypes.GeometryType) QgsAbstract3DSymbol ¶
Creates a new instance of the default 3D symbol for the specified geometry
type
.The caller takes ownership of the returned symbol.
- Parameters
type (QgsWkbTypes.GeometryType) –
- Return type
- symbolMetadata(self, type: str) Qgs3DSymbolAbstractMetadata ¶
Returns metadata for specified symbol
type
. ReturnsNone
if not found- Parameters
type (str) –
- Return type
- symbolTypes(self) List[str] ¶
Returns a list of all available symbol types.
- Return type
List[str]