Add new Timing01 data structure

Author: adamgraham

.docfx/manual/index.md

@@ -19,6 +19,7 @@ The **Animation Library** package contains assets and scripts for animating Unit
 
 - [AnimatorParameter](xref:Zigurous.Animation.AnimatorParameter)
 - [Timing](xref:Zigurous.Animation.Timing)
+- [Timing01](xref:Zigurous.Animation.Timing01)
 - [TimingRange](xref:Zigurous.Animation.TimingRange)
 - [Vector2AnimationCurve](xref:Zigurous.Animation.Vector2AnimationCurve)
 - [Vector3AnimationCurve](xref:Zigurous.Animation.Vector3AnimationCurve)

Editor/Timing01PropertyDrawer.cs

@@ -0,0 +1,73 @@
+using UnityEditor;
+using UnityEngine;
+
+namespace Zigurous.Animation.Editor
+{
+    [CustomPropertyDrawer(typeof(Timing01))]
+    public sealed class Timing01PropertyDrawer : PropertyDrawer
+    {
+        private const float horizontalSpacing = 4.0f;
+
+        private SerializedProperty _start;
+        private SerializedProperty _end;
+
+        public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
+        {
+            // Start drawing the property
+            EditorGUI.BeginProperty(position, label, property);
+
+            // Draw the property label
+            position = EditorGUI.PrefixLabel(position, GUIUtility.GetControlID(FocusType.Passive), label);
+
+            // Store orginal sizes so they can be set back to their original values
+            int originalIndent = EditorGUI.indentLevel;
+            float originalLabelWidth = EditorGUIUtility.labelWidth;
+
+            // Set indent level of child fields
+            EditorGUI.indentLevel = 0;
+
+            // Create references to child fields
+            if (_start == null) _start = property.FindPropertyRelative("_start");
+            if (_end == null) _end = property.FindPropertyRelative("_end");
+
+            // Calculate the bounds of the child fields
+            Rect rect = new Rect(position);
+            rect.width = (position.width - horizontalSpacing) / 2;
+
+            // Draw the child fields
+            rect = SliderWithChangeCheck(_start, rect, "Start");
+            rect = SliderWithChangeCheck(_end, rect, "End");
+
+            // Set sizes back to their original values
+            EditorGUI.indentLevel = originalIndent;
+            EditorGUIUtility.labelWidth = originalLabelWidth;
+
+            // Finish drawing the property
+            EditorGUI.EndProperty();
+        }
+
+        private Rect SliderWithChangeCheck(SerializedProperty property, Rect position, string displayName)
+        {
+            // Check for changes in the field's value
+            EditorGUI.BeginChangeCheck();
+
+            // Calculate the width of the field label
+            GUIContent label = new GUIContent(displayName);
+            EditorGUIUtility.labelWidth = EditorStyles.label.CalcSize(label).x;
+
+            // Draw the field and store the field's value
+            float value = EditorGUI.Slider(position, label, property.floatValue, 0.0f, 1.0f);
+
+            // Update the property's value from the field
+            if (EditorGUI.EndChangeCheck()) {
+                property.floatValue = value;
+            }
+
+            // Advance the position for the next child field
+            position.x += position.width + horizontalSpacing;
+            return position;
+        }
+
+    }
+
+}

Editor/Timing01PropertyDrawer.cs.meta

