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
Returns the active scalar dataset group
Returns the active vector dataset group
Returns averaging method for conversion of 3d stacked mesh data to 2d data
Returns edge mesh renderer settings
Returns whether
groupIndex
has existing scalar settingsReturns whether the group with
index
has render settings (scalar or vector)Returns whether
groupIndex
has existing vector settingsReturns native mesh renderer settings
Reads configuration from the given DOM element
Removes scalar settings with
groupIndex
Removes vector settings for
groupIndex
Returns renderer settings
Sets the active scalar dataset group
Sets the active vector dataset group
Sets averaging method for conversion of 3d stacked mesh data to 2d data
Sets new edge mesh renderer settings
Sets new native mesh renderer settings, triggers repaint
Sets new renderer settings
Sets new triangular mesh renderer settings
Sets new renderer settings
Returns triangular mesh renderer settings
Returns renderer settings
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:
- edgeMeshSettings(self) QgsMeshRendererMeshSettings ¶
Returns edge mesh renderer settings
New in version 3.14.
- Return type:
- hasScalarSettings(self, groupIndex: int) bool ¶
Returns whether
groupIndex
has existing scalar settingsNew 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 settingsNew in version 3.30.2.
- Parameters:
groupIndex (int) –
- Return type:
bool
- nativeMeshSettings(self) QgsMeshRendererMeshSettings ¶
Returns native mesh renderer settings
- Return type:
- 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:
- 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:
- vectorSettings(self, groupIndex: int) QgsMeshRendererVectorSettings ¶
Returns renderer settings
- Parameters:
groupIndex (int) –
- Return type:
- writeXml(self, doc: QDomDocument, context: QgsReadWriteContext = QgsReadWriteContext()) QDomElement ¶
Writes configuration to a new DOM element
- Parameters:
doc (QDomDocument) –
context (
QgsReadWriteContext
= QgsReadWriteContext()) –
- Return type:
QDomElement