Merge pull request #1 from Uralstech/unstable

UXR.Utilities v1.1.0: Added docs and more asset menu extensions.

Documentation/DocSource/QuickStart.md

@@ -4,4 +4,76 @@ Please note that the code provided in this page is *purely* for learning purpose
 
 ## Breaking Changes Notice
 
-If you've just updated the package, it is recommended to check the [*changelogs*](https://github.com/Uralstech/UXR.Utilities/releases) for information on breaking changes.
+If you've just updated the package, it is recommended to check the [*changelogs*](https://github.com/Uralstech/UXR.Utilities/releases) for
+information on breaking changes.
+
+## Notice
+
+In this page, the fields, properties and methods of each type will not be explained. Every type has been fully documented in code, so please
+check the code docstrings or [reference documentation](~/api/Uralstech.UXR.Utilities.yml) to learn more about each type.
+
+## XRKeyboardManager
+
+### Setup
+
+[`XRKeyboardManager`](~/api/Uralstech.UXR.Utilities.XRKeyboardManager.yml) is a singleton
+script to help manage the [*Meta Quest Virtual Keyboard*](https://developers.meta.com/horizon/documentation/unity/VK-unity-overview/).
+
+First, follow the [*getting started guide*](https://developers.meta.com/horizon/documentation/unity/VK-unity-gettingstarted)
+to setup the Virtual Keyboard. Then, add an instance of `XRKeyboardManager` to your scene (Hierarchy -> right click ->
+XR -> XR Keyboard Manager) and fill the required fields. For more information, check the
+[reference documentation for `XRKeyboardManager`.](~/api/Uralstech.UXR.Utilities.XRKeyboardManager.yml)
+
+### Usage
+
+To register a listener to the keyboard, call [`SetListener(OVRVirtualKeyboard.ITextHandler listener)`](~/api/Uralstech.UXR.Utilities.XRKeyboardManager.yml#Uralstech_UXR_Utilities_XRKeyboardManager_SetListener_OVRVirtualKeyboard_ITextHandler_)
+with a reference to the `ITextHandler` listener. This will also cause the keyboard to appear.
+
+To hide the keyboard, call [`RemoveListener(OVRVirtualKeyboard.ITextHandler listener)`](~/api/Uralstech.UXR.Utilities.XRKeyboardManager.yml#Uralstech_UXR_Utilities_XRKeyboardManager_RemoveListener_OVRVirtualKeyboard_ITextHandler_)
+with a reference to the current listener. Ideally this should only be called by the listener itself.
+
+`XRKeyboardManager` also contains some `UnityEvent` callbacks for when the keyboard is toggled. This can be, for example, used to toggle
+the visibility of controller visuals when the keyboard is toggled.
+
+## Input Field
+
+[`TextInputField`](~/api/Uralstech.UXR.Utilities.TextInputField.yml) is a TextMeshPro-based input field that works with `XRKeyboardManager`.
+
+### Usage
+
+Add an instance of the input field to a canvas [*configured to work with Interaction SDK*](https://developers.meta.com/horizon/documentation/unity/unity-isdk-ray-examples-scene/)
+by right-clicking on the hierarchy -> UI -> "XR Input Field".
+
+You can get the content from the input field by either registering a callback to
+the `OnFieldSelected` `UnityEvent` or by directly accessing the `Text` property.
+
+### Voice Input
+
+By adding the [`TextInputFieldVoiceHandler`](~/api/Uralstech.UXR.Utilities.TextInputFieldVoiceHandler.yml) component to a `TextInputField`, you can
+have voice input for the field, toggled by a button. There is a readymade prefab with the voice input setup which can be created by
+right-clicking on the hierarchy -> UI -> "XR Input Field with Voice Input".
+
+Make sure to setup [*Meta's Voice SDK*](https://developers.meta.com/horizon/documentation/unity/voice-sdk-integrate-voice/) and add a dictation
+service to the scene with the input field. The language used in the dictation service is used by the voice handler. Make sure the font you use
+supports the voice input language!
+
+## Camera Follower
+
+[`SimpleCameraFollower`](~/api/Uralstech.UXR.Utilities.SimpleCameraFollower.yml) is a script
+that makes the attached `GameObject` follow the player's camera with:
+- Optional Y and Z positional offsets
+- Configurable movement and rotation delays and
+- Variable movement and rotation speeds
+
+This script does not require much more configuration and can be used as-is, without additional setup.
+
+## Movement Controller
+
+[`SimpleMovementController`](~/api/Uralstech.UXR.Utilities.SimpleMovementController.yml) is a
+script that uses `OVRInput` and `RigidBody` physics to provide continuous movement and snap
+rotation for the player. Since it is a singleton, more than one instance of the script is not
+expected in a given scene.
+
+The movement speed and rotation snap angle can be configured through fields of the same name.
+You can toggle movement completely through the `MovementEnabled` field. In fact, it is used
+by `XRKeyboardManager` to automatically stop movement when the keyboard is active.

UXR.Utilities/Packages/com.uralstech.uxr.utilities/Editor/Scripts/AssetMenuExtensions.cs

@@ -26,6 +26,25 @@ private static void CreateXRInputFieldWithVoice()
                 Debug.LogError($"Could not find prefab for XR Input Field with Voice at path: {prefabPath}. Verify the path and ensure it exists in the package.");
         }
 
+        [MenuItem("GameObject/XR/XR Keyboard Manager", false, 10)]
+        private static void CreateXRKeyboardManager()
+        {
+            // 1. Create a new empty game object.
+            GameObject keyboardManager = new(nameof(XRKeyboardManager));
+
+            // 2. Add the XRKeyboardManager Component to the new Gameobject.
+            keyboardManager.AddComponent<XRKeyboardManager>();
+
+            // 3. Place it in the scene
+            keyboardManager.transform.SetParent(Selection.activeTransform, false);
+
+            // 4. Handle Undo
+            Undo.RegisterCreatedObjectUndo(keyboardManager, $"Create {nameof(XRKeyboardManager)}");
+
+            // 5. Select the created game object.
+            Selection.activeGameObject = keyboardManager;
+        }
+
         private static bool InstantiatePrefab(string relativePrefabPath, out string prefabPath, bool overridePackagePathCache = false)
         {
             prefabPath = string.Empty;

UXR.Utilities/Packages/com.uralstech.uxr.utilities/Editor/UXR.Utilities.Editor.asmdef

@@ -2,7 +2,8 @@
     "name": "UXR.Utilities.Editor",
     "rootNamespace": "",
     "references": [
-        "GUID:e5eb8fa34b6686645a9a31dab0670e46"
+        "GUID:e5eb8fa34b6686645a9a31dab0670e46",
+        "GUID:2281fe9ed9abb88469162fc481fcc7a1"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],

UXR.Utilities/Packages/com.uralstech.uxr.utilities/Runtime/Scripts/Managers/XRKeyboardManager.cs

@@ -72,6 +72,7 @@ public class XRKeyboardManager : Singleton<XRKeyboardManager>
         /// <summary>
         /// The OVRHand script for left hand input.
         /// </summary>
+        [Header("Hand Input")]
         [Tooltip("The OVRHand script for left hand input.")]
         [FormerlySerializedAs("_leftOVRHand")] public OVRHand LeftOVRHand;
 
@@ -84,6 +85,7 @@ public class XRKeyboardManager : Singleton<XRKeyboardManager>
         /// <summary>
         /// Should the hand tracking material be changed depending on if the keyboard is being used?
         /// </summary>
+        [Header("Hand Material Switching")]
         [Tooltip("Should the hand tracking material be changed depending on if the keyboard is being used?")]
         [FormerlySerializedAs("_useDifferentMaterialsForHandsWhenTyping")] public bool UseDifferentMaterialsForHandsWhenTyping;
 

UXR.Utilities/Packages/com.uralstech.uxr.utilities/package.json

@@ -3,7 +3,7 @@
   "displayName": "UXR.Utilities",
   "description": "Random helper scripts I made for Meta Quest XR projects.",
   "keywords": [],
-  "version": "1.0.0",
+  "version": "1.1.0",
   "unity": "6000.0",
   "hideInEditor": false,
   "documentationUrl": "https://uralstech.github.io/UXR.Utilities/",