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

#include <qgsvectorfieldsettings.h>

Inheritance diagram for QgsVectorFieldSettings:

Public Member Functions
QgsVectorFieldArrowSettings	arrowSettings () const
	Returns settings for vector rendered with arrows.
QColor	color () const
	Returns color used for drawing arrows.
QgsInterpolatedLineColor::ColoringMethod	coloringMethod () const
	Returns the coloring method used to render vector datasets.
QgsColorRampShader	colorRampShader () const
	Sets the color ramp shader used to render vector datasets.
double	filterMax () const
	Returns filter value for vector magnitudes.
double	filterMin () const
	Returns filter value for vector magnitudes.
bool	isOnUserDefinedGrid () const
	Returns whether vectors are drawn on user-defined grid.
double	lineWidth () const
	Returns line width of the arrow (in millimeters).
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context=QgsReadWriteContext())
	Reads configuration from the given DOM element.
void	setArrowsSettings (const QgsVectorFieldArrowSettings &arrowSettings)
	Sets settings for vector rendered with arrows.
void	setColor (const QColor &color)
	Sets color used for drawing arrows.
void	setColoringMethod (const QgsInterpolatedLineColor::ColoringMethod &coloringMethod)
	Sets the coloring method used to render vector datasets.
void	setColorRampShader (const QgsColorRampShader &colorRampShader)
	Returns the color ramp shader used to render vector datasets.
void	setFilterMax (double filterMax)
	Sets filter value for vector magnitudes.
void	setFilterMin (double filterMin)
	Sets filter value for vector magnitudes.
void	setLineWidth (double lineWidth)
	Sets line width of the arrow in pixels (in millimeters).
void	setOnUserDefinedGrid (bool enabled)
	Toggles drawing of vectors on user defined grid.
void	setStreamLinesSettings (const QgsVectorFieldStreamlineSettings &streamLinesSettings)
	Sets settings for vector rendered with streamlines.
void	setSymbology (const Qgis::VectorFieldSymbology &symbology)
	Sets the displaying method used to render vector datasets.
void	setTracesSettings (const QgsVectorFieldTracesSettings &tracesSettings)
	Sets settings for vector rendered with traces.
void	setUserGridCellHeight (int height)
	Sets height of user grid cell (in pixels).
void	setUserGridCellWidth (int width)
	Sets width of user grid cell (in pixels).
void	setWindBarbSettings (const QgsVectorFieldWindBarbSettings &windBarbSettings)
	Sets settings for vector rendered with wind barbs.
QgsVectorFieldStreamlineSettings	streamLinesSettings () const
	Returns settings for vector rendered with streamlines.
Qgis::VectorFieldSymbology	symbology () const
	Returns the displaying method used to render vector datasets.
QgsVectorFieldTracesSettings	tracesSettings () const
	Returns settings for vector rendered with traces.
int	userGridCellHeight () const
	Returns height in pixels of user grid cell.
int	userGridCellWidth () const
	Returns width in pixels of user grid cell.
QgsInterpolatedLineColor	vectorStrokeColoring () const
	Returns the stroke coloring used to render vector datasets.
QgsVectorFieldWindBarbSettings	windBarbSettings () const
	Returns settings for vector rendered with wind barbs.
QDomElement	writeXml (QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext()) const
	Writes configuration to a new DOM element.

Detailed Description

Represents a renderer settings for vector datasets.

Since: QGIS 4.4

Definition at line 38 of file qgsvectorfieldsettings.h.

Member Function Documentation

◆ arrowSettings()

QgsVectorFieldArrowSettings QgsVectorFieldSettings::arrowSettings ( ) const

Returns settings for vector rendered with arrows.

Definition at line 104 of file qgsvectorfieldsettings.cpp.

◆ color()

QColor QgsVectorFieldSettings::color ( ) const

Returns color used for drawing arrows.

Definition at line 34 of file qgsvectorfieldsettings.cpp.

◆ coloringMethod()

QgsInterpolatedLineColor::ColoringMethod QgsVectorFieldSettings::coloringMethod ( ) const

Returns the coloring method used to render vector datasets.

Definition at line 181 of file qgsvectorfieldsettings.cpp.

◆ colorRampShader()

QgsColorRampShader QgsVectorFieldSettings::colorRampShader ( ) const

Sets the color ramp shader used to render vector datasets.

Definition at line 191 of file qgsvectorfieldsettings.cpp.

◆ filterMax()

double QgsVectorFieldSettings::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 54 of file qgsvectorfieldsettings.cpp.

◆ filterMin()

double QgsVectorFieldSettings::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 44 of file qgsvectorfieldsettings.cpp.

◆ isOnUserDefinedGrid()

bool QgsVectorFieldSettings::isOnUserDefinedGrid ( ) const

Returns whether vectors are drawn on user-defined grid.

Definition at line 64 of file qgsvectorfieldsettings.cpp.

◆ lineWidth()

double QgsVectorFieldSettings::lineWidth ( ) const

Returns line width of the arrow (in millimeters).

Definition at line 24 of file qgsvectorfieldsettings.cpp.

◆ readXml()

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

Reads configuration from the given DOM element.

Definition at line 149 of file qgsvectorfieldsettings.cpp.

◆ setArrowsSettings()

void QgsVectorFieldSettings::setArrowsSettings ( const QgsVectorFieldArrowSettings & arrowSettings )

