ARFX Debug UI

Section 15. ARFX Debug User Interface

The debug menu is only one of 4 modes. This is its primary first mode.

You can access the debug menu by pressing Z or Select on gamepad. Pressing the input again will change what is displayed on screen. The first two of these modes have information on screen and the last two modes turns on solid colored bars that can be used as full screen fill lighting.

• Shows FPS, the virtual screen's position and rotation, rotation mode, movement mode, and your current bookmark

• Shows FPS, rotation mode, movement mode, and your current bookmark

• Shows only the bottom color bar

• Shows top and bottom color bars

• Disables the Debug Menu

Section 15.1 Information On Display

• Virtual Position & Orientation (Low Center) - This is technically your screen's virtual position and orientation in the scene. You can use this information to return to a location should bookmarks not be an option to use

• Frame Rate Widget (Center Right) – This widget contains highly important information regarding frame rate and frame timings. This is the larger, more informative version of the same widget found in the Options Menu.

• Rotation Mode (Bottom Left) – Indicates one of two rotation modes: “Rotate at Camera” and “Rotate at Screen”

• Movement Mode (Bottom Center) – Indicates if you are in Normal, Locked Height, or Snap movement modes

• Current Bookmark (Bottom Right) – Indicates the internal name of the bookmark your camera is currently at. Note that it will report the same bookmark even if you manually move away from it. Check out the ARFX_Bookmark Section for more information.

Section 15.2 About the Frame Rate Widget

The FPS widget, shown throughout the Options menu and in the Debug menu, helps you judge whether your scene needs some graphical tweaks.

This widget, the larger version of what can be found in the options menu, will accurately tell you your current frame rate and frame timings as a graph. It will also indicate the highest and lowest values reached within said graph. You will want this to be at 60fps and above at all times when using a scene, and the information shown will change colour depending on how your frame rate is going.

Important

The one exception to the 60 fps minimum is when you are using [Genlock] on Unreal and your screen to match the frame timing of your recording camera.

• Green: 60 and above

• Yellow: 31 – 59

• Red: 30 and below

Section 15.3 Rotation Modes

Rotate at Camera - In this mode, rotations made via inputs are done at the hero tracker's (or tracked camera's) location. Allows for only yaw rotations.

Rotate at Screen - In this mode, rotations made via inputs are done at the physical screen's location. Allows for both pitch and yaw rotations.

Section 15.4 Movement Modes

• Normal Movement - Free movement. Movement will follow the direction the ARFX Camera is pointing.

• Locked Height Movement - This locks the height of the ARFX Camera regardless of tilt/pitch (explicitly moving vertically up/down still works). Great for maintaining an angle while on the move.

• Snap Mode—This mode allows you to use either the Arrow Keys or the D-Pad to snap the virtual screen to the surrounding environment.

Section 15.5 How to Customize the Color Bars

To find this, select your ARFX Camera and find this section in the Details panel.

From here, you should be able to customize each bar's height and color as needed. More functionality will likely come soon.