Class: QgsMesh3DSymbol¶

3D symbol that draws mesh geometry as planar triangles.

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.

Added in version 3.6.

Class Hierarchy¶

Base classes¶

QgsAbstract3DSymbol

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

Enums

`RenderingStyle`	How to render the color of the mesh
`ZValueType`	How to render the Z value of the mesh

Methods

`addBackFaces`	Returns whether also triangles facing the other side will be created.
`altitudeClamping`	Returns method that determines altitude (whether to clamp to feature to terrain)
`arrowsEnabled`	Returns if arrows are enabled for 3D rendering
`arrowsFixedSize`	Returns if the arrow size is fixed
`arrowsSpacing`	Returns the arrow spacing
`colorRampShader`	Returns the color ramp shader used to render the color
`cullingMode`	Returns culling mode
`height`	Returns height (altitude) of the symbol (in map units)
`isEnabled`	Returns if the 3d rendering is enabled
`isVerticalMagnitudeRelative`	Returns if the vertical component of the mesh is relative to the mesh vertices Z value
`levelOfDetailIndex`	Returns the index of the level of detail of the mesh that is the position of the simplified mesh that will be rendered (0 is the original mesh)
`materialSettings`	Returns material settings used for shading of the symbol
`maximumTextureSize`	Returns the maximum texture size supported by the hardware Used to store the GL_MAX_TEXTURE_SIZE value that comes from the 3D engine before creating the entity
`renderingStyle`	Returns the rendering style
`setAddBackFaces`	Sets whether also triangles facing the other side will be created.
`setAltitudeClamping`	Sets method that determines altitude (whether to clamp to feature to terrain)
`setArrowsEnabled`	Sets if arrows are enabled for 3D rendering
`setArrowsFixedSize`	Sets if the arrow size is fixed
`setArrowsSpacing`	Sets the arrow spacing
`setColorRampShader`	Sets the color ramp shader used to render the color
`setCullingMode`	Sets culling mode
`setEnabled`	Sets if the 3d rendering is enabled
`setHeight`	Sets height (altitude) of the symbol (in map units)
`setIsVerticalMagnitudeRelative`	Sets if the vertical component of the mesh is relative to the mesh vertices Z value
`setLevelOfDetailIndex`	Returns the index of the level of detail of the mesh that is the position of the simplified mesh that will be rendered (0 is the original mesh)
`setMaterialSettings`	Sets the material settings used for shading of the symbol.
`setMaximumTextureSize`	Sets the maximum texture size supported by the hardware Used to store the GL_MAX_TEXTURE_SIZE value that comes from the 3D engine before creating the entity
`setRenderingStyle`	Sets the rendering style
`setSingleMeshColor`	Sets the single color
`setSmoothedTriangles`	Sets if the mesh triangles have to been smoothed
`setVerticalDatasetGroupIndex`	Sets the index of the dataset group that will be used to render the vertical component of the 3D mesh geometry
`setVerticalScale`	Sets mesh vertical scale
`setWireframeEnabled`	Sets if the mesh wireframe
`setWireframeLineColor`	Sets wireframe line color
`setWireframeLineWidth`	Sets wireframe line width
`singleMeshColor`	Returns the single color
`smoothedTriangles`	Returns if mesh triangle are smoothed
`verticalDatasetGroupIndex`	Returns the index of the dataset group that will be used to render the vertical component of the 3D mesh geometry
`verticalScale`	Returns mesh vertical scale
`wireframeEnabled`	Returns if the mesh wireframe
`wireframeLineColor`	Returns wireframe line color
`wireframeLineWidth`	Returns wireframe line width

class qgis._3d.QgsMesh3DSymbol[source]¶

Bases: QgsAbstract3DSymbol

__init__(): Constructor for QgsMesh3DSymbol

class RenderingStyle(*values)¶

Bases: IntEnum

How to render the color of the mesh

Added in version 3.12.

SingleColor: Render the mesh with a single color
ColorRamp: Render the mesh with a color ramp
ColorRamp2DRendering: Render the mesh with the color ramp shader of the 2D rendering

ColorRamp = 1¶

ColorRamp2DRendering = 2¶

SingleColor = 0¶

class ZValueType(*values)¶

Bases: IntEnum

How to render the Z value of the mesh

Added in version 3.14.

VerticesZValue: Use the Z value of the vertices
ScalarDatasetZvalue: Use the value from a dataset (for example, water surface value)

ScalarDatasetZvalue = 1¶

VerticesZValue = 0¶

addBackFaces(self) → bool[source]¶

Returns whether also triangles facing the other side will be created. Useful if input data have inconsistent order of vertices

Return type:: bool

altitudeClamping(self) → Qgis.AltitudeClamping[source]¶

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

Return type:: Qgis.AltitudeClamping

arrowsEnabled(self) → bool[source]¶

Returns if arrows are enabled for 3D rendering

Added in version 3.14.

Return type:: bool

arrowsFixedSize(self) → bool[source]¶

Returns if the arrow size is fixed

Added in version 3.14.

Return type:: bool

arrowsSpacing(self) → float[source]¶

Returns the arrow spacing

Added in version 3.14.

Return type:: float

colorRampShader(self) → QgsColorRampShader[source]¶

Returns the color ramp shader used to render the color

Added in version 3.12.

Return type:: QgsColorRampShader

cullingMode(self) → Qgs3DTypes.CullingMode[source]¶

Returns culling mode

Added in version 3.34.

Return type:: Qgs3DTypes.CullingMode

height(self) → float[source]¶

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

Return type:: float

isEnabled(self) → bool[source]¶

Returns if the 3d rendering is enabled

Added in version 3.14.

Return type:: bool

isVerticalMagnitudeRelative(self) → bool[source]¶

Returns if the vertical component of the mesh is relative to the mesh vertices Z value

Added in version 3.14.

Return type:: bool

levelOfDetailIndex(self) → int[source]¶

Returns the index of the level of detail of the mesh that is the position of the simplified mesh that will be rendered (0 is the original mesh)