com.unity.splines@2.5.1

## [2.5.1] - 2023-10-17

### Bug Fixes

- [SPLB-208] Fixed a bug where `SplineToolContext` would attempt to draw empty Splines and flood the console with errors.

## [2.5.0] - 2023-10-16

### Added

- Exposed public API for `SplineInstantiate.Seed`.

### Bug Fixes

- [SPLB-201] Fixed error messages showing in edit mode with spline components.
- [SPLB-203] Fixed a bug where baking `SplineInstantiate` instances broke prefab connections.
- [SPLB-196] Fixed a bug where the `Random` state was not restored after an update of the instances in `SplineInstantiate`.
- Fixed a bug where the `SplineCacheUtility` would send null reference exceptions.
- [SPLB-183] Fixed a bug where duplicating the `SplineExtrude` component was not updating the mesh asset reference.
- [SPLB-178] Fixed a bug where linking knots would not trigger a `Spline.changed` event.
- [SPLB-185] Fixed a bug where the Up vector evaluation would return NaN values when normals and curve tangents are parallel.

### Changed

- [SPLB-187] Fixed a bug where `Spline.EvaluatePosition` was allocating memory when called.
- [SPLB-181] Fixed a bug where the Auto tangent mode computed incorrect knot rotations.
- Changed the `SplineComponent` display name in the Inspector to `Spline Container` as a response to user feedback.

Author: Unity Technologies

.buginfo

@@ -1,4 +1,5 @@
 system: jira
 server: jira.unity3d.com
 project: SPLB
-issuetype: Bug
+issuetype: Bug
+package: Splines

CHANGELOG.md

@@ -5,8 +5,33 @@ 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.5.1] - 2023-10-17
 
+### Bug Fixes
+
+- [SPLB-208] Fixed a bug where `SplineToolContext` would attempt to draw empty Splines and flood the console with errors.
+
+## [2.5.0] - 2023-10-16
+
+### Added
+
+- Exposed public API for `SplineInstantiate.Seed`.
+
+### Bug Fixes
+
+- [SPLB-201] Fixed error messages showing in edit mode with spline components.
+- [SPLB-203] Fixed a bug where baking `SplineInstantiate` instances broke prefab connections.
+- [SPLB-196] Fixed a bug where the `Random` state was not restored after an update of the instances in `SplineInstantiate`.
+- Fixed a bug where the `SplineCacheUtility` would send null reference exceptions.
+- [SPLB-183] Fixed a bug where duplicating the `SplineExtrude` component was not updating the mesh asset reference.
+- [SPLB-178] Fixed a bug where linking knots would not trigger a `Spline.changed` event. 
+- [SPLB-185] Fixed a bug where the Up vector evaluation would return NaN values when normals and curve tangents are parallel.
+
+### Changed
+
+- [SPLB-187] Fixed a bug where `Spline.EvaluatePosition` was allocating memory when called.
+- [SPLB-181] Fixed a bug where the Auto tangent mode computed incorrect knot rotations.
+- Changed the `SplineComponent` display name in the Inspector to `Spline Container` as a response to user feedback. 
 
 ## [2.4.0] - 2023-07-26
 

Editor/Components/SplineAnimateEditor.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Collections.Generic;
 using System.Linq;
 using UnityEngine.Splines;
 using UnityEditor.UIElements;
@@ -19,10 +18,7 @@ class SplineAnimateEditor : UnityEditor.Editor
         EnumField m_ObjectForwardField;
         EnumField m_ObjectUpField;
 
-        SerializedProperty m_TargetProperty;
         SerializedProperty m_MethodProperty;
-        SerializedProperty m_DurationProperty;
-        SerializedProperty m_SpeedProperty;
         SerializedProperty m_ObjectForwardProperty;
         SerializedProperty m_ObjectUpProperty;
         SerializedProperty m_StartOffsetProperty;
