QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | List of all members
QgsMeshRendererSettings Class Reference

Represents all mesh renderer settings. More...

#include <qgsmeshrenderersettings.h>

Public Member Functions

 QgsMeshRendererSettings ()
 Constructs renderer with default single layer averaging method. More...
 
 ~QgsMeshRendererSettings ()
 Destructor. More...
 
int activeScalarDatasetGroup () const
 Returns the active scalar dataset group. More...
 
int activeVectorDatasetGroup () const
 Returns the active vector dataset group. More...
 
QgsMesh3dAveragingMethodaveragingMethod () const
 Returns averaging method for conversion of 3d stacked mesh data to 2d data. More...
 
QgsMeshRendererMeshSettings edgeMeshSettings () const
 Returns edge mesh renderer settings. More...
 
QgsMeshRendererMeshSettings nativeMeshSettings () const
 Returns native mesh renderer settings. More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context=QgsReadWriteContext())
 Reads configuration from the given DOM element. More...
 
QgsMeshRendererScalarSettings scalarSettings (int groupIndex) const
 Returns renderer settings. More...
 
void setActiveScalarDatasetGroup (int activeScalarDatasetGroup)
 Sets the active scalar dataset group. More...
 
void setActiveVectorDatasetGroup (int activeVectorDatasetGroup)
 Sets the active vector dataset group. More...
 
void setAveragingMethod (QgsMesh3dAveragingMethod *method)
 Sets averaging method for conversion of 3d stacked mesh data to 2d data. More...
 
void setEdgeMeshSettings (const QgsMeshRendererMeshSettings &settings)
 Sets new edge mesh renderer settings. More...
 
void setNativeMeshSettings (const QgsMeshRendererMeshSettings &settings)
 Sets new native mesh renderer settings, triggers repaint. More...
 
void setScalarSettings (int groupIndex, const QgsMeshRendererScalarSettings &settings)
 Sets new renderer settings. More...
 
void setTriangularMeshSettings (const QgsMeshRendererMeshSettings &settings)
 Sets new triangular mesh renderer settings. More...
 
void setVectorSettings (int groupIndex, const QgsMeshRendererVectorSettings &settings)
 Sets new renderer settings. More...
 
QgsMeshRendererMeshSettings triangularMeshSettings () const
 Returns triangular mesh renderer settings. More...
 
QgsMeshRendererVectorSettings vectorSettings (int groupIndex) const
 Returns renderer settings. More...
 
QDomElement writeXml (QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext()) const
 Writes configuration to a new DOM element. More...
 

Detailed Description

Represents all mesh renderer settings.

Note
The API is considered EXPERIMENTAL and can be changed without a notice
Since
QGIS 3.4

Definition at line 590 of file qgsmeshrenderersettings.h.

Constructor & Destructor Documentation

◆ QgsMeshRendererSettings()

QgsMeshRendererSettings::QgsMeshRendererSettings ( )

Constructs renderer with default single layer averaging method.

Definition at line 387 of file qgsmeshrenderersettings.cpp.

◆ ~QgsMeshRendererSettings()

QgsMeshRendererSettings::~QgsMeshRendererSettings ( )
default

Destructor.

Member Function Documentation

◆ activeScalarDatasetGroup()

int QgsMeshRendererSettings::activeScalarDatasetGroup ( ) const

Returns the active scalar dataset group.

Since
QGIS 3.14

Definition at line 507 of file qgsmeshrenderersettings.cpp.

◆ activeVectorDatasetGroup()

int QgsMeshRendererSettings::activeVectorDatasetGroup ( ) const

Returns the active vector dataset group.

Since
QGIS 3.14

Definition at line 517 of file qgsmeshrenderersettings.cpp.

◆ averagingMethod()

QgsMesh3dAveragingMethod * QgsMeshRendererSettings::averagingMethod ( ) const

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

Caller does not own the resulting pointer

