EffectReverb::Validator Struct Reference

Inheritance diagram for EffectReverb::Validator:

Collaboration diagram for EffectReverb::Validator:

Public Member Functions
	Validator (EffectUIClientInterface &effect, EffectSettingsAccess &access, const EffectReverbSettings &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)
	SpinSlider (RoomSize) SpinSlider(PreDelay) SpinSlider(Reverberance) SpinSlider(HfDamping) SpinSlider(ToneLow) SpinSlider(ToneHigh) SpinSlider(WetGain) SpinSlider(DryGain) SpinSlider(StereoWidth) wxCheckBox *mWetOnlyC
	SpinSliderHandlers (RoomSize) SpinSliderHandlers(PreDelay) SpinSliderHandlers(Reverberance) SpinSliderHandlers(HfDamping) SpinSliderHandlers(ToneLow) SpinSliderHandlers(ToneHigh) SpinSliderHandlers(WetGain) SpinSliderHandlers(DryGain) SpinSliderHandlers(StereoWidth) void OnCheckbox(wxCommandEvent &evt)
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
EffectReverbSettings	mSettings
bool	mProcessingEvent = false

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 95 of file Reverb.cpp.

Constructor & Destructor Documentation

Validator()

EffectReverb::Validator::Validator ( EffectUIClientInterface &  effect, EffectSettingsAccess &  access, const EffectReverbSettings &  settings  )

inline

Definition at line 98 of file Reverb.cpp.

      : EffectUIValidator{ effect, access }
      , mSettings{ settings }
   {}

~Validator()

virtual EffectReverb::Validator::~Validator ( )

virtualdefault

Member Function Documentation

GetEffect()

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

inline

Definition at line 105 of file Reverb.cpp.

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

References EffectUIValidator::mEffect.

PopulateOrExchange()

void EffectReverb::Validator::PopulateOrExchange

(

ShuttleGui &

S

)

Definition at line 528 of file Reverb.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol(2);
 
#define SpinSlider(n, p) \
      m ## n ## T = S.AddSpinCtrl( p, n.def, n.max, n.min); \
      BindTo(*m ## n ## T, wxEVT_SPINCTRL, &Validator::On ## n ## Text);\
      \
      m ## n ## S = S.Style(wxSL_HORIZONTAL).AddSlider( {}, n.def, n.max, n.min); \
      BindTo(*m ## n ## S, wxEVT_SLIDER, &Validator::On ## n ## Slider);
 
      SpinSlider(RoomSize,       XXO("&Room Size (%):"))
      SpinSlider(PreDelay,       XXO("&Pre-delay (ms):"))
      SpinSlider(Reverberance,   XXO("Rever&berance (%):"))
      SpinSlider(HfDamping,      XXO("Da&mping (%):"))
      SpinSlider(ToneLow,        XXO("Tone &Low (%):"))
      SpinSlider(ToneHigh,       XXO("Tone &High (%):"))
      SpinSlider(WetGain,        XXO("Wet &Gain (dB):"))
      SpinSlider(DryGain,        XXO("Dr&y Gain (dB):"))
      SpinSlider(StereoWidth,    XXO("Stereo Wid&th (%):"))
 
#undef SpinSlider
 
   }
   S.EndMultiColumn();
 
   S.StartHorizontalLay(wxCENTER, false);
   {
      mWetOnlyC =
      S.AddCheckBox(XXO("Wet O&nly"), WetOnly.def);
      BindTo(*mWetOnlyC, wxEVT_CHECKBOX, &Validator::OnCheckbox);
   }
   S.EndHorizontalLay();
 
}

References EffectParameter< Structure, Member, Type, Value >::def, EffectReverb::DryGain, EffectReverb::HfDamping, EffectReverb::PreDelay, EffectReverb::Reverberance, EffectReverb::RoomSize, S, SpinSlider, EffectReverb::StereoWidth, EffectReverb::ToneHigh, EffectReverb::ToneLow, EffectReverb::WetGain, EffectReverb::WetOnly, and XXO().

Here is the call graph for this function:

SpinSlider()

EffectReverb::Validator::SpinSlider

(

RoomSize

)

SpinSliderHandlers()

EffectReverb::Validator::SpinSliderHandlers

(

RoomSize

)

&

UpdateUI()

bool EffectReverb::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 568 of file Reverb.cpp.

{
   // get the settings from the MessageBuffer and write them to our local copy
   mSettings = GetSettings(mAccess.Get());
 
   auto& rs = mSettings;
 
#define SetSpinSlider(n) \
   m ## n ## S->SetValue((int) rs.m ## n); \
   m ## n ## T->SetValue(wxString::Format(wxT("%d"), (int) rs.m ## n));
 
   SetSpinSlider(RoomSize);
   SetSpinSlider(PreDelay);
   SetSpinSlider(Reverberance);
   SetSpinSlider(HfDamping);
   SetSpinSlider(ToneLow);
   SetSpinSlider(ToneHigh);
   SetSpinSlider(WetGain);
   SetSpinSlider(DryGain);
   SetSpinSlider(StereoWidth);
 
#undef SetSpinSlider
 
   mWetOnlyC->SetValue((int) rs.mWetOnly);
 
   return true;
}

References EffectReverb::DryGain, EffectWithSettings< EffectReverbSettings, PerTrackEffect >::GetSettings(), EffectReverb::HfDamping, EffectReverb::PreDelay, EffectReverb::Reverberance, EffectReverb::RoomSize, SetSpinSlider, EffectReverb::StereoWidth, EffectReverb::ToneHigh, EffectReverb::ToneLow, and EffectReverb::WetGain.

Here is the call graph for this function:

ValidateUI()

bool EffectReverb::Validator::ValidateUI ( )

overridevirtual

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

Returns

true only if panel settings are acceptable

Implements EffectUIValidator.

Definition at line 156 of file Reverb.cpp.

{
   auto& rs = mSettings;
 
   rs.mRoomSize     = mRoomSizeS->GetValue();
   rs.mPreDelay     = mPreDelayS->GetValue();
   rs.mReverberance = mReverberanceS->GetValue();
   rs.mHfDamping    = mHfDampingS->GetValue();
   rs.mToneLow      = mToneLowS->GetValue();
   rs.mToneHigh     = mToneHighS->GetValue();
   rs.mWetGain      = mWetGainS->GetValue();
   rs.mDryGain      = mDryGainS->GetValue();
   rs.mStereoWidth  = mStereoWidthS->GetValue();
   rs.mWetOnly      = mWetOnlyC->GetValue();
 
   mAccess.ModifySettings
   (
      [this](EffectSettings& settings)
      {
         // pass back the modified settings to the MessageBuffer
 
         EffectReverb::GetSettings(settings) = mSettings;
         return nullptr;
      }
   );
 
   return true;
}

References EffectWithSettings< EffectReverbSettings, PerTrackEffect >::GetSettings(), EffectUIValidator::mAccess, EffectSettingsAccess::ModifySettings(), EffectReverbSettings::mRoomSize, mSettings, and settings().

Here is the call graph for this function:

Member Data Documentation

mProcessingEvent

bool EffectReverb::Validator::mProcessingEvent = false

Definition at line 114 of file Reverb.cpp.

mSettings

EffectReverbSettings EffectReverb::Validator::mSettings

Definition at line 112 of file Reverb.cpp.

Referenced by ValidateUI().

---

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

• Reverb.cpp