com.unity.splines@2.4.0

## [2.4.0] - 2023-07-26

### Added

- Exposed public APIs for `SplineUtility.ReverseFlow`, `SplineUtility.JoinSplinesOnKnots`, and  `SplineUtility.SplitSplineOnKnot`.

### Changed

- For Editor versions of 2023.2 or newer, added clipboard operations for Splines to the Scene view context menu.
- Changed `Splines/Cycle Active Spline` shortcut to Shift-S to remove a conflict with Unity default shortcuts.
- [SPLB-163] Improved performance of spline handles by caching spline data.
- [SPLB-167] Changed the evaluation of up vectors to use a cache instead of re-evaluate the values on every single request.
- In Editor versions of 2023.2 or newer, moved the following actions from the Element Inspector to the Scene view context menu: Link, Unlink, Split, Join, and Reverse Spline Flow.

### Bug Fixes

- [SPLB-176] Fixed a regression where the up vector would not evaluate correctly for some curves.
- Fixed the setter for SplineAnimate.Normalized time to handle ping-pong direction correctly when set.
- Fixed a bug where setting the time value to 0 after reaching the end of the spline animation was not resetting the object position.
- [SPLB-169] Fixed a bug where `CurveUtility.GetNearestPoint` would return incorrect values for the interpolation.

Author: Unity Technologies

CHANGELOG.md

@@ -5,6 +5,30 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+
+## [2.4.0] - 2023-07-26
+
+### Added
+
+- Exposed public APIs for `SplineUtility.ReverseFlow`, `SplineUtility.JoinSplinesOnKnots`, and  `SplineUtility.SplitSplineOnKnot`.
+
+### Changed
+
+- For Editor versions of 2023.2 or newer, added clipboard operations for Splines to the Scene view context menu.
+- Changed `Splines/Cycle Active Spline` shortcut to Shift-S to remove a conflict with Unity default shortcuts.
+- [SPLB-163] Improved performance of spline handles by caching spline data.
+- [SPLB-167] Changed the evaluation of up vectors to use a cache instead of re-evaluate the values on every single request.
+- In Editor versions of 2023.2 or newer, moved the following actions from the Element Inspector to the Scene view context menu: Link, Unlink, Split, Join, and Reverse Spline Flow. 
+
+### Bug Fixes
+
+- [SPLB-176] Fixed a regression where the up vector would not evaluate correctly for some curves.
+- Fixed the setter for SplineAnimate.Normalized time to handle ping-pong direction correctly when set.
+- Fixed a bug where setting the time value to 0 after reaching the end of the spline animation was not resetting the object position.
+- [SPLB-169] Fixed a bug where `CurveUtility.GetNearestPoint` would return incorrect values for the interpolation.
+
 ## [2.3.0] - 2023-05-31
 
 ### Added

Editor/Controls/CurveHandles.cs

