Represents a renderer settings for vector datasets. More...

#include <qgsmeshrenderersettings.h>

Public Types
enum	Symbology { Arrows = 0 , Streamlines , Traces }
	Defines the symbology of vector rendering. More...

Public Member Functions
QgsMeshRendererVectorArrowSettings	arrowSettings () const
	Returns settings for vector rendered with arrows. More...

QColor	color () const
	Returns color used for drawing arrows. More...

QgsInterpolatedLineColor::ColoringMethod	coloringMethod () const
	Returns the coloring method used to render vector datasets. More...

QgsColorRampShader	colorRampShader () const
	Sets the color ramp shader used to render vector datasets. More...

double	filterMax () const
	Returns filter value for vector magnitudes. More...

double	filterMin () const
	Returns filter value for vector magnitudes. More...

bool	isOnUserDefinedGrid () const
	Returns whether vectors are drawn on user-defined grid. More...

double	lineWidth () const
	Returns line width of the arrow (in millimeters) More...

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

void	setArrowsSettings (const QgsMeshRendererVectorArrowSettings &arrowSettings)
	Sets settings for vector rendered with arrows. More...

void	setColor (const QColor &color)
	Sets color used for drawing arrows. More...

void	setColoringMethod (const QgsInterpolatedLineColor::ColoringMethod &coloringMethod)
	Sets the coloring method used to render vector datasets. More...

void	setColorRampShader (const QgsColorRampShader &colorRampShader)
	Returns the color ramp shader used to render vector datasets. More...

void	setFilterMax (double filterMax)
	Sets filter value for vector magnitudes. More...

void	setFilterMin (double filterMin)
	Sets filter value for vector magnitudes. More...

void	setLineWidth (double lineWidth)
	Sets line width of the arrow in pixels (in millimeters) More...

void	setOnUserDefinedGrid (bool enabled)
	Toggles drawing of vectors on user defined grid. More...

void	setStreamLinesSettings (const QgsMeshRendererVectorStreamlineSettings &streamLinesSettings)
	Sets settings for vector rendered with streamlines. More...

void	setSymbology (const Symbology &symbology)
	Sets the displaying method used to render vector datasets. More...

void	setTracesSettings (const QgsMeshRendererVectorTracesSettings &tracesSettings)
	Sets settings for vector rendered with traces. More...

void	setUserGridCellHeight (int height)
	Sets height of user grid cell (in pixels) More...

void	setUserGridCellWidth (int width)
	Sets width of user grid cell (in pixels) More...

QgsMeshRendererVectorStreamlineSettings	streamLinesSettings () const
	Returns settings for vector rendered with streamlines. More...

Symbology	symbology () const
	Returns the displaying method used to render vector datasets. More...

QgsMeshRendererVectorTracesSettings	tracesSettings () const
	Returns settings for vector rendered with traces. More...

int	userGridCellHeight () const
	Returns height in pixels of user grid cell. More...

int	userGridCellWidth () const
	Returns width in pixels of user grid cell. More...

QgsInterpolatedLineColor	vectorStrokeColoring () const
	Returns the stroke coloring used to render vector datasets. More...

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

Detailed Description

Represents a renderer settings for vector datasets.

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

Since: QGIS 3.2

Definition at line 410 of file qgsmeshrenderersettings.h.

Member Enumeration Documentation

◆ Symbology

enum QgsMeshRendererVectorSettings::Symbology

Defines the symbology of vector rendering.

Since: QGIS 3.12

Enumerator
Arrows	Displaying vector dataset with arrows.
Streamlines	Displaying vector dataset with streamlines.
Traces	Displaying vector dataset with particle traces.

Definition at line 418 of file qgsmeshrenderersettings.h.

Member Function Documentation

◆ arrowSettings()

QgsMeshRendererVectorArrowSettings QgsMeshRendererVectorSettings::arrowSettings ( ) const

Returns settings for vector rendered with arrows.

Since: QGIS 3.12

Definition at line 575 of file qgsmeshrenderersettings.cpp.

◆ color()

QColor QgsMeshRendererVectorSettings::color ( ) const

Returns color used for drawing arrows.

Definition at line 201 of file qgsmeshrenderersettings.cpp.

◆ coloringMethod()

QgsInterpolatedLineColor::ColoringMethod QgsMeshRendererVectorSettings::coloringMethod ( ) const

Returns the coloring method used to render vector datasets.

Since: QGIS 3.14

Definition at line 649 of file qgsmeshrenderersettings.cpp.

◆ colorRampShader()

QgsColorRampShader QgsMeshRendererVectorSettings::colorRampShader ( ) const

Sets the color ramp shader used to render vector datasets.

Since: QGIS 3.14

Definition at line 659 of file qgsmeshrenderersettings.cpp.

◆ filterMax()

double QgsMeshRendererVectorSettings::filterMax ( ) const

Returns filter value for vector magnitudes.

If magnitude of the vector is higher than this value, the vector is not drawn. -1 represents that filtering is not active.

Definition at line 221 of file qgsmeshrenderersettings.cpp.

◆ filterMin()

double QgsMeshRendererVectorSettings::filterMin ( ) const

Returns filter value for vector magnitudes.

If magnitude of the vector is lower than this value, the vector is not drawn. -1 represents that filtering is not active.

Definition at line 211 of file qgsmeshrenderersettings.cpp.

◆ isOnUserDefinedGrid()

bool QgsMeshRendererVectorSettings::isOnUserDefinedGrid ( ) const

Returns whether vectors are drawn on user-defined grid.

Definition at line 231 of file qgsmeshrenderersettings.cpp.

◆ lineWidth()

double QgsMeshRendererVectorSettings::lineWidth ( ) const

