Capture User Interactions & Fixed Desktop/VR mode menu bugs & Instructor Menu Button
Capture user interactions
Added several interaction types to the capture functionality. These interaction types are hide and show menu, settings tab, people tab, interact tab, and create tab. While capture is turned on, these interaction types will be registered accordingly to users' actions.
Type of change
[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Testing
[ ] Change that requires a documentation update
How Has This Been Tested?
Spectator Mode
Create and enter a lab.
Click on Settings Tab -> Instructor Menu -> Capture
Once the capture has started, perform actions (clicking different tabs on the menu). You should probably remember how many times and the order when you are clicking the tabs.
Stop the capture
Log into our SFTP client and go to this directory /home/komodo/captures
You should be able to find a folder with your captured data in it.
You should analyze the data by checking the order of the interaction types being captured and the numbers of time that these types have occurred.
VR Mode
It is advised that at least two people (and at least one person should be in the spectator mode) should participate in the testing for VR mode since the Capture button is only available in the spectator mode.
Create and enter a lab. Enter VR mode.
The person who is in spectator mode should click on Settings Tab -> Instructor Menu -> Capture
Once the capture has started, perform actions (clicking different tabs on the menu). You should probably remember how many times and the order when you are clicking the tabs.
Stop the capture
Log into our SFTP client and go to this directory /home/komodo/captures
You should be able to find a folder with your captured data in it.
You should analyze the data by checking the order of the interaction types being captured and the numbers of time that these types have occurred.
All information about what numbers are registered for what interaction types can be found in ClientSpawnManager.cs
[x] Manual Test
[ ] Unit Test
[ ] Integration / End-to-End Test
[Duplicate all of the above for each distinct feature / bug fix / etc.]
Fixed Desktop/VR mode menu bug
Menu bug: When user switches from VR mode to desktop mode, the VR menu from the VR mode will replace the menu being used in desktop mode. We fixed the bug.
Type of change
[x] Bug fix (non-breaking change which fixes an issue)
[] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Testing
[ ] Change that requires a documentation update
How Has This Been Tested?
Open a lab with v0.5.7
Enter VR mode
Switch back to Desktop mode
The expected result: the menu in desktop mode should only contain Settings, People, and Interact tabs.
[x] Manual Test
[ ] Unit Test
[ ] Integration / End-to-End Test
[Duplicate all of the above for each distinct feature / bug fix / etc.]
Instructor Menu Button
To close the instructor menu in previous version, user needs to click the Back button from the instructor menu. We find this unnecessary. To enhance the user experience, we decided to make the Instructor Menu Button to have both Turn On and Turn Off functionalities.
Type of change
[] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Testing
[ ] Change that requires a documentation update
How Has This Been Tested?
Open a lab with v0.5.7
Enter Desktop mode
Press Settings -> Instructor Menu button
The Instructor Menu should now show up.
Press the Instructor Menu button again.
The Instructor Menu should be disabled.
[x] Manual Test
[ ] Unit Test
[ ] Integration / End-to-End Test
[Duplicate all of the above for each distinct feature / bug fix / etc.]
Test Configuration
REPLACE ME: Browser vendor and version: e.g., Chrome Version 91.0.4472.164 (Official Build) (64-bit)
REPLACE ME: VR Device and OS version: e.g., Oculus Quest v29
[x] PC VR (Link / AirLink)
[ ] Standalone
Checklist:
[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas that are not self-documenting
[ ] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[ ] My changes have no unnecessary logging
[ ] I have added tests that prove my fix is effective or that my feature works, for sufficiently complex features
[ ] New and existing unit tests pass locally with my changes
[ ] Any dependent changes have been merged and published in downstream modules
[ ] Sensitive info like tokens, secrets, and passwords have been removed before submitting
parseccentric
commented
2 years ago
Capture User Interactions & Fixed Desktop/VR mode menu bugs & Instructor Menu Button
Capture user interactions
Added several interaction types to the capture functionality. These interaction types are hide and show menu, settings tab, people tab, interact tab, and create tab. While capture is turned on, these interaction types will be registered accordingly to users' actions.
Type of change
How Has This Been Tested?
Spectator Mode
VR Mode It is advised that at least two people (and at least one person should be in the spectator mode) should participate in the testing for VR mode since the Capture button is only available in the spectator mode.
All information about what numbers are registered for what interaction types can be found in ClientSpawnManager.cs
[Duplicate all of the above for each distinct feature / bug fix / etc.]
Fixed Desktop/VR mode menu bug
Menu bug: When user switches from VR mode to desktop mode, the VR menu from the VR mode will replace the menu being used in desktop mode. We fixed the bug.
Type of change
How Has This Been Tested?
Open a lab with v0.5.7
Enter VR mode
Switch back to Desktop mode
The expected result: the menu in desktop mode should only contain Settings, People, and Interact tabs.
[x] Manual Test
[ ] Unit Test
[ ] Integration / End-to-End Test
[Duplicate all of the above for each distinct feature / bug fix / etc.]
Instructor Menu Button
To close the instructor menu in previous version, user needs to click the Back button from the instructor menu. We find this unnecessary. To enhance the user experience, we decided to make the Instructor Menu Button to have both Turn On and Turn Off functionalities.
Type of change
How Has This Been Tested?
Open a lab with v0.5.7
Enter Desktop mode
Press Settings -> Instructor Menu button
The Instructor Menu should now show up.
Press the Instructor Menu button again.
The Instructor Menu should be disabled.
[x] Manual Test
[ ] Unit Test
[ ] Integration / End-to-End Test
[Duplicate all of the above for each distinct feature / bug fix / etc.]
Test Configuration
Checklist:
Modified from this article: Phillip Johnston, “A GitHub Pull Request Template for Your Projects - Embedded Artistry,” Embedded Artistry, Aug. 04, 2017. https://embeddedartistry.com/blog/2017/08/04/a-github-pull-request-template-for-your-projects/ (accessed Jul. 22, 2021).