Inheritance diagram for EffectDistortion::Editor:

Collaboration diagram for EffectDistortion::Editor:

Public Member Functions
	Editor (const EffectUIServices &services, DistortionBase::Instance &instance, EffectSettingsAccess &access, const EffectDistortionSettings &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	OnTypeChoice (wxCommandEvent &evt)

void	OnDCBlockCheckbox (wxCommandEvent &evt)

void	OnThresholdText (wxCommandEvent &evt)

void	OnThresholdSlider (wxCommandEvent &evt)

void	OnNoiseFloorText (wxCommandEvent &evt)

void	OnNoiseFloorSlider (wxCommandEvent &evt)

void	OnParam1Text (wxCommandEvent &evt)

void	OnParam1Slider (wxCommandEvent &evt)

void	OnParam2Text (wxCommandEvent &evt)

void	OnParam2Slider (wxCommandEvent &evt)

void	OnRepeatsText (wxCommandEvent &evt)

void	OnRepeatsSlider (wxCommandEvent &evt)

EffectDistortionState &	GetState ()

void	UpdateControl (control id, bool enable, TranslatableString name)

void	UpdateUIControls ()

void	UpdateControlText (wxTextCtrl *textCtrl, wxString &string, bool enabled)

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
wxChoice *	mTypeChoiceCtrl

wxTextCtrl *	mThresholdT

wxTextCtrl *	mNoiseFloorT

wxTextCtrl *	mParam1T

wxTextCtrl *	mParam2T

wxTextCtrl *	mRepeatsT

wxSlider *	mThresholdS

wxSlider *	mNoiseFloorS

wxSlider *	mParam1S

wxSlider *	mParam2S

wxSlider *	mRepeatsS

wxCheckBox *	mDCBlockCheckBox

wxStaticText *	mThresholdTxt

wxStaticText *	mNoiseFloorTxt

wxStaticText *	mParam1Txt

wxStaticText *	mParam2Txt

wxStaticText *	mRepeatsTxt

wxString	mOldThresholdTxt

wxString	mOldmNoiseFloorTxt

wxString	mOldParam1Txt

wxString	mOldParam2Txt

wxString	mOldRepeatsTxt

EffectDistortionSettings	mSettings

wxWeakRef< wxWindow >	mUIParent {}

DistortionBase::Instance &	mInstance

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 60 of file Distortion.cpp.

Constructor & Destructor Documentation

◆ Editor()

EffectDistortion::Editor::Editor	(	const EffectUIServices &	services,
		DistortionBase::Instance &	instance,
		EffectSettingsAccess &	access,
		const EffectDistortionSettings &	settings
	)

inline

Definition at line 63 of file Distortion.cpp.

      : EffectEditor{ services, access }
      , mInstance(instance)
      , mSettings{ settings }
   {}

◆ ~Editor()

virtual EffectDistortion::Editor::~Editor ( )

virtualdefault

Member Function Documentation

◆ GetState()

EffectDistortionState & EffectDistortion::Editor::GetState ( )

Definition at line 162 of file Distortion.cpp.

{
   return mInstance.mMaster;
}

◆ OnDCBlockCheckbox()

void EffectDistortion::Editor::OnDCBlockCheckbox ( wxCommandEvent & evt )

Definition at line 381 of file Distortion.cpp.

{
   auto& ms = mSettings;
 
   ms.mDCBlock = mDCBlockCheckBox->GetValue();
 
   GetState().mbSavedFilterState = ms.mDCBlock;
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnNoiseFloorSlider()

void EffectDistortion::Editor::OnNoiseFloorSlider ( wxCommandEvent & evt )

Definition at line 432 of file Distortion.cpp.

{
   auto& ms = mSettings;
 
   ms.mNoiseFloor = (double) evt.GetInt();
   mNoiseFloorT->GetValidator()->TransferToWindow();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnNoiseFloorText()

void EffectDistortion::Editor::OnNoiseFloorText ( wxCommandEvent & evt )

Definition at line 421 of file Distortion.cpp.

{
   const auto& ms = mSettings;
 
   mNoiseFloorT->GetValidator()->TransferFromWindow();
   mNoiseFloorS->SetValue((int) floor(ms.mNoiseFloor + 0.5));
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnParam1Slider()

void EffectDistortion::Editor::OnParam1Slider ( wxCommandEvent & evt )

Definition at line 455 of file Distortion.cpp.

{
   auto& ms = mSettings;
 
   ms.mParam1 = (double) evt.GetInt();
   mParam1T->GetValidator()->TransferToWindow();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnParam1Text()

void EffectDistortion::Editor::OnParam1Text ( wxCommandEvent & evt )

Definition at line 444 of file Distortion.cpp.

{
   const auto& ms = mSettings;
 
   mParam1T->GetValidator()->TransferFromWindow();
   mParam1S->SetValue((int) floor(ms.mParam1 + 0.5));
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnParam2Slider()

void EffectDistortion::Editor::OnParam2Slider ( wxCommandEvent & evt )

Definition at line 477 of file Distortion.cpp.

{
   auto& ms = mSettings;
 
   ms.mParam2 = (double) evt.GetInt();
   mParam2T->GetValidator()->TransferToWindow();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnParam2Text()

void EffectDistortion::Editor::OnParam2Text ( wxCommandEvent & evt )

Definition at line 466 of file Distortion.cpp.

{
   const auto& ms = mSettings;
 
   mParam2T->GetValidator()->TransferFromWindow();
   mParam2S->SetValue((int) floor(ms.mParam2 + 0.5));
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnRepeatsSlider()

void EffectDistortion::Editor::OnRepeatsSlider ( wxCommandEvent & evt )

Definition at line 499 of file Distortion.cpp.

{
   auto& ms = mSettings;
 
   ms.mRepeats = evt.GetInt();
   mRepeatsT->GetValidator()->TransferToWindow();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnRepeatsText()

void EffectDistortion::Editor::OnRepeatsText ( wxCommandEvent & evt )

Definition at line 488 of file Distortion.cpp.

{
   const auto& ms = mSettings;
 
   mRepeatsT->GetValidator()->TransferFromWindow();
   mRepeatsS->SetValue(ms.mRepeats);
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnThresholdSlider()

void EffectDistortion::Editor::OnThresholdSlider ( wxCommandEvent & evt )

Definition at line 406 of file Distortion.cpp.

{
   auto& ms = mSettings;
 
   static const double MIN_Threshold_Linear = DB_TO_LINEAR(Threshold_dB.min);
 
   const double thresholdDB = (double)evt.GetInt() / Threshold_dB.scale;
   ms.mThreshold_dB = wxMax(LINEAR_TO_DB(thresholdDB), Threshold_dB.min);
 
   mThresholdT->GetValidator()->TransferToWindow();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References DB_TO_LINEAR, LINEAR_TO_DB, EffectParameter< Structure, Member, Type, Value >::min, EffectParameter< Structure, Member, Type, Value >::scale, DistortionBase::Threshold_dB, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnThresholdText()

void EffectDistortion::Editor::OnThresholdText ( wxCommandEvent & evt )

Definition at line 394 of file Distortion.cpp.

{
   const auto& ms = mSettings;
 
   mThresholdT->GetValidator()->TransferFromWindow();
   const double threshold = DB_TO_LINEAR(ms.mThreshold_dB);
   mThresholdS->SetValue((int) (threshold * Threshold_dB.scale + 0.5));
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References DB_TO_LINEAR, EffectParameter< Structure, Member, Type, Value >::scale, DistortionBase::Threshold_dB, and BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnTypeChoice()

void EffectDistortion::Editor::OnTypeChoice ( wxCommandEvent & evt )

Definition at line 371 of file Distortion.cpp.

{
   mTypeChoiceCtrl->GetValidator()->TransferFromWindow();
 
   UpdateUIControls();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References BasicEffectUIServices::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopulateOrExchange()

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

Definition at line 182 of file Distortion.cpp.

{
   mUIParent = S.GetParent();
   auto& ms = mSettings;
 
   S.AddSpace(0, 5);
   S.StartVerticalLay();
   {
      S.StartMultiColumn(4, wxCENTER);
      {
         mTypeChoiceCtrl = S
            .MinSize( { -1, -1 } )
            .Validator<wxGenericValidator>(&ms.mTableChoiceIndx)
            .AddChoice(XXO("Distortion type:"),
               Msgids(kTableTypeStrings, nTableTypes));
 
         BindTo(*mTypeChoiceCtrl, wxEVT_CHOICE, &Editor::OnTypeChoice);
 
         mDCBlockCheckBox = S.AddCheckBox(XXO("DC blocking filter"),
                                       DCBlock.def);
 
         BindTo(*mDCBlockCheckBox, wxEVT_CHECKBOX, &Editor::OnDCBlockCheckbox);
      }
      S.EndMultiColumn();
      S.AddSpace(0, 10);
 
 
      S.StartStatic(XO("Threshold controls"));
      {
         S.StartMultiColumn(4, wxEXPAND);
         S.SetStretchyCol(2);
         {
            // Allow space for first Column
            S.AddSpace(250,0); S.AddSpace(0,0); S.AddSpace(0,0); S.AddSpace(0,0);
 
            // Upper threshold control
            mThresholdTxt = S.AddVariableText(defaultLabel(0),
               false, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
            mThresholdT = S
               .Name(defaultLabel(0))
               .Validator<FloatingPointValidator<double>>(
                  2, &ms.mThreshold_dB, NumValidatorStyle::DEFAULT,
                  Threshold_dB.min, Threshold_dB.max)
               .AddTextBox( {}, wxT(""), 10);
 
            BindTo(*mThresholdT, wxEVT_TEXT, &Editor::OnThresholdText);
 
            mThresholdS = S
               .Name(defaultLabel(0))
               .Style(wxSL_HORIZONTAL)
               .AddSlider( {}, 0,
                  DB_TO_LINEAR(Threshold_dB.max) * Threshold_dB.scale,
                  DB_TO_LINEAR(Threshold_dB.min) * Threshold_dB.scale);
            S.AddSpace(20, 0);
 
            BindTo(*mThresholdS, wxEVT_SLIDER, &Editor::OnThresholdSlider);
 
            // Noise floor control
            mNoiseFloorTxt = S.AddVariableText(defaultLabel(1),
               false, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
            mNoiseFloorT = S
               .Name(defaultLabel(1))
               .Validator<FloatingPointValidator<double>>(
                  2, &ms.mNoiseFloor, NumValidatorStyle::DEFAULT,
                  NoiseFloor.min, NoiseFloor.max
               )
               .AddTextBox( {}, wxT(""), 10);
 
            BindTo(*mNoiseFloorT, wxEVT_TEXT, &Editor::OnNoiseFloorText);
 
            mNoiseFloorS = S
               .Name(defaultLabel(1))
               .Style(wxSL_HORIZONTAL)
               .AddSlider( {}, 0, NoiseFloor.max, NoiseFloor.min);
            S.AddSpace(20, 0);
 
            BindTo(*mNoiseFloorS, wxEVT_SLIDER, &Editor::OnNoiseFloorSlider);
         }
         S.EndMultiColumn();
      }
      S.EndStatic();
 
      S.StartStatic(XO("Parameter controls"));
      {
         S.StartMultiColumn(4, wxEXPAND);
         S.SetStretchyCol(2);
         {
            // Allow space for first Column
            S.AddSpace(250,0); S.AddSpace(0,0); S.AddSpace(0,0); S.AddSpace(0,0);
 
            // Parameter1 control
            mParam1Txt = S.AddVariableText(defaultLabel(2),
               false, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
            mParam1T = S
               .Name(defaultLabel(2))
               .Validator<FloatingPointValidator<double>>(
                  2, &ms.mParam1, NumValidatorStyle::DEFAULT,
                  Param1.min, Param1.max
               )
               .AddTextBox( {}, wxT(""), 10);
 
            BindTo(*mParam1T, wxEVT_TEXT, &Editor::OnParam1Text);
 
            mParam1S = S
               .Name(defaultLabel(2))
               .Style(wxSL_HORIZONTAL)
               .AddSlider( {}, 0, Param1.max, Param1.min);
            S.AddSpace(20, 0);
 
            BindTo(*mParam1S, wxEVT_SLIDER, &Editor::OnParam1Slider);
 
            // Parameter2 control
            mParam2Txt = S.AddVariableText(defaultLabel(3),
               false, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
            mParam2T = S
               .Name(defaultLabel(3))
               .Validator<FloatingPointValidator<double>>(
                  2, &ms.mParam2, NumValidatorStyle::DEFAULT,
                  Param2.min, Param2.max
               )
               .AddTextBox( {}, wxT(""), 10);
 
            BindTo(*mParam2T, wxEVT_TEXT, &Editor::OnParam2Text);
 
            mParam2S = S
               .Name(defaultLabel(3))
               .Style(wxSL_HORIZONTAL)
               .AddSlider( {}, 0, Param2.max, Param2.min);
 
            BindTo(*mParam2S, wxEVT_SLIDER, &Editor::OnParam2Slider);
 
            S.AddSpace(20, 0);
 
            // Repeats control
            mRepeatsTxt = S.AddVariableText(defaultLabel(4),
               false, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
            mRepeatsT = S
               .Name(defaultLabel(4))
               .Validator<IntegerValidator<int>>(
                  &ms.mRepeats, NumValidatorStyle::DEFAULT,
                  Repeats.min, Repeats.max
               )
               .AddTextBox( {}, wxT(""), 10);
 
            BindTo(*mRepeatsT, wxEVT_TEXT, &Editor::OnRepeatsText);
 
            mRepeatsS = S
               .Name(defaultLabel(4))
               .Style(wxSL_HORIZONTAL)
               .AddSlider( {}, Repeats.def, Repeats.max, Repeats.min);
 
            BindTo(*mRepeatsS, wxEVT_SLIDER, &Editor::OnRepeatsSlider);
 
            S.AddSpace(20, 0);
         }
         S.EndMultiColumn();
      }
      S.EndStatic();
   }
   S.EndVerticalLay();
 
}

References DB_TO_LINEAR, DistortionBase::DCBlock, EffectParameter< Structure, Member, Type, Value >::def, defaultLabel(), DistortionBase::kTableTypeStrings, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, Msgids(), DistortionBase::NoiseFloor, DistortionBase::nTableTypes, OnDCBlockCheckbox(), OnNoiseFloorSlider(), OnNoiseFloorText(), OnParam1Slider(), OnParam1Text(), OnParam2Slider(), OnParam2Text(), OnRepeatsSlider(), OnRepeatsText(), OnThresholdSlider(), OnThresholdText(), OnTypeChoice(), DistortionBase::Param1, DistortionBase::Param2, DistortionBase::Repeats, S, EffectParameter< Structure, Member, Type, Value >::scale, DistortionBase::Threshold_dB, wxT(), XO(), and XXO().

Here is the call graph for this function:

◆ UpdateControl()

void EffectDistortion::Editor::UpdateControl	(	control	id,
		bool	enable,
		TranslatableString	name
	)

Definition at line 682 of file Distortion.cpp.

{
   auto& ms = mSettings;
 
   auto suffix = XO("(Not Used):");
   switch (id)
   {
      case ID_Threshold: {
         /* i18n-hint: Control range. */
         if (enabled) suffix = XO("(-100 to 0 dB):");
         name.Join( suffix, wxT(" ") );
 
         // Logarithmic slider is set indirectly
         const double threshold = DB_TO_LINEAR(ms.mThreshold_dB);
         mThresholdS->SetValue((int) (threshold * Threshold_dB.scale + 0.5));
 
         auto translated = name.Translation();
         mThresholdTxt->SetLabel(translated);
         mThresholdS->SetName(translated);
         mThresholdT->SetName(translated);
         mThresholdS->Enable(enabled);
         mThresholdT->Enable(enabled);
         break;
      }
      case ID_NoiseFloor: {
         /* i18n-hint: Control range. */
         if (enabled) suffix = XO("(-80 to -20 dB):");
         name.Join( suffix, wxT(" ") );
 
         auto translated = name.Translation();
         mNoiseFloorTxt->SetLabel(translated);
         mNoiseFloorS->SetName(translated);
         mNoiseFloorT->SetName(translated);
         mNoiseFloorS->Enable(enabled);
         mNoiseFloorT->Enable(enabled);
         break;
      }
      case ID_Param1: {
         /* i18n-hint: Control range. */
         if (enabled) suffix = XO("(0 to 100):");
         name.Join( suffix, wxT(" ") );
 
         auto translated = name.Translation();
         mParam1Txt->SetLabel(translated);
         mParam1S->SetName(translated);
         mParam1T->SetName(translated);
         mParam1S->Enable(enabled);
         mParam1T->Enable(enabled);
         break;
      }
      case ID_Param2: {
         /* i18n-hint: Control range. */
         if (enabled) suffix = XO("(0 to 100):");
         name.Join( suffix, wxT(" ") );
 
         auto translated = name.Translation();
         mParam2Txt->SetLabel(translated);
         mParam2S->SetName(translated);
         mParam2T->SetName(translated);
         mParam2S->Enable(enabled);
         mParam2T->Enable(enabled);
         break;
      }
      case ID_Repeats: {
         /* i18n-hint: Control range. */
         if (enabled) suffix = XO("(0 to 5):");
         name.Join( suffix, wxT(" ") );
 
         auto translated = name.Translation();
         mRepeatsTxt->SetLabel(translated);
         mRepeatsS->SetName(translated);
         mRepeatsT->SetName(translated);
         mRepeatsS->Enable(enabled);
         mRepeatsT->Enable(enabled);
         break;
      }
      case ID_DCBlock: {
         if (enabled) {
            mDCBlockCheckBox->SetValue(GetState().mbSavedFilterState);
            ms.mDCBlock = GetState().mbSavedFilterState;
         }
         else {
            mDCBlockCheckBox->SetValue(false);
            ms.mDCBlock = false;
         }
 
         mDCBlockCheckBox->Enable(enabled);
         break;
      }
      default:
         break;
   }
}

References DB_TO_LINEAR, EffectDistortion::ID_DCBlock, EffectDistortion::ID_NoiseFloor, EffectDistortion::ID_Param1, EffectDistortion::ID_Param2, EffectDistortion::ID_Repeats, EffectDistortion::ID_Threshold, name, EffectParameter< Structure, Member, Type, Value >::scale, DistortionBase::Threshold_dB, wxT(), and XO().

Here is the call graph for this function:

◆ UpdateControlText()

void EffectDistortion::Editor::UpdateControlText	(	wxTextCtrl *	textCtrl,
		wxString &	string,
		bool	enabled
	)

Definition at line 777 of file Distortion.cpp.

{
   if (enabled) {
      if (textCtrl->GetValue().empty())
         textCtrl->SetValue(string);
      else
         string = textCtrl->GetValue();
   }
   else {
      if (!textCtrl->GetValue().empty())
         string = textCtrl->GetValue();
      textCtrl->SetValue(wxT(""));
   }
}

References wxT().

Here is the call graph for this function:

◆ UpdateUI()

bool EffectDistortion::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 346 of file Distortion.cpp.

{
   const auto& ms = mSettings;
 
   if (!mUIParent->TransferDataToWindow())
   {
      return false;
   }
 
   const double threshold = DB_TO_LINEAR(ms.mThreshold_dB);
 
   mThresholdS->     SetValue((int) (threshold * Threshold_dB.scale + 0.5));
   mDCBlockCheckBox->SetValue(     ms.mDCBlock);
   mNoiseFloorS->    SetValue((int)ms.mNoiseFloor + 0.5);
   mParam1S->        SetValue((int)ms.mParam1 + 0.5);
   mParam2S->        SetValue((int)ms.mParam2 + 0.5);
   mRepeatsS->       SetValue(     ms.mRepeats);
 
   GetState().mbSavedFilterState = ms.mDCBlock;
 
   UpdateUIControls();
 
   return true;
}

References DB_TO_LINEAR, EffectParameter< Structure, Member, Type, Value >::scale, and DistortionBase::Threshold_dB.

◆ UpdateUIControls()

void EffectDistortion::Editor::UpdateUIControls ( )

Definition at line 510 of file Distortion.cpp.

{
   const auto& ms = mSettings;
 
   // set control text and names to match distortion type
   switch (ms.mTableChoiceIndx)
      {
      case kHardClip:
         UpdateControlText(mThresholdT, mOldThresholdTxt, true);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, false);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, true);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, false);
 
         UpdateControl(ID_Threshold, true, XO("Clipping level"));
         UpdateControl(ID_NoiseFloor, false, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Drive"));
         UpdateControl(ID_Param2, true, XO("Make-up Gain"));
         UpdateControl(ID_Repeats, false, defaultLabel(4));
         UpdateControl(ID_DCBlock, false, {});
         break;
      case kSoftClip:
         UpdateControlText(mThresholdT, mOldThresholdTxt, true);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, false);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, true);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, false);
 
         UpdateControl(ID_Threshold, true, XO("Clipping threshold"));
         UpdateControl(ID_NoiseFloor, false, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Hardness"));
         UpdateControl(ID_Param2, true, XO("Make-up Gain"));
         UpdateControl(ID_Repeats, false, defaultLabel(4));
         UpdateControl(ID_DCBlock, false, {});
         break;
      case kHalfSinCurve:
         UpdateControlText(mThresholdT, mOldThresholdTxt, false);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, false);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, true);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, false);
 
         UpdateControl(ID_Threshold, false, defaultLabel(0));
         UpdateControl(ID_NoiseFloor, false, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Distortion amount"));
         UpdateControl(ID_Param2, true, XO("Output level"));
         UpdateControl(ID_Repeats, false, defaultLabel(4));
         UpdateControl(ID_DCBlock, false, {});
         break;
      case kExpCurve:
         UpdateControlText(mThresholdT, mOldThresholdTxt, false);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, false);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, true);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, false);
 
         UpdateControl(ID_Threshold, false, defaultLabel(0));
         UpdateControl(ID_NoiseFloor, false, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Distortion amount"));
         UpdateControl(ID_Param2, true, XO("Output level"));
         UpdateControl(ID_Repeats, false, defaultLabel(4));
         UpdateControl(ID_DCBlock, false, {});
         break;
      case kLogCurve:
         UpdateControlText(mThresholdT, mOldThresholdTxt, false);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, false);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, true);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, false);
 
         UpdateControl(ID_Threshold, false, defaultLabel(0));
         UpdateControl(ID_NoiseFloor, false, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Distortion amount"));
         UpdateControl(ID_Param2, true, XO("Output level"));
         UpdateControl(ID_Repeats, false, defaultLabel(4));
         UpdateControl(ID_DCBlock, false, {});
         break;
      case kCubic:
         UpdateControlText(mThresholdT, mOldThresholdTxt, false);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, false);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, true);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, true);
 
         UpdateControl(ID_Threshold, false, defaultLabel(0));
         UpdateControl(ID_NoiseFloor, false, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Distortion amount"));
         UpdateControl(ID_Param2, true, XO("Output level"));
         UpdateControl(ID_Repeats, true, XO("Repeat processing"));
         UpdateControl(ID_DCBlock, false, {});
         break;
      case kEvenHarmonics:
         UpdateControlText(mThresholdT, mOldThresholdTxt, false);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, false);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, true);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, false);
 
         UpdateControl(ID_Threshold, false, defaultLabel(0));
         UpdateControl(ID_NoiseFloor, false, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Distortion amount"));
         UpdateControl(ID_Param2, true, XO("Harmonic brightness"));
         UpdateControl(ID_Repeats, false, defaultLabel(4));
         UpdateControl(ID_DCBlock, true, {});
         break;
      case kSinCurve:
         UpdateControlText(mThresholdT, mOldThresholdTxt, false);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, false);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, true);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, false);
 
         UpdateControl(ID_Threshold, false, defaultLabel(0));
         UpdateControl(ID_NoiseFloor, false, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Distortion amount"));
         UpdateControl(ID_Param2, true, XO("Output level"));
         UpdateControl(ID_Repeats, false, defaultLabel(4));
         UpdateControl(ID_DCBlock, false, {});
         break;
      case kLeveller:
         UpdateControlText(mThresholdT, mOldThresholdTxt, false);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, true);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, false);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, true);
 
         UpdateControl(ID_Threshold, false, defaultLabel(0));
         UpdateControl(ID_NoiseFloor, true, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Levelling fine adjustment"));
         UpdateControl(ID_Param2, false, defaultLabel(3));
         UpdateControl(ID_Repeats, true, XO("Degree of Levelling"));
         UpdateControl(ID_DCBlock, false, {});
         break;
      case kRectifier:
         UpdateControlText(mThresholdT, mOldThresholdTxt, false);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, false);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, false);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, false);
 
         UpdateControl(ID_Threshold, false, defaultLabel(0));
         UpdateControl(ID_NoiseFloor, false, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Distortion amount"));
         UpdateControl(ID_Param2, false, defaultLabel(3));
         UpdateControl(ID_Repeats, false, defaultLabel(4));
         UpdateControl(ID_DCBlock, true, {});
         break;
      case kHardLimiter:
         UpdateControlText(mThresholdT, mOldThresholdTxt, true);
         UpdateControlText(mNoiseFloorT, mOldmNoiseFloorTxt, false);
         UpdateControlText(mParam1T, mOldParam1Txt, true);
         UpdateControlText(mParam2T, mOldParam2Txt, true);
         UpdateControlText(mRepeatsT, mOldRepeatsTxt, false);
 
         UpdateControl(ID_Threshold, true, XO("dB Limit"));
         UpdateControl(ID_NoiseFloor, false, defaultLabel(1));
         UpdateControl(ID_Param1, true, XO("Wet level"));
         UpdateControl(ID_Param2, true, XO("Residual level"));
         UpdateControl(ID_Repeats, false, defaultLabel(4));
         UpdateControl(ID_DCBlock, false, {});
         break;
      default:
         UpdateControl(ID_Threshold,   true, defaultLabel(0));
         UpdateControl(ID_NoiseFloor,  true, defaultLabel(1));
         UpdateControl(ID_Param1,      true, defaultLabel(2));
         UpdateControl(ID_Param2,      true, defaultLabel(3));
         UpdateControl(ID_Repeats,     true, defaultLabel(4));
         UpdateControl(ID_DCBlock,     false, {});
   }
}

