Code documentation update, instant rewind fix

+Rounding values in Circular buffer due to float imprecisions
+Code documentation update
+Improved naming scheme
+Fixed instant rewinds
+Added more error logging when system is used improperly

Author: SitronX

Assets/TimeRewinder/ExampleScene/TimeRewindExample 2.unity

@@ -3065,8 +3065,8 @@ MonoBehaviour:
   trackParticles:
     enabled: 0
     value:
-      particleLimiter: 0
-      particleResetTo: 0
+      particleTrackingLimit: 0
+      particleRestartFrom: 0
       particlesData: []
 --- !u!4 &4475510621848781043 stripped
 Transform:

Assets/TimeRewinder/TimeRewinderImplementation/Scripts/CircularBuffer.cs

@@ -53,6 +53,7 @@ public T ReadLastValue()
     {
         return dataArray[bufferCurrentPosition];
     }
+
     /// <summary>
     /// Read specified value from circular buffer
     /// </summary>
@@ -74,15 +75,16 @@ public T ReadFromBuffer(float seconds)
     }
     private void MoveLastBufferPosition(float seconds)
     {
-        int howManyBeforeLast=(int)(howManyRecordsPerSecond*seconds);
+        int howManyBeforeLast=Mathf.RoundToInt(howManyRecordsPerSecond*seconds);
 
-        if ((bufferCurrentPosition - howManyBeforeLast) < 0)
+        int moveBy = - (howManyBeforeLast - bufferCurrentPosition) - 1;
+        if (moveBy < 0)
         {
-            bufferCurrentPosition = bufferCapacity - (howManyBeforeLast - bufferCurrentPosition);
+            bufferCurrentPosition = bufferCapacity +moveBy;
         }
         else
         {
-            bufferCurrentPosition -= howManyBeforeLast;
+            bufferCurrentPosition -= (howManyBeforeLast+1);
         }     
     }
 }

Assets/TimeRewinder/TimeRewinderImplementation/Scripts/ImplementedObjects/GenericRewind.cs

@@ -13,17 +13,16 @@ public class GenericRewind : RewindAbstract
 
     public override void Rewind(float seconds)
     {
-
         if (trackTransform)
             RestoreTransform(seconds);
         if (trackVelocity)
             RestoreVelocity(seconds);
         if (trackAnimator)
             RestoreAnimator(seconds);
-        if (trackParticles.Enabled)
-            RestoreParticles(seconds);
-        if(trackAudio)
+        if (trackAudio)
             RestoreAudio(seconds);
+        if (trackParticles.Enabled)
+            RestoreParticles(seconds);       
     }
 
     public override void Track()
@@ -34,16 +33,15 @@ public override void Track()
             TrackVelocity();
         if (trackAnimator)
             TrackAnimator();
-        if (trackParticles.Enabled)
-            TrackParticles();
         if (trackAudio)
             TrackAudio();
+        if (trackParticles.Enabled)
+            TrackParticles();      
     }
     private void Start()
     {
         if(trackParticles.Enabled)
             InitializeParticles(trackParticles.Value);
     }
-
 }
 

Assets/TimeRewinder/TimeRewinderImplementation/Scripts/ImplementedObjects/ScaleRewind.cs

@@ -25,20 +25,17 @@ public override void Track()
         TrackObjectScale();      
     }
 
-
     //In this method define, what will be restored on time rewinding. In our case we want to restore object scale
     public override void Rewind(float seconds)
     {
         RestoreObjectScale(seconds);
     }
 
-
     // This is an example of custom variable tracking
     public void TrackObjectScale()
     {
         trackedObjectScales.WriteLastValue(transform.localScale);
     }
-
 
     // This is an example of custom variable restoring
     public void RestoreObjectScale(float seconds)

Assets/TimeRewinder/TimeRewinderImplementation/Scripts/RewindAbstract.cs

@@ -45,7 +45,7 @@ public struct TransformValues
     }
 
     /// <summary>
