1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
//! Widgets and utilities for making widgets to integrate VIZIA with NIH-plug.
//!
//! # Note
//!
//! None of these widgets are finalized, and their sizes or looks can change at any point. Feel free
//! to copy the widgets and modify them to your personal taste.
use crossbeam::atomic::AtomicCell;
use nih_plug::nih_debug_assert_eq;
use nih_plug::prelude::{GuiContext, Param, ParamPtr};
use std::sync::Arc;
use vizia::prelude::*;
use super::ViziaState;
mod generic_ui;
pub mod param_base;
mod param_button;
mod param_slider;
mod peak_meter;
mod resize_handle;
pub mod util;
pub use generic_ui::GenericUi;
pub use param_button::{ParamButton, ParamButtonExt};
pub use param_slider::{ParamSlider, ParamSliderExt, ParamSliderStyle};
pub use peak_meter::PeakMeter;
pub use resize_handle::ResizeHandle;
/// Register the default theme for the widgets exported by this module. This is automatically called
/// for you when using [`create_vizia_editor()`][super::create_vizia_editor()].
pub fn register_theme(cx: &mut Context) {
cx.add_theme(include_str!("../assets/widgets.css"));
}
/// An event that updates a parameter's value. Since NIH-plug manages the parameters, interacting
/// with parameter values with VIZIA works a little different from updating any other state. These
/// events are automatically handled by `nih_plug_vizia`.
///
/// Call the [`upcast()`][Self::upcast()] method to be able to emit this event through an
/// [`EventContext`][EventContext].
#[derive(Debug, Clone, Copy)]
pub enum ParamEvent<'a, P: Param> {
/// Begin an automation gesture for a parameter.
BeginSetParameter(&'a P),
/// Set a parameter to a new normalized value. This needs to be surrounded by a matching
/// `BeginSetParameter` and `EndSetParameter`.
SetParameter(&'a P, P::Plain),
/// Set a parameter to a new normalized value. This needs to be surrounded by a matching
/// `BeginSetParameter` and `EndSetParameter`.
SetParameterNormalized(&'a P, f32),
/// End an automation gesture for a parameter.
EndSetParameter(&'a P),
}
/// The same as [`ParamEvent`], but type erased. Use `ParamEvent` as an easier way to construct
/// these if you are working with regular parameter objects.
#[derive(Debug, Clone, Copy)]
pub enum RawParamEvent {
/// Begin an automation gesture for a parameter.
BeginSetParameter(ParamPtr),
/// Set a parameter to a new normalized value. This needs to be surrounded by a matching
/// `BeginSetParameter` and `EndSetParameter`.
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,
}
/// Events that directly interact with the [`GuiContext`]. Used to trigger resizes.
pub enum GuiContextEvent {
/// Resize the window to match the current size reported by the [`ViziaState`]'s size function.
/// By changing the plugin's state that is used to determine the window's size before emitting
/// this event, the window can be resized in a declarative and predictable way:
///
/// ```
/// # use std::sync::Arc;
/// # use std::sync::atomic::{AtomicBool, Ordering};
/// # use nih_plug_vizia::ViziaState;
/// # use nih_plug_vizia::vizia::prelude::*;
/// # use nih_plug_vizia::widgets::GuiContextEvent;
/// // Assuming there is some kind of state variable passed to the editor, likely stored as a
/// // `#[persist]` field in the `Params` struct:
/// let window_state = Arc::new(AtomicBool::new(false));
///
/// // And this is the `ViziaState` passed to `create_vizia_editor()`:
/// ViziaState::new(move || {
/// if window_state.load(Ordering::Relaxed) {
/// (800, 400)
/// } else {
/// (400, 400)
/// }
/// });
///
/// // Then the window's size can be toggled between the two sizes like so:
/// fn toggle_window_size(cx: &mut EventContext, window_state: Arc<AtomicBool>) {
/// window_state.fetch_xor(true, Ordering::Relaxed);
///
/// // This will cause NIH-plug to query the size from the `ViziaState` again and resize the
/// // windo to that size
/// cx.emit(GuiContextEvent::Resize);
/// }
/// ```
Resize,
}
/// Handles parameter updates for VIZIA GUIs. Registered in
/// [`ViziaEditor::spawn()`][super::ViziaEditor::spawn()].
pub(crate) struct ParamModel {
pub context: Arc<dyn GuiContext>,
}
/// Handles interactions through `WindowEvent` for VIZIA GUIs by updating the `ViziaState`.
/// Registered in [`ViziaEditor::spawn()`][super::ViziaEditor::spawn()].
#[derive(Lens)]
pub(crate) struct WindowModel {
pub context: Arc<dyn GuiContext>,
pub vizia_state: Arc<ViziaState>,
/// The last known unscaled logical window size. Used to prevent sending duplicate resize
/// requests.
pub last_inner_window_size: AtomicCell<(u32, u32)>,
}
impl Model for ParamModel {
fn event(&mut self, _cx: &mut EventContext, event: &mut Event) {
// `ParamEvent` gets downcast into `NormalizedParamEvent` by the `Message`
// implementation below
event.map(|param_event, _| match *param_event {
RawParamEvent::BeginSetParameter(p) => unsafe {
self.context.raw_begin_set_parameter(p)
},
RawParamEvent::SetParameterNormalized(p, v) => unsafe {
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 => (),
});
}
}
impl Model for WindowModel {
fn event(&mut self, cx: &mut EventContext, event: &mut Event) {
event.map(|gui_context_event, meta| match gui_context_event {
GuiContextEvent::Resize => {
// This will trigger a `WindowEvent::GeometryChanged`, which in turn causes the
// handler below this to be fired
let (width, height) = self.vizia_state.inner_logical_size();
cx.set_window_size(WindowSize { width, height });
meta.consume();
}
});
// This gets fired whenever the inner window gets resized
event.map(|window_event, _| {
if let WindowEvent::GeometryChanged { .. } = window_event {
let logical_size = (cx.window_size().width, cx.window_size().height);
// `self.vizia_state.inner_logical_size()` should match `logical_size`. Since it's
// computed we need to store the last logical size on this object.
nih_debug_assert_eq!(
logical_size,
self.vizia_state.inner_logical_size(),
"The window size set on the vizia context does not match the size returned by \
'ViziaState::size_fn'"
);
let old_logical_size @ (old_logical_width, old_logical_height) =
self.last_inner_window_size.load();
let scale_factor = cx.user_scale_factor();
let old_user_scale_factor = self.vizia_state.scale_factor.load();
// Don't do anything if the current size already matches the new size, this could
// otherwise also cause a feedback loop on resize failure
if logical_size == old_logical_size && scale_factor == old_user_scale_factor {
return;
}
// Our embedded baseview window will have already been resized. If the host does not
// accept our new size, then we'll try to undo that
self.last_inner_window_size.store(logical_size);
self.vizia_state.scale_factor.store(scale_factor);
if !self.context.request_resize() {
self.last_inner_window_size.store(old_logical_size);
self.vizia_state.scale_factor.store(old_user_scale_factor);
// This will cause the window's size to be reverted on the next event loop
// NOTE: Is resizing back the correct behavior now that the size is computed?
cx.set_window_size(WindowSize {
width: old_logical_width,
height: old_logical_height,
});
cx.set_user_scale_factor(old_user_scale_factor);
}
}
});
}
}
impl<P: Param> From<ParamEvent<'_, P>> for RawParamEvent {
fn from(event: ParamEvent<'_, P>) -> Self {
match event {
ParamEvent::BeginSetParameter(p) => RawParamEvent::BeginSetParameter(p.as_ptr()),
ParamEvent::SetParameter(p, v) => {
RawParamEvent::SetParameterNormalized(p.as_ptr(), p.preview_normalized(v))
}
ParamEvent::SetParameterNormalized(p, v) => {
RawParamEvent::SetParameterNormalized(p.as_ptr(), v)
}
ParamEvent::EndSetParameter(p) => RawParamEvent::EndSetParameter(p.as_ptr()),
}
}
}
impl<P: Param> ParamEvent<'_, P> {
/// Convert this event into a type erased version of itself that can be emitted through
/// [`EventContext::emit()`][EventContext::emit()].
///
/// TODO: Think of a better, clearer term for this
pub fn upcast(self) -> RawParamEvent {
self.into()
}
}