QGIS API Documentation 4.3.0-Master (2b7e6c9893e)
Loading...
Searching...
No Matches
QgsVectorFieldWindBarbSettings Class Reference

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

#include <qgsvectorfieldwindbarbsettings.h>

Inheritance diagram for QgsVectorFieldWindBarbSettings:

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.
Qgis::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 (Qgis::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.

Since
QGIS 4.4

Definition at line 31 of file qgsvectorfieldwindbarbsettings.h.

Member Function Documentation

◆ magnitudeMultiplier()

double QgsVectorFieldWindBarbSettings::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 40 of file qgsvectorfieldwindbarbsettings.cpp.

◆ magnitudeUnits()

Qgis::WindSpeedUnit QgsVectorFieldWindBarbSettings::magnitudeUnits ( ) const

Returns the units that the data are in.

Definition at line 85 of file qgsvectorfieldwindbarbsettings.cpp.

◆ readXml()

void QgsVectorFieldWindBarbSettings::readXml ( const QDomElement & elem)

Reads configuration from the given DOM element.

Definition at line 22 of file qgsvectorfieldwindbarbsettings.cpp.

◆ setMagnitudeMultiplier()

void QgsVectorFieldWindBarbSettings::setMagnitudeMultiplier ( double magnitudeMultiplier)

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

Definition at line 60 of file qgsvectorfieldwindbarbsettings.cpp.

◆ setMagnitudeUnits()

void QgsVectorFieldWindBarbSettings::setMagnitudeUnits ( Qgis::WindSpeedUnit units)

Sets the units that the data are in.

Definition at line 90 of file qgsvectorfieldwindbarbsettings.cpp.

◆ setShaftLength()

void QgsVectorFieldWindBarbSettings::setShaftLength ( double shaftLength)

Sets the shaft length (in millimeters).

Definition at line 70 of file qgsvectorfieldwindbarbsettings.cpp.

◆ setShaftLengthUnits()

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

Sets the units for the shaft length.

See also
shaftLengthUnits()

Definition at line 80 of file qgsvectorfieldwindbarbsettings.cpp.

◆ shaftLength()

double QgsVectorFieldWindBarbSettings::shaftLength ( ) const

Returns the shaft length (in millimeters).

Definition at line 65 of file qgsvectorfieldwindbarbsettings.cpp.

◆ shaftLengthUnits()

Qgis::RenderUnit QgsVectorFieldWindBarbSettings::shaftLengthUnits ( ) const

Returns the units for the shaft length.

See also
setShaftLengthUnits()

Definition at line 75 of file qgsvectorfieldwindbarbsettings.cpp.

◆ writeXml()

QDomElement QgsVectorFieldWindBarbSettings::writeXml ( QDomDocument & doc) const

Writes configuration to a new DOM element.

Definition at line 30 of file qgsvectorfieldwindbarbsettings.cpp.


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