ItemKnobSelector
- Last UpdatedDec 16, 2023
- 3 minute read
The ItemKnobSelector implements a multi-positional (2-n) rotating switch.
-
The ItemKnobSelector node inherits from Item.
Platform support
This node is fully supported on XR-Windows platform.
It is partially supported on XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-P WASM platforms.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
Partial support |
Partial support |
Partial support |
Partial support |
|
|
|
|
|
|
Selector Modes
The ItemKnobSelector has two selection nodes.
|
Mode |
Description |
|---|---|
|
Normal |
A switch with 2-n positions and the user can select one of them. |
|
Autoreturn |
Available only for 2 or 3 position selectors. The selector returns automatically to position 0 after the user has released the switch. |
Number of positions
The ItemKnobSelector can have 2-n positions on the dial.
-
With two positions uses right action to go to state 1.
-
With three positions uses right action to go to state 1 and left action to go to state 2.
-
The selected value is retained until the user releases the action or the autoReturnDelay time expires. The autoReturnDelay setting is designed to avoid selection spikes.
Code example
This is a code example for the ItemKnobSelector node.
<ItemKnobSelector name="HS52052" statesRotation="0,-0.7,-1.4" rotationSpeed="2"/>
Default Actions
|
Action |
Hotkey |
Text |
Description |
|---|---|---|---|
|
check |
X |
Check |
Checks the item. |
ItemKnobSelector fields
These are the fields for ItemKnobSelector node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > NodeBaseMovable > Item > ItemKnobSelector
|
Fields |
Type |
Version |
Use |
Default value |
Description |
|---|---|---|---|---|---|
|
autoReturnDelay |
sfloat |
2.5 |
Optional |
1 |
Works only when mode is set to Autoreturn. The selected option is retained for at least this amount of time in seconds before the selector automatically returns to default position. |
|
currentRotation |
sfloat |
Read only |
Internally calculated |
Shows the current rotation, in radiants. |
|
|
knobMesh |
sstring |
Optional |
Auto-populated |
Name of the knob rotating mesh. This value can be overridden if the item does not support naming convention. |
|
|
mode |
senum |
Read only |
Normal |
Defines selector mode: Normal or Autoreturn. Autoreturn works correctly only with 2-state selectors. |
|
|
rotationSpeed |
sfloat |
Optional |
2 |
Defines the animation speed, in radiants per second. |
|
|
statesRotation |
mfloat |
Mandatory |
Not set |
Defines the number of selector states and their corresponding rotation angles. |
|
|
statesText |
mstring |
2.3 |
Optional |
0,1,2,3,4 |
Assigns a text name to the rotation states used in displayState or inside the XR Instructor. |
|
value |
sint |
Optional |
0 |
Defines the selector state. |