Class: QgsPoint3DSymbol

class qgis.3d.QgsPoint3DSymbol

Bases: QgsAbstract3DSymbol

Constructor for QgsPoint3DSymbol with default QgsMarkerSymbol as the billboardSymbol

QgsPoint3DSymbol(other: QgsPoint3DSymbol) Copy Constructor for QgsPoint3DSymbol

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.

Methods

altitudeClamping

Returns method that determines altitude (whether to clamp to feature to terrain)

billboardSymbol

Returns a symbol for billboard

billboardTransform

Returns transform for billboards

clone

rtype

QgsAbstract3DSymbol

compatibleGeometryTypes

rtype

object

copyBaseSettings

Copies base class settings from this object to a destination object.

create

Creates a new QgsPoint3DSymbol.

material

Returns material used for shading of the symbol

readXml

param elem

setAltitudeClamping

Sets method that determines altitude (whether to clamp to feature to terrain)

setBillboardSymbol

Set symbol for billboard and the ownership is transferred

setMaterial

Sets the material settings used for shading of the symbol.

setShape

Sets 3D shape for points

setShapeProperties

Sets a key-value dictionary of point shape properties

setTransform

Sets transform for individual objects represented by the symbol

shape

Returns 3D shape for points

shapeFromString

Returns shape enum value from a string

shapeProperties

Returns a key-value dictionary of point shape properties

shapeToString

Returns string from a shape enum value

transform

Returns transform for individual objects represented by the symbol

type

rtype

str

writeXml

param elem

Attributes

Billboard

Cone

Cube

Cylinder

ExtrudedText

Model

Plane

Sphere

Torus

Billboard = 8
Cone = 2
Cube = 3
Cylinder = 0
ExtrudedText = 6
Model = 7
Plane = 5
class Shape

Bases: int

Sphere = 1
Torus = 4
altitudeClamping(self)Qgs3DTypes.AltitudeClamping

Returns method that determines altitude (whether to clamp to feature to terrain)

Return type

Qgs3DTypes.AltitudeClamping

billboardSymbol(self)QgsMarkerSymbol

Returns a symbol for billboard

Return type

QgsMarkerSymbol

billboardTransform(self) → QMatrix4x4

Returns transform for billboards

Return type

QMatrix4x4

clone(self)QgsAbstract3DSymbol
Return type

QgsAbstract3DSymbol

compatibleGeometryTypes(self) → object
Return type

object

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

QgsAbstract3DSymbol

material(self)QgsAbstractMaterialSettings

Returns material used for shading of the symbol

Return type

QgsAbstractMaterialSettings

readXml(self, elem: QDomElement, context: QgsReadWriteContext)
Parameters
setAltitudeClamping(self, altClamping: Qgs3DTypes.AltitudeClamping)

Sets method that determines altitude (whether to clamp to feature to terrain)

Parameters

altClamping (Qgs3DTypes.AltitudeClamping) –

setBillboardSymbol(self, symbol: QgsMarkerSymbol)

Set symbol for billboard and the ownership is transferred

Parameters

symbol (QgsMarkerSymbol) –

setMaterial(self, material: QgsAbstractMaterialSettings)

Sets the material settings used for shading of the symbol.

Ownership of material is transferred to the symbol.

Parameters

material (QgsAbstractMaterialSettings) –

setShape(self, shape: QgsPoint3DSymbol.Shape)

Sets 3D shape for points

Parameters

shape (QgsPoint3DSymbol.Shape) –

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)QgsPoint3DSymbol.Shape

Returns 3D shape for points

Return type

QgsPoint3DSymbol.Shape

shapeFromString(shape: str)QgsPoint3DSymbol.Shape

Returns shape enum value from a string

Parameters

shape (str) –

Return type

QgsPoint3DSymbol.Shape

shapeProperties(self) → Dict[str, Any]

Returns a key-value dictionary of point shape properties

Return type

Dict[str, Any]

shapeToString(shape: QgsPoint3DSymbol.Shape) → str

Returns string from a shape enum value

Parameters

shape (QgsPoint3DSymbol.Shape) –

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