2.4.0-pre.1

[2.4.0-pre.1] - 2023-05-25

Added

• Added hands support to XR Device Simulator. You must have the XR Hands package installed in your project to use this new functionality.
• Added Is Tracked action to XR Controller (Action-based), and updated presets and prefabs in Starter Assets sample to make use of the new Is Tracked input actions in the XRI Default Input Actions.
• Added properties in the ARGestureInteractor class to control raycast behavior for gestures.
• Added the IXRPokeFilter interface to allow other classes to act as customized poke filters for the XRPokeInteractor instead of only supporting the XRPokeFilter component.
• Added XR Interactor Affordance State Provider component which can drive affordance receivers using interactor interactions events.
• Added Color Gradient Line Renderer Affordance Receiver to pair with an XR Interactor Affordance State Provider on a Ray interactor to improve visual coloring. Has a property to automatically disable coloring of XR Interactor Line Visual.
• Added Hand Menu component, as well as a sample prefab of a working hand menu in the Hands Interaction Demo sample.
  • HandMenu component has a split configuration for hands and controllers, with a new FollowPresetDatum.
  • Added gaze activation settings and a reveal/ hide hand menu animation.
• Added XR Input Modality Manager component which manages swapping between hand and controller hierarchies in the XR Origin. Updated prefabs in the package samples to make use of this component.
• Added ability for XR Interactor Line Visual to curve accurately and track interactable attach points during selection.
• Added Auto Adjust Line Length property to XR Interactor Line Visual to retract the line end after a delay when the ray interactor doesn't hit any valid targets.
• Added the XR Gaze Assistance component to enable split interaction. Eye for aiming and controllers for selection.
• Added the IXRRayProvider interface to allow other ray implementations to take advantage of split interaction.
• Added Focus State to interactables. An interactable that is selected is also focused; it remains focused until another interactable is focused instead. Useful for highlighting an object to later perform operations on.
• Added Visit Each Frame property to XR Controller Recorder to control whether each frame of the input recording must be played back regardless of the time period passed.
• Added XR Transform Stabilizer component that applies optimized stabilization techniques to remove pose jitter and makes aiming and selecting with rays easier for users.
• Added Climb Provider, which provides locomotion counter to interactor movement while the user is selecting a Climb Interactable.
  • Added menu item Assets > Create > XR > Locomotion > Climb Settings, which creates a Climb Settings Datum asset.
  • Added a Climb Provider instance to XR Origin Preconfigured in the Starter Assets sample.
  • Added Climb Sample prefab to the Starter Assets sample, and added an instance of this prefab to DemoScene. This prefab includes preconfigured Climb Interactables.
• Added support for XRRayInteractors to scroll UI panels using the thumbstick.
  • IUInteractors now support UIHoverEnter and UIHoverExit events.
  • UIInputModule gains the trackedScrollDeltaMultiplier property to control scrolling speeds via thumbstick.
  • TrackedDeviceModel gains properties for current UI Selectable and if the selected UI is scrollable.
  • ActionBasedController gains a property for UI scrolling input, set to the thumbstick in the starter assets.
• Added configuration of interaction overrides to XR Interaction Group, allowing certain Group members to take control of interaction when attempting to select, regardless of priority.
• Added Direct Interactor as an interaction override for Poke Interactor in each XR Interaction Group in XR Origin (XR Rig) in Starter Assets sample.
• Added new Shader Graphs and Materials in Hand Interaction Demo for a transparent hand that supports highlighting fingers
• Added the TouchscreenGestureInputController which allows users to surface touchscreen gesture data via the Input System.
• Added the XRScreenSpaceController which enables usage of screenspace input, from touchscreen or mouse, with interactors.
• Added the enableARRaycasting property to XRRayInteractor which enables raycasting against the AR environment if AR Foundation is installed.

Changed

• Changed XRControllerState by adding an isTracked field. Deprecated old constructors, users should update their code to call the ones with the added parameter.
• Changed XRI project validation to only log errors to the console, not warnings.
• Changed XR Interactor Line Visual so it bends to the selected interactable by default. Set Line Bend Ratio to 1 to revert to the old behavior where the line would remain straight.
• Changed XR Interactor Line Visual default value of Line Width from 0.02 to 0.005.
• Improved performance of the line visual and ray interactor by optimizing most of the line computation math for the Burst compiler. The Burst package must be installed in your project to take advantage of the optimizations.
• Changed XRInteractorLineVisual by adding the OnDestroy and LateUpdate methods. Users who had already implemented either method in derived classes will need to call the base method.
• Changed XRInteractorReticleVisual by adding the OnDisable method so it disables the reticle when the component is disabled. Users who had already implemented that method in derived classes will need to call the base method.
• Changed TeleportationAnchor.GetAttachTransform method to return the teleportAnchorTransform value.
• Renamed Starter Assets sample prefabs:
  • Renamed Complete XR Origin Set Up prefab to XR Interaction Setup.
  • Renamed XR Origin prefab to XR Origin (XR Rig).
  • Renamed Complete Teleport Area Set Up prefab to Teleportation Environment.
