QgsVectorFieldArrowSettings Class Reference

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

#include <qgsvectorfieldarrowsettings.h>

Inheritance diagram for QgsVectorFieldArrowSettings:

Public Member Functions
double	arrowHeadLengthRatio () const
	Returns ratio of the head length of the arrow (range 0-1).
double	arrowHeadWidthRatio () const
	Returns ratio of the head width of the arrow (range 0-1).
double	fixedShaftLength () const
	Returns fixed arrow length (in millimeters).
double	maxShaftLength () const
	Returns maximum shaft length (in millimeters).
double	minShaftLength () const
	Returns mininimum shaft length (in millimeters).
void	readXml (const QDomElement &elem)
	Reads configuration from the given DOM element.
double	scaleFactor () const
	Returns scale factor.
void	setArrowHeadLengthRatio (double arrowHeadLengthRatio)
	Sets ratio of the head length of the arrow (range 0-1).
void	setArrowHeadWidthRatio (double arrowHeadWidthRatio)
	Sets ratio of the head width of the arrow (range 0-1).
void	setFixedShaftLength (double fixedShaftLength)
	Sets fixed length (in millimeters).
void	setMaxShaftLength (double maxShaftLength)
	Sets maximum shaft length (in millimeters).
void	setMinShaftLength (double minShaftLength)
	Sets mininimum shaft length (in millimeters).
void	setScaleFactor (double scaleFactor)
	Sets scale factor.
void	setShaftLengthMethod (Qgis::VectorFieldArrowScalingMethod shaftLengthMethod)
	Sets method used for drawing arrows.
Qgis::VectorFieldArrowScalingMethod	shaftLengthMethod () const
	Returns method used for drawing arrows.
QDomElement	writeXml (QDomDocument &doc) const
	Writes configuration to a new DOM element.

Detailed Description

Represents a mesh renderer settings for vector datasets displayed with arrows.

Since

QGIS 4.4

Definition at line 31 of file qgsvectorfieldarrowsettings.h.

Member Function Documentation

arrowHeadLengthRatio()

double QgsVectorFieldArrowSettings::arrowHeadLengthRatio

(

)

const

Returns ratio of the head length of the arrow (range 0-1).

Definition at line 82 of file qgsvectorfieldarrowsettings.cpp.

arrowHeadWidthRatio()

double QgsVectorFieldArrowSettings::arrowHeadWidthRatio

(

)

const

Returns ratio of the head width of the arrow (range 0-1).

Definition at line 72 of file qgsvectorfieldarrowsettings.cpp.

fixedShaftLength()

double QgsVectorFieldArrowSettings::fixedShaftLength

(

)

const

Returns fixed arrow length (in millimeters).

Only for Qgis::VectorFieldArrowScalingMethod::Fixed

Definition at line 62 of file qgsvectorfieldarrowsettings.cpp.

maxShaftLength()

double QgsVectorFieldArrowSettings::maxShaftLength

(

)

const

Returns maximum shaft length (in millimeters).

Only for Qgis::VectorFieldArrowScalingMethod::MinMax

Definition at line 42 of file qgsvectorfieldarrowsettings.cpp.

minShaftLength()

double QgsVectorFieldArrowSettings::minShaftLength

(

)

const

Returns mininimum shaft length (in millimeters).

Only for Qgis::VectorFieldArrowScalingMethod::MinMax

Definition at line 32 of file qgsvectorfieldarrowsettings.cpp.

readXml()

void QgsVectorFieldArrowSettings::readXml

(

const QDomElement &

elem

)

Reads configuration from the given DOM element.

Definition at line 121 of file qgsvectorfieldarrowsettings.cpp.

scaleFactor()

double QgsVectorFieldArrowSettings::scaleFactor

(

)

const

Returns scale factor.

Only for Qgis::VectorFieldArrowScalingMethod::Scaled

Definition at line 52 of file qgsvectorfieldarrowsettings.cpp.

setArrowHeadLengthRatio()

void QgsVectorFieldArrowSettings::setArrowHeadLengthRatio

(

double

arrowHeadLengthRatio

)

Sets ratio of the head length of the arrow (range 0-1).

Definition at line 87 of file qgsvectorfieldarrowsettings.cpp.

setArrowHeadWidthRatio()

void QgsVectorFieldArrowSettings::setArrowHeadWidthRatio

(

double

arrowHeadWidthRatio

)

Sets ratio of the head width of the arrow (range 0-1).

Definition at line 77 of file qgsvectorfieldarrowsettings.cpp.

setFixedShaftLength()

void QgsVectorFieldArrowSettings::setFixedShaftLength

(

double

fixedShaftLength

)

Sets fixed length (in millimeters).

Only for Qgis::VectorFieldArrowScalingMethod::Fixed

Definition at line 67 of file qgsvectorfieldarrowsettings.cpp.

setMaxShaftLength()

void QgsVectorFieldArrowSettings::setMaxShaftLength

(

double

maxShaftLength

)

Sets maximum shaft length (in millimeters).

Only for Qgis::VectorFieldArrowScalingMethod::MinMax

Definition at line 47 of file qgsvectorfieldarrowsettings.cpp.

setMinShaftLength()

void QgsVectorFieldArrowSettings::setMinShaftLength

(

double

minShaftLength

)

Sets mininimum shaft length (in millimeters).

Only for Qgis::VectorFieldArrowScalingMethod::MinMax

Definition at line 37 of file qgsvectorfieldarrowsettings.cpp.

setScaleFactor()

void QgsVectorFieldArrowSettings::setScaleFactor

(

double

scaleFactor

)

Sets scale factor.

Only for Qgis::VectorFieldArrowScalingMethod::Scaled

Definition at line 57 of file qgsvectorfieldarrowsettings.cpp.

setShaftLengthMethod()

void QgsVectorFieldArrowSettings::setShaftLengthMethod

(

Qgis::VectorFieldArrowScalingMethod

shaftLengthMethod

)

Sets method used for drawing arrows.

Definition at line 27 of file qgsvectorfieldarrowsettings.cpp.

shaftLengthMethod()

Qgis::VectorFieldArrowScalingMethod QgsVectorFieldArrowSettings::shaftLengthMethod

(

)

const

Returns method used for drawing arrows.

Definition at line 22 of file qgsvectorfieldarrowsettings.cpp.

writeXml()

QDomElement QgsVectorFieldArrowSettings::writeXml

(

QDomDocument &

doc

)

const

Writes configuration to a new DOM element.

Definition at line 92 of file qgsvectorfieldarrowsettings.cpp.

---

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

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