VST3UIValidator Class Reference

#include <VST3UIValidator.h>

Inheritance diagram for VST3UIValidator:

Collaboration diagram for VST3UIValidator:

Public Member Functions
	VST3UIValidator (wxWindow *parent, VST3Wrapper &wrapper, EffectBase &effect, EffectSettingsAccess &access, bool useNativeUI)
	~VST3UIValidator () override
bool	IsGraphicalUI () override
bool	UpdateUI () override
	Update appearance of the panel for changes in settings. More...
bool	ValidateUI () override
	Get settings data from the panel; may make error dialogs and return false. More...
void	OnClose () override
Public Member Functions inherited from EffectUIValidator
	EffectUIValidator (EffectUIClientInterface &effect, EffectSettingsAccess &access)
virtual	~EffectUIValidator ()
virtual bool	ValidateUI ()=0
	Get settings data from the panel; may make error dialogs and return false. More...
virtual bool	UpdateUI ()
	Update appearance of the panel for changes in settings. More...
virtual bool	IsGraphicalUI ()
virtual void	Disconnect ()
	On the first call only, may disconnect from further event handling. More...
virtual void	OnClose ()
Public Member Functions inherited from Observer::Publisher< EffectSettingChanged >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Private Member Functions
void	OnIdle (wxIdleEvent &)
bool	TryLoadNativeUI (wxWindow *parent)

Private Attributes
VST3Wrapper &	mWrapper
Steinberg::IPtr< Steinberg::IPlugView >	mPlugView
Steinberg::IPtr< Steinberg::IPlugFrame >	mPlugFrame
wxWindow *	mParent { nullptr }
NumericTextCtrl *	mDuration { nullptr }
VST3ParametersWindow *	mPlainUI { nullptr }

Additional Inherited Members
Public Types inherited from Observer::Publisher< EffectSettingChanged >
using	message_type = EffectSettingChanged
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const EffectSettingChanged &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Member Functions inherited from EffectUIValidator
static bool	EnableApply (wxWindow *parent, bool enable=true)
	Enable or disable the Apply button of the dialog that contains parent. More...
static bool	EnablePreview (wxWindow *parent, bool enable=true)
Static Public Attributes inherited from EffectUIValidator
static constexpr int	kPlayID = 20102
Static Public Attributes inherited from Observer::Publisher< EffectSettingChanged >
static constexpr bool	notifies_all
Protected Member Functions inherited from EffectUIValidator
template<typename EventTag , typename Class , typename Event >
void	BindTo (wxEvtHandler &src, const EventTag &eventType, void(Class::*pmf)(Event &))
Protected Member Functions inherited from Observer::Publisher< EffectSettingChanged >
CallbackReturn	Publish (const EffectSettingChanged &message)
	Send a message to connected callbacks. More...
Protected Attributes inherited from EffectUIValidator
EffectUIClientInterface &	mEffect
EffectSettingsAccess &	mAccess
bool	mUIClosed { false }

Detailed Description

Definition at line 19 of file VST3UIValidator.h.

Constructor & Destructor Documentation

VST3UIValidator()

VST3UIValidator::VST3UIValidator	(	wxWindow *	parent,
		VST3Wrapper &	wrapper,
		EffectBase &	effect,
		EffectSettingsAccess &	access,
		bool	useNativeUI
	)

Definition at line 16 of file VST3UIValidator.cpp.

   : EffectUIValidator(effect, access), mWrapper(wrapper), mParent(parent)
{
   if(effect.GetType() == EffectTypeGenerate)
   {
      auto vSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
      auto controlsRoot = safenew wxWindow(parent, wxID_ANY);
      if(!useNativeUI || !TryLoadNativeUI(controlsRoot))
         mPlainUI = VST3ParametersWindow::Setup(*controlsRoot, *mWrapper.mEditController, *mWrapper.mComponentHandler);
      vSizer->Add(controlsRoot);
 
      auto &extra = access.Get().extra;
      mDuration = safenew NumericTextCtrl(
            parent, wxID_ANY,
            NumericConverter::TIME,
            extra.GetDurationFormat(),
            extra.GetDuration(),
            mWrapper.mSetup.sampleRate,
            NumericTextCtrl::Options{}
               .AutoPos(true)
         );
      mDuration->SetName( XO("Duration") );
 
      auto hSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
      hSizer->Add(safenew wxStaticText(parent, wxID_ANY, _("Duration:")));
      hSizer->AddSpacer(5);
      hSizer->Add(mDuration);
      vSizer->AddSpacer(10);
      vSizer->Add(hSizer.release());
 
      parent->SetMinSize(vSizer->CalcMin());
      parent->SetSizer(vSizer.release());
   }
   else if(!useNativeUI || !TryLoadNativeUI(parent))
   {
      mPlainUI = VST3ParametersWindow::Setup(
         *parent,
         *mWrapper.mEditController,
         *mWrapper.mComponentHandler
      );
   }
 
   mWrapper.ParamChangedHandler =
      [this](Steinberg::Vst::ParamID id, Steinberg::Vst::ParamValue value) {
         Publish({ static_cast<size_t>(id), static_cast<float>(value) });
      };
   
   mWrapper.BeginParameterEdit(mAccess);
 
   Bind(wxEVT_IDLE, &VST3UIValidator::OnIdle, this);
 
   mParent->PushEventHandler(this);
}

