QGIS API Documentation 4.0.0-Norrköping (1ddcee3d0e4)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsMeshRendererSettings Class Reference
core library

Represents all mesh renderer settings. More...

#include <qgsmeshrenderersettings.h>

Public Member Functions

 QgsMeshRendererSettings ()
 Constructs renderer with default single layer averaging method.
 QgsMeshRendererSettings (const QgsMeshRendererSettings &other)
 QgsMeshRendererSettings (QgsMeshRendererSettings &&other)
 ~QgsMeshRendererSettings ()
int activeScalarDatasetGroup () const
 Returns the active scalar dataset group.
int activeVectorDatasetGroup () const
 Returns the active vector dataset group.
QgsMesh3DAveragingMethod * averagingMethod () const
 Returns averaging method for conversion of 3d stacked mesh data to 2d data.
QgsMeshRendererMeshSettings edgeMeshSettings () const
 Returns edge mesh renderer settings.
bool hasScalarSettings (int groupIndex) const
 Returns whether groupIndex has existing scalar settings.
bool hasSettings (int datasetGroupIndex) const
 Returns whether the group with index has render settings (scalar or vector).
bool hasVectorSettings (int groupIndex) const
 Returns whether groupIndex has existing vector settings.
QgsMeshRendererMeshSettings nativeMeshSettings () const
 Returns native mesh renderer settings.
QgsMeshRendererSettings & operator= (const QgsMeshRendererSettings &other)
QgsMeshRendererSettings & operator= (QgsMeshRendererSettings &&other)
void readXml (const QDomElement &elem, const QgsReadWriteContext &context=QgsReadWriteContext())
 Reads configuration from the given DOM element.
bool removeScalarSettings (int groupIndex)
 Removes scalar settings with groupIndex.
bool removeVectorSettings (int groupIndex)
 Removes vector settings for groupIndex.
QgsMeshRendererScalarSettings scalarSettings (int groupIndex) const
 Returns renderer settings.
void setActiveScalarDatasetGroup (int activeScalarDatasetGroup)
 Sets the active scalar dataset group.
void setActiveVectorDatasetGroup (int activeVectorDatasetGroup)
 Sets the active vector dataset group.
void setAveragingMethod (QgsMesh3DAveragingMethod *method)
 Sets averaging method for conversion of 3d stacked mesh data to 2d data.
void setEdgeMeshSettings (const QgsMeshRendererMeshSettings &settings)
 Sets new edge mesh renderer settings.
void setNativeMeshSettings (const QgsMeshRendererMeshSettings &settings)
 Sets new native mesh renderer settings, triggers repaint.
void setScalarSettings (int groupIndex, const QgsMeshRendererScalarSettings &settings)
 Sets new renderer settings.
void setTriangularMeshSettings (const QgsMeshRendererMeshSettings &settings)
 Sets new triangular mesh renderer settings.
void setVectorSettings (int groupIndex, const QgsMeshRendererVectorSettings &settings)
 Sets new renderer settings.
QgsMeshRendererMeshSettings triangularMeshSettings () const
 Returns triangular mesh renderer settings.
QgsMeshRendererVectorSettings vectorSettings (int groupIndex) const
 Returns renderer settings.
QDomElement writeXml (QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext()) const
 Writes configuration to a new DOM element.

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 707 of file qgsmeshrenderersettings.h.

Constructor & Destructor Documentation

◆ QgsMeshRendererSettings() [1/3]

QgsMeshRendererSettings::QgsMeshRendererSettings ( )

Constructs renderer with default single layer averaging method.

Definition at line 425 of file qgsmeshrenderersettings.cpp.

◆ QgsMeshRendererSettings() [2/3]

QgsMeshRendererSettings::QgsMeshRendererSettings ( const QgsMeshRendererSettings & other)

Definition at line 429 of file qgsmeshrenderersettings.cpp.

◆ QgsMeshRendererSettings() [3/3]

QgsMeshRendererSettings::QgsMeshRendererSettings ( QgsMeshRendererSettings && other)

Definition at line 442 of file qgsmeshrenderersettings.cpp.

◆ ~QgsMeshRendererSettings()

QgsMeshRendererSettings::~QgsMeshRendererSettings ( )
default

Member Function Documentation

◆ activeScalarDatasetGroup()

int QgsMeshRendererSettings::activeScalarDatasetGroup ( ) const

Returns the active scalar dataset group.

Since
QGIS 3.14

Definition at line 602 of file qgsmeshrenderersettings.cpp.

◆ activeVectorDatasetGroup()

