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...
QgsMeshDatasetIndex	activeScalarDataset () const
	Returns active scalar dataset. More...
QgsMeshDatasetIndex	activeVectorDataset () const
	Returns active vector dataset. More...
QgsMesh3dAveragingMethod *	averagingMethod () const
	Returns averaging method for conversion of 3d stacked mesh data to 2d data. More...
QgsMeshRendererMeshSettings	nativeMeshSettings () const
	Returns renderer settings. More...
void	readXml (const QDomElement &elem)
	Reads configuration from the given DOM element. More...
QgsMeshRendererScalarSettings	scalarSettings (int groupIndex) const
	Returns renderer settings. More...
void	setActiveScalarDataset (QgsMeshDatasetIndex index=QgsMeshDatasetIndex())
	Sets active scalar dataset for rendering. More...
void	setActiveVectorDataset (QgsMeshDatasetIndex index=QgsMeshDatasetIndex())
	Sets active vector dataset for rendering. More...
void	setAveragingMethod (QgsMesh3dAveragingMethod *method)
	Sets averaging method for conversion of 3d stacked mesh data to 2d data. More...
void	setNativeMeshSettings (const QgsMeshRendererMeshSettings &settings)
	Sets new renderer settings, triggers repaint. More...
void	setScalarSettings (int groupIndex, const QgsMeshRendererScalarSettings &settings)
	Sets new renderer settings. More...
void	setTriangularMeshSettings (const QgsMeshRendererMeshSettings &settings)
	Sets new renderer settings. More...
void	setVectorSettings (int groupIndex, const QgsMeshRendererVectorSettings &settings)
	Sets new renderer settings. More...
QgsMeshRendererMeshSettings	triangularMeshSettings () const
	Returns renderer settings. More...
QgsMeshRendererVectorSettings	vectorSettings (int groupIndex) const
	Returns renderer settings. More...
QDomElement	writeXml (QDomDocument &doc) 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 508 of file qgsmeshrenderersettings.h.

Constructor & Destructor Documentation

QgsMeshRendererSettings()

QgsMeshRendererSettings::QgsMeshRendererSettings

(

)

Constructs renderer with default single layer averaging method.

Definition at line 343 of file qgsmeshrenderersettings.cpp.

~QgsMeshRendererSettings()

QgsMeshRendererSettings::~QgsMeshRendererSettings ( )

default

Destructor.

Member Function Documentation

activeScalarDataset()

QgsMeshDatasetIndex QgsMeshRendererSettings::activeScalarDataset ( ) const

inline

Returns active scalar dataset.

Definition at line 554 of file qgsmeshrenderersettings.h.

activeVectorDataset()

QgsMeshDatasetIndex QgsMeshRendererSettings::activeVectorDataset ( ) const

inline

Returns active vector dataset.

Definition at line 559 of file qgsmeshrenderersettings.h.

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 350 of file qgsmeshrenderersettings.cpp.

nativeMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::nativeMeshSettings ( ) const

inline

Returns renderer settings.

Definition at line 520 of file qgsmeshrenderersettings.h.

readXml()

void QgsMeshRendererSettings::readXml

(

const QDomElement &

elem

)

Reads configuration from the given DOM element.

Definition at line 410 of file qgsmeshrenderersettings.cpp.

scalarSettings()

QgsMeshRendererScalarSettings QgsMeshRendererSettings::scalarSettings ( int  groupIndex ) const

inline

Returns renderer settings.

Definition at line 530 of file qgsmeshrenderersettings.h.

setActiveScalarDataset()

void QgsMeshRendererSettings::setActiveScalarDataset ( QgsMeshDatasetIndex  index = QgsMeshDatasetIndex() )

inline

Sets active scalar dataset for rendering.

Definition at line 556 of file qgsmeshrenderersettings.h.

setActiveVectorDataset()

void QgsMeshRendererSettings::setActiveVectorDataset ( QgsMeshDatasetIndex  index = QgsMeshDatasetIndex() )

inline

Sets active vector dataset for rendering.

Definition at line 561 of file qgsmeshrenderersettings.h.

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 355 of file qgsmeshrenderersettings.cpp.

setNativeMeshSettings()

void QgsMeshRendererSettings::setNativeMeshSettings ( const QgsMeshRendererMeshSettings &  settings )

inline

Sets new renderer settings, triggers repaint.

Definition at line 522 of file qgsmeshrenderersettings.h.

setScalarSettings()

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

inline

Sets new renderer settings.

Definition at line 532 of file qgsmeshrenderersettings.h.

setTriangularMeshSettings()

void QgsMeshRendererSettings::setTriangularMeshSettings ( const QgsMeshRendererMeshSettings &  settings )

inline

Sets new renderer settings.

Definition at line 527 of file qgsmeshrenderersettings.h.

setVectorSettings()

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

inline

Sets new renderer settings.

Definition at line 537 of file qgsmeshrenderersettings.h.

triangularMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::triangularMeshSettings ( ) const

inline

Returns renderer settings.

Definition at line 525 of file qgsmeshrenderersettings.h.

vectorSettings()

QgsMeshRendererVectorSettings QgsMeshRendererSettings::vectorSettings ( int  groupIndex ) const

inline

Returns renderer settings.

Definition at line 535 of file qgsmeshrenderersettings.h.

writeXml()

QDomElement QgsMeshRendererSettings::writeXml

(

QDomDocument &

doc

)

const

Writes configuration to a new DOM element.

Definition at line 363 of file qgsmeshrenderersettings.cpp.

---

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

• /build/qgis-3.12.1+28bionic/src/core/mesh/qgsmeshrenderersettings.h
• /build/qgis-3.12.1+28bionic/src/core/mesh/qgsmeshrenderersettings.cpp