OGF::ApplicationBase::ApplicationBaseProgressClient Class Reference

A ProgressClient that redirects all messages to an ApplicationBase. More...

#include <OGF/scene_graph/skin/application_base.h>

Inheritance diagram for OGF::ApplicationBase::ApplicationBaseProgressClient:

Public Member Functions
	ApplicationBaseProgressClient (ApplicationBase *app)
void	begin () override
	Starts listening progress. More...
void	progress (index_t step, index_t percent) override
	Tracks progress. More...
void	end (bool canceled) override
	Stops listening progress. More...
Public Member Functions inherited from GEO::Counted
void	ref () const
	Increments the reference count. More...
void	unref () const
	Decrements the reference count. More...
bool	is_shared () const
	Check if the object is shared. More...
int	nb_refs () const
	Gets the number of references that point to this object. More...

Additional Inherited Members
Static Public Member Functions inherited from GEO::Counted
static void	ref (const Counted *counted)
	Increments the reference count. More...
static void	unref (const Counted *counted)
	Decrements the reference count. More...
Protected Member Functions inherited from GEO::ProgressClient
	~ProgressClient () override
Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object. More...
virtual	~Counted ()
	Destroys a reference counted object. More...

Detailed Description

A ProgressClient that redirects all messages to an ApplicationBase.

Definition at line 428 of file application_base.h.

Member Function Documentation

begin()

void OGF::ApplicationBase::ApplicationBaseProgressClient::begin ( )

overridevirtual

Starts listening progress.

This function is called by the ProgressTask to start tracking the execution of a new task. Clients are free to do whatever is appropriate (show a progress bar, a progress dialog, ...)

Implements GEO::ProgressClient.

end()

void OGF::ApplicationBase::ApplicationBaseProgressClient::end ( bool  canceled )

overridevirtual

Stops listening progress.

This function is called by the ProgressTask to stop tracking the execution of the task. Clients are free to do whatever is appropriate (hide a progress bar, a progress dialog, log the elapsed time, ...). If the task was not terminated normally (i.e., canceled() then parameter canceled is set to true.

Parameters

[in]

canceled

set to true if the task was canceled, false otherwise.

Implements GEO::ProgressClient.

progress()

void OGF::ApplicationBase::ApplicationBaseProgressClient::progress ( index_t  step, index_t  percent  )

overridevirtual

Tracks progress.

This function is called by the ProgressTask repeatedly during the execution of the task. Clients are free to do whatever is appropriate (update a progress bar, log the current values, ...).

Parameters

[in]	step	the current progress step
[in]	percent	the percentage of completion of the task

Implements GEO::ProgressClient.

---

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

• OGF/scene_graph/skin/application_base.h