Make NaN floats / doubles never equal to each other for the ProtoFlux == and != nodes, as well as the ValueEqualityDriver component

Adds a fix for Yellow-Dog-Man/Resonite-Issues#1046

Author: Banane9

CommunityBugFixCollection/Locale/de.json

@@ -27,6 +27,7 @@
     "CommunityBugFixCollection.ImportMultipleAudioFiles.Description": "Macht es möglich mehrere Audiodateien auf einmal zu importieren.",
     "CommunityBugFixCollection.ImportWebFilesAsUrls.Description": "Sorgt dafür, dass URLs zu Textdateien oder Resonite Packages nicht importiert werden, statt als Hyperlink aufzutauchen.",
     "CommunityBugFixCollection.IndependentlyScaleDirectCursor.Description": "Verhindert, dass der direkte Cursor sehr groß wird, wenn er an einem deutlich nährem Objekt hängt als der echte Cursor.",
+    "CommunityBugFixCollection.NaNtEqual.Description": "Sorgt dafür, dass NaN float / double Werte sich bei den == und != ProtoFlux Nodes sowie bei der ValueEqualityDriver Komponente niemals gleichen.",
     "CommunityBugFixCollection.NoLossOfColorProfile.Description": "Verhindert, dass Farbprofile nicht bei allen Berechnungen erhalten bleiben.",
     "CommunityBugFixCollection.NoZeroScaleToolRaycast.Description": "Verhinder einen Crash wenn (Multi-)Werkzeuge auf null skaliert werden.",
     "CommunityBugFixCollection.NodeNameAdjustments.Description": "Korrigiert, dass die Namen der meisten ProtoFlux Nodes in Strings > Constants unsichtbar sind.",

CommunityBugFixCollection/Locale/en.json

@@ -27,6 +27,7 @@
     "CommunityBugFixCollection.ImportMultipleAudioFiles.Description": "Fixes it not being possible to import multiple audio clips at once.",
     "CommunityBugFixCollection.ImportWebFilesAsUrls.Description": "Fixes URLs to text files or Resonite Packages failing to import instead of appearing as a hyperlink.",
     "CommunityBugFixCollection.IndependentlyScaleDirectCursor.Description": "Fixes direct cursor size becoming very large when snapped to an object much closer than the true cursor.",
+    "CommunityBugFixCollection.NaNtEqual.Description": "Makes NaN floats / doubles never equal to each other for the ProtoFlux == and != nodes, as well as the ValueEqualityDriver component.",
     "CommunityBugFixCollection.NoLossOfColorProfile.Description": "Fixes Color Profile not being preserved on all operations.",
     "CommunityBugFixCollection.NoZeroScaleToolRaycast.Description": "Fixes a crash when a (multi)tool is scaled to zero.",
     "CommunityBugFixCollection.NodeNameAdjustments.Description": "Fixes most ProtoFlux nodes in Strings > Constants having invisible names.",

CommunityBugFixCollection/NaNtEqual.cs

