A wrapper for QgsMeshParticuleTracesField used to render the particles. More...

#include <qgsmeshtracerenderer.h>

Inheritance diagram for QgsMeshVectorTraceAnimationGenerator:

Public Member Functions
Q_DECL_DEPRECATED	QgsMeshVectorTraceAnimationGenerator (QgsMeshLayer *layer, const QgsRenderContext &rendererContext)
	Constructor to use with Python binding.
void	setFPS (int FPS)
	Sets the number of frames per seconds that will be rendered.
void	setMaxSpeedPixel (int max)
	Sets the max number of pixels that can be go through by the particles in 1 second.
Public Member Functions inherited from QgsVectorFieldTraceAnimationGenerator
	QgsVectorFieldTraceAnimationGenerator (const QgsVectorFieldTraceAnimationGenerator &other)
	QgsVectorFieldTraceAnimationGenerator (std::unique_ptr< QgsVectorFieldValueSource > source, const QgsRenderContext &rendererContext, const QgsVectorFieldSettings &vectorSettings, bool minimizeFieldSize=true)
	Constructs a generator sampling the vector field from source, which is taken ownership of.
	~QgsVectorFieldTraceAnimationGenerator ()
QImage	imageRendered ()
	Moves all the particles using frame per second (fps) to calculate the displacement and return the rendered frame.
QgsVectorFieldTraceAnimationGenerator &	operator= (const QgsVectorFieldTraceAnimationGenerator &other)
void	seedRandomParticles (int count)
	Seeds particles in the vector field.
void	setFramesPerSecond (int frames)
	Sets the number of frames per seconds that will be rendered.
void	setMaximumSpeedPixel (int pixels)
	Sets the max number of pixels that can be go through by the particles in 1 second.
void	setMinimumTailLength (int l)
	Sets the minimum tail length.
void	setParticlesColor (const QColor &c)
	Sets colors of particle.
void	setParticlesLifeTime (double particleLifeTime)
	Sets maximum life time of particles in seconds.
void	setParticlesSize (double width)
	Sets particle size in px.
void	setTailFactor (double fct)
	Sets the tail factor, used to adjust the length of the tail. 0 : minimum length, >1 increase the tail.
void	setTailPersitence (double p)
	Sets the visual persistence of the tail.

Additional Inherited Members
Static Public Member Functions inherited from QgsVectorFieldTraceAnimationGenerator
static QgsVectorFieldTraceAnimationGenerator *	fromMeshLayer (QgsMeshLayer *layer, const QgsRenderContext &rendererContext)
	Returns a generator for the active vector dataset of layer, or `nullptr` if the layer has no vector dataset to animate.
Protected Member Functions inherited from QgsVectorFieldTraceAnimationGenerator
	QgsVectorFieldTraceAnimationGenerator (QgsMeshLayer *layer, const QgsRenderContext &rendererContext)
	Constructs a generator for the active vector dataset of layer.

Detailed Description

A wrapper for QgsMeshParticuleTracesField used to render the particles.

Available for Python binding

Since: QGIS 3.12

Deprecated: QGIS 4.4. Use QgsVectorFieldTraceAnimationGenerator instead.

Definition at line 38 of file qgsmeshtracerenderer.h.

Constructor & Destructor Documentation

◆ QgsMeshVectorTraceAnimationGenerator()

QgsMeshVectorTraceAnimationGenerator::QgsMeshVectorTraceAnimationGenerator	(	QgsMeshLayer *	layer,
		const QgsRenderContext &	rendererContext )

Constructor to use with Python binding.

Deprecated: QGIS 4.4. Use QgsVectorFieldTraceAnimationGenerator::fromMeshLayer() instead.

Definition at line 20 of file qgsmeshtracerenderer.cpp.

Member Function Documentation

◆ setFPS()

void QgsMeshVectorTraceAnimationGenerator::setFPS ( int FPS )

inline

Sets the number of frames per seconds that will be rendered.

Definition at line 49 of file qgsmeshtracerenderer.h.

◆ setMaxSpeedPixel()

void QgsMeshVectorTraceAnimationGenerator::setMaxSpeedPixel ( int max )

inline

Sets the max number of pixels that can be go through by the particles in 1 second.

Definition at line 52 of file qgsmeshtracerenderer.h.

The documentation for this class was generated from the following files:

/build/qgis-4.3.0+git20260927+0ff9723465c+99sid/src/core/mesh/qgsmeshtracerenderer.h
/build/qgis-4.3.0+git20260927+0ff9723465c+99sid/src/core/mesh/qgsmeshtracerenderer.cpp