References defaultLabel(), EffectDistortion::ID_DCBlock, EffectDistortion::ID_NoiseFloor, EffectDistortion::ID_Param1, EffectDistortion::ID_Param2, EffectDistortion::ID_Repeats, EffectDistortion::ID_Threshold, DistortionBase::kCubic, DistortionBase::kEvenHarmonics, DistortionBase::kExpCurve, DistortionBase::kHalfSinCurve, DistortionBase::kHardClip, DistortionBase::kHardLimiter, DistortionBase::kLeveller, DistortionBase::kLogCurve, DistortionBase::kRectifier, DistortionBase::kSinCurve, DistortionBase::kSoftClip, and XO().

Here is the call graph for this function:

◆ ValidateUI()

bool EffectDistortion::Editor::ValidateUI ( )

overridevirtual

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

Returns: true only if panel settings are acceptable

mUIParent()->Validate() ||

Implements EffectEditor.

Definition at line 131 of file Distortion.cpp.

{
   {
      // This section was copied from the original
      // DistortionBase::TransferDataFromWindow
      //
      // However, the call to ->Validate would bring up an error dialog
      // saying "Empty value"
 
      if (  !mUIParent->TransferDataFromWindow())
      {
         return false;
      }
   }
 
 
   mAccess.ModifySettings
   (
      [this](EffectSettings& settings)
   {
      // pass back the modified settings to the MessageBuffer
 
      GetSettings(settings) = mSettings;
 
      return nullptr;
   }
   );
 
   return true;
}

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

