Class: 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.

Class Hierarchy

Base classes

QgsAbstract3DSymbol

Abstract base class for 3D symbols that are used by VectorLayer3DRenderer objects.

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)
extrusionHeight	Returns extrusion height (in map units)
height	Returns height (altitude) of the symbol (in map units)
materialSettings	Returns material settings used for shading of the symbol
offset	Returns vertical offset of the symbol (in map units)
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)
setMaterialSettings	Sets the material settings used for shading of the symbol.
setOffset	Sets vertical offset of the symbol (in map units)
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)
width	Returns width of the line symbol (in map units)

Static Methods

create

Creates a new QgsLine3DSymbol.

class qgis._3d.QgsLine3DSymbol

Bases: QgsAbstract3DSymbol

altitudeBinding(self) → Qgis.AltitudeBinding

Returns method that determines how altitude is bound to individual vertices

Return type:

Qgis.AltitudeBinding

altitudeClamping(self) → Qgis.AltitudeClamping

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

Return type:

Qgis.AltitudeClamping

static create() → QgsAbstract3DSymbol | None

Creates a new QgsLine3DSymbol.

Caller takes ownership of the returned symbol.

Return type:

Optional[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)

Deprecated since version 3.36: Use offset() instead.

Return type:

float

materialSettings(self) → QgsAbstractMaterialSettings | None

Returns material settings used for shading of the symbol

Return type:

Optional[QgsAbstractMaterialSettings]

offset(self) → float

Returns vertical offset of the symbol (in map units)

Added in version 3.36.

Return type:

float

renderAsSimpleLines(self) → bool

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

Return type:

bool

setAltitudeBinding(self, altBinding: Qgis.AltitudeBinding)

Sets method that determines how altitude is bound to individual vertices

Parameters:

altBinding (Qgis.AltitudeBinding)

setAltitudeClamping(self, altClamping: Qgis.AltitudeClamping)

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

Parameters:

altClamping (Qgis.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)

Deprecated since version 3.36: Use setOffset() instead.

Parameters:

height (float)

setMaterialSettings(self, materialSettings: QgsAbstractMaterialSettings | None)

Sets the material settings used for shading of the symbol.

Ownership of material is transferred to the symbol.

Parameters:

materialSettings (Optional[QgsAbstractMaterialSettings])

setOffset(self, offset: float)

Sets vertical offset of the symbol (in map units)

Added in version 3.36.

Parameters:

offset (float)

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)

width(self) → float

Returns width of the line symbol (in map units)

Return type:

float