-    /// Call this method in Track() if you want to track object Position and Rotation
+    /// Call this method in Track() if you want to track object Transforms (position, rotation and scale)
     /// </summary>
     protected void TrackTransform()
     {
@@ -56,8 +56,9 @@ protected void TrackTransform()
         trackedTransformValues.WriteLastValue(valuesToWrite);
     }
     /// <summary>
-    /// Call this method in GetSnapshotFromSavedValues() to restore Position and Rotation
+    /// Call this method in Rewind() to restore Transform
     /// </summary>
+    /// <param name="seconds">Use seconds parameter from Rewind() method</param>
     protected void RestoreTransform(float seconds)
     {
         TransformValues valuesToRead = trackedTransformValues.ReadFromBuffer(seconds);
@@ -74,6 +75,7 @@ public struct VelocityValues
         public float angularVelocity2D;
     }
     CircularBuffer<VelocityValues> trackedVelocities;
+
     /// <summary>
     /// Call this method in Track() if you want to track velocity of Rigidbody
     /// </summary>
@@ -100,9 +102,11 @@ protected void TrackVelocity()
             Debug.LogError("Cannot find Rigidbody on the object, while TrackVelocity() is being called!!!");
         }
     }
+
     /// <summary>
-    /// Call this method in GetSnapshotFromSavedValues() to velocity of Rigidbody
+    /// Call this method in Rewind() to restore velocity of Rigidbody
     /// </summary>
+    /// <param name="seconds">Use seconds parameter from Rewind() method</param>
     protected void RestoreVelocity(float seconds)
     {   
         if(body!=null)
@@ -149,9 +153,11 @@ protected void TrackAnimator()
             trackedAnimationTimes[i].WriteLastValue(valuesToWrite);
         }         
     }
+
     /// <summary>
-    /// Call this method in GetSnapshotFromSavedValues() to restore Animator state
+    /// Call this method in Rewind() to restore Animator state
     /// </summary>
+    /// <param name="seconds">Use seconds parameter from Rewind() method</param>
     protected void RestoreAnimator(float seconds)
     {
         animator.speed = 0;
@@ -190,9 +196,11 @@ protected void TrackAudio()
 
         trackedAudioTimes.WriteLastValue(dataToWrite);      
     }
+
     /// <summary>
-    /// Call this method in GetSnapshotFromSavedValues() to restore Audio
+    /// Call this method in Rewind() to restore Audio
     /// </summary>
+    /// <param name="seconds">Use seconds parameter from Rewind() method</param>
     protected void RestoreAudio(float seconds)
     {
         AudioTrackedData readValues = trackedAudioTimes.ReadFromBuffer(seconds);
@@ -224,12 +232,10 @@ public struct ParticleTrackedData
         public float particleTime;
     }
 
-
     private List<ParticleData> particleSystemsData;
 
     /// <summary>
-    /// particle system and its enabler, which is for tracking if particle system game object is enabled or disabled
-    /// particle
+    /// particle system and its main object for tracking if particle system game object is enabled or disabled
     /// </summary>
     [Serializable]
     public struct ParticleData
@@ -255,14 +261,12 @@ public struct ParticlesSetting
     /// <summary>
     /// Use this method first when using particle rewinding implementation
     /// </summary>
-    /// <param name="particleDataList">Data defining which particles will be tracked</param>
-    /// <param name="particleTimeLimiter">For long lasting particle systems, set time tracking limiter to drastically improve performance </param>
-    /// <param name="resetParticleTo">Variable defining to which second should tracking return to after particle tracking limit was hit. Play with this variable to get better results, so the tracking resets are not much noticeable.</param>
+    /// <param name="particleSettings"></param>
     protected void InitializeParticles(ParticlesSetting particleSettings)
     {
         if(particleSettings.particlesData.Any(x=>x.particleSystemMainObject == null||x.particleSystem==null))
         {
-            Debug.LogError("Initialized particle system are missing data. Either Particle System or Particle System Enabler is not filled for some values");
+            Debug.LogError("Initialized particle system are missing data. Either Particle System or Main Object is not filled for some values");
         }
         particleSystemsData = particleSettings.particlesData;
         particleTimeLimiter = particleSettings.particleTrackingLimit;
@@ -314,13 +318,14 @@ protected void TrackParticles()
         }
         catch
         {
-            Debug.LogError("Particles Data not filled properly!!! Fill both the Particle System and Particle Main object fields for each element");
+            Debug.LogError("Particles Data not filled properly!!! Fill both the Particle System and Particle Main Object fields for each element");
         }
 
     }
     /// <summary>
