Range
- Last UpdatedDec 07, 2023
- 2 minute read
The Range node is a totalizer that accepts addValues as input and produces a currentValue output that is scaled between the minValue and the maxValue.
-
It has two modes: RANGE and CIRCULAR.
-
The new currentValue is calculated every time the addValue is rewritten by another node or command.
-
The currentValue calculation formula is: currentValue= oldValue + (addValue * addMul / addDiv)
Platform support
This node is fully supported on XR-Windows, XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-Portable WASM platforms.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
Full support |
Full support |
Full support |
Full support |
|
|
|
|
|
|
Code example
An example for the Range node.
<Range name="rangex" rangeMin="0" rangeMax="370" currentValue="50" mode="CIRCULAR"/>
Position
The Range node must be inside a context node, such as Context or Global.
Range fields
These are the fields for Range node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > Range
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
addDiv |
sfloat |
Optional |
1 |
Scales the impact of the addValue in currentValue calculation formula. |
|
addMul |
sfloat |
Optional |
1 |
Scales the impact of the addValue in currentValue calculation formula. |
|
addValue |
sfloat |
Optional |
Not set |
The input field to trigger range currentValue calculation. |
|
addValueOverTime |
sfloat |
Optional |
0 |
Automatically increases/decreases the input value. Expressed in units per seconds. Use as an alternative to addValue. |
|
currentValue |
sfloat |
Read only |
0 |
The output value of the range totalizer. |
|
mode |
sstring |
Optional |
CIRCULAR |
Defines the operating mode of the range.
These values must be expressed in upper case. |
|
rangeMin |
sfloat |
Optional |
0 |
Sets the minimum currentValue. |
|
rangeMax |
sfloat |
Optional |
1 |
Sets the maximum currentValue. |