QGIS API Documentation
3.12.1-București (121cc00ff0)
|
Represents a mesh renderer settings for vector datasets displayed with arrows. More...
#include <qgsmeshrenderersettings.h>
Public Types | |
enum | ArrowScalingMethod { MinMax = 0, Scaled, Fixed } |
Algorithm how to transform vector magnitude to length of arrow on the device in pixels. More... | |
Public Member Functions | |
double | arrowHeadLengthRatio () const |
Returns ratio of the head length of the arrow (range 0-1) More... | |
double | arrowHeadWidthRatio () const |
Returns ratio of the head width of the arrow (range 0-1) More... | |
double | fixedShaftLength () const |
Returns fixed arrow length (in millimeters) More... | |
double | maxShaftLength () const |
Returns maximum shaft length (in millimeters) More... | |
double | minShaftLength () const |
Returns mininimum shaft length (in millimeters) More... | |
void | readXml (const QDomElement &elem) |
Reads configuration from the given DOM element. More... | |
double | scaleFactor () const |
Returns scale factor. More... | |
void | setArrowHeadLengthRatio (double arrowHeadLengthRatio) |
Sets ratio of the head length of the arrow (range 0-1) More... | |
void | setArrowHeadWidthRatio (double arrowHeadWidthRatio) |
Sets ratio of the head width of the arrow (range 0-1) More... | |
void | setFixedShaftLength (double fixedShaftLength) |
Sets fixed length (in millimeters) More... | |
void | setMaxShaftLength (double maxShaftLength) |
Sets maximum shaft length (in millimeters) More... | |
void | setMinShaftLength (double minShaftLength) |
Sets mininimum shaft length (in millimeters) More... | |
void | setScaleFactor (double scaleFactor) |
Sets scale factor. More... | |
void | setShaftLengthMethod (ArrowScalingMethod shaftLengthMethod) |
Sets method used for drawing arrows. More... | |
QgsMeshRendererVectorArrowSettings::ArrowScalingMethod | shaftLengthMethod () const |
Returns method used for drawing arrows. More... | |
QDomElement | writeXml (QDomDocument &doc) const |
Writes configuration to a new DOM element. More... | |
Represents a mesh renderer settings for vector datasets displayed with arrows.
Definition at line 153 of file qgsmeshrenderersettings.h.
Algorithm how to transform vector magnitude to length of arrow on the device in pixels.
Enumerator | |
---|---|
MinMax | Scale vector magnitude linearly to fit in range of vectorFilterMin() and vectorFilterMax() |
Scaled | Scale vector magnitude by factor scaleFactor() |
Fixed | Use fixed length fixedShaftLength() regardless of vector's magnitude. |
Definition at line 158 of file qgsmeshrenderersettings.h.
double QgsMeshRendererVectorArrowSettings::arrowHeadLengthRatio | ( | ) | const |
Returns ratio of the head length of the arrow (range 0-1)
Definition at line 277 of file qgsmeshrenderersettings.cpp.
double QgsMeshRendererVectorArrowSettings::arrowHeadWidthRatio | ( | ) | const |
Returns ratio of the head width of the arrow (range 0-1)
Definition at line 267 of file qgsmeshrenderersettings.cpp.
double QgsMeshRendererVectorArrowSettings::fixedShaftLength | ( | ) | const |
Returns fixed arrow length (in millimeters)
Only for QgsMeshRendererVectorSettings::ArrowScalingMethod::Fixed
Definition at line 257 of file qgsmeshrenderersettings.cpp.
double QgsMeshRendererVectorArrowSettings::maxShaftLength | ( | ) | const |
Returns maximum shaft length (in millimeters)
Only for QgsMeshRendererVectorSettings::ArrowScalingMethod::MinMax
Definition at line 237 of file qgsmeshrenderersettings.cpp.
double QgsMeshRendererVectorArrowSettings::minShaftLength | ( | ) | const |
Returns mininimum shaft length (in millimeters)
Only for QgsMeshRendererVectorSettings::ArrowScalingMethod::MinMax
Definition at line 227 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorArrowSettings::readXml | ( | const QDomElement & | elem | ) |
Reads configuration from the given DOM element.
Definition at line 316 of file qgsmeshrenderersettings.cpp.
double QgsMeshRendererVectorArrowSettings::scaleFactor | ( | ) | const |
Returns scale factor.
Only for QgsMeshRendererVectorSettings::ArrowScalingMethod::Scaled
Definition at line 247 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorArrowSettings::setArrowHeadLengthRatio | ( | double | arrowHeadLengthRatio | ) |
Sets ratio of the head length of the arrow (range 0-1)
Definition at line 282 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorArrowSettings::setArrowHeadWidthRatio | ( | double | arrowHeadWidthRatio | ) |
Sets ratio of the head width of the arrow (range 0-1)
Definition at line 272 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorArrowSettings::setFixedShaftLength | ( | double | fixedShaftLength | ) |
Sets fixed length (in millimeters)
Only for QgsMeshRendererVectorSettings::ArrowScalingMethod::Fixed
Definition at line 262 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorArrowSettings::setMaxShaftLength | ( | double | maxShaftLength | ) |
Sets maximum shaft length (in millimeters)
Only for QgsMeshRendererVectorSettings::ArrowScalingMethod::MinMax
Definition at line 242 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorArrowSettings::setMinShaftLength | ( | double | minShaftLength | ) |
Sets mininimum shaft length (in millimeters)
Only for QgsMeshRendererVectorSettings::ArrowScalingMethod::MinMax
Definition at line 232 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorArrowSettings::setScaleFactor | ( | double | scaleFactor | ) |
Sets scale factor.
Only for QgsMeshRendererVectorSettings::ArrowScalingMethod::Scaled
Definition at line 252 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorArrowSettings::setShaftLengthMethod | ( | QgsMeshRendererVectorArrowSettings::ArrowScalingMethod | shaftLengthMethod | ) |
Sets method used for drawing arrows.
Definition at line 222 of file qgsmeshrenderersettings.cpp.
QgsMeshRendererVectorArrowSettings::ArrowScalingMethod QgsMeshRendererVectorArrowSettings::shaftLengthMethod | ( | ) | const |
Returns method used for drawing arrows.
Definition at line 217 of file qgsmeshrenderersettings.cpp.
QDomElement QgsMeshRendererVectorArrowSettings::writeXml | ( | QDomDocument & | doc | ) | const |
Writes configuration to a new DOM element.
Definition at line 287 of file qgsmeshrenderersettings.cpp.