Here is the call graph for this function:

Member Data Documentation

◆ mDCBlockCheckBox

wxCheckBox* EffectDistortion::Editor::mDCBlockCheckBox

Definition at line 104 of file Distortion.cpp.

◆ mInstance

DistortionBase::Instance& EffectDistortion::Editor::mInstance

Definition at line 127 of file Distortion.cpp.

◆ mNoiseFloorS

wxSlider* EffectDistortion::Editor::mNoiseFloorS

Definition at line 99 of file Distortion.cpp.

◆ mNoiseFloorT

wxTextCtrl* EffectDistortion::Editor::mNoiseFloorT

Definition at line 93 of file Distortion.cpp.

◆ mNoiseFloorTxt

wxStaticText* EffectDistortion::Editor::mNoiseFloorTxt

Definition at line 107 of file Distortion.cpp.

◆ mOldmNoiseFloorTxt

wxString EffectDistortion::Editor::mOldmNoiseFloorTxt

Definition at line 113 of file Distortion.cpp.

◆ mOldParam1Txt

wxString EffectDistortion::Editor::mOldParam1Txt

Definition at line 114 of file Distortion.cpp.

◆ mOldParam2Txt

wxString EffectDistortion::Editor::mOldParam2Txt

Definition at line 115 of file Distortion.cpp.