Sets settings for vector rendered with arrows.

Definition at line 109 of file qgsvectorfieldsettings.cpp.

◆ setColor()

void QgsVectorFieldSettings::setColor ( const QColor & color )

Sets color used for drawing arrows.

Definition at line 39 of file qgsvectorfieldsettings.cpp.

◆ setColoringMethod()

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

Sets the coloring method used to render vector datasets.

Definition at line 186 of file qgsvectorfieldsettings.cpp.

◆ setColorRampShader()

void QgsVectorFieldSettings::setColorRampShader ( const QgsColorRampShader & colorRampShader )

Returns the color ramp shader used to render vector datasets.

Definition at line 196 of file qgsvectorfieldsettings.cpp.

◆ setFilterMax()

void QgsVectorFieldSettings::setFilterMax ( double filterMax )

Sets filter value for vector magnitudes.

See also: filterMax()

Definition at line 59 of file qgsvectorfieldsettings.cpp.

◆ setFilterMin()

void QgsVectorFieldSettings::setFilterMin ( double filterMin )

Sets filter value for vector magnitudes.

See also: filterMin()

Definition at line 49 of file qgsvectorfieldsettings.cpp.

◆ setLineWidth()

void QgsVectorFieldSettings::setLineWidth ( double lineWidth )

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

Definition at line 29 of file qgsvectorfieldsettings.cpp.

◆ setOnUserDefinedGrid()

void QgsVectorFieldSettings::setOnUserDefinedGrid ( bool enabled )

Toggles drawing of vectors on user defined grid.

Definition at line 69 of file qgsvectorfieldsettings.cpp.

◆ setStreamLinesSettings()

void QgsVectorFieldSettings::setStreamLinesSettings ( const QgsVectorFieldStreamlineSettings & streamLinesSettings )

Sets settings for vector rendered with streamlines.

Definition at line 119 of file qgsvectorfieldsettings.cpp.

◆ setSymbology()

void QgsVectorFieldSettings::setSymbology ( const Qgis::VectorFieldSymbology & symbology )

Sets the displaying method used to render vector datasets.

Definition at line 99 of file qgsvectorfieldsettings.cpp.

◆ setTracesSettings()

void QgsVectorFieldSettings::setTracesSettings ( const QgsVectorFieldTracesSettings & tracesSettings )

Sets settings for vector rendered with traces.

Definition at line 222 of file qgsvectorfieldsettings.cpp.

◆ setUserGridCellHeight()

void QgsVectorFieldSettings::setUserGridCellHeight ( int height )

Sets height of user grid cell (in pixels).

Definition at line 89 of file qgsvectorfieldsettings.cpp.

◆ setUserGridCellWidth()

void QgsVectorFieldSettings::setUserGridCellWidth ( int width )

Sets width of user grid cell (in pixels).

Definition at line 79 of file qgsvectorfieldsettings.cpp.

◆ setWindBarbSettings()

void QgsVectorFieldSettings::setWindBarbSettings ( const QgsVectorFieldWindBarbSettings & windBarbSettings )

Sets settings for vector rendered with wind barbs.

Definition at line 232 of file qgsvectorfieldsettings.cpp.

◆ streamLinesSettings()

QgsVectorFieldStreamlineSettings QgsVectorFieldSettings::streamLinesSettings ( ) const

Returns settings for vector rendered with streamlines.

Definition at line 114 of file qgsvectorfieldsettings.cpp.

◆ symbology()

Qgis::VectorFieldSymbology QgsVectorFieldSettings::symbology ( ) const

Returns the displaying method used to render vector datasets.

Definition at line 94 of file qgsvectorfieldsettings.cpp.

◆ tracesSettings()

QgsVectorFieldTracesSettings QgsVectorFieldSettings::tracesSettings ( ) const

Returns settings for vector rendered with traces.

Definition at line 217 of file qgsvectorfieldsettings.cpp.

◆ userGridCellHeight()

int QgsVectorFieldSettings::userGridCellHeight ( ) const

Returns height in pixels of user grid cell.

Definition at line 84 of file qgsvectorfieldsettings.cpp.

◆ userGridCellWidth()

int QgsVectorFieldSettings::userGridCellWidth ( ) const

Returns width in pixels of user grid cell.

Definition at line 74 of file qgsvectorfieldsettings.cpp.

◆ vectorStrokeColoring()

QgsInterpolatedLineColor QgsVectorFieldSettings::vectorStrokeColoring ( ) const

Returns the stroke coloring used to render vector datasets.

Definition at line 201 of file qgsvectorfieldsettings.cpp.

◆ windBarbSettings()

QgsVectorFieldWindBarbSettings QgsVectorFieldSettings::windBarbSettings ( ) const

Returns settings for vector rendered with wind barbs.

Definition at line 227 of file qgsvectorfieldsettings.cpp.

◆ writeXml()

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

Writes configuration to a new DOM element.

Definition at line 124 of file qgsvectorfieldsettings.cpp.

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

/build/qgis-4.3.0+git20260916+2b7e6c9893e+99sid/src/core/vectorfield/qgsvectorfieldsettings.h
/build/qgis-4.3.0+git20260916+2b7e6c9893e+99sid/src/core/vectorfield/qgsvectorfieldsettings.cpp

Public Member Functions