References _, NumericTextCtrl::Options::AutoPos(), VST3Wrapper::BeginParameterEdit(), EffectTypeGenerate, EffectSettings::extra, EffectSettingsAccess::Get(), EffectDefinitionInterface::GetType(), id, EffectUIValidator::mAccess, VST3Wrapper::mComponentHandler, mDuration, VST3Wrapper::mEditController, mParent, mPlainUI, VST3Wrapper::mSetup, mWrapper, OnIdle(), VST3Wrapper::ParamChangedHandler, Observer::Publisher< EffectSettingChanged >::Publish(), safenew, NumericTextCtrl::SetName(), VST3ParametersWindow::Setup(), NumericConverter::TIME, TryLoadNativeUI(), and XO().

Here is the call graph for this function:

~VST3UIValidator()

VST3UIValidator::~VST3UIValidator ( )

override

Definition at line 70 of file VST3UIValidator.cpp.

{
   mWrapper.ParamChangedHandler = {};
}

References mWrapper, and VST3Wrapper::ParamChangedHandler.

Member Function Documentation

IsGraphicalUI()

bool VST3UIValidator::IsGraphicalUI ( )

overridevirtual

Default implementation returns false

Returns

true if using a native plug-in UI, not widgets

Reimplemented from EffectUIValidator.

Definition at line 131 of file VST3UIValidator.cpp.

{
   return mPlugView != nullptr;
}

References mPlugView.

OnClose()

void VST3UIValidator::OnClose ( )

overridevirtual

Handle the UI OnClose event. Default implementation calls mEffect.CloseUI()

Reimplemented from EffectUIValidator.

Definition at line 149 of file VST3UIValidator.cpp.

{
   using namespace Steinberg;
 
   mParent->PopEventHandler();
 
   mPlainUI = nullptr;
   mParent = nullptr;
   if(mPlugView)
   {
      mPlugView->setFrame(nullptr);
      mPlugView->removed();
      mPlugView = nullptr;
      mPlugFrame = nullptr;
   }
 
   mWrapper.EndParameterEdit();
   
   mAccess.ModifySettings([&](EffectSettings &settings){
      if (mDuration != nullptr)
         settings.extra.SetDuration(mDuration->GetValue());
      //Flush changes if there is no processing performed at the moment
      mWrapper.FlushParameters(settings);
      mWrapper.StoreSettings(settings);
      return nullptr;
   });
   //Make sure that new state has been written to the caches...
   mAccess.Flush();
 
   mWrapper.ParamChangedHandler = {};
 
   EffectUIValidator::OnClose();
}

References VST3Wrapper::EndParameterEdit(), EffectSettingsAccess::Flush(), VST3Wrapper::FlushParameters(), NumericConverter::GetValue(), EffectUIValidator::mAccess, mDuration, EffectSettingsAccess::ModifySettings(), mParent, mPlainUI, mPlugFrame, mPlugView, mWrapper, EffectUIValidator::OnClose(), VST3Wrapper::ParamChangedHandler, settings(), and VST3Wrapper::StoreSettings().

Here is the call graph for this function:

OnIdle()

void VST3UIValidator::OnIdle ( wxIdleEvent &  evt )

private

Definition at line 75 of file VST3UIValidator.cpp.

{
   evt.Skip();
   if(!mWrapper.IsActive())
   {
      mAccess.ModifySettings([this](EffectSettings& settings)
      {
         bool hasChanges{false};
         mWrapper.FlushParameters(settings, &hasChanges);
         if(hasChanges)
            mWrapper.StoreSettings(settings);
         return nullptr;
      });
   }
}

References VST3Wrapper::FlushParameters(), VST3Wrapper::IsActive(), EffectUIValidator::mAccess, EffectSettingsAccess::ModifySettings(), mWrapper, settings(), and VST3Wrapper::StoreSettings().

Referenced by VST3UIValidator().

Here is the call graph for this function:

Here is the caller graph for this function:

TryLoadNativeUI()

bool VST3UIValidator::TryLoadNativeUI ( wxWindow *  parent )

private

