3D symbol that draws polygon geometries as planar polygons, optionally extruded (with added walls). More...

#include <qgspolygon3dsymbol.h>

Inheritance diagram for QgsPolygon3DSymbol:

Public Member Functions
	QgsPolygon3DSymbol ()
	~QgsPolygon3DSymbol () override
bool	addBackFaces () const
	Returns whether also triangles facing the other side will be created.
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
Qgs3DTypes::CullingMode	cullingMode () const
	Returns front/back culling mode.
QColor	edgeColor () const
	Returns edge lines color.
bool	edgesEnabled () const
	Returns whether edge highlighting is enabled.
float	edgeWidth () const
	Returns width of edge lines (in pixels).
bool	exportGeometries (Qgs3DSceneExporter exporter, Qt3DCore::QEntity entity, const QString &objectNamePrefix) const override SIP_SKIP
	Exports the geometries contained within the hierarchy of entity.
Qgis::ExtrusionFaces	extrusionFaces () const
	Returns the building extrusion sides to be rendered.
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).
bool	invertNormals () const
	Returns whether the normals of triangles will be inverted (useful for fixing clockwise / counter-clockwise face vertex orders).
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
Q_DECL_DEPRECATED int	renderedFacade () SIP_DEPRECATED
	Returns which facade of the buildings is rendered (0 for None, 1 for Walls, 2 for Roof, 3 for WallsAndRoof).
void	setAddBackFaces (bool add)
	Sets whether also triangles facing the other side will be created.
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	setCullingMode (Qgs3DTypes::CullingMode mode)
	Sets front/back culling mode.
void	setDefaultPropertiesFromLayer (const QgsVectorLayer *layer) override
void	setEdgeColor (const QColor &color)
	Sets edge lines color.
void	setEdgesEnabled (bool enabled)
	Sets whether edge highlighting is enabled.
void	setEdgeWidth (float width)
	Sets width of edge lines (in pixels).
void	setExtrusionFaces (Qgis::ExtrusionFaces side)
	Sets the building extrusion sides to be rendered.
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	setInvertNormals (bool invert)
	Sets whether the normals of triangles will be inverted (useful for fixing clockwise / counter-clockwise face vertex orders).
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).
Q_DECL_DEPRECATED void	setRenderedFacade (int side) SIP_DEPRECATED
	Sets which facade of the buildings is rendered (0 for None, 1 for Walls, 2 for Roof, 3 for WallsAndRoof).
QString	type () const override
void	writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override

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

Detailed Description

3D symbol that draws polygon geometries as planar polygons, optionally extruded (with added walls).

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 35 of file qgspolygon3dsymbol.h.

Constructor & Destructor Documentation

◆ QgsPolygon3DSymbol()

QgsPolygon3DSymbol::QgsPolygon3DSymbol ( )

Definition at line 29 of file qgspolygon3dsymbol.cpp.

◆ ~QgsPolygon3DSymbol()

QgsPolygon3DSymbol::~QgsPolygon3DSymbol ( )

overridedefault

Member Function Documentation

◆ addBackFaces()

bool QgsPolygon3DSymbol::addBackFaces ( ) const

inline

Returns whether also triangles facing the other side will be created.

Useful if input data have inconsistent order of vertices

Since: QGIS 3.2

Definition at line 123 of file qgspolygon3dsymbol.h.

◆ altitudeBinding()

Qgis::AltitudeBinding QgsPolygon3DSymbol::altitudeBinding ( ) const

inline

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

Definition at line 62 of file qgspolygon3dsymbol.h.

◆ altitudeClamping()

Qgis::AltitudeClamping QgsPolygon3DSymbol::altitudeClamping ( ) const

inline

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

Definition at line 57 of file qgspolygon3dsymbol.h.

◆ clone()

QgsAbstract3DSymbol * QgsPolygon3DSymbol::clone ( ) const

override

Definition at line 36 of file qgspolygon3dsymbol.cpp.

◆ compatibleGeometryTypes()

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

override

Definition at line 122 of file qgspolygon3dsymbol.cpp.

◆ create()

QgsAbstract3DSymbol * QgsPolygon3DSymbol::create ( )

static

Creates a new QgsPolygon3DSymbol.

