VST3ParametersWindow Class Reference

"Plain" plugin UI, contains a list of parameter controls and values. More...

#include <VST3ParametersWindow.h>

Inheritance diagram for VST3ParametersWindow:

Collaboration diagram for VST3ParametersWindow:

Public Member Functions
	VST3ParametersWindow (wxWindow *parent, Steinberg::Vst::IEditController &editController, Steinberg::Vst::IComponentHandler &handler, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxScrolledWindowStyle, const wxString &name=wxPanelNameStr)
void	ReloadParameters ()
void	UpdateParameter (Steinberg::Vst::ParamID paramId)

Static Public Member Functions
static VST3ParametersWindow *	Setup (wxWindow &parent, Steinberg::Vst::IEditController &editController, Steinberg::Vst::IComponentHandler &componentHandler)
	Creates VST3ParametersWindow inside parent. More...

Private Member Functions
void	RegisterParameterControl (VST3ParameterControl *control)
void	RegisterParameterLabel (VST3ParameterControl *label)
void	OnParameterValueChanged (const wxCommandEvent &evt)

Private Attributes
const Steinberg::IPtr< Steinberg::Vst::IEditController >	mEditController
const Steinberg::IPtr< Steinberg::Vst::IComponentHandler >	mComponentHandler
std::unordered_map< Steinberg::Vst::ParamID, VST3ParameterControl * >	mControls
std::unordered_map< Steinberg::Vst::ParamID, VST3ParameterControl * >	mLabels

Detailed Description

"Plain" plugin UI, contains a list of parameter controls and values.

Definition at line 35 of file VST3ParametersWindow.h.

Constructor & Destructor Documentation

VST3ParametersWindow()

VST3ParametersWindow::VST3ParametersWindow	(	wxWindow *	parent,
		Steinberg::Vst::IEditController &	editController,
		Steinberg::Vst::IComponentHandler &	handler,
		wxWindowID	id = wxID_ANY,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxScrolledWindowStyle,
		const wxString &	name = wxPanelNameStr
	)

Definition at line 247 of file VST3ParametersWindow.cpp.

   : wxScrolledWindow(parent, id, pos, size, style, name)
   , mEditController(&editController)
   , mComponentHandler(&handler)
{
   using namespace Steinberg;
 
   auto sizer = std::make_unique<wxGridSizer>(3, 5, 5);
 
   for(int i = 0, count = editController.getParameterCount(); i < count; ++i)
   {
      Vst::ParameterInfo parameterInfo { };
      if(editController.getParameterInfo(i, parameterInfo) != kResultOk)
         continue;
 
      if(parameterInfo.flags & (Vst::ParameterInfo::kIsHidden | Vst::ParameterInfo::kIsProgramChange))
         continue;
      
      if((parameterInfo.flags & (Vst::ParameterInfo::kCanAutomate | Vst::ParameterInfo::kIsBypass | Vst::ParameterInfo::kIsReadOnly)) == 0)
         continue;
 
      {
         // Hide proxy parameters with name that starts with "MIDI CC "
         // That prevents Plain UI from creating many useless controls
         static_assert(sizeof(Steinberg::tchar) == sizeof(char16_t));
         static const std::basic_string_view<tchar> MIDI_CC { reinterpret_cast<const tchar*>(u"MIDI CC ") };
         if(std::basic_string_view<tchar>(parameterInfo.title).rfind(MIDI_CC, 0) == 0)
            continue;
      }
      
      if (parameterInfo.stepCount != 1)      // not a toggle
         sizer->Add(safenew wxStaticText(
            this,
            wxID_ANY,
            VST3Utils::ToWxString(parameterInfo.title),
            wxDefaultPosition,
            wxDefaultSize,
            wxALIGN_RIGHT), 0, wxEXPAND
         );
      
      if(parameterInfo.flags & Vst::ParameterInfo::kIsReadOnly)
      {
         auto text = safenew VST3ValueText(
            this,
            wxID_ANY,
            parameterInfo.id,
            VST3Utils::ToWxString(parameterInfo.units)
         );
         sizer->Add(text);
         sizer->AddStretchSpacer();
         RegisterParameterControl(text);
      }
      //toggle
      else if(parameterInfo.stepCount == 1)
      {
         const auto toggle = safenew VST3ToggleParameter (this, wxID_ANY,
            VST3Utils::ToWxString(parameterInfo.title), parameterInfo.id);
         toggle->Bind(wxEVT_CHECKBOX, &VST3ParametersWindow::OnParameterValueChanged, this);
         sizer->Add(toggle, 0, wxEXPAND);
         sizer->AddStretchSpacer();
         sizer->AddStretchSpacer();
         RegisterParameterControl(toggle);
      }
      //list
      else if(parameterInfo.stepCount != 0 && (parameterInfo.flags & Vst::ParameterInfo::kIsList))
      {
         const auto list = safenew VST3ListParameter(this, wxID_ANY, parameterInfo.id);
 
         for(auto j = 0; j <= parameterInfo.stepCount; ++j)
         {
            Vst::String128 displayValue = { 0 };
            editController.getParamStringByValue(
               parameterInfo.id,
               editController.plainParamToNormalized(parameterInfo.id, j),
               displayValue
            );
            list->AppendString(VST3Utils::ToWxString(displayValue));
         }
         list->Bind(wxEVT_CHOICE, &VST3ParametersWindow::OnParameterValueChanged, this);
         sizer->Add(list, 0, wxEXPAND);
         sizer->AddStretchSpacer();
         RegisterParameterControl(list);
      }
      else
      {
         //continuous
         if(parameterInfo.stepCount == 0)
         {
            auto slider = safenew VST3ContinuousParameter(this, wxID_ANY, parameterInfo.id,
               VST3Utils::ToWxString(parameterInfo.title), VST3Utils::ToWxString(parameterInfo.units));
            sizer->Add(slider, 0, wxEXPAND);
            slider->Bind(wxEVT_SLIDER, &VST3ParametersWindow::OnParameterValueChanged, this);
            RegisterParameterControl(slider);
         }
         //discrete
         else
         {
            auto slider = safenew VST3DiscreteParameter(this, wxID_ANY, parameterInfo.id, parameterInfo.stepCount,
               VST3Utils::ToWxString(parameterInfo.title), VST3Utils::ToWxString(parameterInfo.units),
               editController);
            sizer->Add(slider, 0, wxEXPAND);
            slider->Bind(wxEVT_SLIDER, &VST3ParametersWindow::OnParameterValueChanged, this);
            RegisterParameterControl(slider);
         }
         const auto label = safenew VST3ValueText(this, wxID_ANY, parameterInfo.id, VST3Utils::ToWxString(parameterInfo.units));
         sizer->Add(label);
         RegisterParameterLabel(label);
      }
   }
 
   SetSizer(sizer.release());
}