• Renamed Hands Interaction Demo sample prefabs:
  • Renamed Complete XR Origin Hands Set Up prefab to XR Interaction Hands Setup.
  • Renamed XR Origin Hands prefab to XR Origin Hands (XR Rig).
• Changed XR Origin (XR Rig) to reorganize locomotion components to new GameObjects.
• Changed XR Origin (XR Rig) to disable grab move locomotion by default. Activate the Grab Move GameObject to re-enable that functionality.
• Changed XR Origin Hands (XR Rig) to be a prefab variant of the XR Origin (XR Rig) prefab.
• Changed Starter Assets sample prefabs by adding XR Gaze Fallback to the XR Origin GameObject.
• Changed XRRayInteractor, XRInteractorLineVisual, and XRInteractorReticleVisual to support mediation through split interaction.
• Changed XR Ray Interactor to no longer interact with UGUI Canvases while selecting an interactable.
• Changed XR Ray Interactor so the Hover To Select property will now activate with UI elements.

2.3.2

[2.3.2] - 2023-04-28

Changed

• Changed XRI project validation to only log errors to the console, not warnings.
• Updated XRPokeFollowAffordance smoothing property default from 8 to 16 to make it feel more responsive.

Fixed

• Added additional checks against AR Foundation 5.0 and newer so deprecation messages and the use of the newer XR Origin (AR) is hidden when using AR Foundation 4.2 and older.
• Fixed GC allocations produced each frame by XRPokeInteractor.UpdateUIModel.
• Fixed frame-timing for Locomotion Input Tests when running in batch mode.
• XRInteractableAffordanceStateProvider Fixes:
  • Activated state was lower priority than selected, which because select is not exited, this was causing issues with it not appearing.
  • There were some racing coroutines between select and activate, and now trigger a new animation blocks previous animations
  • Leaving the select state cancels select animations that might not have completed
  • Leaving activated state cancels activate animations that might not have completed
• Fixed repeat audio issue in the AudioAffordanceReceiver by adding extra conditions which treat select as a modifier to hover, and activated as a modifier to select. Doing this prevents triggering repeat audio clips that shouldn't fire, like releasing the activate trigger, or releasing the select trigger while still hovering.
• Fixed XRPokeLogic issue where poking from behind objects would sometimes trigger select incorrectly.
• Fixed XRPokeLogic issue where depth percent was incorrectly calculated using an exponential value which would result in poke buttons feeling disconnected from the poke interactor position.

2.3.1

[2.3.1] - 2023-03-27

Added

• Added System Gesture Detector component to the Hands Interaction Demo sample to add system gesture and menu palm pinch gesture events. Added sound upon menu press as an example. Added Aim Flags input actions to the XRI Default Input Actions in the Starter Assets sample to support this.
• Added Interaction filters documentation for IXRHoverFilter, IXRSelectFilter, IXRInteractionStrengthFilter, and the corresponding filter delegates with examples.

Changed

• Changed the Poke Gesture Detector component in the Hands Interaction Demo sample to no longer end the poke gesture when hand tracking is lost. This fixes the Ray Interactor line visual reappearing when hand tracking is lost while doing the poke gesture.
• Changed XRInteractorReticleVisual to ensure consistent attempts to align the reticle prefab's z axis with the transform.up of the XROrigin when AlignPrefabWithSurfaceNormal is true and aligning with a non-horizontal surface.
• Changed XRInteractorReticleVisual to align the reticle prefab's z axis with the forward direction of the reticle's interactor when AlignPrefabWithSurfaceNormal is true and aligning with a horizontal surface.
• Updated installation documentation with convenience links for installing the XRI package on older versions of Unity 2021 where the package was not included in the main Editor manifest.
• Changed so UGUI poke interactions are now considered to be blocking interactions for interaction groups. This allows rays to be properly hidden when hovering or selecting a UGUI canvas with poke.
• Changed to use velocity estimation of poke interactor to add an extra validation mechanism in the XR Poke Filter hover validation check to allow poke selection to occur in cases where it was previously rejected, while still preventing poking from behind and other non-desireable cases.
• Changed to cache poke selection validation check so that it's easier to hold a poke when the selection conditions are met. This makes scrolling UGUI canvases easier and makes poke interactions feel more consistent.
• Changed AR Scale Interactable so changing the Min Scale and/or Max Scale during runtime will keep the current object scale if still within range instead of resizing the object to keep the same scale ratio.

Fixed

