Quick Start
SightLab experiments can be set up with a GUI, with code, or a combination of both. This QuickStart is first showing starting a quick session with the GUI. For running a session with code see the non-GUI example
Quick Start - New Scene | |
---|---|
Create Folder: From Documents\SightLab2\Projects make a copy of BlankProject . |
|
Add Assets: To add assets, place 3D models in the resources/environments or 360 media inresources/media folder. See this page for some places to gather assets (Can also access built-in ones or copy from the sample project). |
|
Launch GUI: Open SightLab_VR.py in your BlankProject copy folder to launch the SightLab GUI and choose hardware. |
|
If have any existing projects loaded, click "New." Next, name Project and click "Save Project" |
|
Open Editor: Click Modify in the GUI to load environments, models, or 360 media. | |
Choose Assets: Can choose from the dropdown list or also drag and drop into the editor. Click "360 Media" if using 360 media. | |
Open Scene Editor: - For 3D models, set up your scene, add ROIs and objects in the scene editor "Inspector" by clicking on the Edit button. |
|
Scene Editor: - You can use the built in 3D model editor Inspector to edit the model, add a regions of interest set a starting point, check scale, set lighting and more (if needed). After editing click File- Save to save the scene. See this page for more details. |
|
Make sure to click the "refresh" button if changes were made to a 3D model or added a new one. | |
Tag Objects: - Objects can be tagged for extra data collection, visibility as well as interactions, such as grabbing. |
|
360 Media: - Add 360 Media to the media folder and choose format. Press Shift (in Desktop Mode) to enter ROI mode, then set ROIs by moving the virtual gaze point and pressing 1. |
|
Generate Trials: Enter a count and click Generate to add more trials if desired. Use Start/End Conditions (Keypress, Timer, Event, Gaze). Can choose different environments or media per trial if desired. Click Done when ready. |
|
Adjust Options: Set additional options on the main page such as eye tracking thresholds, randomization, per trial or combined data files, screen recordings and synchronizing with BIOPAC Acqknowledge. | |
Start Session: Press "Continue" to begin the session | |
Start/End Trials: Enter Participant info (unless set to bypass). Default controls use Spacebar to start/stop. See all controls here. Press the "p" key to toggle viewing the gaze point (off by default) | |
Replay & Review Data: Use SightLabReplay.py for an interactive session replay (use Spacebar to start/stop playback); view data files in the data folder. |
|
Edit Code: Click to edit the code by clicking the "Edit" button or just open in the included Vizard python editor. | |
SightLab script: See this page for SightLab code attributes and methods. | |
For more, refer to the SightLab documentation and examples in the ExampleScripts folder to see how to add much more functionality and use templates, such as adding instructions, rating scales, using AI agents and much more. |
Non-GUI Workflow: For non-GUI see example with code.
Customize Scene/Experiment: Creating a new scene.
Multi-User Setup: Check the multi-user guide for collaborative experiments.
Getting Assets: Need models or media? Check out the Getting 3D Models and Assets page.
See also this video tutorial on starting from the blank scene