Definition at line 92 of file VST3UIValidator.cpp.

{
   using namespace Steinberg;
 
   if(const auto view = owned (mWrapper.mEditController->createView (Vst::ViewType::kEditor))) 
   {
      //Workaround: override default min size set by EffectUIHost::Initialize()
      parent->SetMinSize(wxDefaultSize);
      //IPlugFrame::resizeView is supposed to call IPlugView::setSize
      //in the same call stack, assign before frame is attached
      mPlugView = view;
 
#if __WXGTK__
      safenew internal::x11::SocketWindow(parent, wxID_ANY, view);
#else
 
      static const auto platformType =
#  if __WXMAC__
         kPlatformTypeNSView;
#  elif __WXMSW__
         kPlatformTypeHWND;
#  else
#     error "Platform not supported"
#  endif
      auto plugFrame = owned(safenew internal::PlugFrame { parent });
      view->setFrame(plugFrame);
      if(view->attached(parent->GetHandle(), platformType) != kResultOk)
         return false;
      mPlugFrame = plugFrame;
 
      ViewRect initialSize;
      if(view->getSize(&initialSize) == kResultOk)
         plugFrame->init(view.get(), &initialSize);
#endif
      return true;
   }
   return false;
}

References VST3Wrapper::mEditController, mPlugFrame, mPlugView, mWrapper, and safenew.

Referenced by VST3UIValidator().

Here is the caller graph for this function:

UpdateUI()

bool VST3UIValidator::UpdateUI ( )

overridevirtual

Update appearance of the panel for changes in settings.

Default implementation does nothing, returns true

Returns

true if successful

Reimplemented from EffectUIValidator.

Definition at line 183 of file VST3UIValidator.cpp.

{
   mAccess.ModifySettings([&](EffectSettings& settings) {
      mWrapper.FetchSettings(settings);
      return nullptr;
   });
   
   if (mPlainUI != nullptr)
      mPlainUI->ReloadParameters();
 
   //Write to main...
   mAccess.Flush();
 
   return true;
}

References VST3Wrapper::FetchSettings(), EffectSettingsAccess::Flush(), EffectUIValidator::mAccess, EffectSettingsAccess::ModifySettings(), mPlainUI, mWrapper, VST3ParametersWindow::ReloadParameters(), and settings().

Here is the call graph for this function:

ValidateUI()

bool VST3UIValidator::ValidateUI ( )

overridevirtual

Get settings data from the panel; may make error dialogs and return false.

Returns

true only if panel settings are acceptable

Implements EffectUIValidator.

Definition at line 136 of file VST3UIValidator.cpp.

{
   mAccess.ModifySettings([&](EffectSettings &settings){
      if (mDuration != nullptr)
         settings.extra.SetDuration(mDuration->GetValue());
      mWrapper.FlushParameters(settings);
      mWrapper.StoreSettings(settings);
      return nullptr;
   });
 
   return true;
}

References VST3Wrapper::FlushParameters(), NumericConverter::GetValue(), EffectUIValidator::mAccess, mDuration, EffectSettingsAccess::ModifySettings(), mWrapper, settings(), and VST3Wrapper::StoreSettings().

Here is the call graph for this function:

Member Data Documentation

mDuration

NumericTextCtrl* VST3UIValidator::mDuration { nullptr }

private

Definition at line 28 of file VST3UIValidator.h.

Referenced by OnClose(), ValidateUI(), and VST3UIValidator().

mParent

wxWindow* VST3UIValidator::mParent { nullptr }

private

Definition at line 27 of file VST3UIValidator.h.

Referenced by OnClose(), and VST3UIValidator().

mPlainUI

VST3ParametersWindow* VST3UIValidator::mPlainUI { nullptr }

private

Definition at line 30 of file VST3UIValidator.h.

Referenced by OnClose(), UpdateUI(), and VST3UIValidator().

mPlugFrame

Steinberg::IPtr<Steinberg::IPlugFrame> VST3UIValidator::mPlugFrame

private

Definition at line 26 of file VST3UIValidator.h.

Referenced by OnClose(), and TryLoadNativeUI().

mPlugView

Steinberg::IPtr<Steinberg::IPlugView> VST3UIValidator::mPlugView

private

Definition at line 25 of file VST3UIValidator.h.

Referenced by IsGraphicalUI(), OnClose(), and TryLoadNativeUI().

mWrapper

VST3Wrapper& VST3UIValidator::mWrapper

private

Definition at line 23 of file VST3UIValidator.h.

Referenced by OnClose(), OnIdle(), TryLoadNativeUI(), UpdateUI(), ValidateUI(), VST3UIValidator(), and ~VST3UIValidator().

---

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

• VST3UIValidator.h
• VST3UIValidator.cpp