#include <progressbar.h>

Inheritance diagram for inviwo::ProgressBar:

Public Member Functions
float	getProgress () const

void	resetProgress ()

void	finishProgress ()

void	updateProgress (float progress)

void	show ()

void	hide ()

void	setVisible (bool visible)

bool	isVisible () const

Public Member Functions inherited from inviwo::ActivityIndicator
void	setActive (bool active)

bool	isActive () const

Public Member Functions inherited from inviwo::Observable< ActivityIndicatorObserver >
	Observable (const Observable< ActivityIndicatorObserver > &other)

	Observable (Observable< ActivityIndicatorObserver > &&other) noexcept

Observable< ActivityIndicatorObserver > &	operator= (const Observable< ActivityIndicatorObserver > &other)

Observable< ActivityIndicatorObserver > &	operator= (Observable< ActivityIndicatorObserver > &&other) noexcept

void	addObserver (ActivityIndicatorObserver *observer)

void	removeObserver (ActivityIndicatorObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::ObservableInterface
Public Member Functions inherited from inviwo::Observable< ProgressBarObserver >
	Observable (const Observable< ProgressBarObserver > &other)

	Observable (Observable< ProgressBarObserver > &&other) noexcept

Observable< ProgressBarObserver > &	operator= (const Observable< ProgressBarObserver > &other)

Observable< ProgressBarObserver > &	operator= (Observable< ProgressBarObserver > &&other) noexcept

void	addObserver (ProgressBarObserver *observer)

void	removeObserver (ProgressBarObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Additional Inherited Members
Protected Member Functions inherited from inviwo::Observable< ActivityIndicatorObserver >
void	forEachObserver (C callback)

Protected Member Functions inherited from inviwo::ObservableInterface
void	addObservationHelper (Observer *observer)

void	removeObservationHelper (Observer *observer)

Protected Member Functions inherited from inviwo::ProgressBarObservable
void	notifyProgressChanged (float progress)

void	notifyVisibilityChanged (bool visible)

Protected Member Functions inherited from inviwo::Observable< ProgressBarObserver >
void	forEachObserver (C callback)

Detailed Description

Simple progressbar to be used in a ProgressBarOwner. Expects progress between [0 1]. Progress 0 means that it starts and 1 it is finished.

Note: Use ProgressBarOwner when using it for a Processor

See also: ProgressBarOwner; ProgressBarObserver

Member Function Documentation

◆ finishProgress()

void inviwo::ProgressBar::finishProgress ( )

Set progress to 1 and notify observables if visible.

◆ getProgress()

float inviwo::ProgressBar::getProgress ( ) const

Return current progress. Progress 0 means that it starts and 1 it is finished.

◆ resetProgress()

void inviwo::ProgressBar::resetProgress ( )

Set progress to 0 and notify observables if visible.

◆ updateProgress()

void inviwo::ProgressBar::updateProgress ( float progress )

Set progress in [0 1]. Progress 0 means that it starts and 1 it is finished. Will also notify observables if visible.

Parameters

progress between [0 1]

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

progressbar.h