Caller takes ownership of the returned symbol.

Definition at line 153 of file qgspolygon3dsymbol.cpp.

◆ cullingMode()

Qgs3DTypes::CullingMode QgsPolygon3DSymbol::cullingMode ( ) const

inline

Returns front/back culling mode.

Definition at line 110 of file qgspolygon3dsymbol.h.

◆ edgeColor()

QColor QgsPolygon3DSymbol::edgeColor ( ) const

inline

Returns edge lines color.

Since: QGIS 3.8

Definition at line 159 of file qgspolygon3dsymbol.h.

◆ edgesEnabled()

bool QgsPolygon3DSymbol::edgesEnabled ( ) const

inline

Returns whether edge highlighting is enabled.

Since: QGIS 3.8

Definition at line 135 of file qgspolygon3dsymbol.h.

◆ edgeWidth()

float QgsPolygon3DSymbol::edgeWidth ( ) const

inline

Returns width of edge lines (in pixels).

Since: QGIS 3.8

Definition at line 147 of file qgspolygon3dsymbol.h.

◆ exportGeometries()

bool QgsPolygon3DSymbol::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

Since: QGIS 3.16

Definition at line 171 of file qgspolygon3dsymbol.cpp.

◆ extrusionFaces()

Qgis::ExtrusionFaces QgsPolygon3DSymbol::extrusionFaces ( ) const

inline

Returns the building extrusion sides to be rendered.

Since: QGIS 4.0

Definition at line 191 of file qgspolygon3dsymbol.h.

◆ extrusionHeight()

float QgsPolygon3DSymbol::extrusionHeight ( ) const

inline

Returns extrusion height (in map units).

Definition at line 95 of file qgspolygon3dsymbol.h.

◆ height()

Q_DECL_DEPRECATED float QgsPolygon3DSymbol::height ( ) const

inline

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

Deprecated: QGIS 3.36. Use offset() instead.

Definition at line 71 of file qgspolygon3dsymbol.h.

◆ invertNormals()

bool QgsPolygon3DSymbol::invertNormals ( ) const

inline

Returns whether the normals of triangles will be inverted (useful for fixing clockwise / counter-clockwise face vertex orders).

Definition at line 115 of file qgspolygon3dsymbol.h.

◆ materialSettings()

QgsAbstractMaterialSettings * QgsPolygon3DSymbol::materialSettings ( ) const

Returns material settings used for shading of the symbol.

Definition at line 158 of file qgspolygon3dsymbol.cpp.

◆ offset()

float QgsPolygon3DSymbol::offset ( ) const

inline

Returns vertical offset of the symbol (in map units).

Since: QGIS 3.36

Definition at line 85 of file qgspolygon3dsymbol.h.

◆ readXml()

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

override

Definition at line 88 of file qgspolygon3dsymbol.cpp.

◆ renderedFacade()

int QgsPolygon3DSymbol::renderedFacade ( )

Returns which facade of the buildings is rendered (0 for None, 1 for Walls, 2 for Roof, 3 for WallsAndRoof).

Since: QGIS 3.16

Deprecated: QGIS 4.0. Use extrusionFaces() instead.

Definition at line 235 of file qgspolygon3dsymbol.cpp.

◆ setAddBackFaces()

void QgsPolygon3DSymbol::setAddBackFaces ( bool add )

inline

Sets whether also triangles facing the other side will be created.

Useful if input data have inconsistent order of vertices

Since: QGIS 3.2

Definition at line 129 of file qgspolygon3dsymbol.h.

◆ setAltitudeBinding()

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

inline

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

Definition at line 64 of file qgspolygon3dsymbol.h.

◆ setAltitudeClamping()

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

inline

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

Definition at line 59 of file qgspolygon3dsymbol.h.

◆ setCullingMode()

void QgsPolygon3DSymbol::setCullingMode ( Qgs3DTypes::CullingMode mode )

inline

Sets front/back culling mode.

Definition at line 112 of file qgspolygon3dsymbol.h.

◆ setDefaultPropertiesFromLayer()

void QgsPolygon3DSymbol::setDefaultPropertiesFromLayer ( const QgsVectorLayer * layer )

override

