QgsMeshRendererScalarSettings Class Reference

Represents a mesh renderer settings for scalar datasets. More...

#include <qgsmeshrenderersettings.h>

Public Types
enum	DataResamplingMethod { NoResampling = 0 , NeighbourAverage }
	Resampling of value from dataset. More...

Public Member Functions
double	classificationMaximum () const
	Returns max value used for creation of the color ramp shader.
double	classificationMinimum () const
	Returns min value used for creation of the color ramp shader.
QgsColorRampShader	colorRampShader () const
	Returns color ramp shader function.
DataResamplingMethod	dataResamplingMethod () const
	Returns the type of interpolation to use to convert face defined datasets to values on vertices.
QgsInterpolatedLineWidth	edgeStrokeWidth () const
	Returns the stroke width used to render edges scalar dataset.
Qgis::RenderUnit	edgeStrokeWidthUnit () const
	Returns the stroke width unit used to render edges scalar dataset.
Qgis::MeshRangeExtent	extent () const
	Returns the mesh extent for minimum maximum calculation.
Qgis::MeshRangeLimit	limits () const
	Returns the range limits type for minimum maximum calculation.
double	opacity () const
	Returns opacity.
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context=QgsReadWriteContext())
	Reads configuration from the given DOM element.
void	setClassificationMinimumMaximum (double minimum, double maximum)
	Sets min/max values used for creation of the color ramp shader.
void	setColorRampShader (const QgsColorRampShader &shader)
	Sets color ramp shader function.
void	setDataResamplingMethod (const DataResamplingMethod &dataResamplingMethod)
	Sets data interpolation method.
void	setEdgeStrokeWidth (const QgsInterpolatedLineWidth &strokeWidth)
	Sets the stroke width used to render edges scalar dataset.
void	setEdgeStrokeWidthUnit (Qgis::RenderUnit edgeStrokeWidthUnit)
	Sets the stroke width unit used to render edges scalar dataset.
void	setExtent (Qgis::MeshRangeExtent extent)
	Sets the mesh extent for minimum maximum calculation.
void	setLimits (Qgis::MeshRangeLimit limits)
	Sets the range limits type for minimum maximum calculation.
void	setOpacity (double opacity)
	Sets opacity.
QDomElement	writeXml (QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext()) const
	Writes configuration to a new DOM element.

Detailed Description

Represents a mesh renderer settings for scalar datasets.

Note

The API is considered EXPERIMENTAL and can be changed without a notice

Since

QGIS 3.2

Definition at line 92 of file qgsmeshrenderersettings.h.

Member Enumeration Documentation

DataResamplingMethod

enum QgsMeshRendererScalarSettings::DataResamplingMethod

Resampling of value from dataset.

• for vertices : does a resampling from values defined on surrounding faces
• for faces : does a resampling from values defined on surrounding vertices
• for edges : not supported.

Enumerator
NoResampling	Does not use resampling.
NeighbourAverage	Does a simple average of values defined for all surrounding faces/vertices.

Definition at line 103 of file qgsmeshrenderersettings.h.

Member Function Documentation

classificationMaximum()

double QgsMeshRendererScalarSettings::classificationMaximum

(

)

const

Returns max value used for creation of the color ramp shader.

Definition at line 94 of file qgsmeshrenderersettings.cpp.

classificationMinimum()

double QgsMeshRendererScalarSettings::classificationMinimum

(

)

const

Returns min value used for creation of the color ramp shader.

Definition at line 92 of file qgsmeshrenderersettings.cpp.

colorRampShader()

QgsColorRampShader QgsMeshRendererScalarSettings::colorRampShader

(

)

const

Returns color ramp shader function.

Definition at line 82 of file qgsmeshrenderersettings.cpp.

dataResamplingMethod()

QgsMeshRendererScalarSettings::DataResamplingMethod QgsMeshRendererScalarSettings::dataResamplingMethod

(

)

const

Returns the type of interpolation to use to convert face defined datasets to values on vertices.

Since

QGIS 3.12