◆ mOldRepeatsTxt

wxString EffectDistortion::Editor::mOldRepeatsTxt

Definition at line 116 of file Distortion.cpp.

◆ mOldThresholdTxt

wxString EffectDistortion::Editor::mOldThresholdTxt

Definition at line 112 of file Distortion.cpp.

◆ mParam1S

wxSlider* EffectDistortion::Editor::mParam1S

Definition at line 100 of file Distortion.cpp.

◆ mParam1T

wxTextCtrl* EffectDistortion::Editor::mParam1T

Definition at line 94 of file Distortion.cpp.

◆ mParam1Txt

wxStaticText* EffectDistortion::Editor::mParam1Txt

Definition at line 108 of file Distortion.cpp.

◆ mParam2S

wxSlider* EffectDistortion::Editor::mParam2S

Definition at line 101 of file Distortion.cpp.

◆ mParam2T

wxTextCtrl* EffectDistortion::Editor::mParam2T

Definition at line 95 of file Distortion.cpp.

◆ mParam2Txt

wxStaticText* EffectDistortion::Editor::mParam2Txt

Definition at line 109 of file Distortion.cpp.

◆ mRepeatsS

wxSlider* EffectDistortion::Editor::mRepeatsS

Definition at line 102 of file Distortion.cpp.

