QGIS API Documentation
3.12.1-București (121cc00ff0)
|
Represents a streamline renderer settings for vector datasets. More...
#include <qgsmeshrenderersettings.h>
Public Types | |
enum | Symbology { Arrows = 0, Streamlines, Traces } |
Defines the symbology of vector rendering. More... | |
Public Member Functions | |
QgsMeshRendererVectorArrowSettings | arrowSettings () const |
Returns settings for vector rendered with arrows. More... | |
QColor | color () const |
Returns color used for drawing arrows. More... | |
double | filterMax () const |
Returns filter value for vector magnitudes. More... | |
double | filterMin () const |
Returns filter value for vector magnitudes. More... | |
bool | isOnUserDefinedGrid () const |
Returns whether vectors are drawn on user-defined grid. More... | |
double | lineWidth () const |
Returns line width of the arrow (in millimeters) More... | |
void | readXml (const QDomElement &elem) |
Reads configuration from the given DOM element. More... | |
void | setArrowsSettings (const QgsMeshRendererVectorArrowSettings &arrowSettings) |
Sets settings for vector rendered with arrows. More... | |
void | setColor (const QColor &color) |
Sets color used for drawing arrows. More... | |
void | setFilterMax (double filterMax) |
Sets filter value for vector magnitudes. More... | |
void | setFilterMin (double filterMin) |
Sets filter value for vector magnitudes. More... | |
void | setLineWidth (double lineWidth) |
Sets line width of the arrow in pixels (in millimeters) More... | |
void | setOnUserDefinedGrid (bool enabled) |
Toggles drawing of vectors on user defined grid. More... | |
void | setStreamLinesSettings (const QgsMeshRendererVectorStreamlineSettings &streamLinesSettings) |
Sets settings for vector rendered with streamlines. More... | |
void | setSymbology (const Symbology &symbology) |
Sets the displaying method used to render vector datasets. More... | |
void | setTracesSettings (const QgsMeshRendererVectorTracesSettings &tracesSettings) |
Sets settings for vector rendered with traces. More... | |
void | setUserGridCellHeight (int height) |
Sets height of user grid cell (in pixels) More... | |
void | setUserGridCellWidth (int width) |
Sets width of user grid cell (in pixels) More... | |
QgsMeshRendererVectorStreamlineSettings | streamLinesSettings () const |
Returns settings for vector rendered with streamlines. More... | |
Symbology | symbology () const |
Returns the displaying method used to render vector datasets. More... | |
QgsMeshRendererVectorTracesSettings | tracesSettings () const |
Returns settings for vector rendered with traces. More... | |
int | userGridCellHeight () const |
Returns height in pixels of user grid cell. More... | |
int | userGridCellWidth () const |
Returns width in pixels of user grid cell. More... | |
QDomElement | writeXml (QDomDocument &doc) const |
Writes configuration to a new DOM element. More... | |
Represents a streamline renderer settings for vector datasets.
Definition at line 358 of file qgsmeshrenderersettings.h.
Defines the symbology of vector rendering.
Enumerator | |
---|---|
Arrows | Displaying vector dataset with arrows. |
Streamlines | Displaying vector dataset with streamlines. |
Traces | Displaying vector dataset with streamlines. |
Definition at line 366 of file qgsmeshrenderersettings.h.
QgsMeshRendererVectorArrowSettings QgsMeshRendererVectorSettings::arrowSettings | ( | ) | const |
Returns settings for vector rendered with arrows.
Definition at line 513 of file qgsmeshrenderersettings.cpp.
QColor QgsMeshRendererVectorSettings::color | ( | ) | const |
Returns color used for drawing arrows.
Definition at line 157 of file qgsmeshrenderersettings.cpp.
double QgsMeshRendererVectorSettings::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 177 of file qgsmeshrenderersettings.cpp.
double QgsMeshRendererVectorSettings::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 167 of file qgsmeshrenderersettings.cpp.
bool QgsMeshRendererVectorSettings::isOnUserDefinedGrid | ( | ) | const |
Returns whether vectors are drawn on user-defined grid.
Definition at line 187 of file qgsmeshrenderersettings.cpp.
double QgsMeshRendererVectorSettings::lineWidth | ( | ) | const |
Returns line width of the arrow (in millimeters)
Definition at line 147 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::readXml | ( | const QDomElement & | elem | ) |
Reads configuration from the given DOM element.
Definition at line 554 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setArrowsSettings | ( | const QgsMeshRendererVectorArrowSettings & | arrowSettings | ) |
Sets settings for vector rendered with arrows.
Definition at line 518 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setColor | ( | const QColor & | color | ) |
Sets color used for drawing arrows.
Definition at line 162 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setFilterMax | ( | double | filterMax | ) |
Sets filter value for vector magnitudes.
Definition at line 182 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setFilterMin | ( | double | filterMin | ) |
Sets filter value for vector magnitudes.
Definition at line 172 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setLineWidth | ( | double | lineWidth | ) |
Sets line width of the arrow in pixels (in millimeters)
Definition at line 152 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setOnUserDefinedGrid | ( | bool | enabled | ) |
Toggles drawing of vectors on user defined grid.
Definition at line 192 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setStreamLinesSettings | ( | const QgsMeshRendererVectorStreamlineSettings & | streamLinesSettings | ) |
Sets settings for vector rendered with streamlines.
Definition at line 528 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setSymbology | ( | const Symbology & | symbology | ) |
Sets the displaying method used to render vector datasets.
Definition at line 508 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setTracesSettings | ( | const QgsMeshRendererVectorTracesSettings & | tracesSettings | ) |
Sets settings for vector rendered with traces.
Definition at line 586 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setUserGridCellHeight | ( | int | height | ) |
Sets height of user grid cell (in pixels)
Definition at line 212 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setUserGridCellWidth | ( | int | width | ) |
Sets width of user grid cell (in pixels)
Definition at line 202 of file qgsmeshrenderersettings.cpp.
QgsMeshRendererVectorStreamlineSettings QgsMeshRendererVectorSettings::streamLinesSettings | ( | ) | const |
Returns settings for vector rendered with streamlines.
Definition at line 523 of file qgsmeshrenderersettings.cpp.
QgsMeshRendererVectorSettings::Symbology QgsMeshRendererVectorSettings::symbology | ( | ) | const |
Returns the displaying method used to render vector datasets.
Definition at line 503 of file qgsmeshrenderersettings.cpp.
QgsMeshRendererVectorTracesSettings QgsMeshRendererVectorSettings::tracesSettings | ( | ) | const |
Returns settings for vector rendered with traces.
Definition at line 581 of file qgsmeshrenderersettings.cpp.
int QgsMeshRendererVectorSettings::userGridCellHeight | ( | ) | const |
Returns height in pixels of user grid cell.
Definition at line 207 of file qgsmeshrenderersettings.cpp.
int QgsMeshRendererVectorSettings::userGridCellWidth | ( | ) | const |
Returns width in pixels of user grid cell.
Definition at line 197 of file qgsmeshrenderersettings.cpp.
QDomElement QgsMeshRendererVectorSettings::writeXml | ( | QDomDocument & | doc | ) | const |
Writes configuration to a new DOM element.
Definition at line 533 of file qgsmeshrenderersettings.cpp.