Open CASCADE Technology
6.5.4
|
Internal data structure for scale in ProgressIndicator
Basically it defines three things:
More...
#include <Message_ProgressScale.hxx>
Public Member Functions | |
DEFINE_STANDARD_ALLOC | Message_ProgressScale () |
Creates scale ranged from 0 to 100 with step 1 | |
void | SetName (const Standard_CString theName) |
void | SetName (const Handle< TCollection_HAsciiString > &theName) |
Sets scale name | |
Handle_TCollection_HAsciiString | GetName () const |
Gets scale name Name may be Null handle if not set | |
void | SetMin (const Standard_Real theMin) |
Sets minimum value of scale | |
Standard_Real | GetMin () const |
Gets minimum value of scale | |
void | SetMax (const Standard_Real theMax) |
Sets minimum value of scale | |
Standard_Real | GetMax () const |
Gets minimum value of scale | |
void | SetRange (const Standard_Real min, const Standard_Real max) |
Set both min and max | |
void | SetStep (const Standard_Real theStep) |
Sets default step | |
Standard_Real | GetStep () const |
Gets default step | |
void | SetInfinite (const Standard_Boolean theInfinite=Standard_True) |
Sets flag for infinite scale | |
Standard_Boolean | GetInfinite () const |
Gets flag for infinite scale | |
void | SetScale (const Standard_Real min, const Standard_Real max, const Standard_Real step, const Standard_Boolean theInfinite=Standard_True) |
Set all scale parameters | |
void | SetSpan (const Standard_Real first, const Standard_Real last) |
Defines span occupied by the scale on the basis scale | |
Standard_Real | GetFirst () const |
Standard_Real | GetLast () const |
Return information on span occupied by the scale on the base scale | |
Standard_Real | LocalToBase (const Standard_Real val) const |
Standard_Real | BaseToLocal (const Standard_Real val) const |
Convert value from this scale to base one and back |
- name that can be used for generating user messages <br> - limits and characteristics of the current scale, <br> along with derived coefficients to map it into basic scale [0-1] <br> - methods for conversion of values from current scale <br> to basic one and back <br>
NOTE: There is no special protection against bad input data
like min > max etc. except cases when it can cause exception
Standard_Real Message_ProgressScale::GetFirst | ( | ) | const |
Standard_Real Message_ProgressScale::GetLast | ( | ) | const |
Standard_Real Message_ProgressScale::GetMax | ( | ) | const |
Standard_Real Message_ProgressScale::GetMin | ( | ) | const |
Handle_TCollection_HAsciiString Message_ProgressScale::GetName | ( | ) | const |
Standard_Real Message_ProgressScale::GetStep | ( | ) | const |
void Message_ProgressScale::SetInfinite | ( | const Standard_Boolean | theInfinite = Standard_True | ) |
void Message_ProgressScale::SetMax | ( | const Standard_Real | theMax | ) |
void Message_ProgressScale::SetMin | ( | const Standard_Real | theMin | ) |
void Message_ProgressScale::SetName | ( | const Standard_CString | theName | ) |
void Message_ProgressScale::SetName | ( | const Handle< TCollection_HAsciiString > & | theName | ) |
void Message_ProgressScale::SetRange | ( | const Standard_Real | min, |
const Standard_Real | max | ||
) |
void Message_ProgressScale::SetScale | ( | const Standard_Real | min, |
const Standard_Real | max, | ||
const Standard_Real | step, | ||
const Standard_Boolean | theInfinite = Standard_True |
||
) |
void Message_ProgressScale::SetSpan | ( | const Standard_Real | first, |
const Standard_Real | last | ||
) |
void Message_ProgressScale::SetStep | ( | const Standard_Real | theStep | ) |