◆ mRepeatsT

wxTextCtrl* EffectDistortion::Editor::mRepeatsT

Definition at line 96 of file Distortion.cpp.

◆ mRepeatsTxt

wxStaticText* EffectDistortion::Editor::mRepeatsTxt

Definition at line 110 of file Distortion.cpp.

◆ mSettings

EffectDistortionSettings EffectDistortion::Editor::mSettings

Definition at line 118 of file Distortion.cpp.

Referenced by ValidateUI().

◆ mThresholdS

wxSlider* EffectDistortion::Editor::mThresholdS

Definition at line 98 of file Distortion.cpp.

◆ mThresholdT

wxTextCtrl* EffectDistortion::Editor::mThresholdT

Definition at line 92 of file Distortion.cpp.

◆ mThresholdTxt

wxStaticText* EffectDistortion::Editor::mThresholdTxt

Definition at line 106 of file Distortion.cpp.

◆ mTypeChoiceCtrl

wxChoice* EffectDistortion::Editor::mTypeChoiceCtrl

Definition at line 91 of file Distortion.cpp.

◆ mUIParent

wxWeakRef<wxWindow> EffectDistortion::Editor::mUIParent {}

Definition at line 126 of file Distortion.cpp.

Referenced by ValidateUI().

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

Distortion.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Editor()

