Merge pull request #3 from realitycollective/feature/interaction-docs

Add docs for interactions

docs/01-Camera/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Camera",
+  "link": {
+    "type": "generated-index",
+    "description": "Get started using the Reality Toolkit camera package."
+  }
+}

docs/basics/services.md → docs/01-Camera/camera-boundary-module.md

@@ -2,6 +2,6 @@
 sidebar_position: 2
 ---
 
-# Services
+# Camera Boundary Module
 
 TODO

docs/basics/profiles.md → docs/01-Camera/camera-rig-types.md

@@ -2,6 +2,6 @@
 sidebar_position: 1
 ---
 
-# Profiles
+# Camera Rig Types
 
 TODO

docs/01-Camera/camera-service.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 0
+---
+
+# Camera Service
+
+TODO

docs/02-Interactions/01-interactors/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Interactors",
+  "link": {
+    "type": "generated-index",
+    "description": "Learn more about Interactors in the Reality Toolkit interaction framework."
+  }
+}

docs/02-Interactions/01-interactors/add-interactor.md

@@ -0,0 +1,10 @@
+---
+sidebar_position: 2
+---
+
+# How To Add Or Remove An Interactor?
+
+`Interactor`s are added to a controller via the `ControllerProfile`. Select a profile and in the inspector at the bottom you'll find a list of configured Interactors.
+Add or remove Interactors as you need, e.g. to make certain Interactors only available on target platform A and not on platform B.
+
+![Interactors Configuration](img/interactors-configuration.png)

docs/02-Interactions/01-interactors/available-interactors.md

@@ -0,0 +1,32 @@
+---
+sidebar_position: 1
+---
+
+# Available Default Interactors
+
+The toolkit comes with the following predefined and implemented `Interactor`s.
+
+## Near Interactor
+
+The `NearInteractor` interacts with nearby objects. It does not require touching the object but instead it will
+focus and interact with interactables that are within a configuratble reach from the controller or hand.
+
+## Far Interactor
+
+The `FarInteractor` allows interactions across distance by pointing your controller or hand at objects that are out of reach.
+
+## Poke Interactor
+
+The `PokeInteractor` is used to trigger interactions by poking / touching objects. It is usually located at the index finger tip or another
+convenient location on your controller visualization.
+
+## Teleport Interactor
+
+The `TeleportInteractor` is a special interactor used to teleport from one location to another. It interacts with your app or game
+environment to determine the target position.
+
+:::caution
+
+The `TeleportInteractor` is only available if the `RealityToolkit.Locomotion` module is installed via the Package Manager.
+
+:::

docs/02-Interactions/01-interactors/custom-interactor.md

@@ -0,0 +1,18 @@
+---
+sidebar_position: 3
+---
+
+# How To Write Custom Interactors?
+
+If you must modify the behaviour of a default interactor, you can extend and overrides its implementation by writing your own.
+You can also start from scratch and write custom interactors.
+
+:::caution
+
+Writing custom interactors requires a good understanding of the toolkit's inner workings, specifically of the input service.
+Make sure to get familiar with the implementation before attemping to create your own interactor. We recommend using the default
+interactors. Should you be missing a feature, raise a ticket on the repository and if it is a feature that makes sense for all of
+our users, it will be added to the defaults.
+
+:::
+

docs/02-Interactions/01-interactors/overview.md

@@ -0,0 +1,15 @@
+---
+sidebar_position: 0
+---
+
+# What Are Interactors?
+
+An `Interactor` is a special `GameObject` in your scene that enables specific types of interactions with your interactable objects.
+Usually an Interactor will be attached to the controller in the scene and perform interactions as input on those controllers is happening.
+
+:::tip
+
+You don't have to worry about setting up `Interactor`s yourself. The default toolkit configuration will make sure they are added to the scene
+whenever a compatible controller is detected.
+
+:::

docs/02-Interactions/02-interactables/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Interactables",
+  "link": {
+    "type": "generated-index",
+    "description": "Learn more about Interactables in the Reality Toolkit interaction framework."
+  }
+}

docs/02-Interactions/02-interactables/how-to-interactable.md

@@ -0,0 +1,24 @@
+---
+sidebar_position: 1
+---
+
+# How To Make A GameObject Interactable?
+
+To make a `GameObject` interactable add the `Interactable` component to it.
+
+![Interactable Component](img/interactable-component.png)
+
+Make sure the `Collider` and `Rigidbody` on the object is configured as you require it.
+On the `Interactable` component you can configure whether the Interactable allows
+interactions from a distance, direct or both. You can also define `Input Action`s to listen for
+from `Interactor`s to perform select or grab interaction.
+
+:::tip
+
+All components of the interaction framework are documented extensively in code.
+Make sure to take a look to understand the purpose of each setting.
+
+:::
+
+Congratulations! Your object is now interactable but it will not do anything when interacted with unless
+you add `Interaction Behaviour`s to it. Keep on reading to learn about out of the box provided behaviours.

docs/02-Interactions/02-interactables/overview.md

@@ -0,0 +1,8 @@
+---
+sidebar_position: 0
+---
+
+# What Are Interactables?
+
+An `Interactable` is a `GameObject` in your scene that can be interacted with via `Interactor`s. Each Interactable must have
+a `Rigidbody` and a `Collider` attached to it. The default Interactable implementation of the toolkit will enforce this requirement.

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/_category_.json

@@ -0,0 +1,7 @@
+{
+    "label": "Default Behaviours",
+    "link": {
+        "type": "generated-index",
+        "description": "The toolkit comes with an ever growing catalogue of default interaction behaviours. Learn more about each of them on the upcoming pages."
+    }
+}

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/button-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 0
+---
+
+# ButtonBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/change-material-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 2
+---
+
+# ChangeMaterialBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/focus-hand-pose-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 3
+---
+
+# FocusHandPoseBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/focus-lock-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 4
+---
+
+# FocusLockBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/grab-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 5
+---
+
+# GrabBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/grab-hand-pose-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 6
+---
+
+# GrabHandPoseBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/interaction-events-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 7
+---
+
+# InteractionEventsBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/poke-response-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 8
+---
+
+# PokeResponseBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/sync-controller-visualizer-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 9
+---
+
+# SyncControllerVisualizerBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/toggle-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# ToggleBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/translate-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 10
+---
+
+# TranslateBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/update-rigidbody-behaviour.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 11
+---
+
+# UpdateRigidbodyBehaviour
+
+Coming soon...

docs/02-Interactions/03-interaction-behaviours/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Interaction Behaviours",
+  "link": {
+    "type": "generated-index",
+    "description": "Learn more about Interaction Behaviours in the Reality Toolkit interaction framework."
+  }
+}