ItemViewer2D
- Last UpdatedFeb 19, 2025
- 3 minute read
The ItemViewer2D node unifies InteractionViewer and InteractionActionMenu functionalities in a unique interface.
-
Being a RectBase2D node allows ItemViewer2D to be placed on a Texture2D and placed in the 3D scene.
-
Use ItemViewer2D node to manage user interaction when using VR HMD and their input devices.
-
The ItemViewer node inherits from RectBase2D.
Platform support
This node is supported on XR-Windows platform only.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
No support |
No support |
No support |
No support |
|
|
|
|
|
|
Customizing display information
Use the mode parameter to customize what displays inside the ItemViewer2D.
-
Normal—Item Name, Icons, displayNames, displayValues, Actions.
-
Compact—Item Name, displayNames, displayValues, Actions.
-
Actions—Actions.
Code example
This is a code example for ItemViewer2D.
<ItemViewer2D name="itemViewer" position="0 0" size="640 480" visible="false" renderToTexture2D="monitor_left_texture" backgroundImage="" selectorNode="sel"/>
ItemViewer2D fields
These are the fields for ItemViewer2D node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > RectBase2D > ItemViewer2D
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
backgroundImage |
sstring |
Optional |
interactionviewer_background.png |
Component background image. |
|
cellBackColor |
svec3 |
Optional |
0 0 0 |
When performing an action, a background rect appears below it. This parameter sets the color of this rect. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
cellColor |
svec3 |
Optional |
1 1 1 |
Color used for action display. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
cellFont |
sstring |
Optional |
Arial,Regular,20 |
The font used to display action. |
|
line1Color |
svec3 |
Optional |
1 1 1 |
Text color for display name line. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
line1Font |
sstring |
Optional |
Arial,Bold,22 |
The font to use for item display name. |
|
line2Color |
svec3 |
Optional |
1 1 1 |
Text color for display item value line. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
line2Font |
sstring |
Optional |
Arial,Regular,20 |
The font to use for item value. |
|
mode |
senum |
Optional |
Normal |
Specifies the itemviewer aspect. Options are: Normal, Compact, and Actions. |
|
next |
sevent |
Optional |
Event called from external to move selector right. |
|
|
prev |
sevent |
Optional |
Event called from external to move selector left. |
|
|
refreshTime |
sfloat |
Optional |
0.1 |
Visual refresh interval. |
|
saveSelectedAction |
sbool |
Optional |
true |
If set, the system remembers the last selected action when deselecting an item. This action is automatically selected once the item get selected again. |
|
selectorNode |
sstring |
Mandatory |
Name of the InteractionSelector node to link to. |
|
|
selectDown |
sevent |
Optional |
Event called from external to push an action. |
|
|
selectUp |
sevent |
Optional |
Event called from external to release an action. |
|
|
selectedAction |
sstring |
Read Only |
Internally calculated |
Provides feedback the currently selected action, if any. |
|
selectorImage |
sstring |
Optional |
interactionmenu_selector.png |
The selector image. By default, this is a triangle. |
|
titleColor |
svec3 |
Optional |
0.79 0.79 0.10 |
Text color for item name or group. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
titleFont |
sstring |
Optional |
Arial,Bold,22 |
The font to use for item name or group. |