tuttle::plugin::NoProgress Class Reference

#include <NoProgress.hpp>

Inheritance diagram for tuttle::plugin::NoProgress:

Collaboration diagram for tuttle::plugin::NoProgress:

Public Member Functions
void	progressBegin (const int numSteps, const std::string &msg="")
	Start the algorithm progress bar.
void	progressEnd ()
	Ends the algorithm progress bar.
bool	progressForward (const int nSteps)
	Put the progress bar forward.
Protected Attributes
double	_stepSize
	Step size of progess bar.
double	_counter
	Current position in [0; 1].

---

Detailed Description

Definition at line 9 of file NoProgress.hpp.

---

Member Function Documentation

void tuttle::plugin::NoProgress::progressBegin	(	const int	numSteps,
		const std::string &	msg = ""
	)		[virtual]

Start the algorithm progress bar.

Parameters:

[in]

numSteps

number of steps

Implements tuttle::plugin::IProgress.

Definition at line 12 of file NoProgress.cpp.

References _counter, and _stepSize.

void tuttle::plugin::NoProgress::progressEnd

(

)

[virtual]

Ends the algorithm progress bar.

Implements tuttle::plugin::IProgress.

Definition at line 37 of file NoProgress.cpp.

bool tuttle::plugin::NoProgress::progressForward

(

const int

nSteps

)

[virtual]

Put the progress bar forward.

Parameters:

[in]

nSteps

Number of steps processed since last call.

Returns:

true = effect aborted, false = continu rendering

Implements tuttle::plugin::IProgress.

Definition at line 27 of file NoProgress.cpp.

References _counter, and _stepSize.

---

Field Documentation

double tuttle::plugin::NoProgress::_counter [protected]

Current position in [0; 1].

Definition at line 18 of file NoProgress.hpp.

Referenced by progressBegin(), and progressForward().

double tuttle::plugin::NoProgress::_stepSize [protected]

Step size of progess bar.

Definition at line 17 of file NoProgress.hpp.

Referenced by progressBegin(), and progressForward().

---

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

• TuttleOFX/libraries/tuttle/src/tuttle/plugin/NoProgress.hpp
• TuttleOFX/libraries/tuttle/src/tuttle/plugin/NoProgress.cpp