needle-mirror
diff --git a/‎CHANGELOG.md
+68 b/‎CHANGELOG.md
+68
diff --git a/‎Documentation~/TableOfContents.md
+3-1 b/‎Documentation~/TableOfContents.md
+3-1
diff --git a/‎Documentation~/climb-interactable.md
+1 b/‎Documentation~/climb-interactable.md
+1
diff --git a/‎Documentation~/climb-teleport-interactor.md
+27 b/‎Documentation~/climb-teleport-interactor.md
+27
diff --git a/‎Documentation~/components.md
+5 b/‎Documentation~/components.md
+5
diff --git a/‎Documentation~/extending-xri.md
+4-2 b/‎Documentation~/extending-xri.md
+4-2
diff --git a/‎Documentation~/images/affordance-system-information-flow-url.txt
-1 b/‎Documentation~/images/affordance-system-information-flow-url.txt
-1
diff --git a/‎Documentation~/images/class-hierarchy-url.txt
-1 b/‎Documentation~/images/class-hierarchy-url.txt
-1
diff --git a/‎Documentation~/images/class-hierarchy.svg
+1-1 b/‎Documentation~/images/class-hierarchy.svg
+1-1
diff --git a/‎Documentation~/images/climb-interactable.png
9.45 KB b/‎Documentation~/images/climb-interactable.png
9.45 KB
diff --git a/‎Documentation~/images/climb-teleport-interactor.png
51.2 KB b/‎Documentation~/images/climb-teleport-interactor.png
51.2 KB
diff --git a/‎Documentation~/images/interaction-update-url.txt
-1 b/‎Documentation~/images/interaction-update-url.txt
-1
diff --git a/‎Documentation~/images/interaction_example.gif
-800 KB b/‎Documentation~/images/interaction_example.gif
-800 KB
diff --git a/‎Documentation~/images/sample-spatial-keyboard-display.png
82.9 KB b/‎Documentation~/images/sample-spatial-keyboard-display.png
82.9 KB
diff --git a/‎Documentation~/images/sample-spatial-keyboard-key.png
124 KB b/‎Documentation~/images/sample-spatial-keyboard-key.png
124 KB
diff --git a/‎Documentation~/images/sample-spatial-keyboard-keyboard.png
86.3 KB b/‎Documentation~/images/sample-spatial-keyboard-keyboard.png
86.3 KB
diff --git a/‎Documentation~/images/sample-spatial-keyboard-multiple-layouts.png
128 KB b/‎Documentation~/images/sample-spatial-keyboard-multiple-layouts.png
128 KB
diff --git a/‎Documentation~/images/teleportation-multi-anchor-volume.png
80.6 KB b/‎Documentation~/images/teleportation-multi-anchor-volume.png
80.6 KB
diff --git a/‎Documentation~/includes/version.md
+1-1 b/‎Documentation~/includes/version.md
+1-1
@@ -6,6 +6,74 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 <!-- Headers should be listed in this order: Added, Changed, Deprecated, Removed, Fixed, Security -->
 
