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 QgsVectorFieldSettings &settings)
	Sets new renderer settings.
QgsMeshRendererMeshSettings	triangularMeshSettings () const
	Returns triangular mesh renderer settings.
QgsVectorFieldSettings	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 311 of file qgsmeshrenderersettings.h.

Constructor & Destructor Documentation

◆ QgsMeshRendererSettings() [1/3]

QgsMeshRendererSettings::QgsMeshRendererSettings ( )

Constructs renderer with default single layer averaging method.

Definition at line 229 of file qgsmeshrenderersettings.cpp.

◆ QgsMeshRendererSettings() [2/3]

QgsMeshRendererSettings::QgsMeshRendererSettings ( const QgsMeshRendererSettings & other )

Definition at line 233 of file qgsmeshrenderersettings.cpp.

◆ QgsMeshRendererSettings() [3/3]

QgsMeshRendererSettings::QgsMeshRendererSettings ( QgsMeshRendererSettings && other )

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

◆ activeVectorDatasetGroup()

int QgsMeshRendererSettings::activeVectorDatasetGroup ( ) const

Returns the active vector dataset group.

Since: QGIS 3.14

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

◆ edgeMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::edgeMeshSettings ( ) const

inline

Returns edge mesh renderer settings.

Since: QGIS 3.14

Definition at line 340 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 358 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 426 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 375 of file qgsmeshrenderersettings.h.

◆ nativeMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::nativeMeshSettings ( ) const

inline

Returns native mesh renderer settings.

Definition at line 327 of file qgsmeshrenderersettings.h.

◆ operator=() [1/2]

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

Definition at line 257 of file qgsmeshrenderersettings.cpp.

◆ operator=() [2/2]

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

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

◆ removeScalarSettings()

bool QgsMeshRendererSettings::removeScalarSettings ( int groupIndex )

inline

Removes scalar settings with groupIndex.

Since: QGIS 3.30.2

Definition at line 364 of file qgsmeshrenderersettings.h.

◆ removeVectorSettings()

bool QgsMeshRendererSettings::removeVectorSettings ( int groupIndex )

inline

Removes vector settings for groupIndex.

Since: QGIS 3.30.2

Definition at line 381 of file qgsmeshrenderersettings.h.

◆ scalarSettings()

QgsMeshRendererScalarSettings QgsMeshRendererSettings::scalarSettings ( int groupIndex ) const

inline

Returns renderer settings.

Definition at line 349 of file qgsmeshrenderersettings.h.

◆ setActiveScalarDatasetGroup()

void QgsMeshRendererSettings::setActiveScalarDatasetGroup ( int activeScalarDatasetGroup )

Sets the active scalar dataset group.

Since: QGIS 3.14

Definition at line 411 of file qgsmeshrenderersettings.cpp.

◆ setActiveVectorDatasetGroup()

void QgsMeshRendererSettings::setActiveVectorDatasetGroup ( int activeVectorDatasetGroup )

Sets the active vector dataset group.

Since: QGIS 3.14

Definition at line 421 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 298 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 346 of file qgsmeshrenderersettings.h.

◆ setNativeMeshSettings()

void QgsMeshRendererSettings::setNativeMeshSettings ( const QgsMeshRendererMeshSettings & settings )

inline

Sets new native mesh renderer settings, triggers repaint.

Definition at line 329 of file qgsmeshrenderersettings.h.

◆ setScalarSettings()

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

inline

Sets new renderer settings.

Definition at line 352 of file qgsmeshrenderersettings.h.

◆ setTriangularMeshSettings()

void QgsMeshRendererSettings::setTriangularMeshSettings ( const QgsMeshRendererMeshSettings & settings )

inline

Sets new triangular mesh renderer settings.

Definition at line 334 of file qgsmeshrenderersettings.h.

◆ setVectorSettings()

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

inline

Sets new renderer settings.

Definition at line 369 of file qgsmeshrenderersettings.h.

◆ triangularMeshSettings()

QgsMeshRendererMeshSettings QgsMeshRendererSettings::triangularMeshSettings ( ) const

inline

Returns triangular mesh renderer settings.

Definition at line 332 of file qgsmeshrenderersettings.h.

◆ vectorSettings()

QgsVectorFieldSettings QgsMeshRendererSettings::vectorSettings ( int groupIndex ) const

inline

Returns renderer settings.

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

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

/build/qgis-4.3.0+git20260916+2b7e6c9893e+99sid/src/core/mesh/qgsmeshrenderersettings.h
/build/qgis-4.3.0+git20260916+2b7e6c9893e+99sid/src/core/mesh/qgsmeshrenderersettings.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsMeshRendererSettings() [1/3]

◆ QgsMeshRendererSettings() [2/3]

◆ QgsMeshRendererSettings() [3/3]

◆ ~QgsMeshRendererSettings()

Member Function Documentation

◆ activeScalarDatasetGroup()

◆ activeVectorDatasetGroup()

◆ averagingMethod()

◆ edgeMeshSettings()

◆ hasScalarSettings()

◆ hasSettings()

◆ hasVectorSettings()

◆ nativeMeshSettings()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ readXml()

◆ removeScalarSettings()

◆ removeVectorSettings()

◆ scalarSettings()

◆ setActiveScalarDatasetGroup()

◆ setActiveVectorDatasetGroup()

◆ setAveragingMethod()

◆ setEdgeMeshSettings()

◆ setNativeMeshSettings()

◆ setScalarSettings()

◆ setTriangularMeshSettings()

◆ setVectorSettings()

◆ triangularMeshSettings()

◆ vectorSettings()

◆ writeXml()