SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmmvis::ui::FigureCapture Class Reference

Drives a manifest of figures to PNG, then quits the application. More...

#include <figurecapture.h>

Inheritance diagram for openswmmvis::ui::FigureCapture:
Collaboration diagram for openswmmvis::ui::FigureCapture:

Public Member Functions

 ~FigureCapture () override
 
void start ()
 Begin the queue. Safe to call once; later calls are ignored.
 

Static Public Member Functions

static FigureCapturecreateIfRequested (QMainWindow *host, QObject *parent)
 Build a capture run when SWMMVIS_CAPTURE_MANIFEST names a readable manifest, else nullptr.
 

Detailed Description

Drives a manifest of figures to PNG, then quits the application.

Lifetime: created by createIfRequested() from the main window's constructor and parented to it; a no-op (nullptr) when the env var is unset, so normal runs pay nothing.

Constructor & Destructor Documentation

◆ ~FigureCapture()

openswmmvis::ui::FigureCapture::~FigureCapture ( )
overridedefault

Member Function Documentation

◆ createIfRequested()

FigureCapture * openswmmvis::ui::FigureCapture::createIfRequested ( QMainWindow *  host,
QObject *  parent 
)
static

Build a capture run when SWMMVIS_CAPTURE_MANIFEST names a readable manifest, else nullptr.

Parameters
hostthe main window; widget lookups resolve under it.
parentowner (normally host).
Here is the caller graph for this function:

◆ start()

void openswmmvis::ui::FigureCapture::start ( )

Begin the queue. Safe to call once; later calls are ignored.

Waits out defaults.startupMs first so a model handed in through SWMMVIS_OPEN_ON_STARTUP has finished loading.


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