Class defining color to render mesh datasets. More...

#include <qgsinterpolatedlinerenderer.h>

Public Types
enum	ColoringMethod { SingleColor = 0 , ColorRamp }
	Defines how the color is defined. More...

Public Member Functions
	QgsInterpolatedLineColor ()
	Default constructor.

	QgsInterpolatedLineColor (const QColor &color)
	Constructor with fixed color.

	QgsInterpolatedLineColor (const QgsColorRampShader &colorRampShader)
	Constructor with variable color depending on magnitude.

QColor	color (double magnitude) const
	Returns the color corresponding to the magnitude.

QgsInterpolatedLineColor::ColoringMethod	coloringMethod () const
	Returns the coloring method used.

QgsColorRampShader	colorRampShader () const
	Returns the color ramp shader.

void	graduatedColors (double value1, double value2, QList< double > &breakValues, QList< QColor > &breakColors, QList< QLinearGradient > &gradients) const
	Returns the break values, graduated colors and the associated gradients between two values.

void	readXml (const QDomElement &elem, const QgsReadWriteContext &context)
	Reads configuration from the given DOM element.

void	setColor (const QColor &color)
	Sets the single color to define the coloring.

void	setColor (const QgsColorRampShader &colorRampShader)
	Sets the color ramp to define the coloring.

void	setColoringMethod (ColoringMethod coloringMethod)
	Sets the coloring method used.

QColor	singleColor () const
	Returns the single color that is used if SingleColor coloring mode is set.

QDomElement	writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const
	Writes configuration to a new DOM element.

Detailed Description

Class defining color to render mesh datasets.

The color can vary depending on the dataset value.

Since: QGIS 3.14

Definition at line 36 of file qgsinterpolatedlinerenderer.h.

Member Enumeration Documentation

◆ ColoringMethod

enum QgsInterpolatedLineColor::ColoringMethod

Defines how the color is defined.

Enumerator
SingleColor	Render with a single color.
ColorRamp	Render with a color ramp.

Definition at line 43 of file qgsinterpolatedlinerenderer.h.

Constructor & Destructor Documentation

◆ QgsInterpolatedLineColor() [1/3]

QgsInterpolatedLineColor::QgsInterpolatedLineColor ( )

Default constructor.

Definition at line 439 of file qgsinterpolatedlinerenderer.cpp.

◆ QgsInterpolatedLineColor() [2/3]

QgsInterpolatedLineColor::QgsInterpolatedLineColor ( const QgsColorRampShader & colorRampShader )

Constructor with variable color depending on magnitude.

Definition at line 445 of file qgsinterpolatedlinerenderer.cpp.

◆ QgsInterpolatedLineColor() [3/3]

QgsInterpolatedLineColor::QgsInterpolatedLineColor ( const QColor & color )

Constructor with fixed color.

Definition at line 450 of file qgsinterpolatedlinerenderer.cpp.

Member Function Documentation

◆ color()

QColor QgsInterpolatedLineColor::color ( double magnitude ) const

Returns the color corresponding to the magnitude.

Definition at line 472 of file qgsinterpolatedlinerenderer.cpp.

◆ coloringMethod()

QgsInterpolatedLineColor::ColoringMethod QgsInterpolatedLineColor::coloringMethod ( ) const

Returns the coloring method used.

Definition at line 492 of file qgsinterpolatedlinerenderer.cpp.

◆ colorRampShader()

QgsColorRampShader QgsInterpolatedLineColor::colorRampShader ( ) const

Returns the color ramp shader.

Definition at line 497 of file qgsinterpolatedlinerenderer.cpp.

◆ graduatedColors()

void QgsInterpolatedLineColor::graduatedColors	(	double	value1,
		double	value2,
		QList< double > &	breakValues,
		QList< QColor > &	breakColors,
		QList< QLinearGradient > &	gradients
	)		const

Returns the break values, graduated colors and the associated gradients between two values.

If the color is fixed or only one color for the interval (value1, value2), returns only one color in breakColors and void lists for breakValues, gradients
If the color ramp is classified with 'exact', returns void gradients
If the color ramp is classified with 'discrete', return gradients with uniform colors
if nothing to render (out of range), return all lists void

Definition at line 528 of file qgsinterpolatedlinerenderer.cpp.

◆ readXml()

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

Reads configuration from the given DOM element.

Definition at line 518 of file qgsinterpolatedlinerenderer.cpp.

◆ setColor() [1/2]

void QgsInterpolatedLineColor::setColor ( const QColor & color )

Sets the single color to define the coloring.

Definition at line 467 of file qgsinterpolatedlinerenderer.cpp.

◆ setColor() [2/2]

void QgsInterpolatedLineColor::setColor ( const QgsColorRampShader & colorRampShader )

Sets the color ramp to define the coloring.

Definition at line 458 of file qgsinterpolatedlinerenderer.cpp.

◆ setColoringMethod()

void QgsInterpolatedLineColor::setColoringMethod ( QgsInterpolatedLineColor::ColoringMethod coloringMethod )

Sets the coloring method used.

Since: QGIS 3.20

Definition at line 554 of file qgsinterpolatedlinerenderer.cpp.

◆ singleColor()

QColor QgsInterpolatedLineColor::singleColor ( ) const

Returns the single color that is used if SingleColor coloring mode is set.

Since: QGIS 3.20

Definition at line 502 of file qgsinterpolatedlinerenderer.cpp.

◆ writeXml()

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

Writes configuration to a new DOM element.

Definition at line 507 of file qgsinterpolatedlinerenderer.cpp.

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

/build/qgis-3.41.0+git20241126+3291e9ff48b+99sid/src/core/symbology/qgsinterpolatedlinerenderer.h
/build/qgis-3.41.0+git20241126+3291e9ff48b+99sid/src/core/symbology/qgsinterpolatedlinerenderer.cpp

Public Types

Public Member Functions