Updated Demo Experience

Add demo experience v1.17.5 binary to release assets and updated doc accordingly
Logitech · Apr 30, 2020 · 306de96 · 306de96
1 parent c5d9911
commit 306de96
Show file tree

Hide file tree

Showing 32 changed files with 63 additions and 35 deletions.
diff --git a/Documentation/DemoExperience/Readme.md b/Documentation/DemoExperience/Readme.md
@@ -1,73 +1,100 @@
-# Sample Demo App: Logitech VR Ink Experience
+# Demo App: experience the Logitech VR Ink
 
-This application is meant as the first contact experience when using the Logitech VR Ink. It showcases several interactions that are unique to the stylus. It is a very good way to experiment and get familiar with the VR Ink experience.
+This application is meant as the first contact experience when using the Logitech VR Ink. It showcases several **interactions that are unique to the stylus**. It is a very good way to experiment and get familiar with the VR Ink experience.
 
 ## Install
 
 1. Download the [latest version of the Logitech Demo Experience](https://github.com/Logitech/vr_ink_sdk/releases).
 2. Unzip it on your drive.
 3. Make sure SteamVR is running and VR Ink (and a controller) are paired and connected.
-4. Run the LogitechDemoExperience.exe.
+4. Run the `Logitech_Demo_Experience.exe`.
 
-## Try it
+## Try it out
 
-For a full experience you will need to have a **desk with a flat area of 60x80cm (A1)** that is free of any objects and offers good gliding conditions (textured surfaces will impact the tracking performance).
+For a optimum experience you will need to have a **desk with a flat area of 60x80cm (A1)** that is free of any objects and offers good gliding conditions (textured surfaces will affect the tracking performance).
 Once you have that space, you'll need to calibrate it. Calibration will be stored so you don't have to do it again next time, though you can still run it again if needed.
 
-### Navigating the demo
+## Calibrating the Space
 
-You can use the Navigation menu by selecting it with VR Ink on the desk menu:
+On the **Experiences Menu** select <img src="./../Images/DemoExperience/ALIGN.png" width="50" alt="Align"> to go into calibration mode. Then **press the VR Ink primary button** while holding the VR Ink tip in each of the 3 points of your desired space. This will align the virtual canvas with real 2D surface in front of you.
 
-![Navigation Menu](./../Images/DemoExperience/NavigationMenu.png)
+![calibrating the surface](./../Images/DemoExperience/CalibrateSurface.gif)
 
-The app will offer three different scenarios that can be accessed by using the Navigation menu, select:
+## Try out different Experiences
+You can select the Experience menu by clicking the appropriate icon with VR Ink on the left side of your drawing surface.
 
-- ![Drawing Scene](./../Images/DemoExperience/DrawingScene.png) to access the Drawing experience
+![Navigation Menu](./../Images/DemoExperience/experiences_menu_point.png)
+
+
+
+The app will offer three different scenarios that can be accessed by using the Experiences menu, select:
+
+![Navigation Menu](./../Images/DemoExperience/experience_menu.png)
+
+- <img src="./../Images/DemoExperience/DRAW.png" width="50" alt="Align"> to access the Drawing experience
+
+- <img src="./../Images/DemoExperience/NOTES.png" width="50" alt="Align"> to access the Markup experience
+
+- <img src="./../Images/DemoExperience/SCULPT.png" width="50" alt="Align"> to access the Sculpting experience
+
+<br>
+
+
+
+## Writing & Drawing Experience
+
+Once the surface is calibrated, you can write in 2D by simply touching the tip of the stylus on the physical surface, or you can draw in the air by pressing the Primary Button with your finger. The harder you press the thicker the line will be.
+The Brush Size Slider on the surface will change the maximum thickness of the line. You can also click on the Touchpad and adjust the brush size.
+
+Be sure to check out the two different modes:
+|Mode|Description|
+|---|---|
+| <img src="./../Images/DemoExperience/drawing_option_writing.png" width="50" alt="Windows Logo"><br>**Writing mode** | This mode is optimized for handwriting: with finer line, less impact of force and optimized refresh rate. |
+|<img src="./../Images/DemoExperience/drawing_option_drawing.png" width="50" alt="Steam Logo"><br>**Drawing mode** | In this mode the user has more control over the width of the line by either applying more pressure on the surface or with the finger in air.  |
 
-- ![Markup Scene](./../Images/DemoExperience/MarkupScene.png) to access the Markup experience
 
-- ![Sculpting Scene](./../Images/DemoExperience/SculptingScene.png) to access the Sculpting experience
 
-### Calibrating the Space
 
-![calibrating the surface](./../Images/DemoExperience/CalibrateSurface.gif)
 
-On the Navigation Menu select ![Calibrate world](./../Images/DemoExperience/CalibrateWorld.png) to go into calibration mode. Then click the VR Ink touchstrip while holding the VR Ink tip in each of the 3 corners of your desired space. This will align the virtual canvas with real 2D surface in front of you.
 
-### Drawing Experience
+![Writing-Drawing Experience](./../Images/DemoExperience/drawing_example.png)
 
-![Drawing Experience](./../Images/DemoExperience/DrawingExperience.gif)
+## Markup Experience
 
-Once the surface is calibrated, you can draw in 2D by pressing the tip of the stylus on the physical surface, or you can draw in the air by pressing the Primary Button. The harder you press the thicker the line will be.
-The Brush Size Slider on the surface will change the maximum thickness of the line. You can also swipe up/down on the Touchpad to adjust the brush size.
 
-### Markup Experience
+In this experience your will be able to experience a markup & review situation, typically when you need to review some assets that your team has created. To do so you can:
+- **Annotate 3D models** by either directly drawing in 3D space.
+- But also by creating **virtual post-its** an write on them. Simply start by writing on the one that is already on the table or grab it around.
+- You can also use the Non-Dominand Hand controller for a **handheld menu** and start writing post-it and position them in space.
+- Additionally you can use both controller's grab buttons to **scale and move the models**, and if those a close enough you can grab them with just the stylus.
 
-![Drawing Experience](./../Images/DemoExperience/AnnotationExperience.gif)
 
-In addition to being able to draw in the air and on the 2D surface, you can also draw on the 3D Model in this demo. The house can be dragged around by pressing the grip button on the stylus, and scaled and rotated by pressing the grip on the Vive controller as well.
+![Drawing Experience](./../Images/DemoExperience/markup_scene_2.png)
 
-You can create callouts by selecting the callout button on the surface UI and then by pressing on the Primary Button on VR Ink twice.
+## Sculpting Experience
 
-### Sculpting Experience
+In this demo, you can model the head model by **adding, subtracting or blending "virtual material"**: Simply point with your stylus to the head and press with your index on the primary button. The harder you press, the bigger the effect on the mesh. You can also use the Grip Buttons on VR Ink to rotate the head.
 
-![Drawing Experience](./../Images/DemoExperience/SculptingExperience.gif)
+![Drawing Experience](./../Images/DemoExperience/sculpt_scene.png)
 
-In this demo, you can move the vertices of the head model around using the Primary Button on the stylus. There are 3 modes available: adding, subtracting and blending. The harder you press, the bigger the effect on the mesh. You can also use the Grip Buttons on VR Ink to rotate the head.
+## Cool Tips 
 
 ### Marker Menu
 
-The desk menu is great for a desk experience, but to access these menu options while standing you can use the Marker menu. Press and hold the Touchstrip to make the Marker menu appear in front of VR Ink. Select the option you want by pointing towards an icon and releasing the Touchstrip.
+The desk menu is great for a desk experience, but to access some options **even faster** you can use the Marker menu: 
+- Press and hold the **Touchstrip button** to make the Marker menu appear in front of VR Ink. 
+- Select the option you want by **moving the pen** (left and right).
+- **Confirm by releasing** the Touchstrip.
 
-![MarkerMenu](./../Images/DemoExperience/MarkerMenu.png)
+![MarkerMenu](./../Images/DemoExperience/marker_menu.png)
 
-## Shortcuts
+### Shortcuts
 
 In addition to the Navigation menu, you can also use some keyboard shortcuts:
 
 | Shortcut /Keyboard key           | Effect                                                                                                                                | NOTES                                             |
 |----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
-| Shift + o                        | The environment will change to a calibration mode. Use the Analog Tip to point at the corners of the plinth and click the Touchstrip. |                                                   |
+| Shift + o                        | The environment will change to the calibration mode. Use the Analog Tip to point at the corners of the plinth and then press the primary button. |                                                   |
 | 1                                | Switch to Drawing Experience.                                                                                                         |                                                   |
 | 2                                | Switch to Markup Experience.                                                                                                          |                                                   |
 | 3                                | Switch to Sculpting Experience.                                                                                                       |                                                   |

diff --git a/Documentation/Images/DemoExperience/ALIGN.png b/Documentation/Images/DemoExperience/ALIGN.png
diff --git a/Documentation/Images/DemoExperience/CLOSE.png b/Documentation/Images/DemoExperience/CLOSE.png
diff --git a/Documentation/Images/DemoExperience/DRAW.png b/Documentation/Images/DemoExperience/DRAW.png
diff --git a/Documentation/Images/DemoExperience/NOTES.png b/Documentation/Images/DemoExperience/NOTES.png
diff --git a/Documentation/Images/DemoExperience/QUESTION.png b/Documentation/Images/DemoExperience/QUESTION.png
diff --git a/Documentation/Images/DemoExperience/RETURN.png b/Documentation/Images/DemoExperience/RETURN.png
diff --git a/Documentation/Images/DemoExperience/SCULPT.png b/Documentation/Images/DemoExperience/SCULPT.png
diff --git a/Documentation/Images/DemoExperience/TOOLS.png b/Documentation/Images/DemoExperience/TOOLS.png
diff --git a/Documentation/Images/DemoExperience/WRITING.png b/Documentation/Images/DemoExperience/WRITING.png
diff --git a/Documentation/Images/DemoExperience/draw_menu_2.png b/Documentation/Images/DemoExperience/draw_menu_2.png
diff --git a/Documentation/Images/DemoExperience/drawing_elo.png b/Documentation/Images/DemoExperience/drawing_elo.png
diff --git a/Documentation/Images/DemoExperience/drawing_example.png b/Documentation/Images/DemoExperience/drawing_example.png
diff --git a/Documentation/Images/DemoExperience/drawing_menu.png b/Documentation/Images/DemoExperience/drawing_menu.png
diff --git a/Documentation/Images/DemoExperience/drawing_option_drawing.png b/Documentation/Images/DemoExperience/drawing_option_drawing.png
diff --git a/Documentation/Images/DemoExperience/drawing_option_writing.png b/Documentation/Images/DemoExperience/drawing_option_writing.png
diff --git a/Documentation/Images/DemoExperience/drawing_options.png b/Documentation/Images/DemoExperience/drawing_options.png
diff --git a/Documentation/Images/DemoExperience/drawing_scene.png b/Documentation/Images/DemoExperience/drawing_scene.png
diff --git a/Documentation/Images/DemoExperience/experience_menu.png b/Documentation/Images/DemoExperience/experience_menu.png
diff --git a/Documentation/Images/DemoExperience/experience_menu_2.png b/Documentation/Images/DemoExperience/experience_menu_2.png
diff --git a/Documentation/Images/DemoExperience/experience_menu_UI.png b/Documentation/Images/DemoExperience/experience_menu_UI.png
diff --git a/Documentation/Images/DemoExperience/experiences_menu_point.png b/Documentation/Images/DemoExperience/experiences_menu_point.png
diff --git a/Documentation/Images/DemoExperience/marker_menu.png b/Documentation/Images/DemoExperience/marker_menu.png
diff --git a/Documentation/Images/DemoExperience/marker_menu_bis.png b/Documentation/Images/DemoExperience/marker_menu_bis.png
diff --git a/Documentation/Images/DemoExperience/markup_scene.png b/Documentation/Images/DemoExperience/markup_scene.png
diff --git a/Documentation/Images/DemoExperience/markup_scene_2.png b/Documentation/Images/DemoExperience/markup_scene_2.png
diff --git a/Documentation/Images/DemoExperience/onboard_1.png b/Documentation/Images/DemoExperience/onboard_1.png
diff --git a/Documentation/Images/DemoExperience/onboard_2.png b/Documentation/Images/DemoExperience/onboard_2.png
diff --git a/Documentation/Images/DemoExperience/onboard_3.png b/Documentation/Images/DemoExperience/onboard_3.png
diff --git a/Documentation/Images/DemoExperience/sculpt_menu.png b/Documentation/Images/DemoExperience/sculpt_menu.png
diff --git a/Documentation/Images/DemoExperience/sculpt_scene.png b/Documentation/Images/DemoExperience/sculpt_scene.png
diff --git a/README.md b/README.md
@@ -10,12 +10,13 @@ Here you will find:
 - How to integrate with Unity, Unreal, or your own platform.
 - Recommended design guidelines for VR Ink.
 - A set of example interaction blocks.
+- A [FAQ](https://logitech.github.io/inksupport/) section.
 
 ## Required Software
 
 | <img src="./Documentation/Images/Logos/WinLogo.png" width="50" alt="Windows Logo"><br>**Windows 10** | <img src="./Documentation/Images/Logos/SteamLogo.png" width="50" alt="Steam Logo"><br>**SteamVR 1.4.18** | <img src="./Documentation/Images/Logos/UnityLogo.png" width="50" alt="Unity Logo"><br>**Unity 2017 LTS** | <img src="./Documentation/Images/Logos/UELogo.png" width="50" alt="Unreal Logo"><br>**Unreal 4.19** |
 | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------- |
-| You are developing your VR app in Microsoft Windows 10 64-bit.                                       | This is the minimum required version of SteamVR that fully supports VR Ink.                              | You can use Unity to work with VR Ink. This is the Unity version used by the SDK.                        | You can use Unreal Engine to work with VR Ink. This is the Unreal Engine version used by the SDK.   |
+| You are developing your VR app in Microsoft Windows 10 64-bit.                                       | This is the minimum required version of SteamVR that supports VR Ink.                              | You can use Unity to work with VR Ink. This is the Unity version used by the SDK.                        | You can use Unreal Engine to work with VR Ink. This is the Unreal Engine version used by the SDK.   |
 
 ## SDK Content
 
@@ -32,11 +33,11 @@ Here you will find:
 
 A demo is worth a thousand words! We recommend that you try out the [demo experience](./Documentation/DemoExperience/Readme.md) that we have crafted to showcase some interesting and unique use cases with VR Ink. You will be able to experience three different scenarios:
 
-- Free drawing on a surface, and in 3D, with pressure control.
-- Review and annotate an architectural plan.
-- Sculpt a 3D head in VR.
+- Free writing on a surface and drawing in 3D with pressure control.
+- Markup & Review a model in 3D.
+- Manipulate & Sculpt a 3D head in VR.
 
-[<img src="./Documentation/Images/LandingPage/DemoBanner.gif" width="2000" alt="Logitech VR Ink Demo Experience">](./Documentation/DemoExperience/Readme.md)
+[<img src="./Documentation/Images/DemoExperience/markup_scene_2.png" width="2000" alt="Logitech VR Ink Demo Experience">](./Documentation/DemoExperience/Readme.md)
 
 ## Get in Touch