QGIS/python/core/auto_generated/mesh/qgsmeshrenderersettings.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

931 lines
21 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshrenderersettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsMeshRendererMeshSettings
{
%Docstring(signature="appended")
Represents a mesh renderer settings for mesh objects.
.. 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
Qgis::RenderUnit lineWidthUnit() const;
%Docstring
Returns units of the width of the mesh frame
.. versionadded:: 3.14
%End
void setLineWidthUnit( Qgis::RenderUnit lineWidthUnit );
%Docstring
Sets units of the width of the mesh frame
.. versionadded:: 3.14
%End
QDomElement writeXml( QDomDocument &doc ) const;
%Docstring
Writes configuration to a new DOM element
%End
void readXml( const QDomElement &elem );
%Docstring
Reads configuration from the given DOM element
%End
};
class QgsMeshRendererScalarSettings
{
%Docstring(signature="appended")
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:
enum DataResamplingMethod
{
NoResampling,
NeighbourAverage,
};
QgsColorRampShader colorRampShader() const;
%Docstring
Returns color ramp shader function
%End
void setColorRampShader( const QgsColorRampShader &shader );
%Docstring
Sets color ramp shader function
%End
double classificationMinimum() const;
%Docstring
Returns min value used for creation of the color ramp shader
%End
double classificationMaximum() const;
%Docstring
Returns max value used for creation of the color ramp shader
%End
void setClassificationMinimumMaximum( double minimum, double maximum );
%Docstring
Sets min/max values used for creation of the color ramp shader
%End
double opacity() const;
%Docstring
Returns opacity
%End
void setOpacity( double opacity );
%Docstring
Sets opacity
%End
DataResamplingMethod dataResamplingMethod() const;
%Docstring
Returns the type of interpolation to use to convert face defined
datasets to values on vertices
.. versionadded:: 3.12
%End
void setDataResamplingMethod( const DataResamplingMethod &dataResamplingMethod );
%Docstring
Sets data interpolation method
.. versionadded:: 3.12
%End
QgsInterpolatedLineWidth edgeStrokeWidth() const;
%Docstring
Returns the stroke width used to render edges scalar dataset
.. versionadded:: 3.14
%End
void setEdgeStrokeWidth( const QgsInterpolatedLineWidth &strokeWidth );
%Docstring
Sets the stroke width used to render edges scalar dataset
.. versionadded:: 3.14
%End
Qgis::RenderUnit edgeStrokeWidthUnit() const;
%Docstring
Returns the stroke width unit used to render edges scalar dataset
.. versionadded:: 3.14
%End
void setEdgeStrokeWidthUnit( Qgis::RenderUnit edgeStrokeWidthUnit );
%Docstring
Sets the stroke width unit used to render edges scalar dataset
.. versionadded:: 3.14
%End
void setLimits( Qgis::MeshRangeLimit limits );
%Docstring
Sets the range limits type for minimum maximum calculation
.. versionadded:: 3.42
%End
Qgis::MeshRangeLimit limits() const;
%Docstring
Returns the range limits type for minimum maximum calculation
.. versionadded:: 3.42
%End
void setExtent( Qgis::MeshRangeExtent extent );
%Docstring
Sets the mesh extent for minimum maximum calculation
.. versionadded:: 3.42
%End
Qgis::MeshRangeExtent extent() const;
%Docstring
Returns the mesh extent for minimum maximum calculation
.. versionadded:: 3.42
%End
QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;
%Docstring
Writes configuration to a new DOM element
%End
void readXml( const QDomElement &elem, const QgsReadWriteContext &context = QgsReadWriteContext() );
%Docstring
Reads configuration from the given DOM element
%End
};
class QgsMeshRendererVectorArrowSettings
{
%Docstring(signature="appended")
Represents a mesh renderer settings for vector datasets displayed with
arrows.
.. note::
The API is considered EXPERIMENTAL and can be changed without a notice
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgsmeshrenderersettings.h"
%End
public:
enum ArrowScalingMethod
{
MinMax,
Scaled,
Fixed
};
QgsMeshRendererVectorArrowSettings::ArrowScalingMethod shaftLengthMethod() const;
%Docstring
Returns method used for drawing arrows
%End
void setShaftLengthMethod( ArrowScalingMethod shaftLengthMethod );
%Docstring
Sets method used for drawing arrows
%End
double minShaftLength() const;
%Docstring
Returns mininimum shaft length (in millimeters)
Only for
:py:class:`QgsMeshRendererVectorSettings`.ArrowScalingMethod.MinMax
%End
void setMinShaftLength( double minShaftLength );
%Docstring
Sets mininimum shaft length (in millimeters)
Only for
:py:class:`QgsMeshRendererVectorSettings`.ArrowScalingMethod.MinMax
%End
double maxShaftLength() const;
%Docstring
Returns maximum shaft length (in millimeters)
Only for
:py:class:`QgsMeshRendererVectorSettings`.ArrowScalingMethod.MinMax
%End
void setMaxShaftLength( double maxShaftLength );
%Docstring
Sets maximum shaft length (in millimeters)
Only for
:py:class:`QgsMeshRendererVectorSettings`.ArrowScalingMethod.MinMax
%End
double scaleFactor() const;
%Docstring
Returns scale factor
Only for
:py:class:`QgsMeshRendererVectorSettings`.ArrowScalingMethod.Scaled
%End
void setScaleFactor( double scaleFactor );
%Docstring
Sets scale factor
Only for
:py:class:`QgsMeshRendererVectorSettings`.ArrowScalingMethod.Scaled
%End
double fixedShaftLength() const;
%Docstring
Returns fixed arrow length (in millimeters)
Only for
:py:class:`QgsMeshRendererVectorSettings`.ArrowScalingMethod.Fixed
%End
void setFixedShaftLength( double fixedShaftLength );
%Docstring
Sets fixed length (in millimeters)
Only for
:py:class:`QgsMeshRendererVectorSettings`.ArrowScalingMethod.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
QDomElement writeXml( QDomDocument &doc ) const;
%Docstring
Writes configuration to a new DOM element
%End
void readXml( const QDomElement &elem );
%Docstring
Reads configuration from the given DOM element
%End
};
class QgsMeshRendererVectorStreamlineSettings
{
%Docstring(signature="appended")
Represents a streamline renderer settings for vector datasets displayed
by streamlines.
.. note::
The API is considered EXPERIMENTAL and can be changed without a notice
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgsmeshrenderersettings.h"
%End
public:
enum SeedingStartPointsMethod
{
MeshGridded,
Random
};
SeedingStartPointsMethod seedingMethod() const;
%Docstring
Returns the method used for seeding start points of strealines
%End
void setSeedingMethod( const SeedingStartPointsMethod &seedingMethod );
%Docstring
Sets the method used for seeding start points of strealines
%End
double seedingDensity() const;
%Docstring
Returns the density used for seeding start points
%End
void setSeedingDensity( double seedingDensity );
%Docstring
Sets the density used for seeding start points
%End
void readXml( const QDomElement &elem );
%Docstring
Reads configuration from the given DOM element
%End
QDomElement writeXml( QDomDocument &doc ) const;
%Docstring
Writes configuration to a new DOM element
%End
};
class QgsMeshRendererVectorTracesSettings
{
%Docstring(signature="appended")
Represents a trace renderer settings for vector datasets displayed by
particle traces.
.. note::
The API is considered EXPERIMENTAL and can be changed without a notice
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgsmeshrenderersettings.h"
%End
public:
double maximumTailLength() const;
%Docstring
Returns the maximum tail length
%End
void setMaximumTailLength( double maximumTailLength );
%Docstring
Sets the maximums tail length
%End
int particlesCount() const;
%Docstring
Returns particles count
%End
void setParticlesCount( int value );
%Docstring
Sets particles count
%End
Qgis::RenderUnit maximumTailLengthUnit() const;
%Docstring
Returns the maximum tail length unit
%End
void setMaximumTailLengthUnit( Qgis::RenderUnit maximumTailLengthUnit );
%Docstring
Sets the maximum tail length unit
%End
void readXml( const QDomElement &elem );
%Docstring
Reads configuration from the given DOM element
%End
QDomElement writeXml( QDomDocument &doc ) const;
%Docstring
Writes configuration to a new DOM element
%End
};
class QgsMeshRendererVectorWindBarbSettings
{
%Docstring(signature="appended")
Represents a mesh renderer settings for vector datasets displayed with
wind barbs.
.. note::
The API is considered EXPERIMENTAL and can be changed without a notice
.. versionadded:: 3.38
%End
%TypeHeaderCode
#include "qgsmeshrenderersettings.h"
%End
public:
enum class WindSpeedUnit
{
MetersPerSecond,
KilometersPerHour,
Knots,
MilesPerHour,
FeetPerSecond,
OtherUnit
};
double magnitudeMultiplier() const;
%Docstring
Returns the multiplier for the magnitude to convert it to knots,
according to the units set with
:py:func:`~QgsMeshRendererVectorWindBarbSettings.setMagnitudeUnits` A
custom multiplier can be set with
:py:func:`~QgsMeshRendererVectorWindBarbSettings.setMagnitudeMultiplier`
for the case when units are set to OtherUnit
%End
void setMagnitudeMultiplier( double magnitudeMultiplier );
%Docstring
Sets a multiplier for the magnitude to convert it to knots
%End
double shaftLength() const;
%Docstring
Returns the shaft length (in millimeters)
%End
void setShaftLength( double shaftLength );
%Docstring
Sets the shaft length (in millimeters)
%End
Qgis::RenderUnit shaftLengthUnits() const;
%Docstring
Returns the units for the shaft length.
.. seealso:: :py:func:`setShaftLengthUnits`
%End
void setShaftLengthUnits( Qgis::RenderUnit shaftLengthUnit );
%Docstring
Sets the units for the shaft length.
.. seealso:: :py:func:`shaftLengthUnits`
%End
WindSpeedUnit magnitudeUnits() const;
%Docstring
Returns the units that the data are in
%End
void setMagnitudeUnits( WindSpeedUnit units );
%Docstring
Sets the units that the data are in
%End
QDomElement writeXml( QDomDocument &doc ) const;
%Docstring
Writes configuration to a new DOM element
%End
void readXml( const QDomElement &elem );
%Docstring
Reads configuration from the given DOM element
%End
};
class QgsMeshRendererVectorSettings
{
%Docstring(signature="appended")
Represents a 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 Symbology
{
//! Displaying vector dataset with arrows
Arrows,
//! Displaying vector dataset with streamlines
Streamlines,
//! Displaying vector dataset with particle traces
Traces,
//! Displaying vector dataset with wind barbs
WindBarbs
};
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:`filterMin`
%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:`filterMax`
%End
bool isOnUserDefinedGrid() const;
%Docstring
Returns whether vectors are drawn on user-defined grid
%End
void setOnUserDefinedGrid( bool enabled );
%Docstring
Toggles drawing of vectors on user defined grid
%End
int userGridCellWidth() const;
%Docstring
Returns width in pixels of user grid cell
%End
void setUserGridCellWidth( int width );
%Docstring
Sets width of user grid cell (in pixels)
%End
int userGridCellHeight() const;
%Docstring
Returns height in pixels of user grid cell
%End
void setUserGridCellHeight( int height );
%Docstring
Sets height of user grid cell (in pixels)
%End
Symbology symbology() const;
%Docstring
Returns the displaying method used to render vector datasets
.. versionadded:: 3.12
%End
void setSymbology( const Symbology &symbology );
%Docstring
Sets the displaying method used to render vector datasets
.. versionadded:: 3.12
%End
QgsInterpolatedLineColor::ColoringMethod coloringMethod() const;
%Docstring
Returns the coloring method used to render vector datasets
.. versionadded:: 3.14
%End
void setColoringMethod( const QgsInterpolatedLineColor::ColoringMethod &coloringMethod );
%Docstring
Sets the coloring method used to render vector datasets
.. versionadded:: 3.14
%End
QgsColorRampShader colorRampShader() const;
%Docstring
Sets the color ramp shader used to render vector datasets
.. versionadded:: 3.14
%End
void setColorRampShader( const QgsColorRampShader &colorRampShader );
%Docstring
Returns the color ramp shader used to render vector datasets
.. versionadded:: 3.14
%End
QgsInterpolatedLineColor vectorStrokeColoring() const;
%Docstring
Returns the stroke coloring used to render vector datasets
.. versionadded:: 3.14
%End
QgsMeshRendererVectorArrowSettings arrowSettings() const;
%Docstring
Returns settings for vector rendered with arrows
.. versionadded:: 3.12
%End
void setArrowsSettings( const QgsMeshRendererVectorArrowSettings &arrowSettings );
%Docstring
Sets settings for vector rendered with arrows
.. versionadded:: 3.12
%End
QgsMeshRendererVectorStreamlineSettings streamLinesSettings() const;
%Docstring
Returns settings for vector rendered with streamlines
.. versionadded:: 3.12
%End
void setStreamLinesSettings( const QgsMeshRendererVectorStreamlineSettings &streamLinesSettings );
%Docstring
Sets settings for vector rendered with streamlines
.. versionadded:: 3.12
%End
QgsMeshRendererVectorTracesSettings tracesSettings() const;
%Docstring
Returns settings for vector rendered with traces
.. versionadded:: 3.12
%End
void setTracesSettings( const QgsMeshRendererVectorTracesSettings &tracesSettings );
%Docstring
Sets settings for vector rendered with traces
.. versionadded:: 3.12
%End
QgsMeshRendererVectorWindBarbSettings windBarbSettings() const;
%Docstring
Returns settings for vector rendered with wind barbs
.. versionadded:: 3.38
%End
void setWindBarbSettings( const QgsMeshRendererVectorWindBarbSettings &windBarbSettings );
%Docstring
Sets settings for vector rendered with wind barbs
.. versionadded:: 3.38
%End
QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;
%Docstring
Writes configuration to a new DOM element
%End
void readXml( const QDomElement &elem, const QgsReadWriteContext &context = QgsReadWriteContext() );
%Docstring
Reads configuration from the given DOM element
%End
};
class QgsMeshRendererSettings
{
%Docstring(signature="appended")
Represents all mesh renderer settings.
.. note::
The API is considered EXPERIMENTAL and can be changed without a notice
.. versionadded:: 3.4
%End
%TypeHeaderCode
#include "qgsmeshrenderersettings.h"
%End
public:
QgsMeshRendererSettings();
%Docstring
Constructs renderer with default single layer averaging method
%End
~QgsMeshRendererSettings();
QgsMeshRendererMeshSettings nativeMeshSettings() const;
%Docstring
Returns native mesh renderer settings
%End
void setNativeMeshSettings( const QgsMeshRendererMeshSettings &settings );
%Docstring
Sets new native mesh renderer settings, triggers repaint
%End
QgsMeshRendererMeshSettings triangularMeshSettings() const;
%Docstring
Returns triangular mesh renderer settings
%End
void setTriangularMeshSettings( const QgsMeshRendererMeshSettings &settings );
%Docstring
Sets new triangular mesh renderer settings
%End
QgsMeshRendererMeshSettings edgeMeshSettings() const;
%Docstring
Returns edge mesh renderer settings
.. versionadded:: 3.14
%End
void setEdgeMeshSettings( const QgsMeshRendererMeshSettings &settings );
%Docstring
Sets new edge mesh renderer settings
.. versionadded:: 3.14
%End
QgsMeshRendererScalarSettings scalarSettings( int groupIndex ) const;
%Docstring
Returns renderer settings
%End
void setScalarSettings( int groupIndex, const QgsMeshRendererScalarSettings &settings );
%Docstring
Sets new renderer settings
%End
bool hasScalarSettings( int groupIndex ) const;
%Docstring
Returns whether ``groupIndex`` has existing scalar settings
.. versionadded:: 3.30.2
%End
bool removeScalarSettings( int groupIndex );
%Docstring
Removes scalar settings with ``groupIndex``
.. versionadded:: 3.30.2
%End
QgsMeshRendererVectorSettings vectorSettings( int groupIndex ) const;
%Docstring
Returns renderer settings
%End
void setVectorSettings( int groupIndex, const QgsMeshRendererVectorSettings &settings );
%Docstring
Sets new renderer settings
%End
bool hasVectorSettings( int groupIndex ) const;
%Docstring
Returns whether ``groupIndex`` has existing vector settings
.. versionadded:: 3.30.2
%End
bool removeVectorSettings( int groupIndex );
%Docstring
Removes vector settings for ``groupIndex``
.. versionadded:: 3.30.2
%End
QgsMesh3DAveragingMethod *averagingMethod() const;
%Docstring
Returns averaging method for conversion of 3d stacked mesh data to 2d
data
Caller does not own the resulting pointer
%End
void setAveragingMethod( QgsMesh3DAveragingMethod *method );
%Docstring
Sets averaging method for conversion of 3d stacked mesh data to 2d data
Ownership of the method is not transferred.
%End
QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;
%Docstring
Writes configuration to a new DOM element
%End
void readXml( const QDomElement &elem, const QgsReadWriteContext &context = QgsReadWriteContext() );
%Docstring
Reads configuration from the given DOM element
%End
int activeScalarDatasetGroup() const;
%Docstring
Returns the active scalar dataset group
.. versionadded:: 3.14
%End
void setActiveScalarDatasetGroup( int activeScalarDatasetGroup );
%Docstring
Sets the active scalar dataset group
.. versionadded:: 3.14
%End
int activeVectorDatasetGroup() const;
%Docstring
Returns the active vector dataset group
.. versionadded:: 3.14
%End
void setActiveVectorDatasetGroup( int activeVectorDatasetGroup );
%Docstring
Sets the active vector dataset group
.. versionadded:: 3.14
%End
bool hasSettings( int datasetGroupIndex ) const;
%Docstring
Returns whether the group with ``index`` has render settings (scalar or
vector)
.. versionadded:: 3.22
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshrenderersettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/