figurecapture.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_UI_UTIL_FIGURECAPTURE_H
#define OPENSWMMVIS_UI_UTIL_FIGURECAPTURE_H
 
#include <QElapsedTimer>
#include <QJsonObject>
#include <QList>
#include <QObject>
#include <QSize>
#include <QString>
 
class QMainWindow;
class QTimer;
class QWidget;
 
namespace openswmmvis::ui {
 
enum class FigureLane {
    Offscreen,  
    Live,       
    Human       
};
 
struct FigureSpec {
    QString    name;                
    QString    action;              
    QString    widget;              
    bool       wholeWindow = false; 
    QString    page;                
    QString    tab;                 
    QString    type;                
    QString    typeInto;            
    QString    select;              
    QString    hostSelect;          
    QString    hostSelectIn;        
    QStringList clicks;             
    QString    column;              
    QString    editCell;            
    QString    grab;                
    QSize      size;                
    QSize      hostSize;            
    FigureLane lane        = FigureLane::Offscreen;
    int        settleMs    = 0;     
    int        maxWidth    = 0;     
};
 
struct FigureResult {
    QString name;
    QString status;             
    QString detail;             
    int     width      = 0;
    int     height     = 0;
    qint64  bytes      = 0;
    bool    blank      = false; 
    int     elapsedMs  = 0;
};
 
class FigureCapture : public QObject
{
    Q_OBJECT
 
public:
    static FigureCapture *createIfRequested(QMainWindow *host, QObject *parent);
 
    ~FigureCapture() override;
 
    void start();
 
private:
    FigureCapture(QMainWindow *host, QString manifestPath, QObject *parent);
 
    bool loadManifest(QString *error);
    void applyDefaults();
    void processNext();
    void finishSpec(const FigureResult &result);
    void finishRun();
 
    bool applyHostSelect(const FigureSpec &spec);
    void captureSpec(const FigureSpec &spec);
    void grabInto(QWidget *target, const FigureSpec &spec);
 
    QWidget *activeDialog() const;
    bool selectPage(QWidget *target, const QString &page) const;
    bool selectItem(QWidget *target, const QString &which) const;
    void dismissDialogs();
    void dismissOpenedBy(const FigureSpec &spec);
 
    QMainWindow       *mHost = nullptr;
    QString            mManifestPath;
    QString            mOutDir;
    QJsonObject        mDefaults;
    QList<FigureSpec>  mQueue;
    QList<FigureResult> mResults;
 
    FigureSpec     mCurrent;
    bool           mCurrentDone  = false;  
    bool           mStarted      = false;
    QElapsedTimer  mSpecTimer;
    QTimer        *mWatchdog     = nullptr;
 
    int  mDefaultSettleMs = 600;
    int  mStartupMs       = 2500;
    int  mWatchdogMs      = 20000;
    int  mMaxWidth        = 1400;
    qreal mRenderScale    = 2.0;  
};
 
} // namespace openswmmvis::ui
 
#endif // OPENSWMMVIS_UI_UTIL_FIGURECAPTURE_H