XR Session¶
Category: Executor Tier: Pro
Purpose¶
Manages the XR session lifecycle and global system parameters.
Visual Reference¶

Runtime Behavior¶
Inputs
Activate (Boolean): Triggers the selected action.
Outputs
Session State (Metadata): Exposes current session state (
IDLE,READY,SYNCHRONIZED,VISIBLE,FOCUSED,STOPPING,LOSS_PENDING,EXITING) as runtime metadata for downstream logic.
Properties
Core (always visible)
action (Enum, default
"Initialize"):Initialize,Shutdown,World Scale,Reset Orientation,Set World Origin,Toggle Interface,Set Refresh Rate,Toggle Foveated Rendering,Set Tracking Mode,Custom Commandinterface_name (String, default
"OpenXR")
Initialize/Shutdown
No additional properties. Initialize calls XRInterface::initialize() and sets the viewport to use XR. Shutdown calls uninitialize().
World Scale (visible_if: {action: "World Scale"})
scale_factor (Float, default
1.0): Multiplier applied toXROrigin3D.world_scale.
Toggle Interface (visible_if: {action: "Toggle Interface"})
target_interface (String, default
"OpenXR"): Interface to activate/deactivate.
Set Refresh Rate (visible_if: {action: "Set Refresh Rate"})
refresh_rate (Float, default
90.0): Target display refresh rate in Hz.
Toggle Foveated Rendering (visible_if: {action: "Toggle Foveated Rendering"})
foveated_level (Int, default
0): 0=off, 1=low, 2=medium, 3=high.
Set Tracking Mode (visible_if: {action: "Set Tracking Mode"})
tracking_mode (Enum):
3DOF,6DOF
Custom Command (visible_if: {action: "Custom Command"})
…
Properties¶
Property |
Type |
Default |
Notes |
|---|---|---|---|
Action |
option |
Initialize |
XR session operation |
Interface |
string |
OpenXR |
XR interface name (OpenXR, WebXR, etc.) |
Scale |
float |
1.0 |
Multiplier for XROrigin3D.world_scale |
Target |
string |
OpenXR |
Interface to activate/deactivate |
Hz |
float |
90.0 |
Target display refresh rate |
Level |
int |
0 |
0=off, 1=low, 2=medium, 3=high |
Mode |
option |
6DOF |
Tracking degrees of freedom |
Command |
string |
Vendor-specific command string |