FlowEngine 7.517
Photogrammetry Software Development Kit
Loading...
Searching...
No Matches
FlowEngine::ProgressBarInterface Class Referenceabstract

Pure virtual Progress Bar interface. More...

#include <ProgressBarInterface.h>

Inheritance diagram for FlowEngine::ProgressBarInterface:
FlowEngine::ProgressBarEmpty

Public Member Functions

virtual ~ProgressBarInterface ()=default
 Default virtual destructor.
 
virtual void start (const char *nWindowTitle, bool nShowGlobalProgress, bool nShowCancelButton)=0
 
virtual void finish ()=0
 Hide the loading bar.
 
virtual void resetTicks (unsigned int nTicks, const char *nLoadingText)=0
 
virtual void resetGlobalTicks (unsigned int nGlobalTicks, const char *nLoadingText)=0
 
virtual void update ()=0
 Progress the loading bar - Add + 1 Tick.
 
virtual void updateGlobal ()=0
 Progress the global progress bar - Add + 1 Tick.
 

Detailed Description

Pure virtual Progress Bar interface.

Pure virtual progress bar interface. Override for your own gui.

Constructor & Destructor Documentation

◆ ~ProgressBarInterface()

virtual FlowEngine::ProgressBarInterface::~ProgressBarInterface ( )
virtualdefault

Default virtual destructor.

Member Function Documentation

◆ finish()

virtual void FlowEngine::ProgressBarInterface::finish ( )
pure virtual

Hide the loading bar.

Implemented in FlowEngine::ProgressBarEmpty.

◆ resetGlobalTicks()

virtual void FlowEngine::ProgressBarInterface::resetGlobalTicks ( unsigned int  nGlobalTicks,
const char *  nLoadingText 
)
pure virtual

Set global progress bar ticks (if any) and reset the counter to 0

Parameters
nGlobalTicksthe number of steps to take in order for the main task to finish. when set to 0, the main task has an indefinite number of steps
nLoadingTextpointer to a null terminated string that names the current main task phase

Implemented in FlowEngine::ProgressBarEmpty.

◆ resetTicks()

virtual void FlowEngine::ProgressBarInterface::resetTicks ( unsigned int  nTicks,
const char *  nLoadingText 
)
pure virtual

Set progress bar ticks and reset the counter to 0

Parameters
nTicksthe number of steps to take in order for the task to finish. when set to 0, the task has an indefinite number of steps
nLoadingTextpointer to a null terminated string that names the current task phase

Implemented in FlowEngine::ProgressBarEmpty.

◆ start()

virtual void FlowEngine::ProgressBarInterface::start ( const char *  nWindowTitle,
bool  nShowGlobalProgress,
bool  nShowCancelButton 
)
pure virtual

Show the progress bar

Parameters
nWindowTitlea pointer to a null terminated string that names the main task
nShowGlobalProgresswhen true, the progress is split in main and secondary tasks
nShowCancelButtonwhen true, the running task is cancellable

Implemented in FlowEngine::ProgressBarEmpty.

◆ update()

virtual void FlowEngine::ProgressBarInterface::update ( )
pure virtual

Progress the loading bar - Add + 1 Tick.

Implemented in FlowEngine::ProgressBarEmpty.

◆ updateGlobal()

virtual void FlowEngine::ProgressBarInterface::updateGlobal ( )
pure virtual

Progress the global progress bar - Add + 1 Tick.

Implemented in FlowEngine::ProgressBarEmpty.