int QgsMeshRendererSettings::activeVectorDatasetGroup ( ) const

Returns the active vector dataset group.

Since
QGIS 3.14

Definition at line 612 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 489 of file qgsmeshrenderersettings.cpp.

◆ edgeMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::edgeMeshSettings ( ) const
inline

Returns edge mesh renderer settings.

Since
QGIS 3.14

Definition at line 736 of file qgsmeshrenderersettings.h.

◆ hasScalarSettings()

bool QgsMeshRendererSettings::hasScalarSettings ( int groupIndex) const
inline

Returns whether groupIndex has existing scalar settings.

Since
QGIS 3.30.2

Definition at line 754 of file qgsmeshrenderersettings.h.

◆ hasSettings()

bool QgsMeshRendererSettings::hasSettings ( int datasetGroupIndex) const

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

Since
QGIS 3.22

Definition at line 838 of file qgsmeshrenderersettings.cpp.

◆ hasVectorSettings()

bool QgsMeshRendererSettings::hasVectorSettings ( int groupIndex) const
inline

Returns whether groupIndex has existing vector settings.

Since
QGIS 3.30.2

Definition at line 771 of file qgsmeshrenderersettings.h.

◆ nativeMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::nativeMeshSettings ( ) const
inline

Returns native mesh renderer settings.

Definition at line 723 of file qgsmeshrenderersettings.h.

◆ operator=() [1/2]

QgsMeshRendererSettings & QgsMeshRendererSettings::operator= ( const QgsMeshRendererSettings & other)

Definition at line 453 of file qgsmeshrenderersettings.cpp.

◆ operator=() [2/2]

QgsMeshRendererSettings & QgsMeshRendererSettings::operator= ( QgsMeshRendererSettings && other)

Definition at line 471 of file qgsmeshrenderersettings.cpp.

◆ readXml()

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

Reads configuration from the given DOM element.

Definition at line 551 of file qgsmeshrenderersettings.cpp.

◆ removeScalarSettings()

bool QgsMeshRendererSettings::removeScalarSettings ( int groupIndex)
inline

Removes scalar settings with groupIndex.

Since
QGIS 3.30.2

Definition at line 760 of file qgsmeshrenderersettings.h.

◆ removeVectorSettings()

bool QgsMeshRendererSettings::removeVectorSettings ( int groupIndex)
inline

Removes vector settings for groupIndex.

Since
QGIS 3.30.2

Definition at line 777 of file qgsmeshrenderersettings.h.

◆ scalarSettings()

QgsMeshRendererScalarSettings QgsMeshRendererSettings::scalarSettings ( int groupIndex) const
inline

Returns renderer settings.

Definition at line 745 of file qgsmeshrenderersettings.h.

◆ setActiveScalarDatasetGroup()

void QgsMeshRendererSettings::setActiveScalarDatasetGroup ( int activeScalarDatasetGroup)

Sets the active scalar dataset group.

Since
QGIS 3.14

Definition at line 607 of file qgsmeshrenderersettings.cpp.

◆ setActiveVectorDatasetGroup()

void QgsMeshRendererSettings::setActiveVectorDatasetGroup ( int activeVectorDatasetGroup)

Sets the active vector dataset group.

Since
QGIS 3.14

Definition at line 617 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 494 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 742 of file qgsmeshrenderersettings.h.

◆ setNativeMeshSettings()

void QgsMeshRendererSettings::setNativeMeshSettings ( const QgsMeshRendererMeshSettings & settings)
inline

Sets new native mesh renderer settings, triggers repaint.

Definition at line 725 of file qgsmeshrenderersettings.h.

◆ setScalarSettings()

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

Sets new renderer settings.

Definition at line 748 of file qgsmeshrenderersettings.h.

◆ setTriangularMeshSettings()

void QgsMeshRendererSettings::setTriangularMeshSettings ( const QgsMeshRendererMeshSettings & settings)
inline

Sets new triangular mesh renderer settings.

Definition at line 730 of file qgsmeshrenderersettings.h.

◆ setVectorSettings()

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

Sets new renderer settings.

Definition at line 765 of file qgsmeshrenderersettings.h.

◆ triangularMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::triangularMeshSettings ( ) const
inline

Returns triangular mesh renderer settings.

Definition at line 728 of file qgsmeshrenderersettings.h.

◆ vectorSettings()

QgsMeshRendererVectorSettings QgsMeshRendererSettings::vectorSettings ( int groupIndex) const
inline

Returns renderer settings.

Definition at line 763 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 502 of file qgsmeshrenderersettings.cpp.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0