Inheritance diagram for EffectPhaser::Editor:

Collaboration diagram for EffectPhaser::Editor:

Public Member Functions
	Editor (const EffectUIServices &services, EffectSettingsAccess &access, const EffectPhaserSettings &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	OnStagesSlider (wxCommandEvent &evt)

void	OnDryWetSlider (wxCommandEvent &evt)

void	OnFeedbackSlider (wxCommandEvent &evt)

void	OnDepthSlider (wxCommandEvent &evt)

void	OnPhaseSlider (wxCommandEvent &evt)

void	OnFreqSlider (wxCommandEvent &evt)

void	OnGainSlider (wxCommandEvent &evt)

void	OnStagesText (wxCommandEvent &evt)

void	OnDryWetText (wxCommandEvent &evt)

void	OnFeedbackText (wxCommandEvent &evt)

void	OnDepthText (wxCommandEvent &evt)

void	OnPhaseText (wxCommandEvent &evt)

void	OnFreqText (wxCommandEvent &evt)

void	OnGainText (wxCommandEvent &evt)

void	EnableApplyFromValidate ()

bool	EnableApplyFromTransferDataFromWindow ()

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
wxWeakRef< wxWindow >	mUIParent

EffectPhaserSettings	mSettings

wxTextCtrl *	mStagesT

wxTextCtrl *	mDryWetT

wxTextCtrl *	mFreqT

wxTextCtrl *	mPhaseT

wxTextCtrl *	mDepthT

wxTextCtrl *	mFeedbackT

wxTextCtrl *	mOutGainT

wxSlider *	mStagesS

wxSlider *	mDryWetS

wxSlider *	mFreqS

wxSlider *	mPhaseS

wxSlider *	mDepthS

wxSlider *	mFeedbackS

wxSlider *	mOutGainS

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 26 of file Phaser.cpp.

Constructor & Destructor Documentation

◆ Editor()

EffectPhaser::Editor::Editor	(	const EffectUIServices &	services,
		EffectSettingsAccess &	access,
		const EffectPhaserSettings &	settings
	)

inline

Definition at line 29 of file Phaser.cpp.

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

◆ ~Editor()

virtual EffectPhaser::Editor::~Editor ( )

virtualdefault

Member Function Documentation

◆ EnableApplyFromTransferDataFromWindow()

bool EffectPhaser::Editor::EnableApplyFromTransferDataFromWindow ( )

inline

Definition at line 82 of file Phaser.cpp.

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

References EffectEditor::EnableApply(), and mUIParent.

Here is the call graph for this function:

◆ EnableApplyFromValidate()

void EffectPhaser::Editor::EnableApplyFromValidate ( )

inline

Definition at line 77 of file Phaser.cpp.

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

References EffectEditor::EnableApply(), and mUIParent.

Here is the call graph for this function:

◆ OnDepthSlider()

void EffectPhaser::Editor::OnDepthSlider ( wxCommandEvent & evt )

Definition at line 318 of file Phaser.cpp.

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

References PhaserBase::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 EffectPhaser::Editor::OnDepthText ( wxCommandEvent & evt )

Definition at line 418 of file Phaser.cpp.

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

References PhaserBase::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:

◆ OnDryWetSlider()

void EffectPhaser::Editor::OnDryWetSlider ( wxCommandEvent & evt )

Definition at line 278 of file Phaser.cpp.

{
   auto& ms = mSettings;
 
   ms.mDryWet = evt.GetInt() / DryWet.scale;
   mDryWetT->GetValidator()->TransferToWindow();
   EnableApplyFromValidate();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References PhaserBase::DryWet, 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:

◆ OnDryWetText()

void EffectPhaser::Editor::OnDryWetText ( wxCommandEvent & evt )

Definition at line 373 of file Phaser.cpp.

{
   auto& ms = mSettings;
 
   if (!EnableApplyFromTransferDataFromWindow())
   {
      return;
   }
 
   mDryWetS->SetValue((int) (ms.mDryWet * DryWet.scale));
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References PhaserBase::DryWet, 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:

◆ OnFeedbackSlider()

void EffectPhaser::Editor::OnFeedbackSlider ( wxCommandEvent & evt )

Definition at line 330 of file Phaser.cpp.

{
   auto& ms = mSettings;
 
   int val = evt.GetInt();
   val = ((val + (val > 0 ? 5 : -5)) / 10) * 10; // round to nearest multiple of 10
   val = val > Feedback.max * Feedback.scale ? Feedback.max * Feedback.scale : val;
   mFeedbackS->SetValue(val);
   ms.mFeedback = val / Feedback.scale;
   mFeedbackT->GetValidator()->TransferToWindow();
   EnableApplyFromValidate();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References PhaserBase::Feedback, EffectParameter< Structure, Member, Type, Value >::max, 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:

◆ OnFeedbackText()

void EffectPhaser::Editor::OnFeedbackText ( wxCommandEvent & evt )

Definition at line 433 of file Phaser.cpp.

{
   auto& ms = mSettings;
 
   if (!EnableApplyFromTransferDataFromWindow())
   {
      return;
   }
 
   mFeedbackS->SetValue((int) (ms.mFeedback * Feedback.scale));
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References PhaserBase::Feedback, 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 EffectPhaser::Editor::OnFreqSlider ( wxCommandEvent & evt )

Definition at line 290 of file Phaser.cpp.

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

References PhaserBase::Freq, EffectParameter< Structure, Member, Type, Value >::min, 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 EffectPhaser::Editor::OnFreqText ( wxCommandEvent & evt )

Definition at line 388 of file Phaser.cpp.

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

References PhaserBase::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 EffectPhaser::Editor::OnGainSlider ( wxCommandEvent & evt )

Definition at line 346 of file Phaser.cpp.

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

References PhaserBase::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 EffectPhaser::Editor::OnGainText ( wxCommandEvent & evt )

Definition at line 448 of file Phaser.cpp.

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

References PhaserBase::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 EffectPhaser::Editor::OnPhaseSlider ( wxCommandEvent & evt )

Definition at line 303 of file Phaser.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, PhaserBase::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 EffectPhaser::Editor::OnPhaseText ( wxCommandEvent & evt )

Definition at line 403 of file Phaser.cpp.

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

References PhaserBase::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:

◆ OnStagesSlider()

void EffectPhaser::Editor::OnStagesSlider ( wxCommandEvent & evt )

Definition at line 266 of file Phaser.cpp.

{
   auto& ms = mSettings;
 
   ms.mStages = (evt.GetInt() / Stages.scale) & ~1;  // must be even;
   mStagesT->GetValidator()->TransferToWindow();
   EnableApplyFromValidate();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

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

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnStagesText()

void EffectPhaser::Editor::OnStagesText ( wxCommandEvent & evt )

Definition at line 358 of file Phaser.cpp.

{
   auto& ms = mSettings;
 
   if (!EnableApplyFromTransferDataFromWindow())
   {
      return;
   }
 
   mStagesS->SetValue((int) (ms.mStages * Stages.scale));
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

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

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopulateOrExchange()

void EffectPhaser::Editor::PopulateOrExchange ( ShuttleGui & S )

Definition at line 102 of file Phaser.cpp.

{
   mUIParent = S.GetParent();
   auto& ms = mSettings;
 
   S.SetBorder(5);
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol(2);
 
      mStagesT = S
         .Validator<IntegerValidator<int>>(
            &ms.mStages, NumValidatorStyle::DEFAULT, Stages.min, Stages.max)
         .AddTextBox(XXO("&Stages:"), L"", 15);
      BindTo(*mStagesT, wxEVT_TEXT, &Editor::OnStagesText);
 
      mStagesS = S
         .Name(XO("Stages"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Stages.def * Stages.scale, Stages.max * Stages.scale, Stages.min * Stages.scale);
      mStagesS->SetLineSize(2);
      BindTo(*mStagesS, wxEVT_SLIDER, &Editor::OnStagesSlider);
 
      mDryWetT = S
         .Validator<IntegerValidator<int>>(
            &ms.mDryWet, NumValidatorStyle::DEFAULT, DryWet.min, DryWet.max)
         .AddTextBox(XXO("&Dry/Wet:"), L"", 15);
      BindTo(*mDryWetT, wxEVT_TEXT, &Editor::OnDryWetText);
 
      mDryWetS = S
         .Name(XO("Dry Wet"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, DryWet.def * DryWet.scale, DryWet.max * DryWet.scale, DryWet.min * DryWet.scale);
      BindTo(*mDryWetS, wxEVT_SLIDER, &Editor::OnDryWetSlider);
 
      mFreqT = S
         .Validator<FloatingPointValidator<double>>(
            5, &ms.mFreq, NumValidatorStyle::ONE_TRAILING_ZERO, Freq.min, Freq.max)
         .AddTextBox(XXO("LFO Freq&uency (Hz):"), L"", 15);
      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, 0.0);
      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"", 15);
      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"", 15);
      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);
 
      mFeedbackT = S
         .Validator<IntegerValidator<int>>(
            &ms.mFeedback, NumValidatorStyle::DEFAULT, Feedback.min, Feedback.max)
         .AddTextBox(XXO("Feedbac&k (%):"), L"", 15);
      BindTo(*mFeedbackT, wxEVT_TEXT, &Editor::OnFeedbackText);
 
      mFeedbackS = S
         .Name(XO("Feedback in percent"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Feedback.def * Feedback.scale, Feedback.max * Feedback.scale, Feedback.min * Feedback.scale);
      mFeedbackS->SetLineSize(10);
      BindTo(*mFeedbackS, wxEVT_SLIDER, &Editor::OnFeedbackSlider);
 
      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 EffectEditor::BindTo(), EffectParameter< Structure, Member, Type, Value >::def, PhaserBase::Depth, PhaserBase::DryWet, PhaserBase::Feedback, PhaserBase::Freq, EffectParameter< Structure, Member, Type, Value >::max, mDepthS, mDepthT, mDryWetS, mDryWetT, mFeedbackS, mFeedbackT, mFreqS, mFreqT, EffectParameter< Structure, Member, Type, Value >::min, mOutGainS, mOutGainT, mPhaseS, mPhaseT, mSettings, mStagesS, mStagesT, mUIParent, OnDepthSlider(), OnDepthText(), OnDryWetSlider(), OnDryWetText(), OnFeedbackSlider(), OnFeedbackText(), OnFreqSlider(), OnFreqText(), OnGainSlider(), OnGainText(), OnPhaseSlider(), OnPhaseText(), OnStagesSlider(), OnStagesText(), PhaserBase::OutGain, PhaserBase::Phase, S, EffectParameter< Structure, Member, Type, Value >::scale, PhaserBase::Stages, XO(), and XXO().

Here is the call graph for this function:

◆ UpdateUI()

bool EffectPhaser::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 212 of file Phaser.cpp.

{
   // get the settings from the MessageBuffer and write them to our local copy
   const auto& settings = mAccess.Get();
 
   mSettings = GetSettings(settings);
 
   if (!mUIParent->TransferDataToWindow())
   {
      return false;
   }
 
   mStagesS->  SetValue((int) (mSettings.mStages * Stages.scale));
   mDryWetS->  SetValue((int) (mSettings.mDryWet * DryWet.scale));
   mFreqS->    SetValue((int) (mSettings.mFreq * Freq.scale));
   mPhaseS->   SetValue((int) (mSettings.mPhase * Phase.scale));
   mDepthS->   SetValue((int) (mSettings.mDepth * Depth.scale));
   mFeedbackS->SetValue((int) (mSettings.mFeedback * Feedback.scale));
   mOutGainS-> SetValue((int) (mSettings.mOutGain * OutGain.scale));
 
   return true;
}

References PhaserBase::Depth, PhaserBase::DryWet, PhaserBase::Feedback, PhaserBase::Freq, EffectWithSettings< EffectPhaserSettings, PerTrackEffect >::GetSettings(), PhaserBase::OutGain, PhaserBase::Phase, EffectParameter< Structure, Member, Type, Value >::scale, settings(), and PhaserBase::Stages.

Here is the call graph for this function:

◆ ValidateUI()

bool EffectPhaser::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 236 of file Phaser.cpp.

{
   // This bit was copied from the original override of TransferDataFromWindow
   if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
   {
      return false;
   }
 
   auto& ms = mSettings;
 
   if (ms.mStages & 1)    // must be even
   {
      ms.mStages &= ~1;
      mStagesT->GetValidator()->TransferToWindow();
   }
 
   mAccess.ModifySettings
   (
      [this](EffectSettings& settings)
      {
         // pass back the modified settings to the MessageBuffer
 
         GetSettings(settings) = mSettings;
         return nullptr;
      }
   );
 
   return true;
}