EffectDistortion::Validator Struct Reference

Inheritance diagram for EffectDistortion::Validator:

Collaboration diagram for EffectDistortion::Validator:

Public Member Functions
	Validator (EffectUIClientInterface &effect, EffectDistortion::Instance &instance, EffectSettingsAccess &access, const EffectDistortionSettings &settings)
virtual	~Validator ()=default
Effect &	GetEffect () const
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 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...

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 {}
EffectDistortion::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 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 129 of file Distortion.cpp.

Constructor & Destructor Documentation

Validator()

EffectDistortion::Validator::Validator ( EffectUIClientInterface &  effect, EffectDistortion::Instance &  instance, EffectSettingsAccess &  access, const EffectDistortionSettings &  settings  )

inline

Definition at line 132 of file Distortion.cpp.

      : EffectUIValidator{ effect, access }
      , mInstance(instance)
      , mSettings{ settings }
   {}

~Validator()

virtual EffectDistortion::Validator::~Validator ( )

virtualdefault

Member Function Documentation

GetEffect()

Effect & EffectDistortion::Validator::GetEffect ( ) const

inline

Definition at line 141 of file Distortion.cpp.

{ return static_cast<Effect&>(mEffect); }

References EffectUIValidator::mEffect.

GetState()

EffectDistortionState & EffectDistortion::Validator::GetState

(

)

Definition at line 316 of file Distortion.cpp.

{
   return mInstance.mMaster;
}

OnDCBlockCheckbox()

void EffectDistortion::Validator::OnDCBlockCheckbox

(

wxCommandEvent &

evt

)

Definition at line 770 of file Distortion.cpp.

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

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnNoiseFloorSlider()

void EffectDistortion::Validator::OnNoiseFloorSlider

(

wxCommandEvent &

evt

)

Definition at line 821 of file Distortion.cpp.

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

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnNoiseFloorText()

void EffectDistortion::Validator::OnNoiseFloorText

(

wxCommandEvent &

evt

)

Definition at line 810 of file Distortion.cpp.

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

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnParam1Slider()

void EffectDistortion::Validator::OnParam1Slider

(

wxCommandEvent &

evt

)

Definition at line 844 of file Distortion.cpp.

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

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnParam1Text()

void EffectDistortion::Validator::OnParam1Text

(

wxCommandEvent &

evt

)

Definition at line 833 of file Distortion.cpp.

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

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnParam2Slider()

void EffectDistortion::Validator::OnParam2Slider

(

wxCommandEvent &

evt

)

Definition at line 866 of file Distortion.cpp.

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

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnParam2Text()

void EffectDistortion::Validator::OnParam2Text

(

wxCommandEvent &

evt

)

Definition at line 855 of file Distortion.cpp.

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

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnRepeatsSlider()

void EffectDistortion::Validator::OnRepeatsSlider

(

wxCommandEvent &

evt

)

Definition at line 888 of file Distortion.cpp.

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

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnRepeatsText()

void EffectDistortion::Validator::OnRepeatsText

(

wxCommandEvent &

evt

)

Definition at line 877 of file Distortion.cpp.

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

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnThresholdSlider()

void EffectDistortion::Validator::OnThresholdSlider

(

wxCommandEvent &

evt

)

Definition at line 795 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, EffectDistortion::Threshold_dB, and Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnThresholdText()

void EffectDistortion::Validator::OnThresholdText

(

wxCommandEvent &

evt

)

Definition at line 783 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, EffectDistortion::Threshold_dB, and Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnTypeChoice()

void EffectDistortion::Validator::OnTypeChoice

(

wxCommandEvent &

evt

)

Definition at line 760 of file Distortion.cpp.

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

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void EffectDistortion::Validator::PopulateOrExchange

(

ShuttleGui &

S

)

Definition at line 465 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, &Validator::OnTypeChoice);
 
         mDCBlockCheckBox = S.AddCheckBox(XXO("DC blocking filter"),
                                       DCBlock.def);
 
         BindTo(*mDCBlockCheckBox, wxEVT_CHECKBOX, &Validator::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, &Validator::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, &Validator::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, &Validator::OnNoiseFloorText);
 
            mNoiseFloorS = S
               .Name(defaultLabel(1))
               .Style(wxSL_HORIZONTAL)
               .AddSlider( {}, 0, NoiseFloor.max, NoiseFloor.min);
            S.AddSpace(20, 0);
 
            BindTo(*mNoiseFloorS, wxEVT_SLIDER, &Validator::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, &Validator::OnParam1Text);
 
            mParam1S = S
               .Name(defaultLabel(2))
               .Style(wxSL_HORIZONTAL)
               .AddSlider( {}, 0, Param1.max, Param1.min);
            S.AddSpace(20, 0);
 
            BindTo(*mParam1S, wxEVT_SLIDER, &Validator::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, &Validator::OnParam2Text);
 
            mParam2S = S
               .Name(defaultLabel(3))
               .Style(wxSL_HORIZONTAL)
               .AddSlider( {}, 0, Param2.max, Param2.min);
 
            BindTo(*mParam2S, wxEVT_SLIDER, &Validator::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, &Validator::OnRepeatsText);
 
            mRepeatsS = S
               .Name(defaultLabel(4))
               .Style(wxSL_HORIZONTAL)
               .AddSlider( {}, Repeats.def, Repeats.max, Repeats.min);
 
            BindTo(*mRepeatsS, wxEVT_SLIDER, &Validator::OnRepeatsSlider);
 
            S.AddSpace(20, 0);
         }
         S.EndMultiColumn();
      }
      S.EndStatic();
   }
   S.EndVerticalLay();
 
}

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

