QGIS/python/core/auto_generated/mesh/qgsmeshtracerenderer.sip.in
Vincent Cloarec 7f415ca7a7 [FEATURE] Static particle traces for rendering mesh vector dataset (#33165)
* [FEATURE] Static particle traces for rendering mesh vector dataset

This PR permits to display directly in QGIS static particle traces for vector datasets in mesh layer without any plugin.
The user can choose in the mesh layer properties window :
- the color
- the size of the traces (line width)
- the count of particles
- the maximum length of the particle's tail
2019-12-03 08:13:36 +01:00

103 lines
2.7 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshtracerenderer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsMeshVectorTraceAnimationGenerator
{
%Docstring
A wrapper for QgsMeshParticuleTracesField used to render the particles. Available for Python binding
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgsmeshtracerenderer.h"
%End
public:
QgsMeshVectorTraceAnimationGenerator( QgsMeshLayer *layer, const QgsRenderContext &rendererContext );
%Docstring
Constructor to use with Python binding
%End
QgsMeshVectorTraceAnimationGenerator( const QgsMeshVectorTraceAnimationGenerator &other );
%Docstring
Copy constructor
%End
~QgsMeshVectorTraceAnimationGenerator();
void seedRandomParticles( int count );
%Docstring
seeds particles in the vector fields
%End
QImage imageRendered();
%Docstring
Moves all the particles using frame per second (fps) to calculate the displacement and return the rendered frame
%End
void setFPS( int FPS );
%Docstring
Sets the number of frames per seconds that will be rendered
%End
void setMaxSpeedPixel( int max );
%Docstring
Sets the max number of pixels that can be go through by the particles in 1 second
%End
void setParticlesLifeTime( double particleLifeTime );
%Docstring
Sets maximum life time of particles in seconds
%End
void setParticlesColor( const QColor &c );
%Docstring
Sets colors of particle
%End
void setParticlesSize( double width );
%Docstring
Sets particle size in px
%End
void setTailFactor( double fct );
%Docstring
Sets the tail factor, used to adjust the length of the tail. 0 : minimum length, >1 increase the tail
%End
void setMinimumTailLength( int l );
%Docstring
Sets the minimum tail length
%End
void setTailPersitence( double p );
%Docstring
Sets the visual persistence of the tail
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshtracerenderer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/