QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
Represents a renderer settings for vector datasets. More...
#include <qgsmeshrenderersettings.h>
Public Types | |
enum | Symbology { Arrows = 0 , Streamlines , Traces , WindBarbs } |
Defines the symbology of vector rendering. More... | |
Public Member Functions | |
QgsMeshRendererVectorArrowSettings | arrowSettings () const |
Returns settings for vector rendered with arrows. | |
QColor | color () const |
Returns color used for drawing arrows. | |
QgsInterpolatedLineColor::ColoringMethod | coloringMethod () const |
Returns the coloring method used to render vector datasets. | |
QgsColorRampShader | colorRampShader () const |
Sets the color ramp shader used to render vector datasets. | |
double | filterMax () const |
Returns filter value for vector magnitudes. | |
double | filterMin () const |
Returns filter value for vector magnitudes. | |
bool | isOnUserDefinedGrid () const |
Returns whether vectors are drawn on user-defined grid. | |
double | lineWidth () const |
Returns line width of the arrow (in millimeters) | |
void | readXml (const QDomElement &elem, const QgsReadWriteContext &context=QgsReadWriteContext()) |
Reads configuration from the given DOM element. | |
void | setArrowsSettings (const QgsMeshRendererVectorArrowSettings &arrowSettings) |
Sets settings for vector rendered with arrows. | |
void | setColor (const QColor &color) |
Sets color used for drawing arrows. | |
void | setColoringMethod (const QgsInterpolatedLineColor::ColoringMethod &coloringMethod) |
Sets the coloring method used to render vector datasets. | |
void | setColorRampShader (const QgsColorRampShader &colorRampShader) |
Returns the color ramp shader used to render vector datasets. | |
void | setFilterMax (double filterMax) |
Sets filter value for vector magnitudes. | |
void | setFilterMin (double filterMin) |
Sets filter value for vector magnitudes. | |
void | setLineWidth (double lineWidth) |
Sets line width of the arrow in pixels (in millimeters) | |
void | setOnUserDefinedGrid (bool enabled) |
Toggles drawing of vectors on user defined grid. | |
void | setStreamLinesSettings (const QgsMeshRendererVectorStreamlineSettings &streamLinesSettings) |
Sets settings for vector rendered with streamlines. | |
void | setSymbology (const Symbology &symbology) |
Sets the displaying method used to render vector datasets. | |
void | setTracesSettings (const QgsMeshRendererVectorTracesSettings &tracesSettings) |
Sets settings for vector rendered with traces. | |
void | setUserGridCellHeight (int height) |
Sets height of user grid cell (in pixels) | |
void | setUserGridCellWidth (int width) |
Sets width of user grid cell (in pixels) | |
void | setWindBarbSettings (const QgsMeshRendererVectorWindBarbSettings &windBarbSettings) |
Sets settings for vector rendered with wind barbs. | |
QgsMeshRendererVectorStreamlineSettings | streamLinesSettings () const |
Returns settings for vector rendered with streamlines. | |
Symbology | symbology () const |
Returns the displaying method used to render vector datasets. | |
QgsMeshRendererVectorTracesSettings | tracesSettings () const |
Returns settings for vector rendered with traces. | |
int | userGridCellHeight () const |
Returns height in pixels of user grid cell. | |
int | userGridCellWidth () const |
Returns width in pixels of user grid cell. | |
QgsInterpolatedLineColor | vectorStrokeColoring () const |
Returns the stroke coloring used to render vector datasets. | |
QgsMeshRendererVectorWindBarbSettings | windBarbSettings () const |
Returns settings for vector rendered with wind barbs. | |
QDomElement | writeXml (QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext()) const |
Writes configuration to a new DOM element. | |
Represents a renderer settings for vector datasets.
Definition at line 483 of file qgsmeshrenderersettings.h.
Defines the symbology of vector rendering.
Definition at line 491 of file qgsmeshrenderersettings.h.
QgsMeshRendererVectorArrowSettings QgsMeshRendererVectorSettings::arrowSettings | ( | ) | const |
Returns settings for vector rendered with arrows.
Definition at line 575 of file qgsmeshrenderersettings.cpp.
QColor QgsMeshRendererVectorSettings::color | ( | ) | const |
Returns color used for drawing arrows.
Definition at line 201 of file qgsmeshrenderersettings.cpp.
QgsInterpolatedLineColor::ColoringMethod QgsMeshRendererVectorSettings::coloringMethod | ( | ) | const |
Returns the coloring method used to render vector datasets.
Definition at line 654 of file qgsmeshrenderersettings.cpp.
QgsColorRampShader QgsMeshRendererVectorSettings::colorRampShader | ( | ) | const |
Sets the color ramp shader used to render vector datasets.
Definition at line 664 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 221 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 211 of file qgsmeshrenderersettings.cpp.
bool QgsMeshRendererVectorSettings::isOnUserDefinedGrid | ( | ) | const |
Returns whether vectors are drawn on user-defined grid.
Definition at line 231 of file qgsmeshrenderersettings.cpp.
double QgsMeshRendererVectorSettings::lineWidth | ( | ) | const |
Returns line width of the arrow (in millimeters)
Definition at line 191 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::readXml | ( | const QDomElement & | elem, |
const QgsReadWriteContext & | context = QgsReadWriteContext() |
||
) |
Reads configuration from the given DOM element.
Definition at line 620 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setArrowsSettings | ( | const QgsMeshRendererVectorArrowSettings & | arrowSettings | ) |
Sets settings for vector rendered with arrows.
Definition at line 580 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setColor | ( | const QColor & | color | ) |
Sets color used for drawing arrows.
Definition at line 206 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setColoringMethod | ( | const QgsInterpolatedLineColor::ColoringMethod & | coloringMethod | ) |
Sets the coloring method used to render vector datasets.
Definition at line 659 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setColorRampShader | ( | const QgsColorRampShader & | colorRampShader | ) |
Returns the color ramp shader used to render vector datasets.
Definition at line 669 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setFilterMax | ( | double | filterMax | ) |
Sets filter value for vector magnitudes.
Definition at line 226 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setFilterMin | ( | double | filterMin | ) |
Sets filter value for vector magnitudes.
Definition at line 216 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setLineWidth | ( | double | lineWidth | ) |
Sets line width of the arrow in pixels (in millimeters)
Definition at line 196 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setOnUserDefinedGrid | ( | bool | enabled | ) |
Toggles drawing of vectors on user defined grid.
Definition at line 236 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setStreamLinesSettings | ( | const QgsMeshRendererVectorStreamlineSettings & | streamLinesSettings | ) |
Sets settings for vector rendered with streamlines.
Definition at line 590 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setSymbology | ( | const Symbology & | symbology | ) |
Sets the displaying method used to render vector datasets.
Definition at line 570 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setTracesSettings | ( | const QgsMeshRendererVectorTracesSettings & | tracesSettings | ) |
Sets settings for vector rendered with traces.
Definition at line 695 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setUserGridCellHeight | ( | int | height | ) |
Sets height of user grid cell (in pixels)
Definition at line 256 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setUserGridCellWidth | ( | int | width | ) |
Sets width of user grid cell (in pixels)
Definition at line 246 of file qgsmeshrenderersettings.cpp.
void QgsMeshRendererVectorSettings::setWindBarbSettings | ( | const QgsMeshRendererVectorWindBarbSettings & | windBarbSettings | ) |
Sets settings for vector rendered with wind barbs.
Definition at line 758 of file qgsmeshrenderersettings.cpp.
QgsMeshRendererVectorStreamlineSettings QgsMeshRendererVectorSettings::streamLinesSettings | ( | ) | const |
Returns settings for vector rendered with streamlines.
Definition at line 585 of file qgsmeshrenderersettings.cpp.
QgsMeshRendererVectorSettings::Symbology QgsMeshRendererVectorSettings::symbology | ( | ) | const |
Returns the displaying method used to render vector datasets.
Definition at line 565 of file qgsmeshrenderersettings.cpp.
QgsMeshRendererVectorTracesSettings QgsMeshRendererVectorSettings::tracesSettings | ( | ) | const |
Returns settings for vector rendered with traces.
Definition at line 690 of file qgsmeshrenderersettings.cpp.
int QgsMeshRendererVectorSettings::userGridCellHeight | ( | ) | const |
Returns height in pixels of user grid cell.
Definition at line 251 of file qgsmeshrenderersettings.cpp.
int QgsMeshRendererVectorSettings::userGridCellWidth | ( | ) | const |
Returns width in pixels of user grid cell.
Definition at line 241 of file qgsmeshrenderersettings.cpp.
QgsInterpolatedLineColor QgsMeshRendererVectorSettings::vectorStrokeColoring | ( | ) | const |
Returns the stroke coloring used to render vector datasets.
Definition at line 674 of file qgsmeshrenderersettings.cpp.
QgsMeshRendererVectorWindBarbSettings QgsMeshRendererVectorSettings::windBarbSettings | ( | ) | const |
Returns settings for vector rendered with wind barbs.
Definition at line 753 of file qgsmeshrenderersettings.cpp.
QDomElement QgsMeshRendererVectorSettings::writeXml | ( | QDomDocument & | doc, |
const QgsReadWriteContext & | context = QgsReadWriteContext() |
||
) | const |
Writes configuration to a new DOM element.
Definition at line 595 of file qgsmeshrenderersettings.cpp.