Setting Up a VR Menu in SightLab

Introduction

The 3D Tablet Menu feature in SightLab allows users to use and modify a VR Menu to interact with your scene. This guide will walk you through the setup and use of this feature. Use either a selector/ highlighter tool or your controllers to interact with the menu.

Installation

1. Locate the following files in the ExampleScripts- 3D Tablet Menu directory:

   • 3D_tablet_menu.py: Example using the GUI and standard VR scenes

   • 3D_tablet_menu_XR.py: Example using the passthrough camera to show menu in AR

   • VR_Menu.osgb: Required object for the virtual menu functionality

2. Choose your preferred implementation:

   • If you want to use the existing example: Copy either script and VR_Menu.osgb to your project directory.

   • If you prefer to integrate the functionality into your existing script: Copy only the necessary code snippets and VR_Menu.osgb

Basic Setup

If integrating to your own script, add the following code:

# Import the vr_menu and selector modules

from sightlab_utils.vr_menu import VRMenu

from sightlab_utils import selector

#Add functions that will be called from the menu buttons

def Action1():

    print('button 1 pressed')

#Define which functions are called with the buttons

actions = [Action1, Action2, Action3, Action4]

vr_menu = VRMenu(actions,tablet_model = 'VR_Menu.osgb',config=sightlab.getConfig())

vr_menu_object = vr_menu.tablet

sightlab.addSceneObject('vr_menu_object', vr_menu_object, grab=True)

# After sightlab.startTrial() or yield viztask.waitEvent(TRIAL_START), add:

vr_menu.experiment_loop()

selector.setupSelector(sightlab.getConfig())

Using the VR Menu

• Menu Visibility: Press 'm' key or right thumbstick (controller) to reposition and toggle menu visibility (left trackpad for Vive controllers).

• Menu Grabbing: Use either trigger button to grab the menu.

• Button Interaction: Use either a selector/ highlighter tool or your controllers to interact with the menu.