◆ ~Editor()

Member Function Documentation

◆ GetState()

◆ OnDCBlockCheckbox()

◆ OnNoiseFloorSlider()

◆ OnNoiseFloorText()

◆ OnParam1Slider()

◆ OnParam1Text()

◆ OnParam2Slider()

◆ OnParam2Text()

◆ OnRepeatsSlider()

◆ OnRepeatsText()

◆ OnThresholdSlider()

◆ OnThresholdText()

◆ OnTypeChoice()

◆ PopulateOrExchange()

◆ UpdateControl()

◆ UpdateControlText()

◆ UpdateUI()

◆ UpdateUIControls()

◆ ValidateUI()

Member Data Documentation

◆ mDCBlockCheckBox

◆ mInstance

◆ mNoiseFloorS

◆ mNoiseFloorT

◆ mNoiseFloorTxt

◆ mOldmNoiseFloorTxt

◆ mOldParam1Txt

◆ mOldParam2Txt

◆ mOldRepeatsTxt

◆ mOldThresholdTxt

◆ mParam1S

◆ mParam1T

◆ mParam1Txt

◆ mParam2S

◆ mParam2T

◆ mParam2Txt

◆ mRepeatsS

◆ mRepeatsT

◆ mRepeatsTxt

◆ mSettings

◆ mThresholdS

◆ mThresholdT

◆ mThresholdTxt

◆ mTypeChoiceCtrl

◆ mUIParent