qgsvectorfieldtraceanimationgenerator.h

Go to the documentation of this file.

/***************************************************************************
    qgsvectorfieldtraceanimationgenerator.h
    ---------------------------------------
    begin                : November 2019
    copyright            : (C) 2019 by Vincent Cloarec
    email                : vcloarec at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSVECTORFIELDTRACEANIMATIONGENERATOR_H
#define QGSVECTORFIELDTRACEANIMATIONGENERATOR_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrendercontext.h"
 
#include <QImage>
 
class QgsMeshLayer;
class QgsVectorFieldParticleTracesField;
class QgsVectorFieldSettings;
class QgsVectorFieldValueSource;

class CORE_EXPORT QgsVectorFieldTraceAnimationGenerator SIP_NODEFAULTCTORS
{
  public:
    QgsVectorFieldTraceAnimationGenerator(
      std::unique_ptr<QgsVectorFieldValueSource> source, const QgsRenderContext &rendererContext, const QgsVectorFieldSettings &vectorSettings, bool minimizeFieldSize = true
    ) SIP_SKIP;

    static QgsVectorFieldTraceAnimationGenerator *fromMeshLayer( QgsMeshLayer *layer, const QgsRenderContext &rendererContext ) SIP_FACTORY;
 
    QgsVectorFieldTraceAnimationGenerator( const QgsVectorFieldTraceAnimationGenerator &other );
 
    ~QgsVectorFieldTraceAnimationGenerator();

    void seedRandomParticles( int count );

    QImage imageRendered();

    void setFramesPerSecond( int frames );

    void setMaximumSpeedPixel( int pixels );

    void setParticlesLifeTime( double particleLifeTime );

    void setParticlesColor( const QColor &c );

    void setParticlesSize( double width );

    void setTailFactor( double fct );

    void setMinimumTailLength( int l );

    void setTailPersitence( double p );
 
    QgsVectorFieldTraceAnimationGenerator &operator=( const QgsVectorFieldTraceAnimationGenerator &other );
 
  private:
    std::unique_ptr<QgsVectorFieldParticleTracesField> mParticleField;
    const QgsRenderContext &mRendererContext;
    int mFps = 15;       //frame per second of the output, used to calculate orher parameters of the field
    int mVpixMax = 2000; //is the number of pixels that are going through for 1 s
    double mParticleLifeTime = 5;
 
    void updateFieldParameter();
 
  protected:
    QgsVectorFieldTraceAnimationGenerator( QgsMeshLayer *layer, const QgsRenderContext &rendererContext ) SIP_SKIP;
};
 
#endif // QGSVECTORFIELDTRACEANIMATIONGENERATOR_H