Class: QgsMeshRendererSettings

class qgis.core.QgsMeshRendererSettings

Bases: sip.wrapper

Represents all mesh renderer settings

Note

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

New in version 3.4.

QgsMeshRendererSettings() Constructs renderer with default single layer averaging method

QgsMeshRendererSettings(QgsMeshRendererSettings)

Methods

activeScalarDatasetGroup	Returns the active scalar dataset group
activeVectorDatasetGroup	Returns the active vector dataset group
averagingMethod	Returns averaging method for conversion of 3d stacked mesh data to 2d data
edgeMeshSettings	Returns edge mesh renderer settings
hasScalarSettings	Returns whether groupIndex has existing scalar settings
hasSettings	Returns whether the group with index has render settings (scalar or vector)
hasVectorSettings	Returns whether groupIndex has existing vector settings
nativeMeshSettings	Returns native mesh renderer settings
readXml	Reads configuration from the given DOM element
removeScalarSettings	Removes scalar settings with groupIndex
removeVectorSettings	Removes vector settings for groupIndex
scalarSettings	Returns renderer settings
setActiveScalarDatasetGroup	Sets the active scalar dataset group
setActiveVectorDatasetGroup	Sets the active vector dataset group
setAveragingMethod	Sets averaging method for conversion of 3d stacked mesh data to 2d data
setEdgeMeshSettings	Sets new edge mesh renderer settings
setNativeMeshSettings	Sets new native mesh renderer settings, triggers repaint
setScalarSettings	Sets new renderer settings
setTriangularMeshSettings	Sets new triangular mesh renderer settings
setVectorSettings	Sets new renderer settings
triangularMeshSettings	Returns triangular mesh renderer settings
vectorSettings	Returns renderer settings
writeXml	Writes configuration to a new DOM element

activeScalarDatasetGroup(self) → int

Returns the active scalar dataset group

New in version 3.14.

Return type:

int

activeVectorDatasetGroup(self) → int

Returns the active vector dataset group

New in version 3.14.

Return type:

int

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

edgeMeshSettings(self) → QgsMeshRendererMeshSettings

Returns edge mesh renderer settings

New in version 3.14.

Return type:

QgsMeshRendererMeshSettings

hasScalarSettings(self, groupIndex: int) → bool

Returns whether groupIndex has existing scalar settings

New in version 3.30.2.

Parameters:

groupIndex (int) –

Return type:

bool

hasSettings(self, datasetGroupIndex: int) → bool

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

New in version 3.22.

Parameters:

datasetGroupIndex (int) –

Return type:

bool

hasVectorSettings(self, groupIndex: int) → bool

Returns whether groupIndex has existing vector settings

New in version 3.30.2.

Parameters:

groupIndex (int) –

Return type:

bool

nativeMeshSettings(self) → QgsMeshRendererMeshSettings

Returns native mesh renderer settings

Return type:

QgsMeshRendererMeshSettings

readXml(self, elem: QDomElement, context: QgsReadWriteContext = QgsReadWriteContext())

Reads configuration from the given DOM element

Parameters:

• elem (QDomElement) –

• context (QgsReadWriteContext = QgsReadWriteContext()) –

removeScalarSettings(self, groupIndex: int) → bool

Removes scalar settings with groupIndex

New in version 3.30.2.

Parameters:

groupIndex (int) –

Return type:

bool

removeVectorSettings(self, groupIndex: int) → bool

Removes vector settings for groupIndex

New in version 3.30.2.

Parameters:

groupIndex (int) –

Return type:

bool

scalarSettings(self, groupIndex: int) → QgsMeshRendererScalarSettings

Returns renderer settings

Parameters:

groupIndex (int) –

Return type:

QgsMeshRendererScalarSettings

setActiveScalarDatasetGroup(self, activeScalarDatasetGroup: int)

Sets the active scalar dataset group

New in version 3.14.

Parameters:

activeScalarDatasetGroup (int) –

setActiveVectorDatasetGroup(self, activeVectorDatasetGroup: int)

Sets the active vector dataset group

New in version 3.14.

Parameters:

activeVectorDatasetGroup (int) –

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) –

setEdgeMeshSettings(self, settings: QgsMeshRendererMeshSettings)

Sets new edge mesh renderer settings

New in version 3.14.

Parameters:

settings (QgsMeshRendererMeshSettings) –

setNativeMeshSettings(self, settings: QgsMeshRendererMeshSettings)

Sets new native mesh renderer settings, triggers repaint

Parameters:

settings (QgsMeshRendererMeshSettings) –

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

Sets new renderer settings

Parameters:

• groupIndex (int) –

• settings (QgsMeshRendererScalarSettings) –

setTriangularMeshSettings(self, settings: QgsMeshRendererMeshSettings)

Sets new triangular mesh renderer settings

Parameters:

settings (QgsMeshRendererMeshSettings) –

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

Sets new renderer settings

Parameters:

• groupIndex (int) –

• settings (QgsMeshRendererVectorSettings) –

triangularMeshSettings(self) → QgsMeshRendererMeshSettings

Returns triangular mesh renderer settings

Return type:

QgsMeshRendererMeshSettings

vectorSettings(self, groupIndex: int) → QgsMeshRendererVectorSettings

Returns renderer settings

Parameters:

groupIndex (int) –

Return type:

QgsMeshRendererVectorSettings

writeXml(self, doc: QDomDocument, context: QgsReadWriteContext = QgsReadWriteContext()) → QDomElement

Writes configuration to a new DOM element

Parameters:

• doc (QDomDocument) –

• context (QgsReadWriteContext = QgsReadWriteContext()) –

Return type:

QDomElement