Returns line width of the arrow (in millimeters)

Definition at line 191 of file qgsmeshrenderersettings.cpp.

◆ readXml()

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

Reads configuration from the given DOM element.

Definition at line 619 of file qgsmeshrenderersettings.cpp.

◆ setArrowsSettings()

void QgsMeshRendererVectorSettings::setArrowsSettings ( const QgsMeshRendererVectorArrowSettings & arrowSettings )

Sets settings for vector rendered with arrows.

Since: QGIS 3.12

Definition at line 580 of file qgsmeshrenderersettings.cpp.

◆ setColor()

void QgsMeshRendererVectorSettings::setColor ( const QColor & color )

Sets color used for drawing arrows.

Definition at line 206 of file qgsmeshrenderersettings.cpp.

◆ setColoringMethod()

void QgsMeshRendererVectorSettings::setColoringMethod ( const QgsInterpolatedLineColor::ColoringMethod & coloringMethod )

Sets the coloring method used to render vector datasets.

Since: QGIS 3.14

Definition at line 654 of file qgsmeshrenderersettings.cpp.

◆ setColorRampShader()

void QgsMeshRendererVectorSettings::setColorRampShader ( const QgsColorRampShader & colorRampShader )

Returns the color ramp shader used to render vector datasets.

Since: QGIS 3.14

Definition at line 664 of file qgsmeshrenderersettings.cpp.

◆ setFilterMax()

void QgsMeshRendererVectorSettings::setFilterMax ( double filterMax )

Sets filter value for vector magnitudes.

See also: filterMax()

Definition at line 226 of file qgsmeshrenderersettings.cpp.

◆ setFilterMin()

void QgsMeshRendererVectorSettings::setFilterMin ( double filterMin )

Sets filter value for vector magnitudes.

See also: filterMin()

Definition at line 216 of file qgsmeshrenderersettings.cpp.

◆ setLineWidth()

void QgsMeshRendererVectorSettings::setLineWidth ( double lineWidth )

Sets line width of the arrow in pixels (in millimeters)

Definition at line 196 of file qgsmeshrenderersettings.cpp.

◆ setOnUserDefinedGrid()

void QgsMeshRendererVectorSettings::setOnUserDefinedGrid ( bool enabled )

Toggles drawing of vectors on user defined grid.

Definition at line 236 of file qgsmeshrenderersettings.cpp.

◆ setStreamLinesSettings()

void QgsMeshRendererVectorSettings::setStreamLinesSettings ( const QgsMeshRendererVectorStreamlineSettings & streamLinesSettings )

Sets settings for vector rendered with streamlines.

Since: QGIS 3.12

Definition at line 590 of file qgsmeshrenderersettings.cpp.

◆ setSymbology()

void QgsMeshRendererVectorSettings::setSymbology ( const Symbology & symbology )

Sets the displaying method used to render vector datasets.

Since: QGIS 3.12

Definition at line 570 of file qgsmeshrenderersettings.cpp.

◆ setTracesSettings()

void QgsMeshRendererVectorSettings::setTracesSettings ( const QgsMeshRendererVectorTracesSettings & tracesSettings )

Sets settings for vector rendered with traces.

Since: QGIS 3.12

Definition at line 690 of file qgsmeshrenderersettings.cpp.

◆ setUserGridCellHeight()

void QgsMeshRendererVectorSettings::setUserGridCellHeight ( int height )

Sets height of user grid cell (in pixels)

Definition at line 256 of file qgsmeshrenderersettings.cpp.

◆ setUserGridCellWidth()

void QgsMeshRendererVectorSettings::setUserGridCellWidth ( int width )

Sets width of user grid cell (in pixels)

Definition at line 246 of file qgsmeshrenderersettings.cpp.

◆ streamLinesSettings()

QgsMeshRendererVectorStreamlineSettings QgsMeshRendererVectorSettings::streamLinesSettings ( ) const

Returns settings for vector rendered with streamlines.

Since: QGIS 3.12

Definition at line 585 of file qgsmeshrenderersettings.cpp.

◆ symbology()

QgsMeshRendererVectorSettings::Symbology QgsMeshRendererVectorSettings::symbology ( ) const

Returns the displaying method used to render vector datasets.

Since: QGIS 3.12

Definition at line 565 of file qgsmeshrenderersettings.cpp.

◆ tracesSettings()

QgsMeshRendererVectorTracesSettings QgsMeshRendererVectorSettings::tracesSettings ( ) const

Returns settings for vector rendered with traces.

Since: QGIS 3.12

Definition at line 685 of file qgsmeshrenderersettings.cpp.

◆ userGridCellHeight()

int QgsMeshRendererVectorSettings::userGridCellHeight ( ) const

Returns height in pixels of user grid cell.

Definition at line 251 of file qgsmeshrenderersettings.cpp.

◆ userGridCellWidth()

int QgsMeshRendererVectorSettings::userGridCellWidth ( ) const

Returns width in pixels of user grid cell.

Definition at line 241 of file qgsmeshrenderersettings.cpp.

◆ vectorStrokeColoring()

QgsInterpolatedLineColor QgsMeshRendererVectorSettings::vectorStrokeColoring ( ) const

Returns the stroke coloring used to render vector datasets.

Since: QGIS 3.14

Definition at line 669 of file qgsmeshrenderersettings.cpp.

◆ writeXml()

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

Writes configuration to a new DOM element.

Definition at line 595 of file qgsmeshrenderersettings.cpp.

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

/build/qgis-3.18.1+99unstable/src/core/mesh/qgsmeshrenderersettings.h
/build/qgis-3.18.1+99unstable/src/core/mesh/qgsmeshrenderersettings.cpp

Public Types

Public Member Functions