@@ -0,0 +1,114 @@
+using Elements.Core;
+using FrooxEngine;
+using HarmonyLib;
+using MonkeyLoader.Resonite;
+using ProtoFlux.Core;
+using ProtoFlux.Runtimes.Execution;
+using ProtoFlux.Runtimes.Execution.Nodes;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace CommunityBugFixCollection
+{
+    [HarmonyPatch]
+    [HarmonyPatchCategory(nameof(NaNtEqual))]
+    internal sealed class NaNtEqual : ResoniteMonkey<NaNtEqual>
+    {
+        public override IEnumerable<string> Authors => Contributors.Banane9;
+
+        public override bool CanBeDisabled => true;
+
+        [HarmonyPrefix]
+        [HarmonyPatch(typeof(ValueEqualityDriver<double>), nameof(ValueEqualityDriver<double>.OnChanges))]
+        private static bool ValueEqualityDriverDoublePrefix(ValueEqualityDriver<double> __instance)
+        {
+            if (!Enabled)
+                return true;
+
+            if (!__instance.Target.IsLinkValid)
+                return false;
+
+            var value = __instance.TargetValue.Target?.Value ?? default;
+
+            var areEqual = (!__instance.UseApproximateComparison.Value || !Coder<double>.SupportsApproximateComparison)
+                ? value == __instance.Reference.Value
+                : Coder<double>.Approximately(value, __instance.Reference.Value);
+
+            // XOR inverts the other bool
+            __instance.Target.Target.Value = __instance.Invert.Value ^ areEqual;
+
+            return false;
+        }
+
+        [HarmonyPrefix]
+        [HarmonyPatch(typeof(ValueEqualityDriver<float>), nameof(ValueEqualityDriver<float>.OnChanges))]
+        private static bool ValueEqualityDriverFloatPrefix(ValueEqualityDriver<float> __instance)
+        {
+            if (!Enabled)
+                return true;
+
+            if (!__instance.Target.IsLinkValid)
+                return false;
+
+            var value = __instance.TargetValue.Target?.Value ?? default;
+
+            var areEqual = (!__instance.UseApproximateComparison.Value || !Coder<float>.SupportsApproximateComparison)
+                ? value == __instance.Reference.Value
+                : Coder<float>.Approximately(value, __instance.Reference.Value);
+
+            // XOR inverts the other bool
+            __instance.Target.Target.Value = __instance.Invert.Value ^ areEqual;
+
+            return false;
+        }
+
+        [HarmonyPrefix]
+        [HarmonyPatch(typeof(ValueEquals<double>), nameof(ValueEquals<double>.Compute))]
+        private static bool ValueEqualsDoublePrefix(ExecutionContext context, ref bool __result)
+        {
+            if (!Enabled)
+                return true;
+
+            __result = 0.ReadValue<double>(context) == 1.ReadValue<double>(context);
+
+            return false;
+        }
+
+        [HarmonyPrefix]
+        [HarmonyPatch(typeof(ValueEquals<float>), nameof(ValueEquals<float>.Compute))]
+        private static bool ValueEqualsFloatPrefix(ExecutionContext context, ref bool __result)
+        {
+            if (!Enabled)
+                return true;
+
+            __result = 0.ReadValue<float>(context) == 1.ReadValue<float>(context);
+
+            return false;
+        }
+
+        [HarmonyPrefix]
+        [HarmonyPatch(typeof(ValueNotEquals<double>), nameof(ValueNotEquals<double>.Compute))]
+        private static bool ValueNotEqualsDoublePrefix(ExecutionContext context, ref bool __result)
+        {
+            if (!Enabled)
+                return true;
+
+            __result = 0.ReadValue<double>(context) != 1.ReadValue<double>(context);
+
+            return false;
+        }
+
+        [HarmonyPrefix]
+        [HarmonyPatch(typeof(ValueNotEquals<float>), nameof(ValueNotEquals<float>.Compute))]
+        private static bool ValueNotEqualsFloatPrefix(ExecutionContext context, ref bool __result)
+        {
+            if (!Enabled)
+                return true;
+
+            __result = 0.ReadValue<float>(context) != 1.ReadValue<float>(context);
+
+            return false;
+        }
+    }
+}

README.md

@@ -43,6 +43,7 @@ just disable them in the settings in the meantime.
 * URLs to text files or Resonite Packages failing to import instead of appearing as a hyperlink (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/785)
 * References in multiple duplicated or transferred-between-worlds items breaking (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/984)
 * Context Menu changing size and becoming unusable with extreme FOVs (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/991)
+* NaN floats / doubles compare as equal in ProtoFlux and ValueEqualityDriver (but only when not approximate) (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/1046)
 * ColorX From HexCode (ProtoFlux node) defaults to Linear profile (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/1404)
 * UserInspectors not listing existing users in the session for non-host users (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/1964)
 * ProtoFlux value casts from byte to other values converting incorrectly (mono / graphical client only) (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/2257)