pcl::RealTimeProgressStatus Class Reference

A status monitoring callback to provide progress feedback during long real-time preview generation procedures. More...

#include <RealTimeProgressStatus.h>

Inheritance diagram for pcl::RealTimeProgressStatus:

Public Member Functions
	RealTimeProgressStatus (const RealTimeProgressStatus &x)
	RealTimeProgressStatus (const String &title)
int	Completed (const StatusMonitor &monitor) const override
void	InfoUpdated (const StatusMonitor &monitor) const override
int	Initialized (const StatusMonitor &monitor) const override
int	Updated (const StatusMonitor &monitor) const override
Public Member Functions inherited from pcl::MuteStatus
	MuteStatus ()=default
	MuteStatus (const MuteStatus &x)
	MuteStatus (MuteStatus &&x)
	~MuteStatus () override
MuteStatus &	operator= (const MuteStatus &x)
MuteStatus &	operator= (MuteStatus &&x)
Public Member Functions inherited from pcl::StatusCallback
	StatusCallback ()=default
	StatusCallback (const StatusCallback &)=default
	StatusCallback (StatusCallback &&)=default
virtual	~StatusCallback ()
StatusCallback &	operator= (const StatusCallback &)=default
StatusCallback &	operator= (StatusCallback &&)=default

Detailed Description

RealTimeProgressStatus allows you to drive the Real-Time Preview progress dialog during long real-time preview generation tasks. Using this class is recommended for real-time renditions consistently taking more than a couple of seconds to complete on contemporary hardware.

For detailed information on the Real-Time Preview system and its associated modal progress dialog functionality, please refer to the RealTimePreview class and the RealTimePreview::ShowProgressDialog() static member function.

See also

RealTimePreview, StatusCallback, StatusMonitor, MuteStatus

Definition at line 85 of file RealTimeProgressStatus.h.

Constructor & Destructor Documentation

RealTimeProgressStatus() [1/2]

pcl::RealTimeProgressStatus::RealTimeProgressStatus ( const String &  title )

inline

Constructs a RealTimeProgressStatus instance.

Parameters

title

The text that will be shown as the tile of the Real-Time Preview progress dialog window. Typically this text will be shown centered on the dialog's title bar.

Definition at line 96 of file RealTimeProgressStatus.h.

RealTimeProgressStatus() [2/2]

pcl::RealTimeProgressStatus::RealTimeProgressStatus ( const RealTimeProgressStatus &  x )

inline

Copy constructor.

Definition at line 104 of file RealTimeProgressStatus.h.

Member Function Documentation

Completed()

int pcl::RealTimeProgressStatus::Completed ( const StatusMonitor &  monitor ) const

inlineoverridevirtual

Function called by a status monitor object to signal that the current process has finished.

As reimplemented in RealTimeProgressStatus, this function closes the Real-Time Preview progress dialog window.

Reimplemented from pcl::MuteStatus.

Definition at line 152 of file RealTimeProgressStatus.h.

References pcl::RealTimePreview::CloseProgressDialog(), and pcl::MuteStatus::Completed().

InfoUpdated()

void pcl::RealTimeProgressStatus::InfoUpdated ( const StatusMonitor &  monitor ) const

inlineoverridevirtual

Function called by a status monitor object when the progress information for the current process has been changed.

As reimplemented in RealTimeProgressStatus, this function updates the single-line label text on the Real-Time Preview progress dialog.

Reimplemented from pcl::MuteStatus.

Definition at line 169 of file RealTimeProgressStatus.h.

References pcl::StatusMonitor::Info(), and pcl::RealTimePreview::SetProgressText().

Initialized()

int pcl::RealTimeProgressStatus::Initialized ( const StatusMonitor &  monitor ) const

inlineoverridevirtual

This function is called by a status monitor object when a new monitored process is about to start.

As reimplemented in RealTimeProgressStatus, this function opens the Real-Time Preview progress dialog window and initializes it with the monitor's total count and information text.

Reimplemented from pcl::MuteStatus.

Definition at line 118 of file RealTimeProgressStatus.h.

References pcl::StatusMonitor::Info(), pcl::MuteStatus::Initialized(), pcl::RealTimePreview::ShowProgressDialog(), and pcl::StatusMonitor::Total().

Updated()

int pcl::RealTimeProgressStatus::Updated ( const StatusMonitor &  monitor ) const

inlineoverridevirtual

Function called by a status monitor object to signal an update of the progress count for the current process.

As reimplemented in RealTimeProgressStatus, this function updates the Real-Time Preview progress dialog with the current monitor's count.

Reimplemented from pcl::MuteStatus.

Definition at line 135 of file RealTimeProgressStatus.h.

References pcl::StatusMonitor::Count(), pcl::RealTimePreview::SetProgressCount(), and pcl::MuteStatus::Updated().

---

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

• RealTimeProgressStatus.h