Net.Like.Xue.Tokyo/Assets/Plugins/Animancer/Internal/Interfaces/IMotion.cs

78 lines
3.2 KiB
C#

// Animancer // https://kybernetik.com.au/animancer // Copyright 2018-2023 Kybernetik //
using UnityEngine;
namespace Animancer
{
/// <summary>An object with an <see cref="AverageAngularSpeed"/> and <see cref="AverageVelocity"/>.</summary>
/// https://kybernetik.com.au/animancer/api/Animancer/IMotion
///
public interface IMotion
{
/************************************************************************************************************************/
/// <summary>The initial <see cref="Motion.averageAngularSpeed"/> that the created state will have.</summary>
/// <remarks>The actual average can vary in states like <see cref="ManualMixerState"/>.</remarks>
float AverageAngularSpeed { get; }
/// <summary>The initial <see cref="Motion.averageSpeed"/> that the created state will have.</summary>
/// <remarks>The actual average can vary in states like <see cref="ManualMixerState"/>.</remarks>
Vector3 AverageVelocity { get; }
/************************************************************************************************************************/
}
/// https://kybernetik.com.au/animancer/api/Animancer/AnimancerUtilities
public static partial class AnimancerUtilities
{
/************************************************************************************************************************/
/// <summary>Outputs the <see cref="Motion.averageAngularSpeed"/> or <see cref="IMotion.AverageAngularSpeed"/>.</summary>
/// <remarks>Returns false if the `motion` is null or an unsupported type.</remarks>
public static bool TryGetAverageAngularSpeed(object motion, out float averageAngularSpeed)
{
if (motion is Motion unityMotion)
{
averageAngularSpeed = unityMotion.averageAngularSpeed;
return true;
}
else if (TryGetWrappedObject(motion, out IMotion iMotion))
{
averageAngularSpeed = iMotion.AverageAngularSpeed;
return true;
}
else
{
averageAngularSpeed = default;
return false;
}
}
/************************************************************************************************************************/
/// <summary>Outputs the <see cref="Motion.averageSpeed"/> or <see cref="IMotion.AverageVelocity"/>.</summary>
/// <remarks>Returns false if the `motion` is null or an unsupported type.</remarks>
public static bool TryGetAverageVelocity(object motion, out Vector3 averageVelocity)
{
if (motion is Motion unityMotion)
{
averageVelocity = unityMotion.averageSpeed;
return true;
}
else if (TryGetWrappedObject(motion, out IMotion iMotion))
{
averageVelocity = iMotion.AverageVelocity;
return true;
}
else
{
averageVelocity = default;
return false;
}
}
/************************************************************************************************************************/
}
}