• Fixed the Hands Interaction Demo sample to wait to activate the controller GameObjects until they are reconnected instead of each time hand tracking is lost. Also fixed the controllers appearing at the origin if they have never been tracked.
• Fixed the Hands Interaction Demo sample so it disables the hand interactors while doing a system gesture (such as a user looking at their open palm at eye level).
• Fixed warning about a self-intersecting polygon in the Frame.fbx model in the Hands Interaction Demo sample.
• Fixed warning in Hands Interaction Demo sample about obsolete API usage coming from the hands subsystem.
• Fixed XRSimulatedController and XRSimulatedHMD to have identifying characteristics information in the capabilities field of their corresponding InputDeviceDescription. (XRIT-50)
• Fixed an issue in the XRController class where the inputDevice property was not reinitialized when the controllerNode property was changed. (XRIT-52)
• UGUI ray interactions are now correctly blocked when interaction groups block ray interactions and the ray is hidden.
• Fixed an issue with TrackedDeviceGraphicRaycaster, when using the XRPokeInteractor on UGUI canvases with different sort orders, where interaction was blocked on all but the highest Order in Layer valued canvas. (XRIT-48)
• Fixed an issue with TrackedDeviceGraphicsRaycaster, where opening a dropdown would block all other UGUI canvases to become non-interactable with an XRPokeInteractor until the dropdown was closed.
• Fixed the Starter Assets and Hands Interaction Demo prefabs which contained components and shaders with a mix of both Built-in Render Pipeline and Universal Render Pipeline. They are all now using Built-in Render Pipeline for consistency.
• Fixed XRInteractorReticleVisual incorrect rotation around y axis when aligning prefab to surface normal. (XRIT-18)
• Fixed XRInteractorReticleVisual incorrect rotation when AlignPrefabWithSurfaceNormal is false.
• Fixed XRInteractorReticleVisual inconsistent rotation when AlignPrefabWithSurfaceNormal and DrawOnNoHit are true but there is no active hit.
• Fixed UIInputModule issue where tracked devices cannot drag on UI elements when Cursor.lockState is set to Locked.

2.3.0

[2.3.0] - 2023-02-17

Added

• Added a Raycast Snap Volume Interaction property to control whether the XR Ray Interactor will collide with or ignore trigger snap colliders from an XR Interactable Snap Volume (used by gaze assistance). This allows a user to set Raycast Trigger Interaction to Ignore but still collide with trigger colliders that are associated with a snap volume.
• Added options to XR Poke Follow Affordance in the Starter Assets sample to apply the follow animation if the poke target is a child and to clamp the follow target to a maximum distance from the poke target.
• Added an XR Poke Follow Affordance to the TextButton prefab in the Starter Assets sample so that the button graphics can move in response to poke.
• Added Tracking State and Is Tracked input actions to the XRI Default Input Actions in the Starter Assets sample.
• Added Meta Gaze Adapter sample to allow developers to request permission and initialize eye tracking for the Meta Quest Pro.
• Added Hands Interaction Demo sample to demonstrate interactions with hand tracking.
• Added poke interaction examples to the DemoScene in the Starter Assets sample.
• Added ability to customize the layer mask and trigger interaction when the XR Poke Interactor performs the physics sphere overlap call.
• Added documentation regarding behavior when Select Action Trigger is set to State on XR Direct Interactor and XR Ray Interactor.

Changed

• Changed the Stop Manipulation action (default binding Escape) in the XR Device Simulator to always stop manipulation every time it is pressed instead of cycling between None and FPS mode. Trigger the Cycle Devices action (default binding Tab) to switch back to FPS mode instead.
• Changed Ray Interactor prefab in the Starter Assets sample to enable Treat Selection As Valid State on the XR Interactor Line Visual.
• Changed the GameObject > XR > Grab Interactable menu item to set the Rigidbody Interpolate property on the created GameObject to Interpolate.
• Changed the Rigidbody Interpolate property from None to Interpolate in each of the Starter Assets sample grab interactable prefabs.
• Changed the default value of the Color Property Name property on the Color Material Property Affordance Receiver component to an empty string instead of "_BaseColor". An empty string will now use either "_BaseColor" or "_Color" depending on the current render pipeline to add support for the Built-In Render Pipeline.
• Changed GetValidTargets on each interactor type to return an empty list when the interactor is disabled.
• Changed ActionBasedControllerManager in Starter Assets sample to make use of XR Interaction Group and removed some unused serialized fields.
• Changed XR Origin Preconfigured in Starter Assets sample so it instantiates the controller model prefab at runtime instead of being in the prefab hierarchy to make it easier for users to override the model used.
• Changed Teleport Interactor in Starter Assets sample so it instantiates the reticle prefabs at runtime instead of being in the prefab hierarchy to make it easier for users to override the reticle used.
• Changed com.unity.xr.core-utils dependency to 2.2.0.