Definition at line 107 of file qgsmeshrenderersettings.cpp.

edgeStrokeWidth()

QgsInterpolatedLineWidth QgsMeshRendererScalarSettings::edgeStrokeWidth

(

)

const

Returns the stroke width used to render edges scalar dataset.

Since

QGIS 3.14

Definition at line 181 of file qgsmeshrenderersettings.cpp.

edgeStrokeWidthUnit()

Qgis::RenderUnit QgsMeshRendererScalarSettings::edgeStrokeWidthUnit

(

)

const

Returns the stroke width unit used to render edges scalar dataset.

Since

QGIS 3.14

Definition at line 191 of file qgsmeshrenderersettings.cpp.

extent()

Qgis::MeshRangeExtent QgsMeshRendererScalarSettings::extent ( ) const

inline

Returns the mesh extent for minimum maximum calculation.

Since

QGIS 3.42

Definition at line 204 of file qgsmeshrenderersettings.h.

limits()

Qgis::MeshRangeLimit QgsMeshRendererScalarSettings::limits ( ) const

inline

Returns the range limits type for minimum maximum calculation.

Since

QGIS 3.42

Definition at line 190 of file qgsmeshrenderersettings.h.

opacity()

double QgsMeshRendererScalarSettings::opacity

(

)

const

Returns opacity.

Definition at line 103 of file qgsmeshrenderersettings.cpp.

readXml()

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

Reads configuration from the given DOM element.

Definition at line 152 of file qgsmeshrenderersettings.cpp.

setClassificationMinimumMaximum()

void QgsMeshRendererScalarSettings::setClassificationMinimumMaximum	(	double	minimum,
		double	maximum
	)

Sets min/max values used for creation of the color ramp shader.

Definition at line 96 of file qgsmeshrenderersettings.cpp.

setColorRampShader()

void QgsMeshRendererScalarSettings::setColorRampShader

(

const QgsColorRampShader &

shader

)

Sets color ramp shader function.

Definition at line 87 of file qgsmeshrenderersettings.cpp.

setDataResamplingMethod()

void QgsMeshRendererScalarSettings::setDataResamplingMethod

(

const DataResamplingMethod &

dataResamplingMethod

)

Sets data interpolation method.

Since

QGIS 3.12

Definition at line 112 of file qgsmeshrenderersettings.cpp.

setEdgeStrokeWidth()

void QgsMeshRendererScalarSettings::setEdgeStrokeWidth

(

const QgsInterpolatedLineWidth &

strokeWidth

)

Sets the stroke width used to render edges scalar dataset.

Since

QGIS 3.14

Definition at line 186 of file qgsmeshrenderersettings.cpp.

setEdgeStrokeWidthUnit()

void QgsMeshRendererScalarSettings::setEdgeStrokeWidthUnit

(

Qgis::RenderUnit

edgeStrokeWidthUnit

)

Sets the stroke width unit used to render edges scalar dataset.

Since

QGIS 3.14

Definition at line 196 of file qgsmeshrenderersettings.cpp.

setExtent()

void QgsMeshRendererScalarSettings::setExtent ( Qgis::MeshRangeExtent  extent )

inline

Sets the mesh extent for minimum maximum calculation.

Since

QGIS 3.42

Definition at line 197 of file qgsmeshrenderersettings.h.

setLimits()

void QgsMeshRendererScalarSettings::setLimits ( Qgis::MeshRangeLimit  limits )

inline

Sets the range limits type for minimum maximum calculation.

Since

QGIS 3.42

Definition at line 183 of file qgsmeshrenderersettings.h.

setOpacity()

void QgsMeshRendererScalarSettings::setOpacity

(

double

opacity

)

Sets opacity.

Definition at line 105 of file qgsmeshrenderersettings.cpp.

writeXml()

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

Writes configuration to a new DOM element.

Definition at line 117 of file qgsmeshrenderersettings.cpp.

---

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

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/core/mesh/qgsmeshrenderersettings.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/core/mesh/qgsmeshrenderersettings.cpp