-    /// Call this method in GetSnapshotFromSavedValues() to Particles
+    /// Call this method in Rewind() to restore Particles
     /// </summary>
+    /// <param name="seconds">Use seconds parameter from Rewind() method</param>
     protected void RestoreParticles(float seconds)
     {
         for (int i = 0; i < particleSystemsData.Count; i++)
@@ -349,15 +354,15 @@ protected void RestoreParticles(float seconds)
 
 
     /// <summary>
-    /// Main method where all tracking is filled, lets choose here what will be tracked for specific object
+    /// Main method where all tracking is filled, choose what will be tracked for specific object
     /// </summary>
     public abstract void Track();
 
 
     /// <summary>
-    /// Main method where all rewinding is filled, lets choose here what will be rewinded for specific object
+    /// Main method where all rewinding is filled, choose what will be rewinded for specific object
     /// </summary>
-    /// <param name="seconds">Parameter defining how many seconds we want to rewind back</param>
+    /// <param name="seconds">Parameter defining how many seconds you want to rewind back</param>
     public abstract void Rewind(float seconds);
 
 }      

Assets/TimeRewinder/TimeRewinderImplementation/Scripts/RewindInputs/RewindBySlider.cs

@@ -8,8 +8,6 @@
 /// </summary>
 public class RewindBySlider : MonoBehaviour,IPointerDownHandler, IPointerUpHandler
 {
-    //Cause TimeManager timestep is set to Time.FixedDeltaTime, animator of the slider is also se to same timestep
-
     [SerializeField] Slider slider;
     [SerializeField] AudioSource rewindSound;
 
@@ -30,6 +28,7 @@ void Start()
         sliderAnimator = slider.GetComponent<Animator>();
         SetNormalSpeed();
     }
+    #region Additional controls
     public void RestartTracking()
     {
         slider.value = slider.minValue;
@@ -84,7 +83,8 @@ public void ResumeRewind()
         rewindResume.interactable = false;
         rewindPause.interactable = true;
     }
-    
+    #endregion
+
     public void OnPointerDown(PointerEventData eventData)
     {
         howManyFingersTouching++;
@@ -121,7 +121,7 @@ public void OnSliderDown()
         if (slider.interactable)
         {
             if(!isRewindPaused)
-                RewindManager.Instance.StartRewindTimeBySeconds(-slider.value*RewindManager.Instance.HowManySecondsToTrack);       //Start rewind preview. (Note that slider have negative values, that is why it is passed with minus sign)                                               
+                RewindManager.Instance.StartRewindTimeBySeconds(-slider.value*RewindManager.Instance.HowManySecondsToTrack);       //Start rewind preview (note that slider have negative values, that is why it is passed with minus sign)                                               
 
             SliderAnimationPause();
             rewindSound.Play();
@@ -133,24 +133,23 @@ private void SetNormalSpeed()
     }
     public void OnSliderUpdate(float value)
     {
-        RewindManager.Instance.SetTimeSecondsInRewind(-value * RewindManager.Instance.HowManySecondsToTrack);     //If slider value changes, change rewind preview state     (Note that slider have negative values, that is why it is passed with minus sign) 
+        RewindManager.Instance.SetTimeSecondsInRewind(-value * RewindManager.Instance.HowManySecondsToTrack);     //If slider value changes, change rewind preview state (note that slider have negative values, that is why it is passed with minus sign) 
     }
     public void SliderAnimationPause()                                  //When rewinding slider animator is paused
     {
         sliderAnimator.speed= 0;
-
     }
-    public void RestoreSliderAnimation()                                //Slider restoration so after uses releases it, it will snap back to correct value
+    public void RestoreSliderAnimation()                                //Slider restoration after user releases it, it will snap back to correct value
     {
         float animationTimeStartFrom = slider.value - slider.minValue;
         sliderAnimator.Play("AutoResizeAnim", 0, animationTimeStartFrom);
         StartCoroutine(ResetSliderValue());
     }
+
     //Cause slider animator is in fixed update
     IEnumerator ResetSliderValue()
     {
         yield return new WaitForFixedUpdate();
         slider.value = 0;
-    }
-    
+    }   
 }

