Files
dungeons/Assets/UltimateXR/Runtime/Scripts/Manipulation/IUxrGrabbableModifier.cs
2024-08-06 21:58:35 +02:00

33 lines
1.4 KiB
C#

// --------------------------------------------------------------------------------------------------------------------
// <copyright file="IUxrGrabbableModifier.cs" company="VRMADA">
// Copyright (c) VRMADA, All rights reserved.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
using System.Collections.Generic;
using UnityEngine;
namespace UltimateXR.Manipulation
{
/// <summary>
/// Interface that can be implemented in components that modify a <see cref="UxrGrabbableObject" /> in the same
/// <see cref="GameObject" /> so that the inspector shows which information is being controlled by the modifier.
/// </summary>
public interface IUxrGrabbableModifier
{
#region Public Types & Data
/// <summary>
/// Gets the flags representing the parts of the <see cref="UxrGrabbableObject" /> that are overriden/controlled by the
/// modifier.
/// </summary>
UxrGrabbableModifierFlags GrabbableModifierFlags { get; }
/// <summary>
/// Gets a list of additional grabbable objects affected by the modifier. These grabbable objects can only be up or
/// down in the same hierarchy as the modifier.
/// </summary>
IEnumerable<UxrGrabbableObject> AdditionalTargets { get; }
#endregion
}
}