Here is the call graph for this function:

UpdateControl()

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

Definition at line 1071 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, TranslatableString::Join(), name, EffectParameter< Structure, Member, Type, Value >::scale, EffectDistortion::Threshold_dB, TranslatableString::Translation(), wxT(), and XO().

Here is the call graph for this function:

UpdateControlText()

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

Definition at line 1166 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::Validator::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 629 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, Effect::mUIParent, EffectParameter< Structure, Member, Type, Value >::scale, and EffectDistortion::Threshold_dB.

UpdateUIControls()

void EffectDistortion::Validator::UpdateUIControls

(

)

Definition at line 899 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, EffectDistortion::kCubic, EffectDistortion::kEvenHarmonics, EffectDistortion::kExpCurve, EffectDistortion::kHalfSinCurve, EffectDistortion::kHardClip, EffectDistortion::kHardLimiter, EffectDistortion::kLeveller, EffectDistortion::kLogCurve, EffectDistortion::kRectifier, EffectDistortion::kSinCurve, EffectDistortion::kSoftClip, and XO().

Here is the call graph for this function:

ValidateUI()

bool EffectDistortion::Validator::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 EffectUIValidator.

Definition at line 202 of file Distortion.cpp.

{
   {
      // This section was copied from the original
      // EffectDistortion::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(), EffectUIValidator::mAccess, EffectSettingsAccess::ModifySettings(), mSettings, mUIParent, and settings().

Here is the call graph for this function:

Member Data Documentation

mDCBlockCheckBox

wxCheckBox* EffectDistortion::Validator::mDCBlockCheckBox

Definition at line 175 of file Distortion.cpp.

mInstance

EffectDistortion::Instance& EffectDistortion::Validator::mInstance

Definition at line 198 of file Distortion.cpp.

mNoiseFloorS

wxSlider* EffectDistortion::Validator::mNoiseFloorS

Definition at line 170 of file Distortion.cpp.

mNoiseFloorT

wxTextCtrl* EffectDistortion::Validator::mNoiseFloorT

Definition at line 164 of file Distortion.cpp.

mNoiseFloorTxt

wxStaticText* EffectDistortion::Validator::mNoiseFloorTxt

Definition at line 178 of file Distortion.cpp.

mOldmNoiseFloorTxt

wxString EffectDistortion::Validator::mOldmNoiseFloorTxt

Definition at line 184 of file Distortion.cpp.

mOldParam1Txt

wxString EffectDistortion::Validator::mOldParam1Txt

Definition at line 185 of file Distortion.cpp.

mOldParam2Txt

wxString EffectDistortion::Validator::mOldParam2Txt

Definition at line 186 of file Distortion.cpp.

mOldRepeatsTxt

wxString EffectDistortion::Validator::mOldRepeatsTxt

Definition at line 187 of file Distortion.cpp.

mOldThresholdTxt

wxString EffectDistortion::Validator::mOldThresholdTxt

Definition at line 183 of file Distortion.cpp.

mParam1S

wxSlider* EffectDistortion::Validator::mParam1S

Definition at line 171 of file Distortion.cpp.

mParam1T

wxTextCtrl* EffectDistortion::Validator::mParam1T

Definition at line 165 of file Distortion.cpp.

mParam1Txt

wxStaticText* EffectDistortion::Validator::mParam1Txt

Definition at line 179 of file Distortion.cpp.

mParam2S

wxSlider* EffectDistortion::Validator::mParam2S

Definition at line 172 of file Distortion.cpp.

mParam2T

wxTextCtrl* EffectDistortion::Validator::mParam2T

Definition at line 166 of file Distortion.cpp.

mParam2Txt

wxStaticText* EffectDistortion::Validator::mParam2Txt

Definition at line 180 of file Distortion.cpp.

mRepeatsS

wxSlider* EffectDistortion::Validator::mRepeatsS

Definition at line 173 of file Distortion.cpp.

mRepeatsT

wxTextCtrl* EffectDistortion::Validator::mRepeatsT

Definition at line 167 of file Distortion.cpp.

mRepeatsTxt

wxStaticText* EffectDistortion::Validator::mRepeatsTxt

Definition at line 181 of file Distortion.cpp.

mSettings

EffectDistortionSettings EffectDistortion::Validator::mSettings

Definition at line 189 of file Distortion.cpp.

Referenced by ValidateUI().

mThresholdS

wxSlider* EffectDistortion::Validator::mThresholdS

Definition at line 169 of file Distortion.cpp.

mThresholdT

wxTextCtrl* EffectDistortion::Validator::mThresholdT

Definition at line 163 of file Distortion.cpp.

mThresholdTxt

wxStaticText* EffectDistortion::Validator::mThresholdTxt

Definition at line 177 of file Distortion.cpp.

mTypeChoiceCtrl

wxChoice* EffectDistortion::Validator::mTypeChoiceCtrl

Definition at line 162 of file Distortion.cpp.

mUIParent

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

Definition at line 197 of file Distortion.cpp.

Referenced by ValidateUI().

---

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

• Distortion.cpp