Class: QgsLine3DSymbol¶
- class qgis._3d.QgsLine3DSymbol¶
Bases:
QgsAbstract3DSymbol
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.
QgsLine3DSymbol() Constructor for QgsLine3DSymbol
Methods
Returns method that determines how altitude is bound to individual vertices
Returns method that determines altitude (whether to clamp to feature to terrain)
- rtype:
QgsAbstract3DSymbol
- rtype:
List[Qgis.GeometryType]
Copies base class settings from this object to a
destination
object.Creates a new QgsLine3DSymbol.
Returns extrusion height (in map units)
Returns height (altitude) of the symbol (in map units)
Returns material settings used for shading of the symbol
Returns vertical offset of the symbol (in map units)
- param elem:
Returns whether the renderer will render data with simple lines (otherwise it uses buffer)
Sets method that determines how altitude is bound to individual vertices
Sets method that determines altitude (whether to clamp to feature to terrain)
- param layer:
Sets extrusion height (in map units)
Sets height (altitude) of the symbol (in map units)
Sets the
material
settings used for shading of the symbol.Sets vertical offset of the symbol (in map units)
Sets whether the renderer will render data with simple lines (otherwise it uses buffer)
Sets width of the line symbol (in map units)
- rtype:
str
Returns width of the line symbol (in map units)
- param elem:
- altitudeBinding(self) Qgis.AltitudeBinding ¶
Returns method that determines how altitude is bound to individual vertices
- Return type:
- altitudeClamping(self) Qgis.AltitudeClamping ¶
Returns method that determines altitude (whether to clamp to feature to terrain)
- Return type:
- 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 QgsLine3DSymbol.
Caller takes ownership of the returned symbol.
- Return type:
- 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 QGIS: 3.36. Use
offset()
instead.- Return type:
float
- materialSettings(self) QgsAbstractMaterialSettings ¶
Returns material settings used for shading of the symbol
- Return type:
- offset(self) float ¶
Returns vertical offset of the symbol (in map units)
New in version 3.36.
- Return type:
float
- readXml(self, elem: QDomElement, context: QgsReadWriteContext)¶
- Parameters:
elem (QDomElement) –
context (QgsReadWriteContext) –
- 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) –
- setDefaultPropertiesFromLayer(self, layer: QgsVectorLayer)¶
- Parameters:
layer (QgsVectorLayer) –
- 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 QGIS: 3.36. Use
setOffset()
instead.- Parameters:
height (float) –
- 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) –
- setOffset(self, offset: float)¶
Sets vertical offset of the symbol (in map units)
New 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) –
- 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:
elem (QDomElement) –
context (QgsReadWriteContext) –