This repository has been archived by the owner on Aug 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce teleport validation data provider (#727)
* Add base setup for MixedRealityTeleportValidationDataProvider * Define IMixedRealityTeleportValidationDataProvider * Refactor TeleportValidationResult * Implement profile and inspector * Implement data provider * Register teleport system data providers properly * Fix profile changes not saved * Remove teleport mode * Update submodules
- Loading branch information
Showing
18 changed files
with
298 additions
and
100 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
41 changes: 41 additions & 0 deletions
41
Editor/Profiles/TeleportSystem/MixedRealityTeleportValidationDataProviderProfileInspector.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
// Copyright (c) XRTK. All rights reserved. | ||
// Licensed under the MIT License. See LICENSE in the project root for license information. | ||
|
||
using UnityEditor; | ||
using XRTK.Definitions.TeleportSystem; | ||
|
||
namespace XRTK.Editor.Profiles.TeleportSystem | ||
{ | ||
[CustomEditor(typeof(MixedRealityTeleportValidationDataProviderProfile))] | ||
public class MixedRealityTeleportValidationDataProviderProfileInspector : BaseMixedRealityProfileInspector | ||
{ | ||
private SerializedProperty validLayers; | ||
private SerializedProperty invalidLayers; | ||
private SerializedProperty upDirectionThreshold; | ||
private SerializedProperty maxDistance; | ||
|
||
protected override void OnEnable() | ||
{ | ||
base.OnEnable(); | ||
|
||
validLayers = serializedObject.FindProperty(nameof(validLayers)); | ||
invalidLayers = serializedObject.FindProperty(nameof(invalidLayers)); | ||
upDirectionThreshold = serializedObject.FindProperty(nameof(upDirectionThreshold)); | ||
maxDistance = serializedObject.FindProperty(nameof(maxDistance)); | ||
} | ||
|
||
public override void OnInspectorGUI() | ||
{ | ||
RenderHeader("This profile defines the set of rules to validate against when deciding whether a teleport target location is valid or not."); | ||
|
||
serializedObject.Update(); | ||
|
||
EditorGUILayout.PropertyField(validLayers); | ||
EditorGUILayout.PropertyField(invalidLayers); | ||
EditorGUILayout.PropertyField(upDirectionThreshold); | ||
EditorGUILayout.PropertyField(maxDistance); | ||
|
||
serializedObject.ApplyModifiedProperties(); | ||
} | ||
} | ||
} |
12 changes: 12 additions & 0 deletions
12
...rofiles/TeleportSystem/MixedRealityTeleportValidationDataProviderProfileInspector.cs.meta
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
Runtime/Definitions/TeleportSystem/MixedRealityTeleportValidationDataProviderProfile.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
// Copyright (c) XRTK. All rights reserved. | ||
// Licensed under the MIT License. See LICENSE in the project root for license information. | ||
|
||
using UnityEngine; | ||
using XRTK.Definitions.Utilities; | ||
using XRTK.Services.Teleportation; | ||
|
||
namespace XRTK.Definitions.TeleportSystem | ||
{ | ||
/// <summary> | ||
/// Configuration profile for the <see cref="MixedRealityTeleportValidationDataProvider"/>. | ||
/// </summary> | ||
[CreateAssetMenu(menuName = "Mixed Reality Toolkit/Teleport System/Teleport Validation Data Provider Profile", fileName = "MixedRealityTeleportValidationDataProviderProfile", order = (int)CreateProfileMenuItemIndices.Input)] | ||
public class MixedRealityTeleportValidationDataProviderProfile : BaseMixedRealityProfile | ||
{ | ||
[SerializeField] | ||
[Tooltip("Layers that are considered 'valid' for teleportation.")] | ||
private LayerMask validLayers = UnityEngine.Physics.DefaultRaycastLayers; | ||
|
||
/// <summary> | ||
/// Layers that are considered 'valid' for teleportation. | ||
/// </summary> | ||
public LayerMask ValidLayers | ||
{ | ||
get => validLayers; | ||
internal set => validLayers = value; | ||
} | ||
|
||
[SerializeField] | ||
[Tooltip("Layers that are considered 'invalid' for teleportation.")] | ||
private LayerMask invalidLayers = UnityEngine.Physics.IgnoreRaycastLayer; | ||
|
||
/// <summary> | ||
/// Layers that are considered 'invalid' for teleportation. | ||
/// </summary> | ||
public LayerMask InvalidLayers | ||
{ | ||
get => invalidLayers; | ||
internal set => invalidLayers = value; | ||
} | ||
|
||
[SerializeField] | ||
[Range(0f, 1f)] | ||
[Tooltip("The up direction threshold to use when determining if a surface is 'flat' enough to teleport to.")] | ||
private float upDirectionThreshold = 0.2f; | ||
|
||
/// <summary> | ||
/// The up direction threshold to use when determining if a surface is 'flat' enough to teleport to. | ||
/// </summary> | ||
public float UpDirectionThreshold | ||
{ | ||
get => upDirectionThreshold; | ||
internal set => upDirectionThreshold = value; | ||
} | ||
|
||
[SerializeField] | ||
[Min(.1f)] | ||
[Tooltip("The maximum distance from the player a teleport location can be away.")] | ||
private float maxDistance = 10f; | ||
|
||
/// <summary> | ||
/// The maximum distance from the player a teleport location can be away. | ||
/// </summary> | ||
public float MaxDistance | ||
{ | ||
get => maxDistance; | ||
internal set => maxDistance = value; | ||
} | ||
} | ||
} |
11 changes: 11 additions & 0 deletions
11
Runtime/Definitions/TeleportSystem/MixedRealityTeleportValidationDataProviderProfile.cs.meta
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
24 changes: 24 additions & 0 deletions
24
Runtime/Interfaces/TeleportSystem/IMixedRealityTeleportValidationDataProvider.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
// Copyright (c) XRTK. All rights reserved. | ||
// Licensed under the MIT License. See LICENSE in the project root for license information. | ||
|
||
using UnityEngine; | ||
using XRTK.Interfaces.InputSystem; | ||
using XRTK.Services.Teleportation; | ||
|
||
namespace XRTK.Interfaces.TeleportSystem | ||
{ | ||
/// <summary> | ||
/// Interface to define teleportation validation data providers. | ||
/// </summary> | ||
public interface IMixedRealityTeleportValidationDataProvider : IMixedRealityTeleportDataProvider | ||
{ | ||
/// <summary> | ||
/// Validates a <see cref="IPointerResult"/> and returns whether the <see cref="RaycastHit"/> | ||
/// qualifies for teleporation. | ||
/// </summary> | ||
/// <param name="pointerResult">The <see cref="IPointerResult"/> to validate.</param> | ||
/// <param name="teleportHotSpot"><see cref="IMixedRealityTeleportHotSpot"/> found at the target position, if any.</param> | ||
/// <returns>The <see cref="TeleportValidationResult"/> for <paramref name="pointerResult"/>.</returns> | ||
TeleportValidationResult IsValid(IPointerResult pointerResult, IMixedRealityTeleportHotSpot teleportHotSpot = null); | ||
} | ||
} |
2 changes: 1 addition & 1 deletion
2
...vices/TeleportSystem/TeleportMode.cs.meta → ...ityTeleportValidationDataProvider.cs.meta
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.