cloudViewer.utility.Range#
- class cloudViewer.utility.Range#
Scalar field range structure.
- __init__(*args, **kwargs)#
Overloaded function.
__init__(self: cloudViewer.utility.Range) -> None
Default constructor
__init__(self: cloudViewer.utility.Range, arg0: cloudViewer.utility.Range) -> None
Copy constructor
__init__(self: cloudViewer.utility.Range) -> None
- in_bound(self, value)#
Returns the nearest inbound value
- Parameters:
value (SupportsFloat) –
- Returns:
float
- is_in_bound(self, value)#
Returns whether a value is inbound or not
- Parameters:
value (SupportsFloat) –
- Returns:
bool
- is_in_range(self, value)#
Returns whether a value is inside range or not
- Parameters:
value (SupportsFloat) –
- Returns:
bool
- max(self)#
Returns the maximum value
- Returns:
float
- max_range(self)#
Returns the maximum range
- Returns:
float
- min(self)#
Returns the minimum value
- Returns:
float
- range(self)#
Returns the actual range: start-stop (but can’t be ZERO!)
- Returns:
float
- set_bounds(self, min_val, max_val, reset_start_stop=True)#
Sets the bounds
- Parameters:
min_val (SupportsFloat) –
max_val (SupportsFloat) –
reset_start_stop (bool, optional, default=True) –
- Returns:
None
- set_start(self, value)#
Sets the current start value
- Parameters:
value (SupportsFloat) –
- Returns:
None
- set_stop(self, value)#
Sets the current stop value
- Parameters:
value (SupportsFloat) –
- Returns:
None
- start(self)#
Returns the current start value (in [min,max])
- Returns:
float
- stop(self)#
Returns the current stop value (in [min,max])
- Returns:
float