Class: QgsPoint3DSymbol¶
- class qgis._3d.QgsPoint3DSymbol¶
Bases:
QgsAbstract3DSymbol
3D symbol that draws point geometries as 3D objects using one of the predefined shapes.
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.
QgsPoint3DSymbol() Constructor for
QgsPoint3DSymbol
with defaultQgsMarkerSymbol
as the billboardSymbolQgsPoint3DSymbol(other:
QgsPoint3DSymbol
) Copy Constructor for QgsPoint3DSymbolMethods
Returns method that determines altitude (whether to clamp to feature to terrain)
Returns a symbol for billboard
Returns transform for billboards
- rtype:
QgsAbstract3DSymbol
- rtype:
List[Qgis.GeometryType]
Copies base class settings from this object to a
destination
object.Creates a new QgsPoint3DSymbol.
Returns material settings used for shading of the symbol
- param elem:
Sets method that determines altitude (whether to clamp to feature to terrain)
Set symbol for billboard and the ownership is transferred
- param layer:
Sets the
material
settings used for shading of the symbol.Sets 3D shape for points
Sets a key-value dictionary of point shape properties
Sets transform for individual objects represented by the symbol
Returns 3D shape for points
Returns shape enum value from a string
Returns a key-value dictionary of point shape properties.
Returns the value for a specific shape
property
.Returns string from a shape enum value
Returns transform for individual objects represented by the symbol
- rtype:
str
- param elem:
- altitudeClamping(self) Qgis.AltitudeClamping ¶
Returns method that determines altitude (whether to clamp to feature to terrain)
- Return type:
- billboardSymbol(self) QgsMarkerSymbol ¶
Returns a symbol for billboard
- Return type:
- billboardTransform(self) QMatrix4x4 ¶
Returns transform for billboards
- Return type:
QMatrix4x4
- clone(self) QgsAbstract3DSymbol ¶
- Return type:
- compatibleGeometryTypes(self) List[Qgis.GeometryType] ¶
- Return type:
List[Qgis.GeometryType]
- copyBaseSettings(self, destination: QgsAbstract3DSymbol)¶
Copies base class settings from this object to a
destination
object.
- create() QgsAbstract3DSymbol ¶
Creates a new QgsPoint3DSymbol.
Caller takes ownership of the returned symbol.
- Return type:
- materialSettings(self) QgsAbstractMaterialSettings ¶
Returns material settings used for shading of the symbol
- Return type:
- readXml(self, elem: QDomElement, context: QgsReadWriteContext)¶
- Parameters:
elem (QDomElement) –
context (QgsReadWriteContext) –
- setAltitudeClamping(self, altClamping: Qgis.AltitudeClamping)¶
Sets method that determines altitude (whether to clamp to feature to terrain)
- Parameters:
altClamping (Qgis.AltitudeClamping) –
- setBillboardSymbol(self, symbol: QgsMarkerSymbol)¶
Set symbol for billboard and the ownership is transferred
- Parameters:
symbol (QgsMarkerSymbol) –
- setDefaultPropertiesFromLayer(self, layer: QgsVectorLayer)¶
- Parameters:
layer (QgsVectorLayer) –
- setMaterialSettings(self, materialSettings: QgsAbstractMaterialSettings)¶
Sets the
material
settings used for shading of the symbol.Ownership of
material
is transferred to the symbol.- Parameters:
materialSettings (QgsAbstractMaterialSettings) –
- setShape(self, shape: Qgis.Point3DShape)¶
Sets 3D shape for points
- Parameters:
shape (Qgis.Point3DShape) –
- setShapeProperties(self, properties: Dict[str, Any])¶
Sets a key-value dictionary of point shape properties
- Parameters:
properties (Dict[str) –
- setTransform(self, transform: QMatrix4x4)¶
Sets transform for individual objects represented by the symbol
- Parameters:
transform (QMatrix4x4) –
- shape(self) Qgis.Point3DShape ¶
Returns 3D shape for points
- Return type:
- shapeFromString(shape: str) Qgis.Point3DShape ¶
Returns shape enum value from a string
- Parameters:
shape (str) –
- Return type:
- shapeProperties(self) Dict[str, Any] ¶
Returns a key-value dictionary of point shape properties.
In most cases callers should use
shapeProperty()
instead, to correctly handle default values when a property has not been explicitly set.See also
- Return type:
Dict[str, Any]
- shapeProperty(self, property: str) Any ¶
Returns the value for a specific shape
property
.This method accounts for default property values for the symbol’s
shape()
, used when the property has not been explicitly set.New in version 3.36.
- Parameters:
property (str) –
- Return type:
Any
- shapeToString(shape: Qgis.Point3DShape) str ¶
Returns string from a shape enum value
- Parameters:
shape (Qgis.Point3DShape) –
- Return type:
str
- transform(self) QMatrix4x4 ¶
Returns transform for individual objects represented by the symbol
- Return type:
QMatrix4x4
- type(self) str ¶
- Return type:
str
- writeXml(self, elem: QDomElement, context: QgsReadWriteContext)¶
- Parameters:
elem (QDomElement) –
context (QgsReadWriteContext) –