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

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

#include <qgsmeshrenderersettings.h>

Public Types

enum  DataResamplingMethod { None = 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. More...
 
double classificationMinimum () const
 Returns min value used for creation of the color ramp shader. More...
 
QgsColorRampShader colorRampShader () const
 Returns color ramp shader function. More...
 
DataResamplingMethod dataResamplingMethod () const
 Returns the type of interpolation to use to convert face defined datasets to values on vertices. More...
 
QgsInterpolatedLineWidth edgeStrokeWidth () const
 Returns the stroke width used to render edges scalar dataset. More...
 
QgsUnitTypes::RenderUnit edgeStrokeWidthUnit () const
 Returns the stroke width unit used to render edges scalar dataset. More...
 
double opacity () const
 Returns opacity. More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context=QgsReadWriteContext())
 Reads configuration from the given DOM element. More...
 
void setClassificationMinimumMaximum (double minimum, double maximum)
 Sets min/max values used for creation of the color ramp shader. More...
 
void setColorRampShader (const QgsColorRampShader &shader)
 Sets color ramp shader function. More...
 
void setDataResamplingMethod (const DataResamplingMethod &dataResamplingMethod)
 Sets data interpolation method. More...
 
void setEdgeStrokeWidth (const QgsInterpolatedLineWidth &strokeWidth)
 Sets the stroke width used to render edges scalar dataset. More...
 
void setEdgeStrokeWidthUnit (const QgsUnitTypes::RenderUnit &edgeStrokeWidthUnit)
 Sets the stroke width unit used to render edges scalar dataset. More...
 
void setOpacity (double opacity)
 Sets opacity. More...
 
QDomElement writeXml (QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext()) const
 Writes configuration to a new DOM element. More...
 

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

Member Enumeration Documentation

◆ 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
None 

Does not use resampling.

NeighbourAverage 

Does a simple average of values defined for all surrounding faces/vertices.

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

◆ classificationMinimum()

double QgsMeshRendererScalarSettings::classificationMinimum ( ) const

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

Definition at line 91 of file qgsmeshrenderersettings.cpp.

◆ colorRampShader()

QgsColorRampShader QgsMeshRendererScalarSettings::colorRampShader ( ) const

Returns color ramp shader function.

Definition at line 81 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 105 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 169 of file qgsmeshrenderersettings.cpp.

◆ edgeStrokeWidthUnit()

QgsUnitTypes::RenderUnit QgsMeshRendererScalarSettings::edgeStrokeWidthUnit ( ) const

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

Since
QGIS 3.14

Definition at line 179 of file qgsmeshrenderersettings.cpp.

◆ opacity()

double QgsMeshRendererScalarSettings::opacity ( ) const

Returns opacity.

Definition at line 101 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 144 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 95 of file qgsmeshrenderersettings.cpp.

◆ setColorRampShader()

void QgsMeshRendererScalarSettings::setColorRampShader ( const QgsColorRampShader shader)

Sets color ramp shader function.

Definition at line 86 of file qgsmeshrenderersettings.cpp.

◆ setDataResamplingMethod()

void QgsMeshRendererScalarSettings::setDataResamplingMethod ( const DataResamplingMethod dataResamplingMethod)

Sets data interpolation method.

Since
QGIS 3.12

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

◆ setEdgeStrokeWidthUnit()

void QgsMeshRendererScalarSettings::setEdgeStrokeWidthUnit ( const QgsUnitTypes::RenderUnit edgeStrokeWidthUnit)

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

Since
QGIS 3.14

Definition at line 184 of file qgsmeshrenderersettings.cpp.

◆ setOpacity()

void QgsMeshRendererScalarSettings::setOpacity ( double  opacity)

Sets opacity.

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


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