License + Readme + some fix

marcbal · marcbal · commit d0bd24258184 · 2019-05-03T16:27:20.000+02:00
diff --git a/Assets/RayCursor/Scripts/CursorObject.cs b/Assets/RayCursor/Scripts/CursorObject.cs
@@ -1,6 +1,23 @@
-﻿using RayCursor;
-using System.Collections;
-using System.Collections.Generic;
+﻿/* Copyright 2019 Marc Baloup, Géry Casiez, Thomas Pietrzak
+               (Université de Lille, Inria, France)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. */
 using UnityEngine;
 
 namespace RayCursor
diff --git a/Assets/RayCursor/Scripts/DistanceUtil.cs b/Assets/RayCursor/Scripts/DistanceUtil.cs
@@ -1,4 +1,24 @@
-﻿using System.Collections;
+﻿/* Copyright 2019 Marc Baloup, Géry Casiez, Thomas Pietrzak
+               (Université de Lille, Inria, France)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. */
+using System.Collections;
 using System.Collections.Generic;
 using UnityEngine;
 
diff --git a/Assets/RayCursor/Scripts/RayCursor.cs b/Assets/RayCursor/Scripts/RayCursor.cs
@@ -1,4 +1,23 @@
-﻿using System.Collections;
+﻿/* Copyright 2019 Marc Baloup, Géry Casiez, Thomas Pietrzak
+               (Université de Lille, Inria, France)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. */
 using System.Collections.Generic;
 using UnityEngine;
 
@@ -7,8 +26,7 @@ namespace RayCursor
 {
     public enum Mode
     {
-        Manual,
-        SemiAuto,
+        Manual, SemiAuto
     }
 
     public enum TransferFunction
@@ -107,10 +125,10 @@ void Update()
                 previousClosest = closest;
             }
 
-            if (Input.GetButtonDown("RayCursorSelect") && closest != null)
+            if (GetInputSelect() && closest != null)
             {
                 closest.Select();
-                modes[currentMode].OnSelect();
+                GetCursorMode().OnSelect();
             }
         }
 
@@ -152,6 +170,28 @@ internal CursorTransferFunction GetCursorTransferFunction()
         {
             return transferFunctions[currentTransfertFunction];
         }
+
+
+        /**
+         * <summary>Return true only during the frame the selection button is pressed but was not pressed the frame before (like Input.GetButtonDown()).</summary>
+         */
+        internal bool GetInputSelect()
+        {
+            return Input.GetButtonDown("RayCursorSelect");
+        }
+
+        /**
+         * <summary>Return true during all the frames the touchpad is touched.</summary>
+         */
+        internal bool GetInputTouch()
+        {
+            return Input.GetButton("RayCursorTouch");
+        }
+
+        internal float GetInputTouchY()
+        {
+            return Input.GetAxis("RayCursorTouchY");
+        }
     }
 
     
@@ -330,8 +370,8 @@ public CursorTransferFunction(RayCursor cM)
 
         public void Update()
         {
-            bool currentPadTouch = Input.GetButton("RayCursorTouch");
-            float currentPadY = Input.GetAxis("RayCursorTouchY");
+            bool currentPadTouch = cursorManager.GetInputTouch();
+            float currentPadY = cursorManager.GetInputTouchY();
             float currentTime = Time.time;
             if (!currentPadTouch || !previousPadTouch)
                 ySpeed = 0;
diff --git a/Assets/RayCursor/Scripts/RayObject.cs b/Assets/RayCursor/Scripts/RayObject.cs
@@ -1,6 +1,24 @@
-﻿using OneEuroFilter;
-using System.Collections;
-using System.Collections.Generic;
+﻿/* Copyright 2019 Marc Baloup, Géry Casiez, Thomas Pietrzak
+               (Université de Lille, Inria, France)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. */
+using OneEuroFilter;
 using UnityEngine;
 
 namespace RayCursor
diff --git a/Assets/RayCursor/Scripts/Selectable.cs b/Assets/RayCursor/Scripts/Selectable.cs
@@ -1,4 +1,23 @@
-﻿using System.Collections;
+﻿/* Copyright 2019 Marc Baloup, Géry Casiez, Thomas Pietrzak
+               (Université de Lille, Inria, France)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. */
 using System.Collections.Generic;
 using UnityEngine;
 
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,22 @@
+MIT License
+
+Copyright 2019 Marc Baloup, Géry Casiez, Thomas Pietrzak
+               (Université de Lille, Inria, France)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+# RayCursor: A 3D Pointing Facilitation Technique based on Raycasting
+
+This is a Unity Project containing the source code and prefab for the pointing technique RayCursor
+presented in [this paper](https://dx.doi.org/10.1145/3290605.3300331).
+
+## Usage in your Unity project
+
+1. Copy the folder `Assets/RayCursor` in your assets directory.
+2. In your scene, put the prefab `RayCursor` as a child of the GameObject reprenting a VR controller.
+3. On each GameObject you want to be selectable using RayCursor, add the component `Selectable`.
+   These objects requires a Collider and a MeshRenderer.
+   The highlight of the closest target only works on objects which have exactly one Material in the MeshRenderer.
+   Each `Selectable` instance has an `OnSelect` event that you can listen to via scripting.
+4. Configure the inputs. The configuration depend on the API you use to access the controller inputs. See the next section for more details.
+
+- Minimum version of Unity: `2018.3.0f2`
+- Only one instance of `RayCursor` is possible in a scene.
+
+## Input configuration
+
+### Legacy input system of unity (`Input.getXXX()`)
+
+You have to configure 3 inputs in the configuration screen `Edit -> Project Settings... -> Input`
+
+- `RayCursorSelect`: this input is used to trigger the selection. This is usually mapped to the trigger button of the controller.
+- `RayCursorTouch`: this input is used to detect the presence of the finger on the touchpad.
+- `RayCursorPadY`: this input is used to detect the `y` position of the finger on the touchpad.
+
+You can copy the configuration of the inputs from the configuration of this project for the HTC Vive (Left Controller).
+
+### Others API (Oculus, OpenVR, ...)
+
+You have to change the source code of the 3 methods in `Scripts/RayCursor.cs`:
+
+- `bool RayCursor.GetInputSelect()`
+- `bool RayCursor.GetInputTouch()`
+- `float RayCursor.GetInputTouchY()`
+
+## License
+
+This project is published under the MIT License (see `LICENSE.md`).
