Represents a mesh renderer settings for vector datasets displayed with wind barbs. More...

#include <qgsmeshrenderersettings.h>

Public Types
enum class	WindSpeedUnit { MetersPerSecond = 0 , KilometersPerHour , Knots , MilesPerHour , FeetPerSecond , OtherUnit }
	Wind speed units. Wind barbs use knots so we use this enum for preset conversion values. More...

Public Member Functions
double	magnitudeMultiplier () const
	Returns the multiplier for the magnitude to convert it to knots, according to the units set with setMagnitudeUnits() A custom multiplier can be set with setMagnitudeMultiplier() for the case when units are set to OtherUnit.

WindSpeedUnit	magnitudeUnits () const
	Returns the units that the data are in.

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

void	setMagnitudeMultiplier (double magnitudeMultiplier)
	Sets a multiplier for the magnitude to convert it to knots.

void	setMagnitudeUnits (WindSpeedUnit units)
	Sets the units that the data are in.

void	setShaftLength (double shaftLength)
	Sets the shaft length (in millimeters)

void	setShaftLengthUnits (Qgis::RenderUnit shaftLengthUnit)
	Sets the units for the shaft length.

double	shaftLength () const
	Returns the shaft length (in millimeters)

Qgis::RenderUnit	shaftLengthUnits () const
	Returns the units for the shaft length.

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

Detailed Description

Represents a mesh renderer settings for vector datasets displayed with wind barbs.

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

Since: QGIS 3.38

Definition at line 407 of file qgsmeshrenderersettings.h.

Member Enumeration Documentation

◆ WindSpeedUnit

enum class QgsMeshRendererVectorWindBarbSettings::WindSpeedUnit

strong

Wind speed units. Wind barbs use knots so we use this enum for preset conversion values.

Enumerator
MetersPerSecond	Meters per second.
KilometersPerHour	Kilometers per hour.
Knots	Knots (Nautical miles per hour)
MilesPerHour	Miles per hour.
FeetPerSecond	Feet per second.
OtherUnit	Other unit.

Definition at line 411 of file qgsmeshrenderersettings.h.

Member Function Documentation

◆ magnitudeMultiplier()

double QgsMeshRendererVectorWindBarbSettings::magnitudeMultiplier ( ) const

Returns the multiplier for the magnitude to convert it to knots, according to the units set with setMagnitudeUnits() A custom multiplier can be set with setMagnitudeMultiplier() for the case when units are set to OtherUnit.

Definition at line 783 of file qgsmeshrenderersettings.cpp.

◆ magnitudeUnits()

QgsMeshRendererVectorWindBarbSettings::WindSpeedUnit QgsMeshRendererVectorWindBarbSettings::magnitudeUnits ( ) const

Returns the units that the data are in.

Definition at line 828 of file qgsmeshrenderersettings.cpp.

◆ readXml()

void QgsMeshRendererVectorWindBarbSettings::readXml ( const QDomElement & elem )

Reads configuration from the given DOM element.

Definition at line 763 of file qgsmeshrenderersettings.cpp.

◆ setMagnitudeMultiplier()

void QgsMeshRendererVectorWindBarbSettings::setMagnitudeMultiplier ( double magnitudeMultiplier )

Sets a multiplier for the magnitude to convert it to knots.

Definition at line 803 of file qgsmeshrenderersettings.cpp.

◆ setMagnitudeUnits()

void QgsMeshRendererVectorWindBarbSettings::setMagnitudeUnits ( WindSpeedUnit units )

Sets the units that the data are in.

Definition at line 833 of file qgsmeshrenderersettings.cpp.

◆ setShaftLength()

void QgsMeshRendererVectorWindBarbSettings::setShaftLength ( double shaftLength )

Sets the shaft length (in millimeters)

Definition at line 813 of file qgsmeshrenderersettings.cpp.

◆ setShaftLengthUnits()

void QgsMeshRendererVectorWindBarbSettings::setShaftLengthUnits ( Qgis::RenderUnit shaftLengthUnit )

Sets the units for the shaft length.

See also: shaftLengthUnits()

Definition at line 823 of file qgsmeshrenderersettings.cpp.

◆ shaftLength()

double QgsMeshRendererVectorWindBarbSettings::shaftLength ( ) const

Returns the shaft length (in millimeters)

Definition at line 808 of file qgsmeshrenderersettings.cpp.

◆ shaftLengthUnits()

Qgis::RenderUnit QgsMeshRendererVectorWindBarbSettings::shaftLengthUnits ( ) const

Returns the units for the shaft length.

See also: setShaftLengthUnits()

Definition at line 818 of file qgsmeshrenderersettings.cpp.

◆ writeXml()

QDomElement QgsMeshRendererVectorWindBarbSettings::writeXml ( QDomDocument & doc ) const

Writes configuration to a new DOM element.

Definition at line 773 of file qgsmeshrenderersettings.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/mesh/qgsmeshrenderersettings.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/mesh/qgsmeshrenderersettings.cpp

Public Types

Public Member Functions