From 98bd3add1971b314187c100ce1a2e0949263cd83 Mon Sep 17 00:00:00 2001
From: Robbert van der Helm <mail@robbertvanderhelm.nl>
Date: Tue, 15 Nov 2022 16:43:13 +0100
Subject: [PATCH] Notify nih_plug_vizia GUIs when parameters change

This could be useful in some cases when dealing with computed
properties.
---
 nih_plug_vizia/src/editor.rs  | 28 ++++++++++++++++++++++++----
 nih_plug_vizia/src/lib.rs     |  2 ++
 nih_plug_vizia/src/widgets.rs |  5 +++++
 3 files changed, 31 insertions(+), 4 deletions(-)

diff --git a/nih_plug_vizia/src/editor.rs b/nih_plug_vizia/src/editor.rs
index 2588ce7b..148da973 100644
--- a/nih_plug_vizia/src/editor.rs
+++ b/nih_plug_vizia/src/editor.rs
@@ -3,10 +3,11 @@
 use baseview::{WindowHandle, WindowScalePolicy};
 use crossbeam::atomic::AtomicCell;
 use nih_plug::prelude::{Editor, GuiContext, ParentWindowHandle};
-use std::sync::atomic::Ordering;
+use std::sync::atomic::{AtomicBool, Ordering};
 use std::sync::Arc;
 use vizia::prelude::*;
 
+use crate::widgets::RawParamEvent;
 use crate::{assets, widgets, ViziaState, ViziaTheming};
 
 /// An [`Editor`] implementation that calls an vizia draw loop.
@@ -20,6 +21,13 @@ pub(crate) struct ViziaEditor {
     /// The scaling factor reported by the host, if any. On macOS this will never be set and we
     /// should use the system scaling factor instead.
     pub(crate) scaling_factor: AtomicCell<Option<f32>>,
+
+    /// Whether to emit a parameters changed event during the next idle callback. This is set in the
+    /// `parameter_values_changed()` implementation and it can be used by widgets to explicitly
+    /// check for new parameter values. This is useful when the parameter value is (indirectly) used
+    /// to compute a property in an event handler. Like when positioning an element based on the
+    /// display value's width.
+    pub(crate) emit_parameters_changed_event: Arc<AtomicBool>,
 }
 
 impl Editor for ViziaEditor {
@@ -72,7 +80,18 @@ impl Editor for ViziaEditor {
                 .unwrap_or(WindowScalePolicy::SystemScaleFactor),
         )
         .inner_size((unscaled_width, unscaled_height))
-        .user_scale_factor(user_scale_factor);
+        .user_scale_factor(user_scale_factor)
+        .on_idle({
+            let emit_parameters_changed_event = self.emit_parameters_changed_event.clone();
+            move |cx| {
+                if emit_parameters_changed_event
+                    .compare_exchange(true, false, Ordering::AcqRel, Ordering::Relaxed)
+                    .is_ok()
+                {
+                    cx.emit(RawParamEvent::ParametersChanged);
+                }
+            }
+        });
 
         // This way the plugin can decide to use none of the built in theming
         if theming == ViziaTheming::None {
@@ -102,8 +121,9 @@ impl Editor for ViziaEditor {
     }
 
     fn param_values_changed(&self) {
-        // TODO: Update the GUI when this happens, right now this happens automatically as a result
-        //       of of the reactivity
+        // This will cause a future idle callback to send a parameters changed event.
+        self.emit_parameters_changed_event
+            .store(true, Ordering::Relaxed);
     }
 }
 
diff --git a/nih_plug_vizia/src/lib.rs b/nih_plug_vizia/src/lib.rs
index 68319335..54cc81c3 100644
--- a/nih_plug_vizia/src/lib.rs
+++ b/nih_plug_vizia/src/lib.rs
@@ -59,6 +59,8 @@ where
         scaling_factor: AtomicCell::new(None),
         #[cfg(not(target_os = "macos"))]
         scaling_factor: AtomicCell::new(Some(1.0)),
+
+        emit_parameters_changed_event: Arc::new(AtomicBool::new(false)),
     }))
 }
 
diff --git a/nih_plug_vizia/src/widgets.rs b/nih_plug_vizia/src/widgets.rs
index 16a8da12..3e48d89d 100644
--- a/nih_plug_vizia/src/widgets.rs
+++ b/nih_plug_vizia/src/widgets.rs
@@ -61,6 +61,9 @@ pub enum RawParamEvent {
     SetParameterNormalized(ParamPtr, f32),
     /// End an automation gesture for a parameter.
     EndSetParameter(ParamPtr),
+    /// Sent by the wrapper to indicate that one or more parameter values have changed. Useful when
+    /// using properties based on a parameter's value that are computed inside of an event handler.
+    ParametersChanged,
 }
 
 /// Handles parameter updates for VIZIA GUIs. Registered in
@@ -89,6 +92,8 @@ impl Model for ParamModel {
                 self.context.raw_set_parameter_normalized(p, v)
             },
             RawParamEvent::EndSetParameter(p) => unsafe { self.context.raw_end_set_parameter(p) },
+            // This can be used by widgets to be notified when parameter values have changed
+            RawParamEvent::ParametersChanged => (),
         });
     }
 }