@@ -7,11 +7,10 @@ namespace UnityEditor.Splines
 {
     static class CurveHandles
     {
-        const int k_CurveDrawResolution = 72;
         const float k_CurveLineWidth = 4f;
         const float k_PreviewCurveOpacity = 0.5f;
 
-        static readonly Vector3[] s_CurveDrawingBuffer = new Vector3[k_CurveDrawResolution + 1];
+        static readonly Vector3[] s_CurveDrawingBuffer = new Vector3[SplineCacheUtility.CurveDrawResolution + 1];
         static readonly Vector3[] s_FlowTriangleVertices = new Vector3[3];
 
         /// <summary>
@@ -48,9 +47,9 @@ internal static void Draw(BezierCurve curve, bool activeSpline)
         /// <param name="activeSpline">Whether the curve is part of the active spline.</param>
         internal static void DrawWithHighlight(
             int controlID,
-            BezierCurve curve,
             ISpline spline,
             int curveIndex,
+            float4x4 localToWorld,
             SelectableKnot knotA,
             SelectableKnot knotB,
             bool activeSpline)
@@ -62,13 +61,14 @@ internal static void DrawWithHighlight(
                 case EventType.MouseMove:
                     if (!SplineHandles.ViewToolActive() && activeSpline)
                     {
+                        var curve = spline.GetCurve(curveIndex).Transform(localToWorld);
                         var dist = DistanceToCurve(curve);
                         HandleUtility.AddControl(controlID, Mathf.Max(0, dist - SplineHandleUtility.pickingDistance));
                         //Trigger repaint on MouseMove to update highlight visuals from SplineHandles
                         if (evt.type == EventType.MouseMove || controlID == HandleUtility.nearestControl)
                         {
                             SplineHandleUtility.GetNearestPointOnCurve(curve, out _, out var t);
-                            var curveMidT = GetCurveMiddleInterpolation(curve, spline, curveIndex);
+                            var curveMidT = EditorSplineUtility.GetCurveMiddleInterpolation(curve, spline, curveIndex);
                             var hoveredKnot = t <= curveMidT ? knotA : knotB;
 
                             if (!(SplineHandleUtility.lastHoveredElement is SelectableKnot knot) || !knot.Equals(hoveredKnot))
@@ -81,6 +81,7 @@ internal static void DrawWithHighlight(
                     break;
 
                 case EventType.MouseDown:
+                    var curveMD = spline.GetCurve(curveIndex).Transform(localToWorld);
                     if (!SplineHandles.ViewToolActive() && HandleUtility.nearestControl == controlID)
                     {
                         //Clicking a knot selects it
@@ -90,7 +91,7 @@ internal static void DrawWithHighlight(
                         GUIUtility.hotControl = controlID;
                         evt.Use();
 
-                        SplineHandleUtility.GetNearestPointOnCurve(curve, out _, out var t);
+                        SplineHandleUtility.GetNearestPointOnCurve(curveMD, out _, out var t);
                         SplineSelectionUtility.HandleSelection(t <= .5f ? knotA : knotB, false);
                     }
                     break;
@@ -105,96 +106,35 @@ internal static void DrawWithHighlight(
             }
         }
 
-        /// <summary>
-        /// Draws curve and flow for a BezierCurve without the highlight.
-        /// </summary>
-        /// <param name="controlID">The controlID of the curve to create highlights for.</param>
-        /// <param name="curve">The <see cref="BezierCurve"/> to create highlights for.</param>
-        /// <param name="spline">The <see cref="ISpline"/> (if any) that the curve belongs to.</param>
-        /// <param name="curveIndex">The curve's index if it belongs to a spline - otherwise -1.</param>
-        /// <param name="knotA">The knot at the start of the curve.</param>
-        /// <param name="knotB">The knot at the end of the curve.</param>
-        /// <param name="activeSpline">Whether the curve is part of the active spline.</param>
-        internal static void DrawWithoutHighlight(
-            int controlID,
-            BezierCurve curve,
-            ISpline spline,
-            int curveIndex,
-            SelectableKnot knotA,
-            SelectableKnot knotB,
-            bool activeSpline)
-        {
-            var evt = Event.current;
-            switch (evt.GetTypeForControl(controlID))
-            {
-                case EventType.Repaint:
-                    Draw(controlID, curve, false, activeSpline);
-                    if (SplineHandleSettings.FlowDirectionEnabled && activeSpline)
-                        DrawFlow(curve, spline, curveIndex, math.rotate(knotA.Rotation, math.up()), math.rotate(knotB.Rotation, math.up()));
-                    break;
-            }
-        }
-
         /// <summary>
         /// Draws flow on a BezierCurve to indicate the direction.
         /// </summary>
         /// <param name="curve">The <see cref="BezierCurve"/> to create highlights for.</param>
         /// <param name="spline">The <see cref="ISpline"/> (if any) that the curve belongs to.</param>
         /// <param name="curveIndex">The curve's index if it belongs to a spline - otherwise -1.</param>
-        /// <param name="upAtStart">The up vector at the start of the curve.</param>
-        /// <param name="upAtEnd">The up vector at the end of the curve.</param>
-        internal static void DrawFlow(BezierCurve curve, ISpline spline, int curveIndex, Vector3 upAtStart, Vector3 upAtEnd)
+        internal static void DrawFlow(BezierCurve curve, ISpline spline, int curveIndex)
         {
             if(Event.current.type != EventType.Repaint)
                 return;
 
-            var curveMidT = GetCurveMiddleInterpolation(curve, spline, curveIndex);
-            var arrow = GetFlowArrowData(curve, curveMidT, upAtStart, upAtEnd);
-            s_FlowTriangleVertices[0] = arrow.pointA;
-            s_FlowTriangleVertices[1] = arrow.pointB;
-            s_FlowTriangleVertices[2] = arrow.pointC;
+            var arrow = SplineCacheUtility.GetCurveArrow(spline, curveIndex, curve);
+            s_FlowTriangleVertices[0] = arrow.positions[0];
+            s_FlowTriangleVertices[1] = arrow.positions[1];
+            s_FlowTriangleVertices[2] = arrow.positions[2];
 
-            using (new Handles.DrawingScope(SplineHandleUtility.lineColor, arrow.transform))
+            using (new Handles.DrawingScope(SplineHandleUtility.lineColor, arrow.trs))
             {
                 using (new ZTestScope(CompareFunction.Less))
                     Handles.DrawAAConvexPolygon(s_FlowTriangleVertices);
             }
 
-            using (new Handles.DrawingScope(SplineHandleUtility.lineBehindColor, arrow.transform))
+            using (new Handles.DrawingScope(SplineHandleUtility.lineBehindColor, arrow.trs))
             {
                 using (new ZTestScope(CompareFunction.Greater))
                     Handles.DrawAAConvexPolygon(s_FlowTriangleVertices);
             }
         }
 
-        public static (Vector3 pointA, Vector3 pointB, Vector3 pointC, Matrix4x4 transform) GetFlowArrowData(BezierCurve curve, float t, Vector3 upAtStart, Vector3 upAtEnd, float sizeMultiplier = 1f)
-        {
-            var position = (Vector3)CurveUtility.EvaluatePosition(curve, t);
-            var tangent = ((Vector3)CurveUtility.EvaluateTangent(curve, t)).normalized;
-            var up = CurveUtility.EvaluateUpVector(curve, t, upAtStart, upAtEnd);
-            var rotation = Quaternion.LookRotation(tangent, up);
-
-            var arrowMaxSpline = .05f * CurveUtility.ApproximateLength(curve);
-            var size = HandleUtility.GetHandleSize(position) * .5f * sizeMultiplier;
-
-            tangent = new Vector3(0, 0, .1f) * size;
-            var right = new Vector3(0.075f, 0, 0) * size;
-            var magnitude = tangent.magnitude;
-
-            if(magnitude > arrowMaxSpline)
-            {
-                var ratio = arrowMaxSpline / magnitude;
-                tangent *= ratio;
-                right *= ratio;
-            }
-
-            var a = tangent;
-            var b = -tangent + right;
-            var c = -tangent - right;
-
-            return (pointA: a, pointB: b, pointC: c, transform: Matrix4x4.TRS(position, rotation, Vector3.one));
-        }
-
         static void Draw(int controlID, BezierCurve curve, bool preview, bool activeSpline)
         {
             var evt = Event.current;
@@ -237,11 +177,7 @@ static void Draw(int controlID, BezierCurve curve, bool preview, bool activeSpli
 
         static void FillCurveDrawingBuffer(BezierCurve curve)
         {
-            const float segmentPercentage = 1f / k_CurveDrawResolution;
-            for (int i = 0; i <= k_CurveDrawResolution; ++i)
-            {
-                s_CurveDrawingBuffer[i] = CurveUtility.EvaluatePosition(curve, i * segmentPercentage);
-            }
+            SplineCacheUtility.GetCurvePositions(curve, s_CurveDrawingBuffer);
         }
 
         internal static float DistanceToCurve(BezierCurve curve)
@@ -263,25 +199,6 @@ static float DistanceToCurve()
             return dist;
         }
 
-        /// <summary>
-        /// Returns the interpolation value that corresponds to the middle (distance wise) of the curve.
-        /// If spline and curveIndex are provided, the function leverages the spline's LUTs, otherwise the LUT is built on the fly.
-        /// </summary>
-        /// <param name="curve">The curve to evaluate.</param>
-        /// <param name="spline">The ISpline that curve belongs to. Not used if curve is not part of any spline.</param>
-        /// <param name="curveIndex">The index of the curve if it's part of the spine.</param>
-        /// <typeparam name="T">A type implementing ISpline.</typeparam>
-        internal static float GetCurveMiddleInterpolation<T>(BezierCurve curve, T spline, int curveIndex) where T: ISpline
-        {
-            var curveMidT = 0f;
-            if (curveIndex >= 0)
-                curveMidT = spline.GetCurveInterpolation(curveIndex, spline.GetCurveLength(curveIndex) * 0.5f);
-            else
-                curveMidT = CurveUtility.GetDistanceToInterpolation(curve, CurveUtility.ApproximateLength(curve) * 0.5f);
-
-            return curveMidT;
-        }
-
         internal static void DoCurveHighlightCap(SelectableKnot knot)
         {
             if(Event.current.type != EventType.Repaint)
@@ -295,14 +212,14 @@ internal static void DoCurveHighlightCap(SelectableKnot knot)
                 if(knot.KnotIndex > 0 || spline.Closed)
                 {
                     var curve = spline.GetCurve(spline.PreviousIndex(knot.KnotIndex)).Transform(localToWorld);
-                    var curveMiddleT = GetCurveMiddleInterpolation(curve, spline, spline.PreviousIndex(knot.KnotIndex));
+                    var curveMiddleT = EditorSplineUtility.GetCurveMiddleInterpolation(curve, spline, spline.PreviousIndex(knot.KnotIndex));
                     DrawCurveHighlight(curve, 1f, curveMiddleT);
                 }
 
                 if(knot.KnotIndex < spline.Count - 1  || spline.Closed)
                 {
                     var curve = spline.GetCurve(knot.KnotIndex).Transform(localToWorld);
-                    var curveMiddleT = GetCurveMiddleInterpolation(curve, spline, knot.KnotIndex);
+                    var curveMiddleT = EditorSplineUtility.GetCurveMiddleInterpolation(curve, spline, knot.KnotIndex);
                     DrawCurveHighlight(curve, 0f, curveMiddleT);
                 }
             }
@@ -327,11 +244,11 @@ static void DrawCurveHighlight(BezierCurve curve, float startT, float endT)
 
         static void DrawAAPolyLineForCurveHighlight(Color color, float startT, float endT, float colorAlpha, bool growing)
         {
-            for (int i = 1; i <= k_CurveDrawResolution; ++i)
+            for (int i = 1; i <= SplineCacheUtility.CurveDrawResolution; ++i)
             {
                 Handles.DrawAAPolyLine(SplineHandleUtility.denseLineAATex, k_CurveLineWidth, new[] { s_CurveDrawingBuffer[i - 1], s_CurveDrawingBuffer[i] });
 
-                var current = ((float)i / (float)k_CurveDrawResolution);
+                var current = ((float)i / (float)SplineCacheUtility.CurveDrawResolution);
                 if (growing)
                 {
                     if (current > endT)
@@ -355,7 +272,6 @@ static void DrawAAPolyLineForCurveHighlight(Color color, float startT, float end
         /// Creates the set of control points that make up a curve.
         /// </summary>
         /// <param name="curve">The <see cref="BezierCurve"/> to create control points for.</param>
-
         public static void DrawControlNet(BezierCurve curve)
         {
             Handles.color = Color.green;
@@ -373,4 +289,4 @@ public static void DrawControlNet(BezierCurve curve)
             Handles.DrawDottedLine(curve.P2, curve.P3, 2f);
         }
     }
-}
+}

Editor/Controls/KnotHandles.cs

@@ -26,22 +26,12 @@ internal static void Do(int controlId, SelectableKnot knot, bool selected = fals
             //Hovered might not be available if a TRS tool is in use
             hovered &= SplineHandleUtility.IsHoverAvailableForSplineElement();
 
-#if UNITY_2022_2_OR_NEWER
-            var knotColor = Handles.elementColor;
-            var rotationDiscColor = Handles.elementPreselectionColor;
+            var knotColor = SplineHandleUtility.elementColor;
+            var rotationDiscColor = SplineHandleUtility.elementPreselectionColor;
             if (hovered)
-                knotColor = Handles.elementPreselectionColor;
+                knotColor = SplineHandleUtility.elementPreselectionColor;
             else if (selected)
-                knotColor = Handles.elementSelectionColor;
-#else
-            var knotColor = SplineHandleUtility.knotColor;
-            var highlightColor = SplineHandleUtility.knotColor;
-            var rotationDiscColor = Handles.preselectionColor;
-            if (hovered)
-                knotColor = Handles.preselectionColor;
-            else if (selected)
-                knotColor = Handles.selectedColor;
-#endif
+                knotColor = SplineHandleUtility.elementSelectionColor;
 
             Draw(knot.Position, knot.Rotation, knotColor, selected, hovered, rotationDiscColor, k_KnotRotDiscWidthHover);    
             DrawKnotIndices(knot);
@@ -127,35 +117,19 @@ internal static void Draw(int controlId, SelectableKnot knot)
             //Hovered might not be available if a TRS tool is in use
             hovered &= SplineHandleUtility.IsHoverAvailableForSplineElement();
 
-#if UNITY_2022_2_OR_NEWER
-            var knotColor = Handles.elementColor;
-            var highlightColor = Handles.elementPreselectionColor;
-            var rotationDiscColor = Handles.elementPreselectionColor;
-            if (hovered)
-            {
-                knotColor = Handles.elementPreselectionColor;
-                highlightColor = Handles.elementPreselectionColor;
-            }
-            else if (selected)
-            {
-                knotColor = Handles.elementSelectionColor;
-                highlightColor = Handles.elementSelectionColor;
-            }
-#else
-            var knotColor = SplineHandleUtility.knotColor;
-            var highlightColor = SplineHandleUtility.knotColor;
-            var rotationDiscColor = Handles.preselectionColor;
+            var knotColor = SplineHandleUtility.elementColor;
+            var highlightColor = SplineHandleUtility.elementPreselectionColor;
+            var rotationDiscColor = SplineHandleUtility.elementPreselectionColor;
             if (hovered)
             {
-                knotColor = Handles.preselectionColor;
-                highlightColor = Handles.preselectionColor;
+                knotColor = SplineHandleUtility.elementPreselectionColor;
+                highlightColor = SplineHandleUtility.elementPreselectionColor;
             }
             else if (selected)
             {
-                knotColor = Handles.selectedColor;
-                highlightColor = Handles.selectedColor;
+                knotColor = SplineHandleUtility.elementSelectionColor;
+                highlightColor = SplineHandleUtility.elementSelectionColor;
             }
-#endif
 
             if (SplineHandleUtility.canDrawOnCurves && (hovered || selected))
             {

Editor/Controls/SplineElementRectSelector.cs

@@ -225,4 +225,4 @@ static Rect GetRectFromPoints(Vector2 a, Vector2 b)
             return new Rect(min, max - min);
         }
     }
-}
+}