Class: QgsMeshRendererSettings¶

Represents all mesh renderer settings.

Note

The API is considered EXPERIMENTAL and can be changed without a notice

Added in version 3.4.

class qgis.core.QgsMeshRendererSettings[source]¶

Bases: object

__init__(): Constructs renderer with default single layer averaging method

__init__(other: QgsMeshRendererSettings)

Parameters:: other (QgsMeshRendererSettings)

activeScalarDatasetGroup(self) → int[source]¶

Returns the active scalar dataset group

Added in version 3.14.

Return type:: int

activeVectorDatasetGroup(self) → int[source]¶

Returns the active vector dataset group

Added in version 3.14.

Return type:: int

averagingMethod(self) → QgsMesh3DAveragingMethod | None[source]¶

Returns averaging method for conversion of 3d stacked mesh data to 2d data

Caller does not own the resulting pointer

Return type:: Optional[QgsMesh3DAveragingMethod]

edgeMeshSettings(self) → QgsMeshRendererMeshSettings[source]¶

Returns edge mesh renderer settings

Added in version 3.14.

Return type:: QgsMeshRendererMeshSettings

hasScalarSettings(self, groupIndex: int) → bool[source]¶

Returns whether groupIndex has existing scalar settings

Added in version 3.30.2.

Parameters:: groupIndex (int)
Return type:: bool

hasSettings(self, datasetGroupIndex: int) → bool[source]¶

Returns whether the group with index has render settings (scalar or vector)

Added in version 3.22.

Parameters:: datasetGroupIndex (int)
Return type:: bool

hasVectorSettings(self, groupIndex: int) → bool[source]¶

Returns whether groupIndex has existing vector settings

Added in version 3.30.2.

Parameters:: groupIndex (int)
Return type:: bool

nativeMeshSettings(self) → QgsMeshRendererMeshSettings[source]¶

Returns native mesh renderer settings

Return type:: QgsMeshRendererMeshSettings

readXml(self, elem: QDomElement, context: QgsReadWriteContext = QgsReadWriteContext())[source]¶

Reads configuration from the given DOM element

Parameters:

elem (QDomElement)
context (QgsReadWriteContext = QgsReadWriteContext())

removeScalarSettings(self, groupIndex: int) → bool[source]¶

Removes scalar settings with groupIndex

Added in version 3.30.2.

Parameters:: groupIndex (int)
Return type:: bool

removeVectorSettings(self, groupIndex: int) → bool[source]¶

Removes vector settings for groupIndex

Added in version 3.30.2.

Parameters:: groupIndex (int)
Return type:: bool

scalarSettings(self, groupIndex: int) → QgsMeshRendererScalarSettings[source]¶

Returns renderer settings

Parameters:: groupIndex (int)
Return type:: QgsMeshRendererScalarSettings

setActiveScalarDatasetGroup(self, activeScalarDatasetGroup: int)[source]¶

Sets the active scalar dataset group

Added in version 3.14.

Parameters:: activeScalarDatasetGroup (int)

setActiveVectorDatasetGroup(self, activeVectorDatasetGroup: int)[source]¶

Sets the active vector dataset group

Added in version 3.14.

Parameters:: activeVectorDatasetGroup (int)

setAveragingMethod(self, method: QgsMesh3DAveragingMethod | None)[source]¶

Sets averaging method for conversion of 3d stacked mesh data to 2d data

Ownership of the method is not transferred.

Parameters:: method (Optional[QgsMesh3DAveragingMethod])

setEdgeMeshSettings(self, settings: QgsMeshRendererMeshSettings)[source]¶

Sets new edge mesh renderer settings

Added in version 3.14.

Parameters:: settings (QgsMeshRendererMeshSettings)

setNativeMeshSettings(self, settings: QgsMeshRendererMeshSettings)[source]¶

Sets new native mesh renderer settings, triggers repaint

Parameters:: settings (QgsMeshRendererMeshSettings)

setScalarSettings(self, groupIndex: int, settings: QgsMeshRendererScalarSettings)[source]¶

Sets new renderer settings

Parameters:

groupIndex (int)
settings (QgsMeshRendererScalarSettings)

setTriangularMeshSettings(self, settings: QgsMeshRendererMeshSettings)[source]¶

Sets new triangular mesh renderer settings

Parameters:: settings (QgsMeshRendererMeshSettings)

setVectorSettings(self, groupIndex: int, settings: QgsMeshRendererVectorSettings)[source]¶

Sets new renderer settings

Parameters:

groupIndex (int)
settings (QgsMeshRendererVectorSettings)

triangularMeshSettings(self) → QgsMeshRendererMeshSettings[source]¶

Returns triangular mesh renderer settings

Return type:: QgsMeshRendererMeshSettings

vectorSettings(self, groupIndex: int) → QgsMeshRendererVectorSettings[source]¶

Returns renderer settings

Parameters:: groupIndex (int)
Return type:: QgsMeshRendererVectorSettings

writeXml(self, doc: QDomDocument, context: QgsReadWriteContext = QgsReadWriteContext()) → QDomElement[source]¶

Writes configuration to a new DOM element

Parameters:

doc (QDomDocument)
context (QgsReadWriteContext = QgsReadWriteContext())

Return type:

QDomElement