EffectWahwah::Editor Struct Reference

Inheritance diagram for EffectWahwah::Editor:

Collaboration diagram for EffectWahwah::Editor:

Public Member Functions
	Editor (const EffectUIServices &services, EffectSettingsAccess &access, const EffectWahwahSettings &settings)
virtual	~Editor ()=default
bool	ValidateUI () override
	Get settings data from the panel; may make error dialogs and return false. More...
bool	UpdateUI () override
	Update appearance of the panel for changes in settings. More...
void	PopulateOrExchange (ShuttleGui &S)
void	OnFreqSlider (wxCommandEvent &evt)
void	OnPhaseSlider (wxCommandEvent &evt)
void	OnDepthSlider (wxCommandEvent &evt)
void	OnResonanceSlider (wxCommandEvent &evt)
void	OnFreqOffSlider (wxCommandEvent &evt)
void	OnGainSlider (wxCommandEvent &evt)
void	OnFreqText (wxCommandEvent &evt)
void	OnPhaseText (wxCommandEvent &evt)
void	OnDepthText (wxCommandEvent &evt)
void	OnResonanceText (wxCommandEvent &evt)
void	OnFreqOffText (wxCommandEvent &evt)
void	OnGainText (wxCommandEvent &evt)
void	EnableApplyFromValidate ()
bool	EnableApplyFromTransferDataToWindow ()
Public Member Functions inherited from EffectEditor
	EffectEditor (const EffectUIServices &services, EffectSettingsAccess &access)
virtual	~EffectEditor ()
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...

Public Attributes
wxTextCtrl *	mFreqT
wxTextCtrl *	mPhaseT
wxTextCtrl *	mDepthT
wxTextCtrl *	mResT
wxTextCtrl *	mFreqOfsT
wxTextCtrl *	mOutGainT
wxSlider *	mFreqS
wxSlider *	mPhaseS
wxSlider *	mDepthS
wxSlider *	mResS
wxSlider *	mFreqOfsS
wxSlider *	mOutGainS
wxWeakRef< wxWindow >	mUIParent
EffectWahwahSettings	mSettings

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 EffectEditor
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 EffectEditor
static constexpr int	kPlayID = 20102
Static Public Attributes inherited from Observer::Publisher< EffectSettingChanged >
static constexpr bool	notifies_all
Protected Member Functions inherited from EffectEditor
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 EffectEditor
const EffectUIServices &	mUIServices
EffectSettingsAccess &	mAccess
bool	mUIClosed { false }

Detailed Description

Definition at line 36 of file Wahwah.cpp.

Constructor & Destructor Documentation

Editor()

EffectWahwah::Editor::Editor ( const EffectUIServices &  services, EffectSettingsAccess &  access, const EffectWahwahSettings &  settings  )

inline

Definition at line 39 of file Wahwah.cpp.

      : EffectEditor{ services, access }
      , mSettings{ settings }
   {}

~Editor()

virtual EffectWahwah::Editor::~Editor ( )

virtualdefault

Member Function Documentation

EnableApplyFromTransferDataToWindow()

bool EffectWahwah::Editor::EnableApplyFromTransferDataToWindow ( )

inline

Definition at line 88 of file Wahwah.cpp.

   {
      return EnableApply(mUIParent, mUIParent->TransferDataFromWindow());
   }

References EffectEditor::EnableApply(), and mUIParent.

Here is the call graph for this function:

EnableApplyFromValidate()

void EffectWahwah::Editor::EnableApplyFromValidate ( )

inline

Definition at line 83 of file Wahwah.cpp.

   {
      EnableApply(mUIParent, mUIParent->Validate());
   }

References EffectEditor::EnableApply(), and mUIParent.

Here is the call graph for this function:

OnDepthSlider()

void EffectWahwah::Editor::OnDepthSlider

(

wxCommandEvent &

evt

)

Definition at line 263 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   ms.mDepth = evt.GetInt() / Depth.scale;
   mDepthT->GetValidator()->TransferToWindow();
 
   EnableApplyFromValidate();
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::Depth, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnDepthText()

void EffectWahwah::Editor::OnDepthText

(

wxCommandEvent &

evt

)

Definition at line 339 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   if (!EnableApplyFromTransferDataToWindow())
   {
      return;
   }
 
   mDepthS->SetValue((int)(ms.mDepth * Depth.scale));
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::Depth, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnFreqOffSlider()