+## [2.6.3] - 2024-07-23
+
+### Changed
+- Changed `BaseTeleportationInteractable` and `ClimbInteractable` `Awake` logic to limit expensive `FindObjectOfType` search for `TeleportationProvider` and `ClimbProvider` to once per frame if those `LocomotionProviders` are left null in the inspector. (Backport from 3.0.4)
+
+### Fixed
+- Fixed Teleportation Area component so it filters out Sphere Cast overlap hits at the start of the sweep so it no longer teleports to (0, 0, 0). Changed so the selection is blocked so the XR Interactor Line Visual uses its blocked style in that case. ([XRIT-138](https://issuetracker.unity3d.com/product/unity/issues/guid/XRIT-138)) (Backport from 3.0.5)
+- Fixed Sector interaction Editor to draw all properties in the Input Actions Editor window in Unity 2022.3 or newer. (Backport from 3.0.5)
+- Fixed regression with `XRSocketInteractor` and `XRSocketGrabTransformer` where an interactable GameObject does not move to the position of the `XRSocketInteractor` when set as the Starting Selected Interactable. ([XRIT-164](https://issuetracker.unity3d.com/product/unity/issues/guid/XRIT-164)) (Backport from 3.0.5)
+
+## [2.6.2] - 2024-06-05
+
+### Fixed
+- Fixed bug fix backport to match version from 3.0.4.
+
+## [2.6.1] - 2024-05-31
+
+### Added
+- Added interaction layer configuration to `XRInteractorLineVisual` to allow specification of which interactables cause a straight line ray cast to bend to the attach transform on select. (Backport from 3.0.4)
+
+### Fixed
+- Fixed missing Scripting API documentation on public enum value. (Backport from 3.0.3)
+- Fixed the AR Starter Assets sample to import the verified version of AR Foundation package instead of the latest compatible version when using the **Fix** button in the Project Validation window on Unity 2021.3. (Backport from 3.0.4)
+- Reverted breaking API change made in version 2.6.0 to `XRBaseGrabTransformer` by no longer making `Start` and `OnDestroy` methods `virtual`.
+
+## [2.6.0] - 2024-05-01
+
+### Added
+- Added a new type of teleport interactable, [Teleportation Multi-Anchor Volume](../manual/teleportation-multi-anchor-volume.md), that enables teleportation to one of several destination poses chosen by a filter object that implements `ITeleportationVolumeAnchorFilter`. (Backport from 3.0.0-pre.1)
+  - Added `FurthestTeleportationAnchorFilter`, which is the default filter that chooses the furthest anchor as the destination. Use the menu item **Assets > Create > XR > Locomotion > Furthest Teleportation Anchor Filter** to create an instance of this filter.
+  - Added `GazeTeleportationAnchorFilter`, which chooses a destination based on where the user is looking and how far away the anchor is. Use the menu item **Assets > Create > XR > Locomotion > Gaze Teleportation Anchor Filter** to create an instance of this filter.
+  - Added menu item **Assets > Create > XR > Locomotion > Teleport Volume Destination Settings**, which creates a Teleport Volume Destination Settings Datum asset.
+  - Added `Multi Floor Ladder` prefab to the Starter Assets sample, and added an instance of this prefab to the `Climb Sample` prefab. This prefab includes another ladder Climb Interactable and a Teleportation Multi-Anchor Volume that uses a Gaze Teleportation Anchor Filter to teleport to one of three destinations.
+- Added the interface `IXRInteractableCustomReticle`, which allows a component on an interactable's **Custom Reticle** prefab to respond to the interactable instantiating the reticle and attaching it to an instance of `IXRCustomReticleProvider`. (Backport from 3.0.0-pre.1)
+  - Added an example implementation of this interface in the new `Climb Teleport Reticle` prefab in the Starter Assets sample.
+- Added a rotation threshold to [`XRScreenSpaceController`](xref:UnityEngine.XR.Interaction.Toolkit.XRScreenSpaceController) so that scaling is not triggered while rotating. (Backport from 3.0.0-pre.1)
+- Added in-editor touchscreen gesture support for rotation and scaling in the starter assets. The input action map now has bindings for the related gestures. (Backport from 3.0.0-pre.1)
+- Added Climb Teleport Interactor, which enables assistance with climb locomotion by teleporting the user to a specific destination when they end a climb interaction. (Backport from 3.0.0-pre.1)
+  - Added the property **Climb Assistance Teleport Volume** to Climb Interactable to enable this teleportation behavior for a specific climb interactable.
+  - Made the following changes to the Starter Assets sample to demonstrate climb teleportation:
+    - Added a Climb Teleport Interactor instance in the `XR Origin (XR Rig)` prefab under **Locomotion System** > **Climb**.
+    - Assigned the **Climb Assistance Teleport Volume** references in the `Single Floor Ladder` and `Multi Floor Ladder` prefabs.
+    - Added the affordance component Climb Teleport Destination Indicator, and added an instance of this component to the `XR Origin (XR Rig)` prefab.
+    - Added the `Climb Teleport Arrow` prefab and supporting assets.
+- Added public members `climbAnchorInteractable`, `climbAnchorInteractor`, and `climbAnchorUpdated` to `ClimbProvider`. (Backport from 3.0.0-pre.1)
+- Added public method `Angle(in Vector3, in Vector3, out float)`, which finds the angle between two vectors, to `BurstMathUtility`. (Backport from 3.0.0-pre.1)
+- Added `IAttachPointVelocityProvider`, `IAttachPointVelocityTracker`, and `AttachPointVelocityTracker` to make the attach point velocity tracking functionality accessible outside of the `XRBaseInteractor`. (Backport from 3.0.0-pre.1)
+- Added public [`RequestTeleport`](xref:UnityEngine.XR.Interaction.Toolkit.TeleportationAnchor.RequestTeleport) method to [`TeleportationAnchor`](xref:UnityEngine.XR.Interaction.Toolkit.TeleportationAnchor) to allow a teleport to the anchor to be triggered manually, such as from a UI button click event, instead of only from interaction events like select exited. Teleport to anchor can also be triggered from the Inspector window in the More (&#8942;) menu during Play mode for debugging. (Backport from 3.0.0-pre.2)
+  - Added protected [`SendTeleportRequest(IXRInteractor)`](xref:UnityEngine.XR.Interaction.Toolkit.BaseTeleportationInteractable.SendTeleportRequest(UnityEngine.XR.Interaction.Toolkit.IXRInteractor)) to the base abstract class to allow the teleport to be triggered from additional contexts.
+- Added option in [`ARTransformer`](xref:UnityEngine.XR.Interaction.Toolkit.Transformers.ARTransformer) to filter translatable planes by the AR Foundation plane classifications. Uses either a list of `PlaneClassification` enum (for older than ARF 6.0) or `PlaneClassifications` flags enum (ARF 6.0 and newer) types. (Backport from 3.0.0-pre.2)
+- Added `ARTransformerEditor` to customize the Inspector window of the AR Transformer component. (Backport from 3.0.0-pre.2)
+- Added [Spatial Keyboard](../manual/samples-spatial-keyboard.html) sample demo scene, scripts, and prefabs. (Backport from 3.0.2)
+
+### Changed
+- Changed setup of the ladder and elevated teleport area in the `Climb Sample` prefab in the Starter Assets sample so that the objects are set up in a new `Single Floor Ladder` prefab. This prefab also contains a Teleportation Multi-Anchor Volume to allow teleportation to the top or bottom, whichever is furthest from the user. (Backport from 3.0.0-pre.1)
+- Changed `XRPokeInteractor` to use `IAttachPointVelocityTracker` instead of the velocity tracking that used to live in `XRBaseInteractor`. (Backport from 3.0.0-pre.1)
+- Changed [`XRScreenSpaceController`](xref:UnityEngine.XR.Interaction.Toolkit.XRScreenSpaceController) to add a rotation threshold so that scaling is not triggered while rotating. This behavior can be disabled by disabling Use Rotation Threshold. (Backport from 3.0.0-pre.1)
+- Changed `XRBaseGrabTransformer` by making `Start` and `OnDestroy` methods `virtual`. (Backport from 3.0.0-pre.2)
+- Changed `GrabTransformerRotationAxisLock` by moving the script from the Hands Interaction Demo sample to the Starter Assets sample, renamed to  `RotationAxisLockGrabTransformer`, and updated namespace to match the sample. (Backport from 3.0.2)
+  - Changed the Hands Interaction Demo sample `TableHandle` prefab to use the `RotationAxisLockGrabTransformer` component in Starter Assets.
+- Changed `XRDeviceSimulator` to drive AR Foundation's Simulation Camera so that there is no conflict between XR Simulation and XR Device Simulator. Requires AR Foundation 6.0.0 or newer. (Backport from 3.0.2)
+- Changed XR Poke Interactor to reset poke velocity tracking on hover to improve accuracy of poke interactions. (Backport from 3.0.2)
+- Changed some APIs used by the `XRPokeInteractor` for enabling the ability to poke UGUI canvases from `internal` to `public` to allow for custom interactor implementations.
+
+### Fixed
+- Fixed deprecation warnings when using `Rigidbody.velocity` in Unity 2023.3 or newer. (Backport from 3.0.2)
+- Fixed an issue where poke filters on nested transforms with different scales would fail to compute a valid poke axis length. (Backport from 3.0.2)
+
 ## [2.5.4] - 2024-04-05
 
 ### Fixed
 
@@ -1,6 +1,7 @@
 * [XR Interaction Toolkit](index.md)
-  * [What's new in 2.5](whats-new-2.5.md)
+  * [What's new in 2.6](whats-new-2.6.md)
     * Previous releases
+      * [What's new in 2.5](whats-new-2.5.md)
       * [What's new in 2.4](whats-new-2.4.md)
       * [What's new in 2.3](whats-new-2.3.md)
       * [What's new in 2.2](whats-new-2.2.md)
@@ -22,6 +23,7 @@
   * [Hands Interaction Demo](samples-hands-interaction-demo.md)
   * [AR Starter Assets](samples-ar-starter-assets.md)
   * [XR Device Simulator](samples-xr-device-simulator.md)
+  * [Spatial Keyboard](samples-spatial-keyboard.md)
   * [Meta Gaze Adapter](samples-meta-gaze-adapter.md)
 * Reference
   * [Glossary](glossary.md)
 
@@ -24,6 +24,7 @@ Interactable that can be climbed while selected.
 | **Climb Transform** | Transform that defines the coordinate space for climb locomotion. Will use this GameObject's Transform by default. |
 | **Filter Interaction By Distance** | Controls whether to apply a distance check when validating hover and select interaction. |
 | **Max Interaction Distance** | The maximum distance that an interactor can be from this interactable to begin hover or select. |
+| **Climb Assistance Teleport Volume** | The [Teleportation Multi-Anchor Volume](teleportation-multi-anchor-volume.md) used to assist with movement to a specific destination after ending a climb (optional, may be **None**). Only used if there is a [Climb Teleport Interactor](climb-teleport-interactor.md) in the scene. |
 | **Climb Settings Override** | Optional override of locomotion settings specified in the climb provider. Only applies as an override if set to **Use Value** or if the asset reference is set. |
 | &emsp;**Use Asset** | Enable to use a `ClimbSettings` object externally defined in a `ClimbSettingsDatum` asset that can be assigned using the accompanying field. |
 | &emsp;**Use Value** | Enable to use a `ClimbSettings` object which comes with default values editable in the component editor. |
 
@@ -0,0 +1,27 @@
+# Climb Teleport Interactor
+
+Interactor that drives climb locomotion assistance via teleportation. This component is not designed to be attached to a controller (thus does not derive from `XRBaseControllerInteractor`, unlike `XRDirectInteractor` and `XRRayInteractor`) and instead performs interactions in response to climb locomotion.
+
+This interactor responds to the user grabbing a [Climb Interactable](climb-interactable.md) that references the same [Climb Provider](climb-provider.md) as this interactor. If the Climb Interactable has a [Teleportation Multi-Anchor Volume](teleportation-multi-anchor-volume.md) assigned to its **Climb Assistance Teleport Volume**, the Climb Teleport Interactor will hover the Teleport Volume while the user is grabbing the Climb Interactable. If there is no **Climb Assistance Teleport Volume** assigned, the interactor will do nothing. The Teleport Volume will respond to hover as it normally does, by choosing one of its anchors as the teleport destination. By default the Teleport Volume will also periodically update its destination while hovered, due to the Climb Teleport Interactor overriding its **Destination Evaluation Settings**, so that the user can change their destination while climbing. When climb locomotion ends, the Climb Teleport Interactor triggers teleportation to the evaluated destination by starting and immediately ending either a select or activate interaction on the Teleport Volume, depending on the Teleport Volume's **Teleport Trigger**. The interactor also stops hovering the Teleport Volume the next frame after teleporting.
+
+![ClimbTeleportInteractor component](images/climb-teleport-interactor.png)
+
+| **Property** | **Description** |
+|---|---|
+| **Interaction Manager** | The [XRInteractionManager](xr-interaction-manager.md) that this Interactor will communicate with (will find one if **None**). |
+| **Interaction Layer Mask** | Allows interaction with Interactables whose [Interaction Layer Mask](interaction-layers.md) overlaps with any Layer in this Interaction Layer Mask. |
+| **Attach Transform** | The `Transform` that is used as the attach point for Interactables.<br />Automatically instantiated and set in `Awake` if **None**.<br />Setting this will not automatically destroy the previous object. |
+| **Disable Visuals When Blocked In Group** | Whether to disable visuals when this Interactor is part of an [Interaction Group](xr-interaction-group.md) and is incapable of interacting due to active interaction by another Interactor in the Group. |
+| **Starting Selected Interactable** | The Interactable that this Interactor automatically selects at startup (optional, may be **None**). |
+| **Keep Selected Target Valid** | Whether to keep selecting an Interactable after initially selecting it even when it is no longer a valid target.<br />Enable to make the `XRInteractionManager` retain the selection even if the Interactable is not contained within the list of valid targets. Disable to make the Interaction Manager clear the selection if it isn't within the list of valid targets.<br />A common use for disabling this is for Ray Interactors used for teleportation to make the teleportation Interactable no longer selected when not currently pointing at it. |
+| **Climb Provider** | The climb locomotion provider to query for active locomotion and climbed interactable. |
+| **Destination Evaluation Settings** | Optional settings for how the hovered teleport volume evaluates a destination anchor. Applies as an override to the teleport volume's settings if set to **Use Value** or if the asset reference is set. |
+| &emsp;**Use Asset** | Enable to use a `TeleportVolumeDestinationSettings` object externally defined in a `TeleportVolumeDestinationSettingsDatum` asset that can be assigned using the accompanying field. |
+| &emsp;**Use Value** | Enable to use a `TeleportVolumeDestinationSettings` object which comes with default values editable in the component editor. |
+| &emsp;Enable Destination Evaluation Delay | Whether the volume delays evaluation of the destination anchor until the user has hovered over the volume for a certain amount of time. If the user doesn't hover long enough before triggering teleport, no anchor will be used and so no teleport will occur. |
+| &emsp;Destination Evaluation Delay Time | The amount of time, in seconds, for which the user must hover over the volume before it designates a destination anchor. Only used and displayed when **Enable Destination Evaluation Delay** is enabled. |
+| &emsp;Poll For Destination Change | Whether the volume periodically queries the filter for its calculated destination. If the determined anchor is not the current destination, the volume will initiate re-evaluation of the destination anchor. This is useful if you want the user to be able to change their destination while hovering over the volume. |
+| &emsp;Destination Poll Frequency | The amount of time, in seconds, between queries to the filter for its calculated destination anchor. Only used and displayed when **Poll For Destination Change** is enabled. |
+| &emsp;Destination Filter Object | The anchor filter used to evaluate a teleportation destination (must implement the `ITeleportationVolumeAnchorFilter` interface). If set to **None**, the volume will use the anchor furthest from the user as the destination. |
+| **Interactor Filters** | See the [Interaction Filters](interaction-filters.md) page. |
+| **Interactor Events** | See the [Interactor Events](interactor-events.md) page. |
@@ -17,6 +17,7 @@
 - [Climb Interactable](climb-interactable.md)
 - [Teleportation Anchor](teleportation-anchor.md)
 - [Teleportation Area](teleportation-area.md)
+- [Teleportation Multi-Anchor Volume](teleportation-multi-anchor-volume.md)
 
 ### AR Interactables
 
@@ -35,6 +36,10 @@
 - [XR Ray Interactor](xr-ray-interactor.md)
 - [XR Socket Interactor](xr-socket-interactor.md)
 
+### Locomotion Interactors
+
+- [Climb Teleport Interactor](climb-teleport-interactor.md)
+
 ## Filters
 
 - [XR Poke Filter](xr-poke-filter.md)
 
@@ -1,6 +1,8 @@
 # Extending the XR Interaction Toolkit
 
-You can extend the XR Interaction Toolkit system through either [inheritance](https://unity3d.com/learn/tutorials/topics/scripting/inheritance) or composition. Both Interactors and Interactables derive from an abstract base class that you can derive from and use to hook into the Interaction Manager to provide your own functionality. Additionally, you can use event callbacks to add functionality to the existing components. Below is a diagram showing how existing Interactor and Interactable classes inherit their base classes. 
+You can extend the XR Interaction Toolkit system through either [inheritance](https://unity3d.com/learn/tutorials/topics/scripting/inheritance) or composition. Both Interactors and Interactables derive from an abstract base class that you can derive from and use to hook into the XR Interaction Manager to provide your own functionality. Additionally, you can use event callbacks to add functionality to the existing components.
+
+Below is a diagram showing how existing Interactor and Interactable classes inherit their base classes. Note that this is not an exhaustive representation of all classes.
 
 ![class-hierarchy](images/class-hierarchy.svg)
 
@@ -14,7 +16,7 @@ Interactors and Interactables both have various event callbacks that can be used
 
 ## Extending Interactors
 
-You can derive from the `XRBaseInteractor` and/or `XRBaseControllerInteractor` abstract base classes to define your own way of interacting with the world. Unity currently provides Direct (collision) and Ray Interactors, but you can decide how you want the user to choose objects in the world and what they can do with them (though typically you do the latter by deriving from the Base Interactable class).
+You can derive from the `XRBaseInteractor` and/or `XRBaseControllerInteractor` abstract base classes to define your own way of interacting with the world. Unity currently provides different interactors for poke, near, and far interaction, but you can decide how you want the user to choose objects in the world and what they can do with them (though typically you do the latter by deriving from the `XRBaseInteractable` class).
 
 In addition to standard Unity callbacks, you can override the following methods and properties:
 
 
@@ -1 +1 @@
-2.5.4
+2.6.3