References label, OnParameterValueChanged(), RegisterParameterControl(), RegisterParameterLabel(), safenew, and VST3Utils::ToWxString().

Referenced by Setup().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

OnParameterValueChanged()

void VST3ParametersWindow::OnParameterValueChanged ( const wxCommandEvent &  evt )

private

Definition at line 401 of file VST3ParametersWindow.cpp.

{
   if(auto control = dynamic_cast<VST3ParameterControl*>(evt.GetEventObject()))
   {
      const auto paramId = control->GetParameterId();
      const auto normalizedValue = control->GetNormalizedValue(*mEditController);
 
      mEditController->setParamNormalized(paramId, normalizedValue);
      if(mComponentHandler->beginEdit(paramId) == Steinberg::kResultOk)
      {
         auto cleanup = finally([=] { mComponentHandler->endEdit(paramId); });
         mComponentHandler->performEdit(paramId, normalizedValue);
      }
      auto it = mLabels.find(paramId);
      if (it != mLabels.end()) {
         it->second->SetNormalizedValue(*mEditController, normalizedValue);
         control->UpdateAccessible(*mEditController, normalizedValue);
      }
   }
}

References mComponentHandler, mEditController, and mLabels.

Referenced by VST3ParametersWindow().

Here is the caller graph for this function:

RegisterParameterControl()

void VST3ParametersWindow::RegisterParameterControl ( VST3ParameterControl *  control )

private

Definition at line 389 of file VST3ParametersWindow.cpp.

{
   mControls[control->GetParameterId()] = control;
   control->SetNormalizedValue(*mEditController, mEditController->getParamNormalized(control->GetParameterId()));
}

References VST3ParameterControl::GetParameterId(), mControls, mEditController, and VST3ParameterControl::SetNormalizedValue().

Referenced by VST3ParametersWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterParameterLabel()

void VST3ParametersWindow::RegisterParameterLabel ( VST3ParameterControl *  label )

private

Definition at line 395 of file VST3ParametersWindow.cpp.

{
   mLabels[label->GetParameterId()] = label;
   label->SetNormalizedValue(*mEditController, mEditController->getParamNormalized(label->GetParameterId()));
}