Fixed

• Fixed Teleportation Anchor incorrectly triggering a teleport when the Ray Interactor stops pointing at the anchor when it no longer has any ray cast hits.
• Fixed Starter Assets sample prefabs and DemoScene to have the Gaze Interactor prefab.
• Fixed XRPokeInteractor so it uses the targetFilter for filtering the valid targets returned by GetValidTargets.
• Fixed the Fix button for project validation issue "Interaction Layer 31 is not set to 'Teleport'" not persisting to the settings asset when closing the Unity Editor.
• Fixed missing references in device simulator UI button images by assigning to null.
• Fixed the PokeStateData that is generated from UI poke interaction so that its axisAlignedPokeInteractionPoint is relative to the world position of the target transform.
• Fixed broken click animations in XRInteractableAffordanceStateProvider.
• Fixed XR Device Simulator so it will use the new main camera if the previous one is disabled or destroyed.
• Fixed issue where AR gestures did not take into account UI in ARBaseGestureInteractable behaviors (such as AR Placement Interactable) by adding an excludeUITouches property, which is enabled by default.
• Fixed potential invalid stayed colliders list in XRDirectInteractor and XRSocketInteractor when the interactor is disabled while in contact with a collider.
• Fixed hover and select events being incorrectly fired when an XRDirectInteractor or XRSocketInteractor GameObject or component is disabled while in contact with an interactable, moved away from the interactable, and then enabled.
• Fixed XR Poke Interactor to query the local PhysicsScene instead of using static physics calls.
• Fixed poke in UI scrolling in a scroll view outside of the viewport by ensuring the Tracked Device Graphic Raycaster respects the alpha hit test threshold.
• Fixed the Teleport Anchor prefab in Starter Assets to place the teleport destination at the top of the platform, fixing a bump that would occur when moving with locomotion after teleporting.

2.3.0-pre.1

[2.3.0-pre.1] - 2022-12-07

Added

• Added new Affordance System. This introduces the XRI Affordance state provider, which connects to an XR Interactable to determine new affordance states, which then power Affordance Receivers to animate tweens using Affordance Theme scriptable Objects. This can be used for audio, ui, material and other kinds of animation tweens, reactive to interaction state changes, all powered by the Job System.
• Added an option to Edit > Project Settings > XR Interaction Toolkit to automatically instantiate the prefab in the XR Device Simulator sample.
• Added XR Interaction Group component, which allows only one member Interactor or Group within the Group to be interacting at a time.
• Added the option Disable Visuals When Blocked In Group to XR Base Interactor, which controls whether to disable the Interactor's visuals when the Interactor is part of an Interaction Group and is unable to interact due to active interaction by another Interactor in the Group. This option is enabled by default.
• Added an XR Interaction Group to each hand in the XR Origin Preconfigured prefab in the Starter Assets sample. Each Group prioritizes Direct interaction over Ray interaction.
• Added a runtime UI for the XR Device Simulator. Users can now also move the player position around the physical play space using WASD and Q/E to simulate the user walking around. Reimport the XR Device Simulator sample to access this new functionality and UI.
• Added ability to control the tracking state of the simulated devices in the XR Device Simulator Inspector window.
• Added properties to XR Device Simulator to control the [0.0, 1.0] amount of the simulated grip and trigger inputs when those controls are activated.
• Added lazy follow functionality for UI which can be enabled by adding the LazyFollow component to a GameObject.
• Added IXRInteractionStrengthInteractor and IXRInteractionStrengthInteractable interfaces that are implemented by XRBaseInteractor and XRBaseInteractable, respectively. These add additional properties and methods related to interaction strength, which conveys a variable (that is, analog) selection interaction strength between an interactor and interactable. This is typically based on a motion controller's grip or trigger amount, or based on a poke depth for those interactable objects that support being poked.
• Added the IXRInteractionStrengthFilter interface. Instances of this interface can be added to Interactables to extend their interaction strength computation without needing to create a derived class.
• Added IsHovered and IsSelected methods to XRBaseInteractable that works similarly to IsHovering and IsSelecting on XRBaseInteractor for querying whether a specific interactor is hovering or selecting that interactable.
• Added XRPokeInteractor and XRPokeFilter classes that provide basic poking functionality for both hands and controllers.
• Added XR Poke Follow Affordance component in the Starter Assets sample to control the smooth visual pressing of a Transform component (such as a button, for example) driven by the current select value of a poke interaction.
• Added XR General Grab Transformer which supports moving and rotating unconstrained with one or two interactors, and scaling when using two interactors.
• Added XRGazeInteractor, driven by either eye-gaze or head-gaze pose information. This allows a developer to use eye or head gaze to hover or select by dwelling on interactables.
• Added XRInteractableSnapVolume to allow snapping a ray interactor to a nearby target interactable. This can be combined with the XRGazeInteractor to achieve gaze-assisted hover and selection.
• Added Gaze Configuration properties to XRBaseInteractable related to gaze interactions, automatic selection and deselection from hover, and gaze-assisted hover and selection.
• Added a drawOnNoHit property to XRInteractorReticleVisual that forces the reticle to draw when no ray cast hits are detected.
• Added a snapEndpointIfAvailable property to XRInteractorLineVisual to allow bending the visual ray towards a specified target point, such as guided by an XRInteractableSnapVolume for more user-friendly object selection.
• Added Eye Gaze Position and Eye Gaze Rotation actions to the XRI Default Input Actions asset along with corresponding XRI Default Gaze Controller preset to the Starter Assets sample.
• Added an Integer Fallback Composite binding for Input System input actions, which is useful for a tracking state action. This composite works similarly to the Vector 3 Fallback and Quaternion Fallback Composite bindings.
• Added GetCustomReticle method to XRBaseInteractable to allow lookup of the custom reticle associated with a particular Interactor.
• Added Poke Interactor to each hand in the Complete XR Origin Set Up prefab in Starter Assets

