ML Reference
Public Member Functions
ml::ProgressField Class Reference
Fields

Field to encapsulate an increasing float value from range [0,1]. More...

#include <mlFields.h>

Inheritance diagram for ml::ProgressField:
ml::FloatField ml::Field

List of all members.

Public Member Functions

 ProgressField ()
 Default constructor, do not use it.
 ProgressField (const std::string &name)
 Constructor, creates a field with a name to manage a progressive float value.
void setFloatValue (float floatValue)
 Sets field value to floatValue if floatValue==0, floatValue==1 or floatValue > previous floatValue + setUpdateDifference.
void setProgressValue (float floatValue)
 Same as setFloatValue().
float getProgressValue ()
 Same as getFloatValue().
void setUpdateDifference (float epsilonValue)
 Sets an epsilon value which a new value must have more than the previous value to be accepted as new field value.
Deprecated
 ProgressField (const std::string &name, float *valuePtr)

Detailed Description

Field to encapsulate an increasing float value from range [0,1].

It accepts a new value only if it is 0, 1 or at least an epsilon higher than the previous value.

Definition at line 580 of file mlFields.h.

Constructor & Destructor Documentation

ml::ProgressField::ProgressField ( )

Default constructor, do not use it.

ml::ProgressField::ProgressField ( const std::string &  name)

Constructor, creates a field with a name to manage a progressive float value.

Default epsilon value is 0.02. Default value is 0.

ml::ProgressField::ProgressField ( const std::string &  name,
float *  valuePtr 
)
Deprecated:
Use ProgressField(const std::string& name) instead.

Member Function Documentation

float ml::ProgressField::getProgressValue ( ) [inline]

Same as getFloatValue().

Definition at line 604 of file mlFields.h.

References ml::FloatField::getFloatValue().

void ml::ProgressField::setFloatValue ( float  floatValue)

Sets field value to floatValue if floatValue==0, floatValue==1 or floatValue > previous floatValue + setUpdateDifference.

Reimplemented from ml::FloatField.

void ml::ProgressField::setProgressValue ( float  floatValue)

Same as setFloatValue().

void ml::ProgressField::setUpdateDifference ( float  epsilonValue)

Sets an epsilon value which a new value must have more than the previous value to be accepted as new field value.

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