Merge pull request #80 from neogeek/feature/is-on-beat-update

neogeek · web-flow · commit a56471bcf3df · 2024-10-25T09:36:22.000-04:00
[feat] Added delta param to IsOnTheBeat method.
diff --git a/Documentation/API/Utilities/IsOnTheBeat.md b/Documentation/API/Utilities/IsOnTheBeat.md
@@ -9,9 +9,10 @@ using System;
 using RhythmGameUtilities;
 
 const int bpm = 120;
-const int currentTime = 10;
+const float currentTime = 10f;
+const float delta = 0.05f;
 
-if (Utilities.IsOnTheBeat(bpm, currentTime))
+if (Utilities.IsOnTheBeat(bpm, currentTime, delta))
 {
     Console.WriteLine("Is on the beat!");
 }
@@ -29,9 +30,10 @@ using namespace RhythmGameUtilities;
 int main()
 {
     const int bpm = 120;
-    const int currentTime = 10;
+    const float currentTime = 10f;
+    const float delta = 0.05f;
 
-    if (IsOnTheBeat(bpm, currentTime))
+    if (IsOnTheBeat(bpm, currentTime, delta))
     {
         std::cout << "Is on the beat!" << std::endl;
     }
diff --git a/README.md b/README.md
@@ -773,9 +773,10 @@ using System;
 using RhythmGameUtilities;
 
 const int bpm = 120;
-const int currentTime = 10;
+const float currentTime = 10f;
+const float delta = 0.05f;
 
-if (Utilities.IsOnTheBeat(bpm, currentTime))
+if (Utilities.IsOnTheBeat(bpm, currentTime, delta))
 {
     Console.WriteLine("Is on the beat!");
 }
@@ -793,9 +794,10 @@ using namespace RhythmGameUtilities;
 int main()
 {
     const int bpm = 120;
-    const int currentTime = 10;
+    const float currentTime = 10f;
+    const float delta = 0.05f;
 
-    if (IsOnTheBeat(bpm, currentTime))
+    if (IsOnTheBeat(bpm, currentTime, delta))
     {
         std::cout << "Is on the beat!" << std::endl;
     }
diff --git a/RhythmGameUtilities/Scripts/Utilities.cs b/RhythmGameUtilities/Scripts/Utilities.cs
@@ -35,7 +35,7 @@ public static extern int ConvertSecondsToTicksInternal(float seconds, int resolu
 #elif LINUX_BUILD || UNITY_EDITOR_LINUX || UNITY_STANDALONE_LINUX
         [DllImport("libRhythmGameUtilities.so", CallingConvention = CallingConvention.Cdecl)]
 #endif
-        public static extern bool IsOnTheBeat(int bpm, float currentTime);
+        public static extern bool IsOnTheBeat(int bpm, float currentTime, float delta);
 
 #if WINDOWS_BUILD || UNITY_EDITOR_WIN || UNITY_STANDALONE_WIN
         [DllImport("libRhythmGameUtilities.dll", CallingConvention = CallingConvention.Cdecl)]
@@ -103,9 +103,10 @@ public static int ConvertSecondsToTicks(float seconds, int resolution, Dictionar
         ///
         /// <param name="bpm">The base BPM for a song.</param>
         /// <param name="currentTime">A timestamp to compare to the BPM.</param>
-        public static bool IsOnTheBeat(int bpm, float currentTime)
+        /// <param name="delta">The plus/minus delta to test the current time against.</param>
+        public static bool IsOnTheBeat(int bpm, float currentTime, float delta = 0.05f)
         {
-            return UtilitiesInternal.IsOnTheBeat(bpm, currentTime);
+            return UtilitiesInternal.IsOnTheBeat(bpm, currentTime, delta);
         }
 
         /// <summary>
diff --git a/UnityPackage/README.md b/UnityPackage/README.md
@@ -773,9 +773,10 @@ using System;
 using RhythmGameUtilities;
 
 const int bpm = 120;
-const int currentTime = 10;
+const float currentTime = 10f;
+const float delta = 0.05f;
 
-if (Utilities.IsOnTheBeat(bpm, currentTime))
+if (Utilities.IsOnTheBeat(bpm, currentTime, delta))
 {
     Console.WriteLine("Is on the beat!");
 }
@@ -793,9 +794,10 @@ using namespace RhythmGameUtilities;
 int main()
 {
     const int bpm = 120;
-    const int currentTime = 10;
+    const float currentTime = 10f;
+    const float delta = 0.05f;
 
-    if (IsOnTheBeat(bpm, currentTime))
+    if (IsOnTheBeat(bpm, currentTime, delta))
     {
         std::cout << "Is on the beat!" << std::endl;
     }
diff --git a/UnityPackage/Scripts/Utilities.cs b/UnityPackage/Scripts/Utilities.cs
@@ -35,7 +35,7 @@ public static extern int ConvertSecondsToTicksInternal(float seconds, int resolu
 #elif LINUX_BUILD || UNITY_EDITOR_LINUX || UNITY_STANDALONE_LINUX
         [DllImport("libRhythmGameUtilities.so", CallingConvention = CallingConvention.Cdecl)]
 #endif
-        public static extern bool IsOnTheBeat(int bpm, float currentTime);
+        public static extern bool IsOnTheBeat(int bpm, float currentTime, float delta);
 
 #if WINDOWS_BUILD || UNITY_EDITOR_WIN || UNITY_STANDALONE_WIN
         [DllImport("libRhythmGameUtilities.dll", CallingConvention = CallingConvention.Cdecl)]
@@ -103,9 +103,10 @@ public static int ConvertSecondsToTicks(float seconds, int resolution, Dictionar
         ///
         /// <param name="bpm">The base BPM for a song.</param>
         /// <param name="currentTime">A timestamp to compare to the BPM.</param>
-        public static bool IsOnTheBeat(int bpm, float currentTime)
+        /// <param name="delta">The plus/minus delta to test the current time against.</param>
+        public static bool IsOnTheBeat(int bpm, float currentTime, float delta = 0.05f)
         {
-            return UtilitiesInternal.IsOnTheBeat(bpm, currentTime);
+            return UtilitiesInternal.IsOnTheBeat(bpm, currentTime, delta);
         }
 
         /// <summary>
diff --git a/include/RhythmGameUtilities/Utilities.hpp b/include/RhythmGameUtilities/Utilities.hpp
@@ -169,18 +169,20 @@ extern "C"
      *
      * @param bpm The base BPM for a song.
      * @param currentTime A timestamp to compare to the BPM.
+     * @param delta The plus/minus delta to test the current time against.
      * @public
      */
 
-    PACKAGE_API bool IsOnTheBeat(int bpm, float currentTime)
+    PACKAGE_API bool IsOnTheBeat(int bpm, float currentTime,
+                                 float delta = 0.05f)
     {
         auto beatInterval = SECONDS_PER_MINUTE / (float)bpm;
 
         auto beatFraction = currentTime / beatInterval;
 
         auto difference = std::abs(beatFraction - std::round(beatFraction));
 
-        auto result = difference < 0.05f;
+        auto result = difference < delta;
 
         return result;
     }

Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,10 @@ using System;`
`9`	`9`	`using RhythmGameUtilities;`
`10`	`10`
`11`	`11`	`const int bpm = 120;`
`12`		`-const int currentTime = 10;`
	`12`	`+const float currentTime = 10f;`
	`13`	`+const float delta = 0.05f;`
`13`	`14`
`14`		`-if (Utilities.IsOnTheBeat(bpm, currentTime))`
	`15`	`+if (Utilities.IsOnTheBeat(bpm, currentTime, delta))`
`15`	`16`	`{`
`16`	`17`	`Console.WriteLine("Is on the beat!");`
`17`	`18`	`}`
`@@ -29,9 +30,10 @@ using namespace RhythmGameUtilities;`
`29`	`30`	`int main()`
`30`	`31`	`{`
`31`	`32`	`const int bpm = 120;`
`32`		`- const int currentTime = 10;`
	`33`	`+ const float currentTime = 10f;`
	`34`	`+ const float delta = 0.05f;`
`33`	`35`
`34`		`- if (IsOnTheBeat(bpm, currentTime))`
	`36`	`+ if (IsOnTheBeat(bpm, currentTime, delta))`
`35`	`37`	`{`
`36`	`38`	`std::cout << "Is on the beat!" << std::endl;`
`37`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -773,9 +773,10 @@ using System;`
`773`	`773`	`using RhythmGameUtilities;`
`774`	`774`
`775`	`775`	`const int bpm = 120;`
`776`		`-const int currentTime = 10;`
	`776`	`+const float currentTime = 10f;`
	`777`	`+const float delta = 0.05f;`
`777`	`778`
`778`		`-if (Utilities.IsOnTheBeat(bpm, currentTime))`
	`779`	`+if (Utilities.IsOnTheBeat(bpm, currentTime, delta))`
`779`	`780`	`{`
`780`	`781`	`Console.WriteLine("Is on the beat!");`
`781`	`782`	`}`
`@@ -793,9 +794,10 @@ using namespace RhythmGameUtilities;`
`793`	`794`	`int main()`
`794`	`795`	`{`
`795`	`796`	`const int bpm = 120;`
`796`		`- const int currentTime = 10;`
	`797`	`+ const float currentTime = 10f;`
	`798`	`+ const float delta = 0.05f;`
`797`	`799`
`798`		`- if (IsOnTheBeat(bpm, currentTime))`
	`800`	`+ if (IsOnTheBeat(bpm, currentTime, delta))`
`799`	`801`	`{`
`800`	`802`	`std::cout << "Is on the beat!" << std::endl;`
`801`	`803`	`}`
Original file line number	Diff line number	Diff line change
`@@ -169,18 +169,20 @@ extern "C"`
`169`	`169`	`*`
`170`	`170`	`* @param bpm The base BPM for a song.`
`171`	`171`	`* @param currentTime A timestamp to compare to the BPM.`
	`172`	`+ * @param delta The plus/minus delta to test the current time against.`
`172`	`173`	`* @public`
`173`	`174`	`*/`
`174`	`175`
`175`		`- PACKAGE_API bool IsOnTheBeat(int bpm, float currentTime)`
	`176`	`+ PACKAGE_API bool IsOnTheBeat(int bpm, float currentTime,`
	`177`	`+ float delta = 0.05f)`
`176`	`178`	`{`
`177`	`179`	`auto beatInterval = SECONDS_PER_MINUTE / (float)bpm;`
`178`	`180`
`179`	`181`	`auto beatFraction = currentTime / beatInterval;`
`180`	`182`
`181`	`183`	`auto difference = std::abs(beatFraction - std::round(beatFraction));`
`182`	`184`
`183`		`- auto result = difference < 0.05f;`
	`185`	`+ auto result = difference < delta;`
`184`	`186`
`185`	`187`	`return result;`
`186`	`188`	`}`