Changed

• Changed the default grab transformers from XR Single Grab Free Transformer and XR Dual Grab Free Transformer to XR General Grab Transformer. This new grab transformer does not respond to the pose of the Attach Transform of the XR Grab Interactable changing while grabbed. If you need to modify the pose after being grabbed, you will need to add a different grab transformer from the Component > XR > Transformers menu.
• Changed GameObject > XR > Grab Interactable to add the XR General Grab Transformer component by default.
• Changed XR Grab Interactable to re-initialize the dynamic attach pose when changing from multiple grabs back to a single grab by default. Disable Reinitialize Every Single Grab (reinitializeDynamicAttachEverySingleGrab) for previous behavior.
• Changed XRDeviceSimulator to destroy itself if another instance already exists at runtime.
• Changed XR Device Simulator to initialize the simulated controllers to position them in front of the HMD instead of at (0, 0, 0).
• Changed XR Device Simulator to start manipulating the HMD and controllers as if the whole player was turning their torso, similar to a typical FPS style configuration, to simplify its use. Press Tab to cycle between manipulating all devices in this mode, the left controller individually, and the right controller individually.
• Changed GameObject > XR > XR Origin (VR) to set the Tracking State Input property on the Tracked Pose Driver of the Main Camera on versions of Input System that support it.
• Changed XRSimulatedController and XRSimulatedHMD to report support for updating during the before render phase.
• Changed DefaultExecutionOrder of the XRInteractionManager from -100 to -105.
• Changed InteractorRegisteredEventArgs by adding a containingGroupObject property of type IXRInteractionGroup which is set when the Interactor is contained in an Interaction Group.
• Changed XRBaseInteractable initialization logic of the IXRInteractable.colliders list to exclude trigger colliders when no colliders are set in the Inspector window.
• Changed XRInteractableUtility.TryGetClosestCollider and XRInteractableUtility.TryGetClosestPointOnCollider to ignore trigger colliders.
• Changed the default value of Select Action Trigger (XRBaseControllerInteractor.selectActionTrigger) on interactors from State to State Change.
• Changed com.unity.inputsystem dependency to 1.4.4.
• Changed com.unity.xr.core-utils dependency to 2.2.0-pre.2.
• Changed com.unity.xr.legacyinputhelpers dependency to 2.1.10.

Fixed

