UPM package version 3.4.1

web-flow · web-flow · commit 6387c445d71b · 2023-03-05T11:39:35.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,8 @@
-# Changelog
+# Svelto.ECS Changelog
 All notable changes to this project will be documented in this file. Changes are listed in random order of importance.
 
-## [3.4.0] - 03-2023
-~~~~
+## [3.4.1] - 03-2023
+
 * removed static caches used in performance critical paths as they were causing unexpected performance issues (the fetching of static data is slower than i imagined)
 * add Native prefix in front of the native memory utilities method names
 * largely improved the console logger system
@@ -18,7 +18,7 @@ All notable changes to this project will be documented in this file. Changes are
 * Fix reported bugs
 * Minor Svelto Dictionary improvements
 * Added ValueContainer, a simple int, Tvalue dictionary based on sparse set. It has very specific use cases at the moment. Mainly to be used for the new ECS OOP Abstraction resoruce manager
-
+* Added IReactOnSubmissionStarted interface
 
 ## [3.3.2] - 04-06-2022
 
diff --git a/Core/CheckEntityUtilities.cs b/Core/CheckEntityUtilities.cs
@@ -85,9 +85,9 @@ void RemoveGroupID(ExclusiveBuildGroup groupID)
 #if DONT_USE
         [Conditional("MEANINGLESS")]
 #endif
-        void ClearDebugChecks() { _multipleOperationOnSameEGIDChecker.Clear(); }
+        void ClearChecksForMultipleOperationsOnTheSameEgid() { _multipleOperationOnSameEGIDChecker.Clear(); }
 
-        readonly Svelto.DataStructures.FasterDictionary<EGID, uint>                          _multipleOperationOnSameEGIDChecker;
-        readonly Svelto.DataStructures.FasterDictionary<ExclusiveGroupStruct, HashSet<uint>> _idChecker;
+        readonly DataStructures.FasterDictionary<EGID, uint>                          _multipleOperationOnSameEGIDChecker;
+        readonly DataStructures.FasterDictionary<ExclusiveGroupStruct, HashSet<uint>> _idChecker;
     }
 }
diff --git a/Core/ComponentBuilder.cs b/Core/ComponentBuilder.cs
@@ -48,7 +48,7 @@ static void Init()
         {
             id.Data = Interlocked.Increment(ref BurstCompatibleCounter.counter);
             
-            DBC.ECS.Check.Ensure(id.Data < ushort.MaxValue, "too many types registered, HOW :)");
+            Check.Ensure(id.Data < ushort.MaxValue, "too many types registered, HOW :)");
         }
     }
 
diff --git a/Core/DBC.cs b/Core/DBC.cs
@@ -224,7 +224,7 @@ public static void Assert(bool assertion)
 #endregion // Implementation
     }      // End Check
 