@@ -45,10 +41,7 @@ void OnEnable()
             m_SplineAnimate.Updated += OnSplineAnimateUpdated;
 
             try {
-                m_TargetProperty = serializedObject.FindProperty("m_Target");
                 m_MethodProperty = serializedObject.FindProperty("m_Method");
-                m_DurationProperty = serializedObject.FindProperty("m_Duration");
-                m_SpeedProperty = serializedObject.FindProperty("m_MaxSpeed");
                 m_ObjectForwardProperty = serializedObject.FindProperty("m_ObjectForwardAxis");
                 m_ObjectUpProperty = serializedObject.FindProperty("m_ObjectUpAxis");
                 m_StartOffsetProperty = serializedObject.FindProperty("m_StartOffset");
@@ -146,7 +139,7 @@ public override VisualElement CreateInspectorGUI()
                 s_ThemeStyleSheet = AssetDatabase.LoadAssetAtPath<StyleSheet>($"Packages/com.unity.splines/Editor/Stylesheets/SplineAnimateInspector{(EditorGUIUtility.isProSkin ? "Dark" : "Light")}.uss");
 
             m_Root.styleSheets.Add(s_ThemeStyleSheet);
-
+            
             var methodField = m_Root.Q<PropertyField>("method");
             methodField.RegisterValueChangeCallback((_) => { RefreshMethodParamFields((SplineAnimate.Method)m_MethodProperty.enumValueIndex); });
             RefreshMethodParamFields((SplineAnimate.Method)m_MethodProperty.enumValueIndex);

Editor/Controls/SplineHandles.cs

@@ -96,7 +96,9 @@ public static void DoHandles(IReadOnlyList<SplineInfo> splines)
                 // Drawing done in two separate passes to make sure the curves are drawn behind the spline elements.
                 // Draw the curves.
                 for (int i = 0; i < splines.Count; ++i)
+                {
                     DoSegmentsHandles(splines[i]);
+                }
 
                 DoKnotsAndTangentsHandles(splines);
             }
