Class: QgsLine3DSymbol

class qgis.3d.QgsLine3DSymbol

Bases: QgsAbstract3DSymbol

Constructor for QgsLine3DSymbol

3D symbol that draws linestring geometries as planar polygons (created from lines using a buffer with given thickness).

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.

New in version 3.0:

Methods

altitudeBinding

Returns method that determines how altitude is bound to individual vertices

altitudeClamping

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

clone

rtype

QgsAbstract3DSymbol

compatibleGeometryTypes

rtype

object

copyBaseSettings

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

create

Creates a new QgsLine3DSymbol.

extrusionHeight

Returns extrusion height (in map units)

height

Returns height (altitude) of the symbol (in map units)

material

Returns material used for shading of the symbol

readXml

param elem

renderAsSimpleLines

Returns whether the renderer will render data with simple lines (otherwise it uses buffer)

setAltitudeBinding

Sets method that determines how altitude is bound to individual vertices

setAltitudeClamping

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

setExtrusionHeight

Sets extrusion height (in map units)

setHeight

Sets height (altitude) of the symbol (in map units)

setMaterial

Sets the material settings used for shading of the symbol.

setRenderAsSimpleLines

Sets whether the renderer will render data with simple lines (otherwise it uses buffer)

setWidth

Sets width of the line symbol (in map units)

type

rtype

str

width

Returns width of the line symbol (in map units)

writeXml

param elem

altitudeBinding(self) Qgs3DTypes.AltitudeBinding

Returns method that determines how altitude is bound to individual vertices

Return type

Qgs3DTypes.AltitudeBinding

altitudeClamping(self) Qgs3DTypes.AltitudeClamping

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

Return type

Qgs3DTypes.AltitudeClamping

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 QgsLine3DSymbol.

Caller takes ownership of the returned symbol.

Return type

QgsAbstract3DSymbol

extrusionHeight(self) float

Returns extrusion height (in map units)

Return type

float

height(self) float

Returns height (altitude) of the symbol (in map units)

Return type

float

material(self) QgsAbstractMaterialSettings

Returns material used for shading of the symbol

Return type

QgsAbstractMaterialSettings

readXml(self, elem: QDomElement, context: QgsReadWriteContext)
Parameters
renderAsSimpleLines(self) bool

Returns whether the renderer will render data with simple lines (otherwise it uses buffer)

Return type

bool

setAltitudeBinding(self, altBinding: Qgs3DTypes.AltitudeBinding)

Sets method that determines how altitude is bound to individual vertices

Parameters

altBinding (Qgs3DTypes.AltitudeBinding) –

setAltitudeClamping(self, altClamping: Qgs3DTypes.AltitudeClamping)

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

Parameters

altClamping (Qgs3DTypes.AltitudeClamping) –

setExtrusionHeight(self, extrusionHeight: float)

Sets extrusion height (in map units)

Parameters

extrusionHeight (float) –

setHeight(self, height: float)

Sets height (altitude) of the symbol (in map units)

Parameters

height (float) –

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) –

setRenderAsSimpleLines(self, enabled: bool)

Sets whether the renderer will render data with simple lines (otherwise it uses buffer)

Parameters

enabled (bool) –

setWidth(self, width: float)

Sets width of the line symbol (in map units)

Parameters

width (float) –

type(self) str
Return type

str

width(self) float

Returns width of the line symbol (in map units)

Return type

float

writeXml(self, elem: QDomElement, context: QgsReadWriteContext)
Parameters