Ruler
- Last UpdatedOct 22, 2025
- 2 minute read
The Ruler node enables you to display and measure the distance among two points.
Note: This feature can be seen only inside the XR Studio Graphic Context Editor.
The two points are represented by a small 3D colored sphere.
The line displays in overlay so that it can be seen, even if one or both of the points are covered by other meshes.
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 |
|
|
|
|
|
|
Code example
This is a code example for the Ruler node.
<Ruler name="ruler" templateInfo="t_ruler|ruler" positionStart="-12 2 25" positionEnd="-12 3 23"/>
Ruler fields
These are the fields for Ruler node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > Ruler
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
length |
sfloat |
Read only |
Internally calculated |
The distance between start and end. |
|
lineColor |
svec3 |
Optional |
1 1 1 |
Overlay line color. |
|
pointsColor |
svec3 |
Optional |
0 1 0 |
The color of the start and end points. |
|
positionStart |
svec3 |
Mandatory |
No default |
The scene coordinates for the rule start point. |
|
positionStop |
svec3 |
Mandatory |
No default |
The scene coordinates for the rule end point. |