@@ -147,6 +149,9 @@ public static void DoKnotsAndTangentsHandles(IReadOnlyList<SplineInfo> splines)
         public static void DoSegmentsHandles(SplineInfo splineInfo)
         {
             var spline = splineInfo.Spline;
+            if (spline == null || spline.Count < 2)
+                return;
+
             var localToWorld = splineInfo.LocalToWorld;
 
             // If the spline isn't closed, skip the last index of the spline

Editor/GUI/Editors/SplineComponentEditor.cs

@@ -5,6 +5,8 @@
 class SplineComponentEditor : Editor
 {
     static GUIStyle s_FoldoutStyle;
+    
+    internal static readonly string k_Helpbox = L10n.Tr("Instantiated Objects need a SplineContainer target to be created.");
 
     protected bool Foldout(bool foldout, GUIContent content)
     {

Editor/GUI/Editors/SplineExtrudeEditor.cs

@@ -100,6 +100,9 @@ public override void OnInspectorGUI()
             EditorGUI.BeginChangeCheck();
 
             EditorGUILayout.PropertyField(m_Container, new GUIContent(k_Spline, m_Container.tooltip));
+            if(m_Container.objectReferenceValue == null)
+                EditorGUILayout.HelpBox(k_Helpbox, MessageType.Warning);
+            
             EditorGUILayout.LabelField(k_Geometry, EditorStyles.boldLabel);
 
             if(m_AnyMissingMesh)

Editor/GUI/Editors/SplineInstantiateEditor.cs

@@ -107,6 +107,7 @@ enum SpawnType
     SerializedProperty m_ItemsToInstantiate;
     SerializedProperty m_InstantiateMethod;
 
+    SerializedProperty m_Seed;
     SerializedProperty m_Space;
     SerializedProperty m_UpAxis;
     SerializedProperty m_ForwardAxis;
@@ -123,8 +124,6 @@ enum SpawnType
         L10n.Tr("Spacing (Linear)")
     };
 
-    static readonly string k_Helpbox = L10n.Tr("Instantiated Objects need a SplineContainer target to be created.");
-
     //Setup Section
     static readonly string k_Setup = L10n.Tr("Instantiated Object Setup");
     static readonly string k_ObjectUp = L10n.Tr("Up Axis");
@@ -143,7 +142,6 @@ enum SpawnType
     SpawnType m_SpacingType;
 
     //Offsets
-    static readonly string k_Offset = L10n.Tr("Offsets");
     static readonly string k_PositionOffset = L10n.Tr("Position Offset");
     static readonly string k_PositionOffsetTooltip = L10n.Tr("Whether or not to use a position offset.");
     static readonly string k_RotationOffset = L10n.Tr("Rotation Offset");
@@ -156,6 +154,9 @@ enum SpawnType
     static readonly string k_AutoRefresh = L10n.Tr("Auto Refresh Generation");
     static readonly string k_AutoRefreshTooltip = L10n.Tr("Automatically refresh the instances when the spline or the values are changed.");
 
+    static readonly string k_Seed = L10n.Tr("Randomization Seed");
+    static readonly string k_SeedTooltip = L10n.Tr("Value used to initialize the pseudorandom number generator of the instances.");
+    
     static readonly string k_Randomize = L10n.Tr("Randomize");
     static readonly string k_RandomizeTooltip = L10n.Tr("Compute a new randomization of the instances along the spline.");
     static readonly string k_Regenerate = L10n.Tr("Regenerate");
@@ -204,6 +205,7 @@ bool Initialize()
         m_PositionOffset = serializedObject.FindProperty("m_PositionOffset");
         m_RotationOffset = serializedObject.FindProperty("m_RotationOffset");
         m_ScaleOffset = serializedObject.FindProperty("m_ScaleOffset");
+        m_Seed = serializedObject.FindProperty("m_Seed");
 
         m_AutoRefresh = serializedObject.FindProperty("m_AutoRefresh");
 
@@ -276,13 +278,18 @@ public override void OnInspectorGUI()
         EditorGUI.BeginChangeCheck();
         EditorGUILayout.PropertyField(m_ItemsToInstantiate);
         dirtyInstances = EditorGUI.EndChangeCheck();
-
+        
         DoSetupSection();
         dirtyInstances |= DoInstantiateSection();
         updateInstances |= DisplayOffsets();
 
         EditorGUILayout.LabelField(k_Generation, EditorStyles.boldLabel);
         EditorGUI.indentLevel++;
+        EditorGUI.BeginChangeCheck();
+        EditorGUILayout.PropertyField(m_Seed, new GUIContent(k_Seed, k_SeedTooltip));
+        var newSeed = EditorGUI.EndChangeCheck();
+        dirtyInstances |= newSeed;
+        updateInstances |= newSeed;
         EditorGUILayout.PropertyField(m_AutoRefresh, new GUIContent(k_AutoRefresh, k_AutoRefreshTooltip));
         EditorGUI.indentLevel--;
         serializedObject.ApplyModifiedProperties();
@@ -291,7 +298,7 @@ public override void OnInspectorGUI()
         EditorGUILayout.BeginHorizontal();
         EditorGUILayout.Space();
         if (GUILayout.Button(new GUIContent(k_Randomize, k_RandomizeTooltip), GUILayout.MaxWidth(100f)))
-        {
+        {            
             Undo.RecordObjects(targets, "Changing SplineInstantiate seed");
             splineInstantiate.Randomize();
             updateInstances = true;
@@ -318,16 +325,13 @@ public override void OnInspectorGUI()
         EditorGUILayout.Separator();
 
         if (dirtyInstances)
-        {
             splineInstantiate.SetDirty();
-            SceneView.RepaintAll();
-        }
 
         if (updateInstances)
-        {
             splineInstantiate.UpdateInstances();
+        
+        if (dirtyInstances || updateInstances)
             SceneView.RepaintAll();
-        }
     }
 
     void DoSetupSection()
@@ -599,19 +603,20 @@ void BakeInstances(SplineInstantiate splineInstantiate)
         splineInstantiate.UpdateInstances();
         for (int i = 0; i < splineInstantiate.instances.Count; ++i)
         {
-            var newInstance = Instantiate(splineInstantiate.instances[i], splineInstantiate.transform, true);
+            var newInstance = splineInstantiate.instances[i];
             newInstance.name = "Instance-" + i;
             newInstance.hideFlags = HideFlags.None;
+            newInstance.transform.SetParent(((SplineInstantiate)target).gameObject.transform, true);
 
             Undo.RegisterCreatedObjectUndo(newInstance, "Baking instance");
         }
 
+        splineInstantiate.instances.Clear();
         if(splineInstantiate.InstancesRoot != null)
             Undo.DestroyObjectImmediate(splineInstantiate.InstancesRoot);
 
         Undo.DestroyObjectImmediate(splineInstantiate);
 
-        splineInstantiate.instances.Clear();
         Undo.CollapseUndoOperations(group);
     }
 }

Editor/Tools/SplineToolContext.cs

@@ -275,7 +275,10 @@ void DeleteSelected()
             }
         }
 
