Class: QgsMeshRendererSettings

class qgis.core.QgsMeshRendererSettings

Bases: sip.wrapper

Constructs renderer with default single layer averaging method

QgsMeshRendererSettings(QgsMeshRendererSettings)

Represents all mesh renderer settings

Note

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

Methods

activeScalarDataset

Returns active scalar dataset

activeVectorDataset

Returns active vector dataset

averagingMethod

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

nativeMeshSettings

Returns renderer settings

readXml

Reads configuration from the given DOM element

scalarSettings

Returns renderer settings

setActiveScalarDataset

Sets active scalar dataset for rendering

setActiveVectorDataset

Sets active vector dataset for rendering.

setAveragingMethod

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

setNativeMeshSettings

Sets new renderer settings, triggers repaint

setScalarSettings

Sets new renderer settings

setTriangularMeshSettings

Sets new renderer settings

setVectorSettings

Sets new renderer settings

triangularMeshSettings

Returns renderer settings

vectorSettings

Returns renderer settings

writeXml

Writes configuration to a new DOM element

activeScalarDataset(self) → QgsMeshDatasetIndex

Returns active scalar dataset

Return type

QgsMeshDatasetIndex

activeVectorDataset(self) → QgsMeshDatasetIndex

Returns active vector dataset

Return type

QgsMeshDatasetIndex

averagingMethod(self) → QgsMesh3dAveragingMethod

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

Caller does not own the resulting pointer

Return type

QgsMesh3dAveragingMethod

nativeMeshSettings(self) → QgsMeshRendererMeshSettings

Returns renderer settings

Return type

QgsMeshRendererMeshSettings

readXml(self, elem: QDomElement)

Reads configuration from the given DOM element

Parameters

elem (QDomElement) –

scalarSettings(self, groupIndex: int) → QgsMeshRendererScalarSettings

Returns renderer settings

Parameters

groupIndex (int) –

Return type

QgsMeshRendererScalarSettings

setActiveScalarDataset(self, index: QgsMeshDatasetIndex = QgsMeshDatasetIndex())

Sets active scalar dataset for rendering

Parameters

index (QgsMeshDatasetIndex = QgsMeshDatasetIndex()) –

setActiveVectorDataset(self, index: QgsMeshDatasetIndex = QgsMeshDatasetIndex())

Sets active vector dataset for rendering.

Parameters

index (QgsMeshDatasetIndex = QgsMeshDatasetIndex()) –

setAveragingMethod(self, method: QgsMesh3dAveragingMethod)

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

Ownership of the method is not transferred.

Parameters

method (QgsMesh3dAveragingMethod) –

setNativeMeshSettings(self, settings: QgsMeshRendererMeshSettings)

Sets new renderer settings, triggers repaint

Parameters

settings (QgsMeshRendererMeshSettings) –

setScalarSettings(self, groupIndex: int, settings: QgsMeshRendererScalarSettings)

Sets new renderer settings

Parameters
setTriangularMeshSettings(self, settings: QgsMeshRendererMeshSettings)

Sets new renderer settings

Parameters

settings (QgsMeshRendererMeshSettings) –

setVectorSettings(self, groupIndex: int, settings: QgsMeshRendererVectorSettings)

Sets new renderer settings

Parameters
triangularMeshSettings(self) → QgsMeshRendererMeshSettings

Returns renderer settings

Return type

QgsMeshRendererMeshSettings

vectorSettings(self, groupIndex: int) → QgsMeshRendererVectorSettings

Returns renderer settings

Parameters

groupIndex (int) –

Return type

QgsMeshRendererVectorSettings

writeXml(self, doc: QDomDocument) → QDomElement

Writes configuration to a new DOM element

Parameters

doc (QDomDocument) –

Return type

QDomElement