ItemGauge
- Last UpdatedDec 16, 2023
- 3 minute read
Use the ItemGauge node to map a radial gauge indicator, such as a manometer.
-
The ItemGauge node inherits from ItemTextureDisplay.
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 |
|
|
|
|
|
|
Code example
This is a code example for ItemGauge.
<ItemGauge name="PI52034" needleScale="0 40" needleRange="0 4.71"/>
Default Actions
|
Action |
Hotkey |
Text |
Description |
|---|---|---|---|
|
check |
X |
Check |
Checks the item. |
ItemGauge fields
These are the fields for ItemGauge node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > NodeBaseMovable > Item > ItemTextureDisplay > ItemGauge
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
center |
svec2 |
Optional |
-1 -1 (texture center) |
The coordinates of the hand fixed point that is the center of the gauge radial indicator. |
|
font |
sstring |
Optional |
Arial,Bold,24 |
The font to use for the marker values and the marker unit. The font name must be a system font. Only Bold and Regular parameters are accepted. |
|
generateBackground |
sbool |
Optional |
true |
If set to true, the gauge label is overwritten with markers and other information. |
|
markerColor |
svec3 |
Optional |
marker color |
The color of marker, expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
markerDecimals |
svec2 |
Optional |
1 |
Defines the number of decimals to display in the gauge markers. |
|
marketLength |
sfloat |
Optional |
-1 (radius/10) |
Length in pixels of the value markers. |
|
markerLengthInner |
sfloat |
Optional |
-1 (radius/10) |
Length, in pixels, of the value inner markers. |
|
markerNum |
sint |
Optional |
4 |
Number of markers in the gauge. Each marker also displays the associated value. |
|
markerNumInner |
sint |
Optional |
10 |
Number of inner markers in the gauge. These are little markers between main markers. Each marker also displays the associated value. |
|
markerThickness |
sfloat |
Optional |
3 |
Thickness, in pixels, of the value markers. |
|
markerThicknessInner |
sfloat |
Optional |
2 |
Thickness, in pixels, of the inner markers. |
|
markerUnitText |
sstring |
Optional |
mw/pl |
Gauge unit measure text. |
|
markerUnitTextPosition |
svec2 |
Optional |
-1 -1 (center_x,center_y-radius/2)) |
Unit measure text center position. |
|
markerZeroRSad |
sfloat |
Optional |
-2.35 |
Offset that can be used to rotate the markers and align them correctly. |
|
needleAxis |
svec3 |
Optional |
1 0 0 |
Defines the axis the needle turns around. |
|
needleMesh |
sstring |
Optional |
Auto-populated |
Automatic name of the gauge needle mesh. Can be overridden if the item does not support naming convention. |
|
needleRange |
svec2 |
Optional |
0 1 |
Defines the rotation values of the needle for the two extreme of the scale. Angle expressed in radiants. |
|
needleScale |
svec2 |
Optional |
0 1 |
Defines value minimum (x) and maximum (y). |
|
needleZeroRad |
sfloat |
Optional |
0 |
The needle zero offset position. This can be used to modify the zero position set by the geom. |
|
radius |
sfloat |
Optional |
-1 (Min(tw/2,th/2) |
Length, in pixels, of the indicator hand. |
|
value |
sfloat |
Optional |
no default value |
Value of the variable displayed by the gauge, in the needleScale range. |