-        void FrameSelected()
+        /// <summary>
+        /// This methods automatically frames the selected splines or spline elements in the scene view.
+        /// </summary>
+        public void FrameSelected()
         {
             Bounds selectionBounds;
             if (TransformOperation.canManipulate)

Editor/Utilities/SplineCacheUtility.cs

@@ -75,9 +75,7 @@ static void ClearCache(Spline spline, int knotIndex, SplineModification modifica
             if (knotIndex == -1 || modificationType != SplineModification.KnotModified)
             {
                 s_CurvesBuffers?.Clear();
-                
-                if(s_SplineCacheTable.ContainsKey(spline))
-                    s_SplineCacheTable[spline] = null;
+                s_SplineCacheTable.Remove(spline);
             }
             else // If Knot modified by the tools
             {
@@ -109,7 +107,7 @@ static void UpdateCachePosition(Spline spline, int curveIndex)
                     s_CurvesBuffers.Remove(curve);
             }
 
-            if (s_SplineCacheTable == null || !s_SplineCacheTable.ContainsKey(spline))
+            if (s_SplineCacheTable == null || !s_SplineCacheTable.ContainsKey(spline) || s_SplineCacheTable[spline] == null)
                 return;
 
             // Update position cache

Editor/Utilities/SplineExtrudeUtility.cs

@@ -0,0 +1,61 @@
+using UnityEngine;
+using UnityEngine.Splines;
+
+namespace UnityEditor.Splines
+{
+    [InitializeOnLoad]
+    public static class SplineExtrudeUtility
+    {
+        static SplineExtrudeUtility()
+        {            
+#if UNITY_2022_2_OR_NEWER
+            ClipboardUtility.duplicatedGameObjects += OnPasteOrDuplicated;
+            ClipboardUtility.pastedGameObjects += OnPasteOrDuplicated;
+#else
+            ObjectChangeEvents.changesPublished += ObjectEventChangesPublished;
+#endif
+        }
+
+#if UNITY_2022_2_OR_NEWER
+        static void OnPasteOrDuplicated(GameObject[] duplicates)
+        {
+            foreach (var duplicate in duplicates)
+                CheckForExtrudeMeshCreatedOrModified(duplicate);
+        }
+#else
+        static void ObjectEventChangesPublished(ref ObjectChangeEventStream stream)
+        {
+            for (int i = 0, c = stream.length; i < c; ++i)
+            {
+                // SplineExtrude was created via duplicate, copy paste
+                if (stream.GetEventType(i) == ObjectChangeKind.CreateGameObjectHierarchy)
+                {
+                    stream.GetCreateGameObjectHierarchyEvent(i, out CreateGameObjectHierarchyEventArgs data);
+                    GameObjectCreatedOrStructureModified(data.instanceId);
+                }
+            }
+        }
+        
+        static void GameObjectCreatedOrStructureModified(int instanceId)
+        {
+            if (EditorUtility.InstanceIDToObject(instanceId) is GameObject go)
+                CheckForExtrudeMeshCreatedOrModified(go);
+        }
+#endif
+        
+        static void CheckForExtrudeMeshCreatedOrModified(GameObject go)
+        {
+            //Check if the current GameObject has a SplineExtrude component
+            if(go.TryGetComponent<SplineExtrude>(out var extrudeComponent))
+                extrudeComponent.Reset();
+            
+            var childCount = go.transform.childCount;
+            if (childCount > 0)
+            {
+                //Check through the children
+                for(int childIndex = 0; childIndex < childCount; ++childIndex)
+                    CheckForExtrudeMeshCreatedOrModified(go.transform.GetChild(childIndex).gameObject);
+            }
+        }
+    }
+}