• Fixed Tracked Device Graphic Raycaster to use the correct ray cast method when Check for 2D Occlusion is enabled, and changed it to use the local PhysicsScene2D.
• Fixed issue with RegistrationList and SmallRegistrationList where unregistering and then registering an item that already exists in the registered snapshot would result in the item being counted twice due to being added to the buffered add list.
• Fixed issue with RegistrationList and SmallRegistrationList where unregistering an item that was not yet flushed to the registered snapshot would result in the list returning an incorrect flushedCount due to being incorrectly added to the buffered remove list instead of just removing from the buffered add list.
• Fixed issue with RegistrationList not reporting the registration status of items added via MoveItemImmediately.
• Fixed Grab Transformers (that derive from XRBaseGrabTransformer) to skip automatic registration specified by registrationMode when it has already been added to the XRGrabInteractable. It previously only checked the Starting Single/Multiple Grab Transformers lists.
• Fixed expansion state of Select Filters in the Inspector window reusing the Hover Filters state in some cases.
• Fixed XRRayInteractor null reference exception that causes editor spam when sample points are deleted upon hot-reload.
• Fixed incorrectly false return values for AddCustomReticle and RemoveCustomReticle on the `XRInteractorLin...

2.0.4

[2.0.4] - 2022-10-19

Changed

• Ray casts now query the local PhysicsScene instead of using static Physics routines which uses the default physics scene. Gesture classes that perform ray casts use the camera's scene, and components that perform ray casts use its scene during Awake.
• Creating a new XR Origin (VR) now automatically adds an Input Action Manager component and sets the Action Assets to XRI Default Input Action.inputactions asset if available from the Starter Assets sample package.

Fixed

• Fixed XR Interactor Line Visual so it deactivates the current reticle GameObject when the behavior is enabled or disabled.
• Fixed XRUIInputModule to use the correct button type for middle and right mouse buttons when sending mouse button events.
• Fixed issue where the last point in the curve rendered by XR Interactor Line Visual would not always be continuous with the rest of the curve (for example when sphere cast is used).
• Fixed issue where XRInteractorReticleVisual script did not properly detect ray casts with UI objects. (XRIT-18)
• Fixed an issue with throwing physics on Quest devices where bad frame-timing would cause unexpectedly high velocities to be applied.
• Fixed issue where using the MockHMD XR Plugin package with the XRDeviceSimulator would cause the device simulator's rotation to be overwritten. This issue can also be fixed by upgrading the Input System package to 1.4.1+.
• Fixed Tracked Device Graphic Raycaster to use the correct ray cast method when Check for 2D Occlusion is enabled, and changed it to use the local PhysicsScene2D.

2.2.0

[2.2.0] - 2022-09-30

Added

• Added ability for the target position, rotation, and scale of an XR Grab Interactable to be calculated by another component. Developers can derive from XRBaseGrabTransformer and add those components to the same GameObject as the XR Grab Interactable. The existing logic was moved to XRSingleGrabFreeTransformer. For more information, see Grab transformers.
• Added properties allowHoverAudioWhileSelecting and allowHoverHapticsWhileSelecting to XRBaseControllerInteractor, which control whether to allow the Interactor from playing audio and haptics, respectively, in response to a Hover event if the Hovered Interactable is currently Selected by the Interactor.
• Added property stopLineAtSelection to XRInteractorLineVisual, which controls whether the line will stop at the attach point of the closest interactable selected by the interactor, if there is one.
• Added property treatSelectionAsValidState to XRInteractorLineVisual, which forces the use of valid state visuals while the interactor is selecting an interactable, whether or not the interactor has any valid targets.
• Added support for teleportation directionality so that users can specify the direction they will face when teleportation finishes.
  • Added a Teleport Direction input action for each hand in the XRI Default Input Actions asset in the Starter Assets sample.
  • Added the property anchorRotationMode as an option for how XRRayInteractor controls anchor rotation. RotateOverTime is the existing and default behavior, which is useful for rotating a held object. The other option is MatchDirection, which is useful for controlling teleportation direction by matching rotation to the direction of the 2-dimensional input.
  • Added input options for directional anchor rotation to ActionBasedController and XRController.
  • Added the property matchDirectionalInput as an option for a BaseTeleportationInteractable to apply directional input (based on anchor rotation) when its matchOrientation is set to WorldSpaceUp or TargetUp.
  • Added an interface IXRReticleDirectionProvider for teleportation interactables to override the direction of the reticle.
• Added Fixed update type to XRBaseController which is in sync with MonoBehavior.FixedUpdate.
• Added the IXRTargetPriorityInteractor interface that allow Interactors to monitor the Interactables priority for selection in the current frame. There are different monitoring options (None, Highest Priority Only, and All) with different performance tradeoffs.
• Added the XRInteractionManager.IsHighestPriorityTarget method to check if an Interactable is the highest priority candidate for selection of an Interactor (IXRTargetPriorityInteractor) in the current frame, which is useful for custom affordance feedback.
• Added the IXRHoverFilter interface. Instances of this interface can be added to Interactors, Interactables, or to the Interaction Manager to extend their hover validations without needing to create a derived class.
• Added the IXRSelectFilter interface. Instances of this interface can be added to Interactors, Interactables, or to the Interaction Manager to extend their select validations without needing to create a derived class.
• Added color gradient and reticle options to XR Interactor Line Visual for when the Interactor has a valid target but it selection is blocked. These can be configured by setting the properties Blocked Color Gradient and Blocked Reticle, respectively.
• Added the public method CanHover to XRInteractionManager, which checks whether a given Interactor is able to hover a given Interactable.
• Added the public method CanSelect to XRInteractionManager, which checks whether a given Interactor is able to select a given Interactable.
• Added the public method IsHoverPossible to XRInteractionManager, which checks whether a given Interactor would be able to hover a given Interactable if the Interactor were in a state where it could hover.
• Added the public method IsSelectPossible to XRInteractionManager, which checks whether a given Interactor would be able to select a given Interactable if the Interactor were in a state where it could select.
• Added Enable Fly option to Continuous Move Provider, which allows for unconstrained movement in any direction.
• Added properties filterSelectionByHitNormal and upNormalToleranceDegrees to BaseTeleportationInteractable, which are used to configure whether a user can teleport to a location if the hit normal is not aligned with the interactable's up vector.
• Added Grab Move Provider and Two Handed Grab Move Provider, which provide locomotion based on tracked controller position while a button is held. Grab Move Provider provides translation of the user, and Two Handed Grab Move Provider provides translation, yaw rotation, and uniform scaling of the user.
  • Added a Grab Move input action for each hand in the XRI Default Input Actions asset in the Starter Assets sample.
  • Added XRI Default Left Grab Move and XRI Default Right Grab Move presets to the Starter Assets sample.
  • Added ConstrainedMoveProvider base class for GrabMoveProvider and TwoHandedGrabMoveProvider, to hold logic for constrained movement with a CharacterController.

Changed

• Changed XR Grab Interactable to support being selected by multiple Interactors. To enable that ability in the Inspector window, set Select Mode to Multiple. If your derived class does not properly handle multiple selections and you want to disable the Multiple option, you will need to add [CanSelectMultiple(false)] to your component script.
• Ray casts now query the local PhysicsScene instead of using static Physics routines which uses the default physics scene. Gesture classes that perform ray casts use the camera's scene, and components that perform ray casts use its scene during Awake.
• Changed XRInteractionManager by adding the Awake method. Users who had already implemented Awake in derived classes will need to call the base method.
• Creating a new XR Origin (VR) now automatically adds an Input Action Manager component and sets the Action Assets to XRI Default Input Action.inputactions asset if available from the Starter Assets sample package.
• Move speed in Continuous Move Providers and line width in XR Interactor Line Visual are now scaled by the scale of the XR Origin.
• Changed the Ray Interactor GameObject created through the GameObject > XR create menu to have a Sorting Group to make it render in front of UI and changed the TunnelingVignette prefab in the Tunneling Vignette sample to have a Sorting Group to make it render in front of the Line Renderer of a Ray Interactor.
• Changed minimum supported version of the Unity Editor from 2019.4 to 2020.3 (LTS).

Fixed

• Fixed issue where the last point in the curve rendered by XR Interactor Line Visual would not always be continuous with the rest of the curve (for example when sphere cast is used).
• Fixed issue where using the MockHMD XR Plugin package with the XRDeviceSimulator would cause the device simulator's rotation to be overwritten. This issue can also be fixed by upgrading the Input System package to 1.4.1+.
• Fixed issue where XRInteractorReticleVisual script did not properly detect ray casts with UI objects. (XRIT-18)
• Fixed an issue with throwing physics on Quest devices where bad frame-timing would cause unexpectedly high velocities to be applied.
• Fixed "Retrieving array element that was out of bounds" error when viewing the Tunneling Vignette Controller in the Inspector window when the Locomotion Vignette Providers list is empty.
• Fixed XR Interactor Line Visual so it deactivates the current reticle GameObject when the behavior is enabled or disabled.

2.1.1

[2.1.1] - 2022-07-29

Added

• Added enableBuiltInActionsAsFallback property on XRUIInputModule to provide a fallback default behavior out of the box when using the new Input System as the Active Input Handling.
• Added missing documentation for UI Setup that specifies how to perform object occlusion for UI objects when using the Tracked Device Graphics Raycaster component.
• Added a warning message to the Inspector of XR Interactor Line Visual and XR Interactor Reticle Visual when the Reticle has a Collider which may disrupt the ray cast. This added an XRInteractorReticleVisualEditor class.

Changed

• Changed the dynamic attach behavior of XR Grab Interactable so it only ignores the Match Position property when being grabbed by an XR Ray Interactor with Force Grab enabled instead of ignoring both Match Position and Match Rotation. This lets you bring the object to your hand while keeping the rotation if configured. To make it easier to override the dynamic attach properties for a selecting interactor, the protected methods ShouldMatchAttachPosition, ShouldMatchAttachRotation, and ShouldSnapToColliderVolume were added to XRGrabInteractable.
• Updated Editor tooltip and documentation to clarify how the Stop Line At First Raycast Hit property works on the XR Interactor Line Visual component. (XRIT-4)

Fixed

• Fixed rendering of the Tunneling Vignette causing issues like the Line Renderer cutting short by setting ZWrite Off in the shader. If the sample has already been imported into your project, you will need to import again to get the update.
• Fixed so the TunnelingVignette material asset does not get modified by the TunnelingVignetteController.
• Fixed GetValidTargets performance when there are several Interactors in the scene hovering one or no Interactables.
• Fixed missing input binding for the Move action in the XRI RightHand Locomotion Action Map in the XRI Default Input Actions asset inside the Starter Assets sample.
• Fixed the Rotate Anchor and Translate Anchor input bindings in the XRI Default Input Actions asset to be simpler by not using composite bindings.
• Fixed CharacterControllerDriver so it will try to find the ContinuousMoveProviderBase on other active GameObjects if it isn't on the same GameObject.

2.0.3

[2.0.3] - 2022-07-26

Fixed

• Fixed the simulated HMD and controllers so they no longer reset to origin after switching focus away and back to the Unity Editor. (1409417)
• Fixed warnings about setting velocities of a kinematic body when updating an XR Grab Interactable with Movement Type set to Kinematic.
• Fixed UIInputModule so it will use the new Main Camera if the previous one is disabled when UIInputModule.uiCamera is not set.
• Fixed warning in the Inspector window for interactors missing the XR Controller component when the GameObject is deactivated by changing the find method to include inactive GameObjects.
• Fixed XR Interactor Line Visual so it will instantiate the Reticle GameObject when it is a Prefab asset so it does not modify the asset on disk.
• Fixed UIInputModule to support EventSystem IPointerMoveHandler for Unity 2021.1 and newer. Also added the corresponding pointerMove event to UIInputModule to allow the pointer move events to be globally handled.

2.1.0-pre.1

[2.1.0-pre.1] - 2022-05-02

Added

• Added properties to XR Grab Interactable to use dynamic attach transforms so the grab pose will be based on the pose of the Interactor when the selection is made. You can enable the Use Dynamic Attach property to keep the object in the same position and rotation when grabbed. (1373337)
• Added filtering for interactions to help determine the intent of the user. The new abstractions XR Target Filter and XR Target Evaluator let users configure and extend the logic of how an Interactor ranks an Interactable from a list of valid ones, specifically in the GetValidTargets method. Several different evaluators are included in this update, and custom ones can be created. This makes it easier to customize the Interactor without needing to create a derived behavior.
• Added the XRBaseInteractable.distanceCalculationMode property. This give users the ability to configure how an Interactable calculates its distance to a location, such as to an Interactor for sorting its valid targets, at varying tradeoffs between accuracy and performance.
• Added the XRBaseInteractable.getDistanceOverride property that lets users assign a method to be called when the Interactable is performing a distance calculation to a location, which is used when the Interactor is ordering its valid targets. This property makes it easier to customize the Interactable without needing to create a derived behavior.
• Added IsOverUIGameObject function to XRRayInteractor that does a simple check to see if the ray cast result is hitting a UI GameObject.
• Added InputActionReference properties to the XRUIInputModule for left/right/middle clicks, navigation move, submit, cancel, scroll and pointer movement actions. This allows for greater flexibility and customization of what devices can drive UI input when using the XRUIInputModule.
• The XRI Default Input Actions asset in the Starter Assets sample package now includes an XRI UI Action Map for UI-specific Input Actions. Also included is a Preset asset to quickly map the actions onto the XRUIInputModule component.
• Added a Tunneling Vignette sample. It contains assets to let users set up and configure the tunneling vignette as a comfort mode intended to mitigate motion sickness in VR.
• Added a Tunneling Vignette Controller component used for driving the vignette material included with the Tunneling Vignette sample. Locomotion Provider components can be drag-and-dropped into a list of Locomotion Providers that will trigger the tunneling vignette effect. A custom inspector allows previewing each effect for the corresponding Locomotion Provider.
  • Added ITunnelingVignetteProvider interface to allow custom behaviors to control the vignette effect.
  • Added a LocomotionPhase enum in LocomotionProvider that can be used to describe different phases of a locomotion for use with the tunneling vignette. Added code in ContinuousMoveProviderBase, ContinuousTurnProviderBase, SnapTurnProviderBase, and TeleportationProvider to compute their LocomotionPhase.
  • Added a Delay Time property to the Teleportation Provider and Snap Turn Provider components to support customization of timing for use with fading in the tunneling vignette.

Changed

• Updated code paths with macro protections around InputSystem or Input Manager based code to prevent attempted usage when either one is not active.
• Scroll speed when using the ScrollWheel Input System Action is now being divided by 20 pixels per line instead of 120 pixels per line to match the InputSystemUIInputModule scrolling speed.
• Changed XRSocketInteractor hover mesh pose calculation to only ignore the current pose of the attach transform for XRGrabInteractable when Use Dynamic Attach is disabled instead of for all types of IXRSelectInteractable.
• Changed XRControllerRecorder.recording from internal to public.

Fixed

• Fixed UIInputModule so pointer clicks set the correct button (left/right/middle) for the EventSystem in the PointerEventData.
• Fixed compilation errors on platforms such as Game Core where ENABLE_VR is not currently defined.