Definition at line 394 of file qgsmeshrenderersettings.cpp.

◆ edgeMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::edgeMeshSettings ( ) const
inline

Returns edge mesh renderer settings.

Since
QGIS 3.14

Definition at line 615 of file qgsmeshrenderersettings.h.

◆ nativeMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::nativeMeshSettings ( ) const
inline

Returns native mesh renderer settings.

Definition at line 602 of file qgsmeshrenderersettings.h.

◆ readXml()

void QgsMeshRendererSettings::readXml ( const QDomElement &  elem,
const QgsReadWriteContext context = QgsReadWriteContext() 
)

Reads configuration from the given DOM element.

Definition at line 456 of file qgsmeshrenderersettings.cpp.

◆ scalarSettings()

QgsMeshRendererScalarSettings QgsMeshRendererSettings::scalarSettings ( int  groupIndex) const
inline

Returns renderer settings.

Definition at line 624 of file qgsmeshrenderersettings.h.

◆ setActiveScalarDatasetGroup()

void QgsMeshRendererSettings::setActiveScalarDatasetGroup ( int  activeScalarDatasetGroup)

Sets the active scalar dataset group.

Since
QGIS 3.14

Definition at line 512 of file qgsmeshrenderersettings.cpp.

◆ setActiveVectorDatasetGroup()

void QgsMeshRendererSettings::setActiveVectorDatasetGroup ( int  activeVectorDatasetGroup)

Sets the active vector dataset group.

Since
QGIS 3.14

Definition at line 522 of file qgsmeshrenderersettings.cpp.

◆ setAveragingMethod()

void QgsMeshRendererSettings::setAveragingMethod ( QgsMesh3dAveragingMethod method)

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

Ownership of the method is not transferred.

Definition at line 399 of file qgsmeshrenderersettings.cpp.

◆ setEdgeMeshSettings()

void QgsMeshRendererSettings::setEdgeMeshSettings ( const QgsMeshRendererMeshSettings settings)
inline

Sets new edge mesh renderer settings.

Since
QGIS 3.14

Definition at line 621 of file qgsmeshrenderersettings.h.

◆ setNativeMeshSettings()

void QgsMeshRendererSettings::setNativeMeshSettings ( const QgsMeshRendererMeshSettings settings)
inline

Sets new native mesh renderer settings, triggers repaint.

Definition at line 604 of file qgsmeshrenderersettings.h.

◆ setScalarSettings()

void QgsMeshRendererSettings::setScalarSettings ( int  groupIndex,
const QgsMeshRendererScalarSettings settings 
)
inline

Sets new renderer settings.

Definition at line 626 of file qgsmeshrenderersettings.h.

◆ setTriangularMeshSettings()

void QgsMeshRendererSettings::setTriangularMeshSettings ( const QgsMeshRendererMeshSettings settings)
inline

Sets new triangular mesh renderer settings.

Definition at line 609 of file qgsmeshrenderersettings.h.

◆ setVectorSettings()

void QgsMeshRendererSettings::setVectorSettings ( int  groupIndex,
const QgsMeshRendererVectorSettings settings 
)
inline

Sets new renderer settings.

Definition at line 631 of file qgsmeshrenderersettings.h.

◆ triangularMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::triangularMeshSettings ( ) const
inline

Returns triangular mesh renderer settings.

Definition at line 607 of file qgsmeshrenderersettings.h.

◆ vectorSettings()

QgsMeshRendererVectorSettings QgsMeshRendererSettings::vectorSettings ( int  groupIndex) const
inline

Returns renderer settings.

Definition at line 629 of file qgsmeshrenderersettings.h.

◆ writeXml()

QDomElement QgsMeshRendererSettings::writeXml ( QDomDocument &  doc,
const QgsReadWriteContext context = QgsReadWriteContext() 
) const

Writes configuration to a new DOM element.

Definition at line 407 of file qgsmeshrenderersettings.cpp.


The documentation for this class was generated from the following files: