#include <qgsline3dsymbol.h>

Inheritance diagram for QgsLine3DSymbol:

Public Member Functions
	QgsLine3DSymbol ()

	~QgsLine3DSymbol () override

Qgis::AltitudeBinding	altitudeBinding () const
	Returns method that determines how altitude is bound to individual vertices.

Qgis::AltitudeClamping	altitudeClamping () const
	Returns method that determines altitude (whether to clamp to feature to terrain)

QgsAbstract3DSymbol *	clone () const override SIP_FACTORY

QList< Qgis::GeometryType >	compatibleGeometryTypes () const override

bool	exportGeometries (Qgs3DSceneExporter exporter, Qt3DCore::QEntity entity, const QString &objectNamePrefix) const override SIP_SKIP
	Exports the geometries contained within the hierarchy of entity.

float	extrusionHeight () const
	Returns extrusion height (in map units)

Q_DECL_DEPRECATED float	height () const SIP_DEPRECATED
	Returns height (altitude) of the symbol (in map units)

QgsAbstractMaterialSettings *	materialSettings () const
	Returns material settings used for shading of the symbol.

float	offset () const
	Returns vertical offset of the symbol (in map units)

void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override

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

void	setAltitudeBinding (Qgis::AltitudeBinding altBinding)
	Sets method that determines how altitude is bound to individual vertices.

void	setAltitudeClamping (Qgis::AltitudeClamping altClamping)
	Sets method that determines altitude (whether to clamp to feature to terrain)

void	setDefaultPropertiesFromLayer (const QgsVectorLayer *layer) override

void	setExtrusionHeight (float extrusionHeight)
	Sets extrusion height (in map units)

Q_DECL_DEPRECATED void	setHeight (float height) SIP_DEPRECATED
	Sets height (altitude) of the symbol (in map units)

void	setMaterialSettings (QgsAbstractMaterialSettings *materialSettings SIP_TRANSFER)
	Sets the material settings used for shading of the symbol.

void	setOffset (float offset)
	Sets vertical offset of the symbol (in map units)

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

void	setWidth (float width)
	Sets width of the line symbol (in map units)

QString	type () const override

float	width () const
	Returns width of the line symbol (in map units)

void	writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override

Static Public Member Functions
static QgsAbstract3DSymbol *	create () SIP_FACTORY
	Creates a new QgsLine3DSymbol.

Detailed Description

3

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.

Definition at line 34 of file qgsline3dsymbol.h.

Constructor & Destructor Documentation

◆ QgsLine3DSymbol()

QgsLine3DSymbol::QgsLine3DSymbol ( )

Definition at line 25 of file qgsline3dsymbol.cpp.

◆ ~QgsLine3DSymbol()

QgsLine3DSymbol::~QgsLine3DSymbol ( )

overridedefault

Member Function Documentation

◆ altitudeBinding()

Qgis::AltitudeBinding QgsLine3DSymbol::altitudeBinding ( ) const

inline

Returns method that determines how altitude is bound to individual vertices.

Definition at line 62 of file qgsline3dsymbol.h.

◆ altitudeClamping()

Qgis::AltitudeClamping QgsLine3DSymbol::altitudeClamping ( ) const

inline

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

Definition at line 57 of file qgsline3dsymbol.h.

◆ clone()

QgsAbstract3DSymbol * QgsLine3DSymbol::clone ( ) const

override

Definition at line 33 of file qgsline3dsymbol.cpp.

◆ compatibleGeometryTypes()

QList< Qgis::GeometryType > QgsLine3DSymbol::compatibleGeometryTypes ( ) const

override

Definition at line 101 of file qgsline3dsymbol.cpp.

◆ create()

QgsAbstract3DSymbol * QgsLine3DSymbol::create ( )

static

Creates a new QgsLine3DSymbol.

Caller takes ownership of the returned symbol.

Definition at line 116 of file qgsline3dsymbol.cpp.

◆ exportGeometries()

bool QgsLine3DSymbol::exportGeometries	(	Qgs3DSceneExporter *	exporter,
		Qt3DCore::QEntity *	entity,
		const QString &	objectNamePrefix
	)		const

override

Exports the geometries contained within the hierarchy of entity.

Returns whether any objects were exported

Definition at line 121 of file qgsline3dsymbol.cpp.

◆ extrusionHeight()

float QgsLine3DSymbol::extrusionHeight ( ) const

inline

Returns extrusion height (in map units)

Definition at line 100 of file qgsline3dsymbol.h.

◆ height()

Q_DECL_DEPRECATED float QgsLine3DSymbol::height ( ) const