Assets/TimeRewinder/TimeRewinderImplementation/Scripts/RewindManager.cs

@@ -37,10 +37,10 @@ public class RewindManager : MonoBehaviour
     List<RewindAbstract> _rewindedObjects;
 
     /// <summary>
-    /// Call this method to rewind time by specified seconds instantly without snapshot preview
+    /// Call this method to rewind time by specified seconds instantly without snapshot preview. Usefull for one time instant rewinds.
     /// </summary>
     /// <param name="seconds">Parameter defining how many seconds should object rewind to from now (Parameter must be >=0).</param>
-    public void RewindTimeBySeconds(float seconds)
+    public void InstantRewindTimeBySeconds(float seconds)
     {
         if(seconds>HowManySecondsAvailableForRewind)
         {
@@ -52,17 +52,20 @@ public void RewindTimeBySeconds(float seconds)
             Debug.LogError("Parameter in RewindTimeBySeconds() must have positive value!!!");
             return;
         }
-
         _rewindedObjects.ForEach(x => x.Rewind(seconds));
+        HowManySecondsAvailableForRewind -= seconds;
         BuffersRestore?.Invoke(seconds);
     }
     /// <summary>
-    /// Call this method if you want to start rewinding time with ability to preview snapshots. After done rewinding, StopRewindTimeBySeconds() must be called!!!. To update snapshot preview between, call method SetTimeSecondsInRewind()
+    /// Call this method if you want to start rewinding time with ability to preview snapshots. After done rewinding, StopRewindTimeBySeconds() must be called!!!. To update snapshot preview between, call method SetTimeSecondsInRewind().
     /// </summary>
     /// <param name="seconds">Parameter defining how many seconds before should the rewind preview rewind to (Parameter must be >=0)</param>
     /// <returns></returns>
     public void StartRewindTimeBySeconds(float seconds)
     {
+        if (IsBeingRewinded)
+            Debug.LogError("The previous rewind must be stopped by calling StopRewindTimeBySeconds() before you start another rewind");
+        
         CheckReachingOutOfBounds(seconds);
 
         rewindSeconds = seconds;
@@ -79,14 +82,28 @@ public void SetTimeSecondsInRewind(float seconds)
         rewindSeconds = seconds;
     }
     /// <summary>
-    /// Call this method to stop previewing rewind state and effectively set current values to the rewind state
+    /// Call this method to stop previewing rewind state and resume normal game flow
     /// </summary>
     public void StopRewindTimeBySeconds()
     {
+        if (!IsBeingRewinded)
+            Debug.LogError("Rewind must be started before you try to stop it. StartRewindTimeBySeconds() must be called first");
+
         HowManySecondsAvailableForRewind -= rewindSeconds;
         BuffersRestore?.Invoke(rewindSeconds);
         IsBeingRewinded = false;
     }
+    /// <summary>
+    /// Call if you want to restart the whole tracking system
+    /// </summary>
+    public void RestartTracking()
+    {
+        if (IsBeingRewinded)
+            StopRewindTimeBySeconds();
+
+        HowManySecondsAvailableForRewind = 0;
+        TrackingEnabled = true;
+    }
     private void CheckReachingOutOfBounds(float seconds)
     {
         if (Mathf.Round(seconds*100) > Mathf.Round(HowManySecondsAvailableForRewind*100))
@@ -100,15 +117,6 @@ private void CheckReachingOutOfBounds(float seconds)
             return;
         }
     }
-    public void RestartTracking()
-    {
-        if(IsBeingRewinded)
-            StopRewindTimeBySeconds();
-
-        HowManySecondsAvailableForRewind = 0;
-        TrackingEnabled = true;
-    }
-   
     private void Awake()
     {
         _rewindedObjects = FindObjectsOfType<RewindAbstract>().ToList();