Definition at line 127 of file qgspolygon3dsymbol.cpp.

◆ setEdgeColor()

void QgsPolygon3DSymbol::setEdgeColor ( const QColor & color )

inline

Sets edge lines color.

Since: QGIS 3.8

Definition at line 165 of file qgspolygon3dsymbol.h.

◆ setEdgesEnabled()

void QgsPolygon3DSymbol::setEdgesEnabled ( bool enabled )

inline

Sets whether edge highlighting is enabled.

Since: QGIS 3.8

Definition at line 141 of file qgspolygon3dsymbol.h.

◆ setEdgeWidth()

void QgsPolygon3DSymbol::setEdgeWidth ( float width )

inline

Sets width of edge lines (in pixels).

Since: QGIS 3.8

Definition at line 153 of file qgspolygon3dsymbol.h.

◆ setExtrusionFaces()

void QgsPolygon3DSymbol::setExtrusionFaces ( Qgis::ExtrusionFaces side )

inline

Sets the building extrusion sides to be rendered.

Since: QGIS 4.0

Definition at line 178 of file qgspolygon3dsymbol.h.

◆ setExtrusionHeight()

void QgsPolygon3DSymbol::setExtrusionHeight ( float extrusionHeight )

inline

Sets extrusion height (in map units).

Definition at line 97 of file qgspolygon3dsymbol.h.

◆ setHeight()

Q_DECL_DEPRECATED void QgsPolygon3DSymbol::setHeight ( float height )

inline

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

Deprecated: QGIS 3.36. Use setOffset() instead.

Definition at line 78 of file qgspolygon3dsymbol.h.

◆ setInvertNormals()

void QgsPolygon3DSymbol::setInvertNormals ( bool invert )

inline

Sets whether the normals of triangles will be inverted (useful for fixing clockwise / counter-clockwise face vertex orders).

Definition at line 117 of file qgspolygon3dsymbol.h.

◆ setMaterialSettings()

void QgsPolygon3DSymbol::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 163 of file qgspolygon3dsymbol.cpp.

◆ setOffset()

void QgsPolygon3DSymbol::setOffset ( float offset )

inline

Sets vertical offset of the symbol (in map units).

Since: QGIS 3.36

Definition at line 92 of file qgspolygon3dsymbol.h.

◆ setRenderedFacade()

void QgsPolygon3DSymbol::setRenderedFacade ( int side )

Sets which facade of the buildings is rendered (0 for None, 1 for Walls, 2 for Roof, 3 for WallsAndRoof).

Since: QGIS 3.16

Deprecated: QGIS 4.0. Use setExtrusionFaces() instead.

Definition at line 211 of file qgspolygon3dsymbol.cpp.

◆ type()

QString QgsPolygon3DSymbol::type ( ) const

inlineoverride

Definition at line 41 of file qgspolygon3dsymbol.h.

◆ writeXml()

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

override

Definition at line 55 of file qgspolygon3dsymbol.cpp.

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

/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/3d/symbols/qgspolygon3dsymbol.h
/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/3d/symbols/qgspolygon3dsymbol.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsPolygon3DSymbol()

◆ ~QgsPolygon3DSymbol()

Member Function Documentation

◆ addBackFaces()

◆ altitudeBinding()

◆ altitudeClamping()

◆ clone()

◆ compatibleGeometryTypes()

◆ create()

◆ cullingMode()

◆ edgeColor()

◆ edgesEnabled()

◆ edgeWidth()

◆ exportGeometries()

◆ extrusionFaces()

◆ extrusionHeight()

◆ height()

◆ invertNormals()

◆ materialSettings()

◆ offset()

◆ readXml()

◆ renderedFacade()

◆ setAddBackFaces()

◆ setAltitudeBinding()

◆ setAltitudeClamping()

◆ setCullingMode()

◆ setDefaultPropertiesFromLayer()

◆ setEdgeColor()

◆ setEdgesEnabled()

◆ setEdgeWidth()

◆ setExtrusionFaces()

◆ setExtrusionHeight()

◆ setHeight()

◆ setInvertNormals()

◆ setMaterialSettings()

◆ setOffset()

◆ setRenderedFacade()

◆ type()

◆ writeXml()