-    internal class Trace
+    class Trace
     {
         internal static void Assert(bool assertion, string v)
         {
diff --git a/Core/EGIDMapper.cs b/Core/EGIDMapper.cs
@@ -25,10 +25,10 @@ public ref T Entity(uint entityID)
         {
 #if DEBUG && !PROFILE_SVELTO
             if (_map == null)
-                throw new System.Exception(
+                throw new Exception(
                     "Not initialized EGIDMapper in this group ".FastConcat(typeof(T).ToString()));
             if (_map.TryFindIndex(entityID, out var findIndex) == false)
-                throw new System.Exception("Entity not found in this group ".FastConcat(typeof(T).ToString()));
+                throw new Exception("Entity not found in this group ".FastConcat(typeof(T).ToString()));
 #else
             _map.TryFindIndex(entityID, out var findIndex);
 #endif
diff --git a/Core/EnginesGroup/SortedEnginesGroup.cs b/Core/EnginesGroup/SortedEnginesGroup.cs
@@ -47,7 +47,7 @@ public abstract class SortedEnginesGroup<Interface, SequenceOrder> : IStepGroupE
     {
         protected SortedEnginesGroup(FasterList<Interface> engines)
         {
-            _name = "SortedEnginesGroup - "+this.GetType().Name;
+            _name = "SortedEnginesGroup - "+GetType().Name;
             _instancedSequence = new Sequence<Interface, SequenceOrder>(engines);
         }
 
@@ -80,7 +80,7 @@ public abstract class SortedEnginesGroup<Interface, Parameter, SequenceOrder>: I
     {
         protected SortedEnginesGroup(FasterList<Interface> engines)
         {
-            _name = "SortedEnginesGroup - "+this.GetType().Name;
+            _name = "SortedEnginesGroup - "+GetType().Name;
             _instancedSequence = new Sequence<Interface, SequenceOrder>(engines);
         }
 
diff --git a/Core/EnginesGroup/UnsortedEnginesGroup.cs b/Core/EnginesGroup/UnsortedEnginesGroup.cs
@@ -15,13 +15,13 @@ public abstract class UnsortedEnginesGroup<Interface> : IStepGroupEngine
     {
         protected UnsortedEnginesGroup()
         {
-            _name              = "UnsortedEnginesGroup - "+this.GetType().Name;
+            _name              = "UnsortedEnginesGroup - "+GetType().Name;
             _instancedSequence = new FasterList<Interface>();
         }
         
         protected UnsortedEnginesGroup(FasterList<Interface> engines)
         {
-            _name              = "UnsortedEnginesGroup - "+this.GetType().Name;
+            _name              = "UnsortedEnginesGroup - "+GetType().Name;
             _instancedSequence = engines;
         }
 
@@ -59,13 +59,13 @@ public abstract class UnsortedEnginesGroup<Interface, Parameter> : IStepGroupEng
     {
         protected UnsortedEnginesGroup()
         {
-            _name              = "UnsortedEnginesGroup - "+this.GetType().Name;
+            _name              = "UnsortedEnginesGroup - "+GetType().Name;
             _instancedSequence = new FasterList<Interface>();
         }
         
         protected UnsortedEnginesGroup(FasterList<Interface> engines)
         {
-            _name              = "UnsortedEnginesGroup - "+this.GetType().Name;
+            _name              = "UnsortedEnginesGroup - "+GetType().Name;
             _instancedSequence = engines;
         }
 
diff --git a/Core/EnginesRoot.Engines.cs b/Core/EnginesRoot.Engines.cs
@@ -330,7 +330,7 @@ public readonly struct EntitiesSubmitter
         {
             public EntitiesSubmitter(EnginesRoot enginesRoot): this()
             {
-                _enginesRoot = new Svelto.DataStructures.WeakReference<EnginesRoot>(enginesRoot);
+                _enginesRoot = new DataStructures.WeakReference<EnginesRoot>(enginesRoot);
             }
 
             internal void SubmitEntities()
@@ -360,7 +360,6 @@ internal void SubmitEntities()
 #if UNITY_NATIVE
                         enginesRootTarget.FlushNativeOperations(profiler);
 #endif
-                        //todo: proper unit test structural changes made as result of add/remove callbacks
                         while (enginesRootTarget.HasMadeNewStructuralChangesInThisIteration()
                             && iterations++ < MAX_SUBMISSION_ITERATIONS)
                         {
@@ -385,7 +384,7 @@ internal void SubmitEntities()
                 }
             }
 
-            readonly Svelto.DataStructures.WeakReference<EnginesRoot> _enginesRoot;
+            readonly DataStructures.WeakReference<EnginesRoot> _enginesRoot;
         }
 
         ~EnginesRoot()
diff --git a/Core/EnginesRoot.GenericEntityFunctions.cs b/Core/EnginesRoot.GenericEntityFunctions.cs
@@ -104,7 +104,7 @@ public void SwapEntityGroup<T>(EGID fromEGID, EGID toEGID, [CallerMemberName] st
                 enginesRootTarget.CheckAddEntityID(toEGID, TypeCache<T>.type, caller);
 
                 enginesRootTarget.QueueSwapEntityOperation(fromEGID, toEGID
-                                                         , this._enginesRoot.Target.FindRealComponents<T>(fromEGID)
+                                                         , _enginesRoot.Target.FindRealComponents<T>(fromEGID)
                                                          , caller);
             }
 
diff --git a/Core/EnginesRoot.Submission.cs b/Core/EnginesRoot.Submission.cs
@@ -11,6 +11,9 @@ public partial class EnginesRoot
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         void SingleSubmission(PlatformProfiler profiler)
         {
+            //clear the data checks before the submission. We want to allow structural changes inside the callbacks
+            ClearChecksForMultipleOperationsOnTheSameEgid();
+            
             _entitiesOperations.ExecuteRemoveAndSwappingOperations(
                 _swapEntities,
                 _removeEntities,
@@ -19,8 +22,9 @@ void SingleSubmission(PlatformProfiler profiler)
                 this);
 
             AddEntities(profiler);
-
-            ClearDebugChecks(); //this must be done first as I need the carry the last states after the submission
+            
+            //clear the data checks after the submission, so if structural changes happened inside the callback, the debug structure is reset for the next frame operations
+            ClearChecksForMultipleOperationsOnTheSameEgid();
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
@@ -476,7 +480,7 @@ void SwapEntitiesBetweenGroups(ExclusiveGroupStruct fromGroupId, ExclusiveGroupS
 
                 fromDictionary.AddEntitiesToDictionary(toDictionary, toGroupId
 #if SLOW_SVELTO_SUBMISSION
-                                         , this.entityLocator
+                                         , entityLocator
 #endif
                 );
             }
diff --git a/Core/EntitiesDB.cs b/Core/EntitiesDB.cs
@@ -205,6 +205,9 @@ public bool TryQueryMappedEntities<T>
             return true;
         }
 
+        /// <summary>
+        /// determine if component with specific ID exists in group
+        /// </summary>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public bool Exists<T>(EGID entityGID) where T : struct, _IInternalEntityComponent
         {
@@ -214,6 +217,9 @@ public bool Exists<T>(EGID entityGID) where T : struct, _IInternalEntityComponen
             return casted != null && casted.ContainsKey(entityGID.entityID);
         }
 
+        /// <summary>
+        /// determine if component with specific ID exists in group
+        /// </summary>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public bool Exists<T>(uint id, ExclusiveGroupStruct group) where T : struct, _IInternalEntityComponent
         {
@@ -223,6 +229,9 @@ public bool Exists<T>(uint id, ExclusiveGroupStruct group) where T : struct, _II
             return casted != null && casted.ContainsKey(id);
         }
 
+        /// <summary>
+        /// determine if group exists and is not empty
+        /// </summary>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public bool ExistsAndIsNotEmpty(ExclusiveGroupStruct gid)
         {
@@ -235,12 +244,18 @@ public bool ExistsAndIsNotEmpty(ExclusiveGroupStruct gid)
             return false;
         }
 
+        /// <summary>
+        /// determine if entities we specific components are found in group
+        /// </summary>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public bool HasAny<T>(ExclusiveGroupStruct groupStruct) where T : struct, _IInternalEntityComponent
         {
             return Count<T>(groupStruct) > 0;
         }
 
+        /// <summary>
+        /// count the number of components in a group
+        /// </summary>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public int Count<T>(ExclusiveGroupStruct groupStruct) where T : struct, _IInternalEntityComponent
         {
diff --git a/Core/Groups/ExclusiveGroupStruct.cs b/Core/Groups/ExclusiveGroupStruct.cs
@@ -48,11 +48,11 @@ public override int GetHashCode()
         public bool Equals(ExclusiveGroupStruct other)
         {
 #if DEBUG && !PROFILE_SVELTO
-            if ((other.id != this.id || other._bytemask == this._bytemask) == false)
+            if ((other.id != id || other._bytemask == _bytemask) == false)
                 throw new ECSException(
                     "if the groups are correctly initialised, two groups with the same ID and different bitmask cannot exist");
 #endif            
-            return other.id == this.id;
+            return other.id == id;
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
diff --git a/Core/Groups/QueryGroups.cs b/Core/Groups/QueryGroups.cs
@@ -6,7 +6,7 @@
 
 namespace Svelto.ECS.Experimental
 {
-    internal struct GroupsList
+    struct GroupsList
     {
         public static GroupsList Init()
         {
diff --git a/Core/Hybrid/ValueReference.cs b/Core/Hybrid/ValueReference.cs
@@ -25,5 +25,5 @@ public T ConvertAndDispose<W>(W implementer) where W:IImplementor
     }
 
     // Used to validate the use of this struct on the component builder check fields.
-    internal interface IValueReferenceInternal {}
+    interface IValueReferenceInternal {}
 }
diff --git a/Core/Streams/EntityStream.cs b/Core/Streams/EntityStream.cs
@@ -3,7 +3,7 @@
 
 namespace Svelto.ECS
 {
-    internal interface ITypeSafeStream
+    interface ITypeSafeStream
     {
         void Dispose();
     }
diff --git a/DataStructures/ITypeSafeDictionary.cs b/DataStructures/ITypeSafeDictionary.cs
@@ -92,6 +92,6 @@ void ExecuteEnginesDisposeCallbacks_Group
         uint GetIndex(uint valueEntityId);
         bool TryFindIndex(uint entityGidEntityId, out uint index);
 
-        void KeysEvaluator(System.Action<uint> action);
+        void KeysEvaluator(Action<uint> action);
     }
 }
diff --git a/DataStructures/TypeSafeDictionaryMethods.cs b/DataStructures/TypeSafeDictionaryMethods.cs
diff --git a/Serialization/EnginesRoot.GenericEntitySerialization.cs b/Serialization/EnginesRoot.GenericEntitySerialization.cs
diff --git a/Svelto.ECS.csproj b/Svelto.ECS.csproj
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -85,9 +85,9 @@ void RemoveGroupID(ExclusiveBuildGroup groupID)`
`85`	`85`	`#if DONT_USE`
`86`	`86`	`[Conditional("MEANINGLESS")]`
`87`	`87`	`#endif`
`88`		`- void ClearDebugChecks() { _multipleOperationOnSameEGIDChecker.Clear(); }`
	`88`	`+ void ClearChecksForMultipleOperationsOnTheSameEgid() { _multipleOperationOnSameEGIDChecker.Clear(); }`
`89`	`89`
`90`		`- readonly Svelto.DataStructures.FasterDictionary<EGID, uint> _multipleOperationOnSameEGIDChecker;`
`91`		`- readonly Svelto.DataStructures.FasterDictionary<ExclusiveGroupStruct, HashSet<uint>> _idChecker;`
	`90`	`+ readonly DataStructures.FasterDictionary<EGID, uint> _multipleOperationOnSameEGIDChecker;`
	`91`	`+ readonly DataStructures.FasterDictionary<ExclusiveGroupStruct, HashSet<uint>> _idChecker;`
`92`	`92`	`}`
`93`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ static void Init()`
`48`	`48`	`{`
`49`	`49`	`id.Data = Interlocked.Increment(ref BurstCompatibleCounter.counter);`
`50`	`50`
`51`		`- DBC.ECS.Check.Ensure(id.Data < ushort.MaxValue, "too many types registered, HOW :)");`
	`51`	`+ Check.Ensure(id.Data < ushort.MaxValue, "too many types registered, HOW :)");`
`52`	`52`	`}`
`53`	`53`	`}`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -224,7 +224,7 @@ public static void Assert(bool assertion)`
`224`	`224`	`#endregion // Implementation`
`225`	`225`	`} // End Check`
`226`	`226`
`227`		`- internal class Trace`
	`227`	`+ class Trace`
`228`	`228`	`{`
`229`	`229`	`internal static void Assert(bool assertion, string v)`
`230`	`230`	`{`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public abstract class SortedEnginesGroup<Interface, SequenceOrder> : IStepGroupE`
`47`	`47`	`{`
`48`	`48`	`protected SortedEnginesGroup(FasterList<Interface> engines)`
`49`	`49`	`{`
`50`		`- _name = "SortedEnginesGroup - "+this.GetType().Name;`
	`50`	`+ _name = "SortedEnginesGroup - "+GetType().Name;`
`51`	`51`	`_instancedSequence = new Sequence<Interface, SequenceOrder>(engines);`
`52`	`52`	`}`
`53`	`53`
`@@ -80,7 +80,7 @@ public abstract class SortedEnginesGroup<Interface, Parameter, SequenceOrder>: I`
`80`	`80`	`{`
`81`	`81`	`protected SortedEnginesGroup(FasterList<Interface> engines)`
`82`	`82`	`{`
`83`		`- _name = "SortedEnginesGroup - "+this.GetType().Name;`
	`83`	`+ _name = "SortedEnginesGroup - "+GetType().Name;`
`84`	`84`	`_instancedSequence = new Sequence<Interface, SequenceOrder>(engines);`
`85`	`85`	`}`
`86`	`86`
Original file line number	Diff line number	Diff line change
`@@ -15,13 +15,13 @@ public abstract class UnsortedEnginesGroup<Interface> : IStepGroupEngine`
`15`	`15`	`{`
`16`	`16`	`protected UnsortedEnginesGroup()`
`17`	`17`	`{`
`18`		`- _name = "UnsortedEnginesGroup - "+this.GetType().Name;`
	`18`	`+ _name = "UnsortedEnginesGroup - "+GetType().Name;`
`19`	`19`	`_instancedSequence = new FasterList<Interface>();`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`protected UnsortedEnginesGroup(FasterList<Interface> engines)`
`23`	`23`	`{`
`24`		`- _name = "UnsortedEnginesGroup - "+this.GetType().Name;`
	`24`	`+ _name = "UnsortedEnginesGroup - "+GetType().Name;`
`25`	`25`	`_instancedSequence = engines;`
`26`	`26`	`}`
`27`	`27`
`@@ -59,13 +59,13 @@ public abstract class UnsortedEnginesGroup<Interface, Parameter> : IStepGroupEng`
`59`	`59`	`{`
`60`	`60`	`protected UnsortedEnginesGroup()`
`61`	`61`	`{`
`62`		`- _name = "UnsortedEnginesGroup - "+this.GetType().Name;`
	`62`	`+ _name = "UnsortedEnginesGroup - "+GetType().Name;`
`63`	`63`	`_instancedSequence = new FasterList<Interface>();`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`protected UnsortedEnginesGroup(FasterList<Interface> engines)`
`67`	`67`	`{`
`68`		`- _name = "UnsortedEnginesGroup - "+this.GetType().Name;`
	`68`	`+ _name = "UnsortedEnginesGroup - "+GetType().Name;`
`69`	`69`	`_instancedSequence = engines;`
`70`	`70`	`}`
`71`	`71`
Original file line number	Diff line number	Diff line change
`@@ -330,7 +330,7 @@ public readonly struct EntitiesSubmitter`
`330`	`330`	`{`
`331`	`331`	`public EntitiesSubmitter(EnginesRoot enginesRoot): this()`
`332`	`332`	`{`
`333`		`- _enginesRoot = new Svelto.DataStructures.WeakReference<EnginesRoot>(enginesRoot);`
	`333`	`+ _enginesRoot = new DataStructures.WeakReference<EnginesRoot>(enginesRoot);`
`334`	`334`	`}`
`335`	`335`
`336`	`336`	`internal void SubmitEntities()`
`@@ -360,7 +360,6 @@ internal void SubmitEntities()`
`360`	`360`	`#if UNITY_NATIVE`
`361`	`361`	`enginesRootTarget.FlushNativeOperations(profiler);`
`362`	`362`	`#endif`
`363`		`- //todo: proper unit test structural changes made as result of add/remove callbacks`
`364`	`363`	`while (enginesRootTarget.HasMadeNewStructuralChangesInThisIteration()`
`365`	`364`	`&& iterations++ < MAX_SUBMISSION_ITERATIONS)`
`366`	`365`	`{`
`@@ -385,7 +384,7 @@ internal void SubmitEntities()`
`385`	`384`	`}`
`386`	`385`	`}`
`387`	`386`
`388`		`- readonly Svelto.DataStructures.WeakReference<EnginesRoot> _enginesRoot;`
	`387`	`+ readonly DataStructures.WeakReference<EnginesRoot> _enginesRoot;`
`389`	`388`	`}`
`390`	`389`
`391`	`390`	`~EnginesRoot()`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ public void SwapEntityGroup<T>(EGID fromEGID, EGID toEGID, [CallerMemberName] st`
`104`	`104`	`enginesRootTarget.CheckAddEntityID(toEGID, TypeCache<T>.type, caller);`
`105`	`105`
`106`	`106`	`enginesRootTarget.QueueSwapEntityOperation(fromEGID, toEGID`
`107`		`- , this._enginesRoot.Target.FindRealComponents<T>(fromEGID)`
	`107`	`+ , _enginesRoot.Target.FindRealComponents<T>(fromEGID)`
`108`	`108`	`, caller);`
`109`	`109`	`}`
`110`	`110`