@@ -6,10 +6,10 @@ namespace Zigurous.Animation.Editor
     [CustomPropertyDrawer(typeof(Timing))]
     public sealed class TimingPropertyDrawer : PropertyDrawer
     {
-        private static readonly float horizontalSpacing = 4.0f;
+        private const float horizontalSpacing = 4.0f;
 
-        private SerializedProperty _startTime;
-        private SerializedProperty _endTime;
+        private SerializedProperty _start;
+        private SerializedProperty _end;
 
         public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
         {
@@ -27,16 +27,16 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten
             EditorGUI.indentLevel = 0;
 
             // Create references to child fields
-            if (_startTime == null) _startTime = property.FindPropertyRelative("startTime");
-            if (_endTime == null) _endTime = property.FindPropertyRelative("endTime");
+            if (_start == null) _start = property.FindPropertyRelative("start");
+            if (_end == null) _end = property.FindPropertyRelative("end");
 
             // Calculate the bounds of the child fields
             Rect rect = new Rect(position);
             rect.width = (position.width - horizontalSpacing) / 2;
 
             // Draw the child fields
-            rect = SliderWithChangeCheck(_startTime, rect, "Start");
-            rect = SliderWithChangeCheck(_endTime, rect, "End");
+            rect = FloatFieldWithChangeCheck(_start, rect);
+            rect = FloatFieldWithChangeCheck(_end, rect);
 
             // Set sizes back to their original values
             EditorGUI.indentLevel = originalIndent;
@@ -46,17 +46,17 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten
             EditorGUI.EndProperty();
         }
 
-        private Rect SliderWithChangeCheck(SerializedProperty property, Rect position, string displayName)
+        private Rect FloatFieldWithChangeCheck(SerializedProperty property, Rect position)
         {
             // Check for changes in the field's value
             EditorGUI.BeginChangeCheck();
 
             // Calculate the width of the field label
-            GUIContent label = new GUIContent(displayName);
+            GUIContent label = new GUIContent(property.displayName);
             EditorGUIUtility.labelWidth = EditorStyles.label.CalcSize(label).x;
 
             // Draw the field and store the field's value
-            float value = EditorGUI.Slider(position, label, property.floatValue, 0.0f, 1.0f);
+            float value = EditorGUI.FloatField(position, label, property.floatValue);
 
             // Update the property's value from the field
             if (EditorGUI.EndChangeCheck()) {

Editor/TimingPropertyDrawer.cs

@@ -20,7 +20,7 @@ public struct Timing
         [Tooltip("The end time of the animation.")]
         public float end;
 
-        /// <summary>Constructs a new Timing with the given <paramref name="start"/> and <paramref name="end"/>.</summary>
+        /// <summary>Constructs a new timing with the given <paramref name="start"/> and <paramref name="end"/>.</summary>
         /// <param name="start">The start time of the animation.</param>
         /// <param name="end">The end time of the animation.</param>
         public Timing(float start, float end)
@@ -37,7 +37,7 @@ public float Random()
             return UnityEngine.Random.Range(this.start, this.end);
         }
 
-        /// <returns>Whether the given <paramref name="time"/> is within range of the animation timing.</returns>
+        /// <returns>Whether the given <paramref name="time"/> is within the start and end time.</returns>
         /// <param name="time">The time to check.</param>
         public bool Includes(float time)
         {

Runtime/DataStructures/Timing.cs

@@ -0,0 +1,66 @@
+using UnityEngine;
+
+namespace Zigurous.Animation
+{
+    /// <summary>
+    /// Represents the start and end time of an animation normalized between 0
+    /// and 1.
+    /// </summary>
+    [System.Serializable]
+    public struct Timing01
+    {
+        [SerializeField]
+        [Tooltip("The start time of the animation, between 0 and 1.")]
+        [Range(0.0f, 1.0f)]
+        private float _start;
+
+        /// <summary>
+        /// The start time of the animation, between 0 and 1.
+        /// </summary>
+        public float start
+        {
+            get => _start;
+            set => _start = Mathf.Clamp01(value);
+        }
+
+        [SerializeField]
+        [Tooltip("The end time of the animation, between 0 and 1.")]
+        [Range(0.0f, 1.0f)]
+        private float _end;
+
+        /// <summary>
+        /// The end time of the animation, between 0 and 1.
+        /// </summary>
+        public float end
+        {
+            get => _end;
+            set => _end = Mathf.Clamp01(value);
+        }
+
+        /// <summary>Constructs a new timing with the given <paramref name="start"/> and <paramref name="end"/>.</summary>
+        /// <param name="start">The start time of the animation, between 0 and 1.</param>
+        /// <param name="end">The end time of the animation, between 0 and 1.</param>
+        public Timing01(float start, float end)
+        {
+            _start = Mathf.Clamp01(start);
+            _end = Mathf.Clamp01(end);
+        }
+
+        /// <returns>
+        /// A random time within the start and end time.
+        /// </returns>
+        public float Random()
+        {
+            return UnityEngine.Random.Range(this.start, this.end);
+        }
+
+        /// <returns>Whether the given <paramref name="time"/> is within the start and end time.</returns>
+        /// <param name="time">The time to check.</param>
+        public bool Includes(float time)
+        {
+            return time >= this.start && time <= this.end;
+        }
+
+    }
+
+}