QGIS API Documentation  3.11.0-Master (68611307d7)
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  DataInterpolationMethod { None = 0, NeighbourAverage }
 Interpolation of value defined on vertices from datasets with data defined on faces. 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...
 
DataInterpolationMethod dataInterpolationMethod () const
 Returns the type of interpolation to use to convert face defined datasets to values on vertices. More...
 
double opacity () const
 Returns opacity. More...
 
void readXml (const QDomElement &elem)
 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 setDataInterpolationMethod (const DataInterpolationMethod &dataInterpolationMethod)
 Sets data interpolation method. More...
 
void setOpacity (double opacity)
 Sets opacity. More...
 
QDomElement writeXml (QDomDocument &doc) 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 78 of file qgsmeshrenderersettings.h.

Member Enumeration Documentation

◆ DataInterpolationMethod

Interpolation of value defined on vertices from datasets with data defined on faces.

Enumerator
None 

Use data defined on face centers, do not interpolate to vertices.

NeighbourAverage 

For each vertex does a simple average of values defined for all faces that contains given vertex.

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

◆ classificationMinimum()

double QgsMeshRendererScalarSettings::classificationMinimum ( ) const

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

Definition at line 80 of file qgsmeshrenderersettings.cpp.

◆ colorRampShader()

QgsColorRampShader QgsMeshRendererScalarSettings::colorRampShader ( ) const

Returns color ramp shader function.

Definition at line 70 of file qgsmeshrenderersettings.cpp.

◆ dataInterpolationMethod()

QgsMeshRendererScalarSettings::DataInterpolationMethod QgsMeshRendererScalarSettings::dataInterpolationMethod ( ) const

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

Since
QGIS 3.12

Definition at line 94 of file qgsmeshrenderersettings.cpp.

◆ opacity()

double QgsMeshRendererScalarSettings::opacity ( ) const

Returns opacity.

Definition at line 90 of file qgsmeshrenderersettings.cpp.

◆ readXml()

void QgsMeshRendererScalarSettings::readXml ( const QDomElement &  elem)

Reads configuration from the given DOM element.

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

◆ setColorRampShader()

void QgsMeshRendererScalarSettings::setColorRampShader ( const QgsColorRampShader shader)

Sets color ramp shader function.

Definition at line 75 of file qgsmeshrenderersettings.cpp.

◆ setDataInterpolationMethod()

void QgsMeshRendererScalarSettings::setDataInterpolationMethod ( const DataInterpolationMethod dataInterpolationMethod)

Sets data interpolation method.

Since
QGIS 3.12

Definition at line 99 of file qgsmeshrenderersettings.cpp.

◆ setOpacity()

void QgsMeshRendererScalarSettings::setOpacity ( double  opacity)

Sets opacity.

Definition at line 92 of file qgsmeshrenderersettings.cpp.

◆ writeXml()

QDomElement QgsMeshRendererScalarSettings::writeXml ( QDomDocument &  doc) const

Writes configuration to a new DOM element.

Definition at line 104 of file qgsmeshrenderersettings.cpp.


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