inline

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

Deprecated:: QGIS 3.36. Use offset() instead.

Definition at line 76 of file qgsline3dsymbol.h.

◆ materialSettings()

QgsAbstractMaterialSettings * QgsLine3DSymbol::materialSettings ( ) const

Returns material settings used for shading of the symbol.

Definition at line 88 of file qgsline3dsymbol.cpp.

◆ offset()

float QgsLine3DSymbol::offset ( ) const

inline

Returns vertical offset of the symbol (in map units)

Since: QGIS 3.36

Definition at line 90 of file qgsline3dsymbol.h.

◆ readXml()

void QgsLine3DSymbol::readXml	(	const QDomElement &	elem,
		const QgsReadWriteContext &	context
	)

override

Definition at line 68 of file qgsline3dsymbol.cpp.

◆ renderAsSimpleLines()

bool QgsLine3DSymbol::renderAsSimpleLines ( ) const

inline

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

Definition at line 105 of file qgsline3dsymbol.h.

◆ setAltitudeBinding()

void QgsLine3DSymbol::setAltitudeBinding ( Qgis::AltitudeBinding altBinding )

inline

Sets method that determines how altitude is bound to individual vertices.

Definition at line 64 of file qgsline3dsymbol.h.

◆ setAltitudeClamping()

void QgsLine3DSymbol::setAltitudeClamping ( Qgis::AltitudeClamping altClamping )

inline

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

Definition at line 59 of file qgsline3dsymbol.h.

◆ setDefaultPropertiesFromLayer()

void QgsLine3DSymbol::setDefaultPropertiesFromLayer ( const QgsVectorLayer * layer )

override

Definition at line 106 of file qgsline3dsymbol.cpp.

◆ setExtrusionHeight()

void QgsLine3DSymbol::setExtrusionHeight ( float extrusionHeight )

inline

Sets extrusion height (in map units)

Definition at line 102 of file qgsline3dsymbol.h.

◆ setHeight()

Q_DECL_DEPRECATED void QgsLine3DSymbol::setHeight ( float height )

inline

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

Deprecated:: QGIS 3.36. Use setOffset() instead.

Definition at line 83 of file qgsline3dsymbol.h.

◆ setMaterialSettings()

void QgsLine3DSymbol::setMaterialSettings ( QgsAbstractMaterialSettings *materialSettings SIP_TRANSFER )

Sets the material settings used for shading of the symbol.

Ownership of material is transferred to the symbol.

Definition at line 93 of file qgsline3dsymbol.cpp.

◆ setOffset()

void QgsLine3DSymbol::setOffset ( float offset )

inline

Sets vertical offset of the symbol (in map units)

Since: QGIS 3.36

Definition at line 97 of file qgsline3dsymbol.h.

◆ setRenderAsSimpleLines()

void QgsLine3DSymbol::setRenderAsSimpleLines ( bool enabled )

inline

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

Definition at line 107 of file qgsline3dsymbol.h.

◆ setWidth()

void QgsLine3DSymbol::setWidth ( float width )

inline

Sets width of the line symbol (in map units)

Definition at line 69 of file qgsline3dsymbol.h.

◆ type()

QString QgsLine3DSymbol::type ( ) const

inlineoverride

Definition at line 48 of file qgsline3dsymbol.h.

◆ width()

float QgsLine3DSymbol::width ( ) const

inline

Returns width of the line symbol (in map units)

Definition at line 67 of file qgsline3dsymbol.h.

◆ writeXml()

void QgsLine3DSymbol::writeXml	(	QDomElement &	elem,
		const QgsReadWriteContext &	context
	)		const

override

Definition at line 47 of file qgsline3dsymbol.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/3d/symbols/qgsline3dsymbol.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/3d/symbols/qgsline3dsymbol.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsLine3DSymbol()

◆ ~QgsLine3DSymbol()

Member Function Documentation

◆ altitudeBinding()

◆ altitudeClamping()

◆ clone()

◆ compatibleGeometryTypes()

◆ create()

◆ exportGeometries()

◆ extrusionHeight()

◆ height()

◆ materialSettings()

◆ offset()

◆ readXml()

◆ renderAsSimpleLines()

◆ setAltitudeBinding()

◆ setAltitudeClamping()

◆ setDefaultPropertiesFromLayer()

◆ setExtrusionHeight()

◆ setHeight()

◆ setMaterialSettings()

◆ setOffset()

◆ setRenderAsSimpleLines()

◆ setWidth()

◆ type()

◆ width()

◆ writeXml()