void EffectWahwah::Editor::OnFreqOffSlider

(

wxCommandEvent &

evt

)

Definition at line 287 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   ms.mFreqOfs = evt.GetInt() / FreqOfs.scale;
   mFreqOfsT->GetValidator()->TransferToWindow();
 
   EnableApplyFromValidate();
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::FreqOfs, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnFreqOffText()

void EffectWahwah::Editor::OnFreqOffText

(

wxCommandEvent &

evt

)

Definition at line 367 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   if (!EnableApplyFromTransferDataToWindow())
   {
      return;
   }
 
   mFreqOfsS->SetValue((int)(ms.mFreqOfs * FreqOfs.scale));
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::FreqOfs, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnFreqSlider()

void EffectWahwah::Editor::OnFreqSlider

(

wxCommandEvent &

evt

)

Definition at line 236 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   ms.mFreq = (double)evt.GetInt() / Freq.scale;
   mFreqT->GetValidator()->TransferToWindow();
 
   EnableApplyFromValidate();
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::Freq, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnFreqText()

void EffectWahwah::Editor::OnFreqText

(

wxCommandEvent &

evt

)

Definition at line 311 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   if (!EnableApplyFromTransferDataToWindow())
   {
      return;
   }
 
   mFreqS->SetValue((int)(ms.mFreq * Freq.scale));
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::Freq, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnGainSlider()

void EffectWahwah::Editor::OnGainSlider

(

wxCommandEvent &

evt

)

Definition at line 299 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   ms.mOutGain = evt.GetInt() / OutGain.scale;
   mOutGainT->GetValidator()->TransferToWindow();
 
   EnableApplyFromValidate();
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::OutGain, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnGainText()

void EffectWahwah::Editor::OnGainText

(

wxCommandEvent &

evt

)

Definition at line 381 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   if (!EnableApplyFromTransferDataToWindow())
   {
      return;
   }
 
   mOutGainS->SetValue((int)(ms.mOutGain * OutGain.scale));
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::OutGain, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnPhaseSlider()

void EffectWahwah::Editor::OnPhaseSlider

(

wxCommandEvent &

evt

)

Definition at line 248 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   int val = ((evt.GetInt() + 5) / 10) * 10; // round to nearest multiple of 10
   val = val > Phase.max * Phase.scale ? Phase.max * Phase.scale : val;
   mPhaseS->SetValue(val);
   ms.mPhase = (double)val / Phase.scale;
   mPhaseT->GetValidator()->TransferToWindow();
 
   EnableApplyFromValidate();
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References EffectParameter< Structure, Member, Type, Value >::max, WahWahBase::Phase, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnPhaseText()

void EffectWahwah::Editor::OnPhaseText

(

wxCommandEvent &

evt

)

Definition at line 325 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   if (!EnableApplyFromTransferDataToWindow())
   {
      return;
   }
 
   mPhaseS->SetValue((int)(ms.mPhase * Phase.scale));
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::Phase, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnResonanceSlider()

void EffectWahwah::Editor::OnResonanceSlider

(

wxCommandEvent &

evt

)

Definition at line 275 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   ms.mRes = (double)evt.GetInt() / Res.scale;
   mResT->GetValidator()->TransferToWindow();
 
   EnableApplyFromValidate();
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::Res, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnResonanceText()

void EffectWahwah::Editor::OnResonanceText

(

wxCommandEvent &

evt

)

Definition at line 353 of file Wahwah.cpp.

