Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
arvr [2025/02/10 07:20] – created Ronell Sicatarvr [2026/04/29 06:47] (current) – Ronell Sicat
Line 1: Line 1:
 ====== AR/VR Tools User Guides ====== ====== AR/VR Tools User Guides ======
  
-The KAUST Visualization Core Lab (KVL) provides augmented reality (AR) and virtual reality (VR) hardware, software, and technical support. KVL provides a wide variety of AR/VR devices as well as high-end Windows workstations for AR/VR development. KVL also provides access and support for AR/VR software such as Avizo, Unity, GetReal3D, and SimLab Composer. In some cases, KVL also provides development support and collaboration for special projects. [[help@vis.kaust.edu.sa|Contact us]] or [[https://www.youtube.com/watch?v=eggkRxc9TG8|watch this presentation]] to learn more.+The KAUST Visualization Core Lab (KVL) provides augmented reality (AR) and virtual reality (VR) hardware, software, and technical support. KVL provides a wide variety of AR/VR devices as well as high-end Windows workstations for AR/VR development. KVL also provides access and support for AR/VR software such as Avizo, Unity, GetReal3D, and our own KVL Viewer and KVL Digital Twin Platform. In some cases, KVL also provides development support and collaboration for special projects. [[help@vis.kaust.edu.sa|Contact us]] or [[https://www.youtube.com/live/GnoC5jvVTQM|watch this presentation]] to learn more.
  
 ===== AR/VR Hardware ===== ===== AR/VR Hardware =====
  
-Users who wish to quickly access an AR/VR workstation can book our [[facility_user_guides#Vive|Vive facility]]. [[help@vis.kaust.edu.sa|Contact us]] to request access to other AR/VR hardware below (we also have legacy hardware available, e.g., HTC Vive, Meta 2, Magic Leap One, Oculus Rift).+Users who wish to quickly access an AR/VR workstation and/or device can book our [[facility_user_guides#Vive|Vive facility]]. [[help@vis.kaust.edu.sa|Contact us]] to request access to other AR/VR hardware below (we also have legacy hardware available, e.g., HTC Vive, Meta 2, Magic Leap One, Oculus Rift).
  
-  * [[https://www.microsoft.com/en-us/hololens/hardware|HoloLens 2]] (2X) +  * [[https://www.vive.com/us/product/vive-pro2/overview/|HTC Vive Pro 2]] (3X)
-  * [[https://www.vive.com/us/product/vive-pro2/overview/|HTC Vive Pro 2]] (2X)+
   * [[https://www.vive.com/eu/product/vive-pro/|HTC Vive Pro]] (1X)   * [[https://www.vive.com/eu/product/vive-pro/|HTC Vive Pro]] (1X)
   * [[https://www.vive.com/us/product/vive-focus3/overview/|HTC Vive Focus 3]] (2X)   * [[https://www.vive.com/us/product/vive-focus3/overview/|HTC Vive Focus 3]] (2X)
   * [[https://www.meta.com/quest/products/quest-2/|Meta/Oculus Quest 2]] (2X)   * [[https://www.meta.com/quest/products/quest-2/|Meta/Oculus Quest 2]] (2X)
 +  * [[https://www.meta.com/quest/quest-3/|Meta/Oculus Quest 3]] (2X)
   * [[https://www.meta.com/quest/quest-pro/|Meta/Oculus Quest Pro]] (2X)   * [[https://www.meta.com/quest/quest-pro/|Meta/Oculus Quest Pro]] (2X)
 +  * [[https://www.apple.com/apple-vision-pro/|Apple Vision Pro]] (2X)
 +  * [[https://www.microsoft.com/en-us/hololens/hardware|HoloLens 2]] (2X)
  
 ===== AR/VR Software ===== ===== AR/VR Software =====
Line 20: Line 22:
 ==== Avizo ==== ==== Avizo ====
  
-The easiest way to bring your data to VR is by using [[vistools#Avizo|Avizo]]. If you can load your data in Avizo, then you can visualize and interact with your data in VR by following a few steps without the need for any programming. A big advantage of this approach is that it works out of the box in three different KVL facilities that users can book: 1) [[facility_user_guides#Vive|Vive]] head mounted display, 2) [[facility_user_guides#Zone 5|Zone 5]] immersive display, and 3) [[facility_user_guides#CUBES|CUBES]] immersive display. Zone 5 and CUBES are great for giving impressive demonstrations/presentations that can wow your audience with a unique stereo 3D visualization experience. Another advantage is that you can also use Avizo as a powerful tool for processing your data, and it works on your laptop/desktop as well. +The easiest way to bring your data to VR is by using [[vistools#Avizo|Avizo]]. If you can load your data in Avizo, then you can visualize and interact with your data in VR by following a few steps without the need for any programming. A big advantage of this approach is that it works out of the box in two KVL facilities that users can book: 1) [[facility_user_guides#Vive|Vive]] head mounted display, and 2) [[facility_user_guides#CUBES|CUBES]] immersive display. CUBES is great for giving impressive demonstrations/presentations that can wow your audience with a unique stereo 3D visualization experience. Another advantage is that you can also use Avizo as a powerful tool for processing your data, and it works on your laptop/desktop as well. 
  
 ==== Unity ==== ==== Unity ====
  
-Users can also develop their own AR/VR application using the [[https://unity.com/|Unity]] game engine. KVL can provide Educational Unity licenses upon [[help@vis.kaust.edu.sa|request]]. If your dataset is or can be converted to a mesh format, e.g., FBX, OBJ, DAE, then it is relatively easy to bring your data into an AR/VR application in Unity. If your dataset is tabular, e.g., csv, then you can use the [[https://sites.google.com/view/dxr-vis|DXR toolkit]] to create glyph-based plots. We recommend using Unity's AR or VR project templates as starting points for development since they are typically pre-configured to work with most hardware via OpenXR. This [[highlights:2023:shushahvr|Coral Reef Restoration Planning and Visualization]] application is an example of a Unity-based VR application developed by KVL with KAUST collaborators.+Users can also develop their own AR/VR application using the [[https://unity.com/|Unity]] game engine. KVL can provide Educational Unity licenses upon [[help@vis.kaust.edu.sa|request]]. If your dataset is or can be converted to a mesh format, e.g., FBX, OBJ, DAE, then it is relatively easy to bring your data into an AR/VR application in Unity. For other data types, reach out to us to discuss if we can convert your data to something that can be used in AR/VR. We recommend using Unity's AR or VR project templates as starting points for development since they are typically pre-configured to work with most hardware via OpenXR. This [[highlights:2023:shushahvr|Coral Reef Restoration Planning and Visualization]] application is an example of a Unity-based VR application developed by KVL with KAUST collaborators. 
 ==== GetReal3D for Unity ==== ==== GetReal3D for Unity ====
  
-[[https://www.mechdyne.com/software-services/getreal3d-for-unity/|GetReal3D]] can be used to bring a Unity application into our immersive displays: [[facility_user_guides#Zone 5|Zone 5]] and [[facility_user_guides#CUBES|CUBES]]. This can be done by using the GetReal3D for Unity plugin which can be [[help@vis.kaust.edu.sa|requested from KVL]]. Install it into your Unity project using the following steps:+[[https://www.mechdyne.com/software-services/getreal3d-for-unity/|GetReal3D]] can be used to bring a Unity application into our immersive CAVE environment: [[facility_user_guides#CUBES|CUBES]]. This can be done by using the GetReal3D for Unity plugin which can be [[help@vis.kaust.edu.sa|requested from KVL]]. Install it into your Unity project using the following steps:
   - Select "Assets" -> "Import Package" -> "Custom Package" from the main menu.   - Select "Assets" -> "Import Package" -> "Custom Package" from the main menu.
   - Navigate to and select the GetReal3D Unity package file.   - Navigate to and select the GetReal3D Unity package file.
Line 61: Line 64:
   * Unity 2022.3.4f1   * Unity 2022.3.4f1
  
-<!--- +===== Example Projects =====
-==== SimLab Composer ==== +
- +
-[[https://www.simlab-soft.com/3d-products/simlab-composer-main.aspx|SimLab Composer]] can be used to build and share VR applications without the need for programming. SimLab Composer is great for quickly developing VR applications geared towards tours/navigation/exploration of a 3D environment, e.g., 3D architectural models, or inspecting 3D models, e.g., product prototypes, in real-world scale/size. It can also be used to build step-by-step VR training modules. We currently have limited machine-locked licenses for this software. Please [[help@vis.kaust.edu.sa|reach out to us to request access]]. +
- +
----> +
- +
-{{tag>kvl ar vr unity simlab avizo techviz getreal3d}} +
- +
-<!--- +
- +
-===== Vive VR Development Guide ===== +
-The Kaust Visualization Core Laboratory now provides its users with access to the HTC Vive HMD VR system.  The system consists of a head-mounted display (HMD), two handheld controllers, a tracking system, and a high-end PC.  Users will need to be familiar with this hardware as well as with the required software elements, which consist of Steam, SteamVR, and the Unity game development environment. +
- +
-The general workflow is that a new user will first apply for and obtain access to the facility.  The user may then develop in Unity (free software) either on their own machine or directly on one of the KVL Vive systems.  This development process is detailed below.  The user may now experience their work in fully immersive VR via the HTC Vive system and Unity. +
- +
-KVL offers training in Unity development for VR.  Please keep an eye out for upcoming opportunities to join a class. +
- +
-=== Getting Started === +
- +
-Firstly, users will require **access** to the facilities where the VIVEs are available.  Please book access to the VIVE systems @ [[booking|Booking KVL Facilities]]. +
- +
-All users will require their KAUST **credentials** to log into the VIVE systems. +
- +
-Users require a **free Unity account**.  Go to https://unity3d.com to register.  Note also that you may download Unity for free on your own machine but if you plan to develop for the KVL systems, be sure to obtain the same Unity version as is currently installed on the KVL Vive system. +
- +
-Users also must sign up for a **free Steam account**.  Go to https://store.steampowered.com/join/ to register. +
- +
-Now, **log into the KVL Vive system** using your active directory credentials. +
- +
-**Launch Steam** and enter your **Steam credentials**: +
- +
-{{:wiki:documentation:vr:steamlogin.png?nolink&500|}} +
- +
-**Launch Steam VR** by clicking on the VR icon in the upper right-hand corner of the Steam window. +
- +
-{{:wiki:documentation:vr:steamvricon.png?nolink&500|}} +
-  +
-**Confirm the Vive is ready for use** by looking at the SteamVR window(s) at the bottom of the windows desktop: +
- +
-{{:wiki:documentation:vr:steamvrstatus.png?nolink&500|}} +
- +
-A green “Ready” indicates that the Vive is connected and ready for use.  A red “Not Ready” indicates a problem with the system.  Depending on the problem, more information may be displayed in a second window just about the main SteamVR window, as above with the “Missing files” message.   +
- +
-In the event of a technical problem, you may follow the troubleshooting feature.  If the problem persists, please contact visualization lab staff for assistance. +
- +
-**Launch Unity**  +
- +
-Prepare your Unity scene to work with VR and the HTC Vive (these details are beyond the scope of this training document) +
- +
-For reference, you may open the KVL Vive Demo scene, which contains all of the basic elements required for Vive display through Unity. +
- +
-=== Resources for HTC Vive Developers (Unity) === +
- +
-Unity Main Site: http://unity3d.com +
-Unity Community Answers: http://answers.unity3d.com/ +
-SteamVR: http://store.steampowered.com/steamvr +
- +
-=== Important Reminders for Users: === +
- +
-Please remember to **CHARGE THE VIVE REMOTES** by plugging them in when you finish your work. +
- +
-Always LOG OUT when finished. +
- +
-=== Development Notes ===+
  
-If you use git-based version control for your project, the following is a useful git-ignore setting to use: https://github.com/github/gitignore/blob/main/Unity.gitignore.+Below are example AR/VR projects that we developed in the past:
  
---->+  * [[highlights:2023:cpvvr|Coral Probiotics Village in VR]] 
 +  * [[highlights:2023:shushahvr|Coral Reef Restoration Planning and Visualization]] 
 +  * [[highlights:2024:climatemodel|KVL Develops Holographic App for KAUST Winners of 2024 Gordon Bell Prize for Climate Modelling]] 
 +  * [[highlights:2024:kvlanpercart|KVL Co-organizes Science as Art Exhibit with ANPERC]]