NDEVR
API Documentation
ProgressSource

Represents a named progress source with an identifier and completion percentage. More...

Collaboration diagram for ProgressSource:
[legend]

Public Member Functions

 ProgressSource (TranslatedString name, uint04 id=Constant< uint04 >::Invalid, fltp04 progress=1.0f)
 Constructs a ProgressSource with the given name, identifier, and progress value.

Public Attributes

uint04 id = Constant<uint04>::Invalid
 The unique identifier for this progress source.
TranslatedString name
 The translated display name of this progress source.
fltp04 progress = 1.0f
 The completion percentage as a fraction from 0.0 to 1.0.

Detailed Description

Represents a named progress source with an identifier and completion percentage.


Definition at line 40 of file ProgressSource.h.

Constructor & Destructor Documentation

◆ ProgressSource()

ProgressSource::ProgressSource ( TranslatedString name,
uint04 id = Constant<uint04>::Invalid,
fltp04 progress = 1.0f )
inline

Constructs a ProgressSource with the given name, identifier, and progress value.

Parameters
[in]nameThe translated display name for this progress source.
[in]idThe unique identifier for this progress source. Defaults to invalid.
[in]progressThe completion percentage as a fraction from 0.0 to 1.0. Defaults to 1.0.

Definition at line 48 of file ProgressSource.h.

References id, name, and progress.


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