{
   auto& ms = mSettings;
 
   if (!EnableApplyFromTransferDataToWindow())
   {
      return;
   }
 
   mResS->SetValue((int)(ms.mRes * Res.scale));
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References WahWahBase::Res, EffectParameter< Structure, Member, Type, Value >::scale, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void EffectWahwah::Editor::PopulateOrExchange

(

ShuttleGui &

S

)

Definition at line 123 of file Wahwah.cpp.

{
   mUIParent = S.GetParent();
   auto& ms = mSettings;
 
   S.SetBorder(5);
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol(2);
 
      mFreqT = S
         .Validator<FloatingPointValidator<double>>(
            5, &ms.mFreq, NumValidatorStyle::ONE_TRAILING_ZERO, Freq.min, Freq.max)
         .AddTextBox(XXO("LFO Freq&uency (Hz):"), L"", 12);
      BindTo(*mFreqT, wxEVT_TEXT, &Editor::OnFreqText);
 
      mFreqS = S
         .Name(XO("LFO frequency in hertz"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Freq.def * Freq.scale, Freq.max * Freq.scale, Freq.min * Freq.scale);
      BindTo(*mFreqS, wxEVT_SLIDER, &Editor::OnFreqSlider);
 
      mPhaseT = S
         .Validator<FloatingPointValidator<double>>(
            1, &ms.mPhase, NumValidatorStyle::DEFAULT, Phase.min, Phase.max)
         .AddTextBox(XXO("LFO Sta&rt Phase (deg.):"), L"", 12);
      BindTo(*mPhaseT, wxEVT_TEXT, &Editor::OnPhaseText);
 
      mPhaseS = S
         .Name(XO("LFO start phase in degrees"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Phase.def * Phase.scale, Phase.max * Phase.scale, Phase.min * Phase.scale);
      mPhaseS->SetLineSize(10);
      BindTo(*mPhaseS, wxEVT_SLIDER, &Editor::OnPhaseSlider);
 
      mDepthT = S
         .Validator<IntegerValidator<int>>(
            &ms.mDepth, NumValidatorStyle::DEFAULT, Depth.min, Depth.max)
         .AddTextBox(XXO("Dept&h (%):"), L"", 12);
      BindTo(*mDepthT, wxEVT_TEXT, &Editor::OnDepthText);
 
      mDepthS = S
         .Name(XO("Depth in percent"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Depth.def * Depth.scale, Depth.max * Depth.scale, Depth.min * Depth.scale);
      BindTo(*mDepthS, wxEVT_SLIDER, &Editor::OnDepthSlider);
 
      mResT = S
         .Validator<FloatingPointValidator<double>>(
            1, &ms.mRes, NumValidatorStyle::DEFAULT, Res.min, Res.max)
         .AddTextBox(XXO("Reso&nance:"), L"", 12);
      BindTo(*mResT, wxEVT_TEXT, &Editor::OnResonanceText);
 
      mResS = S
         .Name(XO("Resonance"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Res.def * Res.scale, Res.max * Res.scale, Res.min * Res.scale);
      BindTo(*mResS, wxEVT_SLIDER, &Editor::OnResonanceSlider);
 
      mFreqOfsT = S
         .Validator<IntegerValidator<int>>(
            &ms.mFreqOfs, NumValidatorStyle::DEFAULT, FreqOfs.min, FreqOfs.max)
         .AddTextBox(XXO("Wah Frequency Offse&t (%):"), L"", 12);
      BindTo(*mFreqOfsT, wxEVT_TEXT, &Editor::OnFreqOffText);
 
      mFreqOfsS = S
         .Name(XO("Wah frequency offset in percent"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, FreqOfs.def * FreqOfs.scale, FreqOfs.max * FreqOfs.scale, FreqOfs.min * FreqOfs.scale);
      BindTo(*mFreqOfsS, wxEVT_SLIDER, &Editor::OnFreqOffSlider);
 
      mOutGainT = S
         .Validator<FloatingPointValidator<double>>(
            1, &ms.mOutGain, NumValidatorStyle::DEFAULT, OutGain.min, OutGain.max)
         .AddTextBox(XXO("&Output gain (dB):"), L"", 12);
      BindTo(*mOutGainT, wxEVT_TEXT, &Editor::OnGainText);
 
      mOutGainS = S
         .Name(XO("Output gain (dB)"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, OutGain.def * OutGain.scale, OutGain.max * OutGain.scale, OutGain.min * OutGain.scale);
      BindTo(*mOutGainS, wxEVT_SLIDER, &Editor::OnGainSlider);
   }
   S.EndMultiColumn();
}

References EffectParameter< Structure, Member, Type, Value >::def, WahWahBase::Depth, WahWahBase::Freq, WahWahBase::FreqOfs, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, OnDepthSlider(), OnDepthText(), OnFreqOffSlider(), OnFreqOffText(), OnFreqSlider(), OnFreqText(), OnGainSlider(), OnGainText(), OnPhaseSlider(), OnPhaseText(), OnResonanceSlider(), OnResonanceText(), WahWahBase::OutGain, WahWahBase::Phase, WahWahBase::Res, S, EffectParameter< Structure, Member, Type, Value >::scale, XO(), and XXO().

Here is the call graph for this function:

UpdateUI()

bool EffectWahwah::Editor::UpdateUI ( )

overridevirtual

Update appearance of the panel for changes in settings.

Default implementation does nothing, returns true

Returns

true if successful

Reimplemented from EffectEditor.

Definition at line 217 of file Wahwah.cpp.

{
   // get the settings from the MessageBuffer and write them to our local copy
   const auto& settings = mAccess.Get();
 
   mSettings = GetSettings(settings);
 
   auto& ms = mSettings;
 
   mFreqS->SetValue((int)(ms.mFreq * Freq.scale));
   mPhaseS->SetValue((int)(ms.mPhase * Phase.scale));
   mDepthS->SetValue((int)(ms.mDepth * Depth.scale));
   mResS->SetValue((int)(ms.mRes * Res.scale));
   mFreqOfsS->SetValue((int)(ms.mFreqOfs * FreqOfs.scale));
   mOutGainS->SetValue((int)(ms.mOutGain * OutGain.scale));
 
   return true;
}

References WahWahBase::Depth, WahWahBase::Freq, WahWahBase::FreqOfs, EffectWithSettings< EffectWahwahSettings, PerTrackEffect >::GetSettings(), WahWahBase::OutGain, WahWahBase::Phase, WahWahBase::Res, EffectParameter< Structure, Member, Type, Value >::scale, and settings().

Here is the call graph for this function:

ValidateUI()

bool EffectWahwah::Editor::ValidateUI ( )

overridevirtual

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

Returns

true only if panel settings are acceptable

Implements EffectEditor.

Definition at line 95 of file Wahwah.cpp.

{
   mAccess.ModifySettings
   (
      [this](EffectSettings& settings)
      {
         // pass back the modified settings to the MessageBuffer
         GetSettings(settings) = mSettings;
         return nullptr;
      }
   );
 
   return true;
}

References EffectWithSettings< EffectWahwahSettings, PerTrackEffect >::GetSettings(), EffectEditor::mAccess, EffectSettingsAccess::ModifySettings(), mSettings, and settings().

Here is the call graph for this function:

Member Data Documentation

mDepthS

wxSlider* EffectWahwah::Editor::mDepthS

Definition at line 74 of file Wahwah.cpp.

mDepthT

wxTextCtrl* EffectWahwah::Editor::mDepthT

Definition at line 67 of file Wahwah.cpp.

mFreqOfsS

wxSlider* EffectWahwah::Editor::mFreqOfsS

Definition at line 76 of file Wahwah.cpp.

mFreqOfsT

wxTextCtrl* EffectWahwah::Editor::mFreqOfsT

Definition at line 69 of file Wahwah.cpp.

mFreqS

wxSlider* EffectWahwah::Editor::mFreqS

Definition at line 72 of file Wahwah.cpp.

mFreqT

wxTextCtrl* EffectWahwah::Editor::mFreqT

Definition at line 65 of file Wahwah.cpp.

mOutGainS

wxSlider* EffectWahwah::Editor::mOutGainS

Definition at line 77 of file Wahwah.cpp.

mOutGainT

wxTextCtrl* EffectWahwah::Editor::mOutGainT

Definition at line 70 of file Wahwah.cpp.

mPhaseS

wxSlider* EffectWahwah::Editor::mPhaseS

Definition at line 73 of file Wahwah.cpp.

mPhaseT

wxTextCtrl* EffectWahwah::Editor::mPhaseT

Definition at line 66 of file Wahwah.cpp.

mResS

wxSlider* EffectWahwah::Editor::mResS

Definition at line 75 of file Wahwah.cpp.

mResT

wxTextCtrl* EffectWahwah::Editor::mResT

Definition at line 68 of file Wahwah.cpp.

mSettings

EffectWahwahSettings EffectWahwah::Editor::mSettings

Definition at line 81 of file Wahwah.cpp.

Referenced by ValidateUI().

mUIParent

wxWeakRef<wxWindow> EffectWahwah::Editor::mUIParent

Definition at line 80 of file Wahwah.cpp.

Referenced by EnableApplyFromTransferDataToWindow(), and EnableApplyFromValidate().

---

The documentation for this struct was generated from the following file:

• Wahwah.cpp