mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
aea3dccea7
Rudimentary support of rendering of vector data (e.g. velocity) on mesh map layers. Rendering can be adjusted by QgsMeshRenderer*Settings. Only in Python API, no GUI widgets for styling present.
283 lines
6.9 KiB
Plaintext
283 lines
6.9 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/mesh/qgsmeshrenderersettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsMeshRendererMeshSettings
|
|
{
|
|
%Docstring
|
|
|
|
Represents a mesh renderer settings for mesh object
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshrenderersettings.h"
|
|
%End
|
|
public:
|
|
bool isEnabled() const;
|
|
%Docstring
|
|
Returns whether mesh structure rendering is enabled
|
|
%End
|
|
void setEnabled( bool enabled );
|
|
%Docstring
|
|
Sets whether mesh structure rendering is enabled
|
|
%End
|
|
|
|
double lineWidth() const;
|
|
%Docstring
|
|
Returns line width used for rendering (in millimeters)
|
|
%End
|
|
void setLineWidth( double lineWidth );
|
|
%Docstring
|
|
Sets line width used for rendering (in millimeters)
|
|
%End
|
|
|
|
QColor color() const;
|
|
%Docstring
|
|
Returns color used for rendering
|
|
%End
|
|
void setColor( const QColor &color );
|
|
%Docstring
|
|
Sets color used for rendering of the mesh
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsMeshRendererScalarSettings
|
|
{
|
|
%Docstring
|
|
|
|
Represents a mesh renderer settings for scalar datasets
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshrenderersettings.h"
|
|
%End
|
|
public:
|
|
QColor maxColor() const;
|
|
%Docstring
|
|
Returns color representing maximum scalar value in the dataset
|
|
%End
|
|
void setMaxColor( const QColor &maxColor );
|
|
%Docstring
|
|
Sets color representing maximum scalar value in the dataset
|
|
%End
|
|
|
|
QColor minColor() const;
|
|
%Docstring
|
|
Returns color representing minimum scalar value in the dataset
|
|
%End
|
|
void setMinColor( const QColor &minColor );
|
|
%Docstring
|
|
Sets color representing maximum scalar value in the dataset
|
|
%End
|
|
|
|
double minValue() const;
|
|
%Docstring
|
|
Returns min scalar value that represents minColor()
|
|
|
|
if set to numerical_limits<double>.quiet_NaN(), value for minColor() is
|
|
taken from minimum value of active scalar dataset
|
|
%End
|
|
|
|
void setMinValue( double minValue );
|
|
%Docstring
|
|
Sets min scalar value that represents minColor()
|
|
|
|
.. seealso:: :py:func:`QgsMeshRendererScalarSettings.minValue`
|
|
%End
|
|
|
|
double maxValue() const;
|
|
%Docstring
|
|
Returns max scalar value that represents maxColor()
|
|
|
|
if set to numerical_limits<double>.quiet_NaN(), value for maxColor() is
|
|
taken from maximum value of active scalar dataset
|
|
%End
|
|
|
|
void setMaxValue( double maxValue );
|
|
%Docstring
|
|
Sets min scalar value that represents minColor()
|
|
|
|
.. seealso:: :py:func:`QgsMeshRendererScalarSettings.maxValue`
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsMeshRendererVectorSettings
|
|
{
|
|
%Docstring
|
|
|
|
Represents a mesh renderer settings for vector datasets
|
|
|
|
.. note::
|
|
|
|
The API is considered EXPERIMENTAL and can be changed without a notice
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmeshrenderersettings.h"
|
|
%End
|
|
public:
|
|
enum VectorRenderingType
|
|
{
|
|
|
|
MinMax,
|
|
|
|
Scaled,
|
|
|
|
Fixed
|
|
};
|
|
|
|
double lineWidth() const;
|
|
%Docstring
|
|
Returns line width of the arrow (in millimeters)
|
|
%End
|
|
void setLineWidth( double lineWidth );
|
|
%Docstring
|
|
Sets line width of the arrow in pixels (in millimeters)
|
|
%End
|
|
|
|
QColor color() const;
|
|
%Docstring
|
|
Returns color used for drawing arrows
|
|
%End
|
|
void setColor( const QColor &color );
|
|
%Docstring
|
|
Sets color used for drawing arrows
|
|
%End
|
|
|
|
double filterMin() const;
|
|
%Docstring
|
|
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.
|
|
%End
|
|
|
|
void setFilterMin( double filterMin );
|
|
%Docstring
|
|
Sets filter value for vector magnitudes.
|
|
|
|
.. seealso:: :py:func:`QgsMeshRendererVectorSettings.vectorFilterMin`
|
|
%End
|
|
|
|
double filterMax() const;
|
|
%Docstring
|
|
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.
|
|
%End
|
|
|
|
void setFilterMax( double filterMax );
|
|
%Docstring
|
|
Sets filter value for vector magnitudes.
|
|
|
|
.. seealso:: :py:func:`QgsMeshRendererVectorSettings.vectorFilterMax`
|
|
%End
|
|
|
|
QgsMeshRendererVectorSettings::VectorRenderingType shaftLengthMethod() const;
|
|
%Docstring
|
|
Returns method used for drawing arrows
|
|
%End
|
|
void setShaftLengthMethod( const QgsMeshRendererVectorSettings::VectorRenderingType &shaftLengthMethod );
|
|
%Docstring
|
|
Sets method used for drawing arrows
|
|
%End
|
|
|
|
double minShaftLength() const;
|
|
%Docstring
|
|
Returns mininimum shaft length (in millimeters)
|
|
|
|
Only for QgsMeshRendererVectorSettings.ArrowType.MinMax
|
|
%End
|
|
|
|
void setMinShaftLength( double minShaftLength );
|
|
%Docstring
|
|
Sets mininimum shaft length (in millimeters)
|
|
|
|
Only for QgsMeshRendererVectorSettings.ArrowType.MinMax
|
|
%End
|
|
|
|
double maxShaftLength() const;
|
|
%Docstring
|
|
Returns maximum shaft length (in millimeters)
|
|
|
|
Only for QgsMeshRendererVectorSettings.ArrowType.MinMax
|
|
%End
|
|
|
|
void setMaxShaftLength( double maxShaftLength );
|
|
%Docstring
|
|
Sets maximum shaft length (in millimeters)
|
|
|
|
Only for QgsMeshRendererVectorSettings.ArrowType.MinMax
|
|
%End
|
|
|
|
double scaleFactor() const;
|
|
%Docstring
|
|
Returns scale factor. Only for QgsMeshRendererVectorSettings.ArrowType.Scaled
|
|
%End
|
|
void setScaleFactor( double scaleFactor );
|
|
%Docstring
|
|
Sets scale factor. Only for QgsMeshRendererVectorSettings.ArrowType.Scaled
|
|
%End
|
|
|
|
double fixedShaftLength() const;
|
|
%Docstring
|
|
Returns fixed arrow length (in millimeters). Only for QgsMeshRendererVectorSettings.ArrowType.Fixed
|
|
%End
|
|
void setFixedShaftLength( double fixedShaftLength );
|
|
%Docstring
|
|
Sets fixed length (in millimeters). Only for QgsMeshRendererVectorSettings.ArrowType.Fixed
|
|
%End
|
|
|
|
double arrowHeadWidthRatio() const;
|
|
%Docstring
|
|
Returns ratio of the head width of the arrow (range 0-1)
|
|
%End
|
|
void setArrowHeadWidthRatio( double arrowHeadWidthRatio );
|
|
%Docstring
|
|
Sets ratio of the head width of the arrow (range 0-1)
|
|
%End
|
|
|
|
double arrowHeadLengthRatio() const;
|
|
%Docstring
|
|
Returns ratio of the head length of the arrow (range 0-1)
|
|
%End
|
|
void setArrowHeadLengthRatio( double arrowHeadLengthRatio );
|
|
%Docstring
|
|
Sets ratio of the head length of the arrow (range 0-1)
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/mesh/qgsmeshrenderersettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|