References label, mEditController, and mLabels.

Referenced by VST3ParametersWindow().

Here is the caller graph for this function:

ReloadParameters()

void VST3ParametersWindow::ReloadParameters

(

)

Definition at line 367 of file VST3ParametersWindow.cpp.

{
   for(auto& p : mControls)
      p.second->SetNormalizedValue(*mEditController, mEditController->getParamNormalized(p.second->GetParameterId()));
   for(auto& p : mLabels)
      p.second->SetNormalizedValue(*mEditController, mEditController->getParamNormalized(p.second->GetParameterId()));
}

References mControls, mEditController, and mLabels.

Referenced by VST3Editor::UpdateUI().

Here is the caller graph for this function:

Setup()

VST3ParametersWindow * VST3ParametersWindow::Setup ( wxWindow &  parent, Steinberg::Vst::IEditController &  editController, Steinberg::Vst::IComponentHandler &  componentHandler  )

static

Creates VST3ParametersWindow inside parent.

Parameters

parent	Where all parameter controls will be placed
editController	Used to read current values
handler	Used to report parameter changes

Definition at line 422 of file VST3ParametersWindow.cpp.

{
   constexpr int WindowBorder { 5 };
   constexpr int WindowMaxHeight { 450 };
 
   auto parametersWindow = safenew VST3ParametersWindow(&parent,
      editController,
      componentHandler,
      wxID_ANY,
      wxDefaultPosition,
      wxDefaultSize,
      wxVSCROLL | wxTAB_TRAVERSAL);
   // This fools NVDA into not saying "Panel" when the dialog gets focus
   parametersWindow->SetName(wxT("\a"));
   parametersWindow->SetLabel(wxT("\a"));
 
   auto mainSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
   
   mainSizer->Add(parametersWindow, 1, wxEXPAND | wxALL, WindowBorder);
 
   auto minSize = parametersWindow->GetSizer()->CalcMin();
   if(minSize.GetHeight() > (WindowMaxHeight - WindowBorder * 2))
   {
      minSize.SetHeight(WindowMaxHeight);
      parametersWindow->SetScrollRate(0, 20);
   }
   else
      minSize.y += WindowBorder * 2;
   
   parent.SetMinSize(minSize);
   parent.SetSizer(mainSizer.release());
 
   return parametersWindow;
}

References safenew, VST3ParametersWindow(), and wxT().

Referenced by VST3Editor::VST3Editor().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateParameter()

void VST3ParametersWindow::UpdateParameter

(

Steinberg::Vst::ParamID

paramId

)

Definition at line 375 of file VST3ParametersWindow.cpp.

{
   {
      auto it = mControls.find(paramId);
      if(it != mControls.end())
         it->second->SetNormalizedValue(*mEditController, mEditController->getParamNormalized(it->second->GetParameterId()));
   }
   {
      auto it = mLabels.find(paramId);
      if(it != mLabels.end())
         it->second->SetNormalizedValue(*mEditController, mEditController->getParamNormalized(it->second->GetParameterId()));
   }
}

References mControls, mEditController, and mLabels.

Member Data Documentation

mComponentHandler

const Steinberg::IPtr<Steinberg::Vst::IComponentHandler> VST3ParametersWindow::mComponentHandler

private

Definition at line 38 of file VST3ParametersWindow.h.

Referenced by OnParameterValueChanged().

mControls

std::unordered_map<Steinberg::Vst::ParamID, VST3ParameterControl*> VST3ParametersWindow::mControls

private

Definition at line 39 of file VST3ParametersWindow.h.

Referenced by RegisterParameterControl(), ReloadParameters(), and UpdateParameter().

mEditController

const Steinberg::IPtr<Steinberg::Vst::IEditController> VST3ParametersWindow::mEditController

private

Definition at line 37 of file VST3ParametersWindow.h.

Referenced by OnParameterValueChanged(), RegisterParameterControl(), RegisterParameterLabel(), ReloadParameters(), and UpdateParameter().

mLabels

std::unordered_map<Steinberg::Vst::ParamID, VST3ParameterControl*> VST3ParametersWindow::mLabels

private

Definition at line 40 of file VST3ParametersWindow.h.

Referenced by OnParameterValueChanged(), RegisterParameterLabel(), ReloadParameters(), and UpdateParameter().

---

The documentation for this class was generated from the following files:

• VST3ParametersWindow.h
• VST3ParametersWindow.cpp