anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl Class Reference

Inheritance diagram for anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl:

Collaboration diagram for anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl:

Public Member Functions
	RealtimeEffectControl ()=default
	RealtimeEffectControl (wxWindow *parent, RealtimeEffectPicker *effectPicker, wxWindowID winid, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)
void	Create (wxWindow *parent, RealtimeEffectPicker *effectPicker, wxWindowID winid, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)
TranslatableString	GetEffectName () const
void	SetEffect (AudacityProject &project, const std::shared_ptr< SampleTrack > &track, const std::shared_ptr< RealtimeEffectState > &pState)
void	RemoveFromList ()
void	OnOptionsClicked (wxCommandEvent &event)
void	OnChangeButtonClicked (wxCommandEvent &event)
void	OnPaint (wxPaintEvent &)
void	OnFocusChange (wxFocusEvent &evt)
Public Member Functions inherited from ListNavigationEnabled< MovableControl >
	ListNavigationEnabled ()

Static Public Member Functions
static const PluginDescriptor *	GetPlugin (const PluginID &ID)

Private Attributes
wxWeakRef< AudacityProject >	mProject
std::shared_ptr< SampleTrack >	mTrack
std::shared_ptr< RealtimeEffectState >	mEffectState
std::shared_ptr< EffectSettingsAccess >	mSettingsAccess
RealtimeEffectPicker *	mEffectPicker { nullptr }
ThemedAButtonWrapper< AButton > *	mChangeButton {nullptr}
AButton *	mEnableButton {nullptr}
ThemedAButtonWrapper< AButton > *	mOptionsButton {}
Observer::Subscription	mSubscription

Detailed Description

Definition at line 287 of file RealtimeEffectPanel.cpp.

Constructor & Destructor Documentation

RealtimeEffectControl() [1/2]

anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::RealtimeEffectControl ( )

default

RealtimeEffectControl() [2/2]

anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::RealtimeEffectControl ( wxWindow *  parent, RealtimeEffectPicker *  effectPicker, wxWindowID  winid, const wxPoint &  pos = wxDefaultPosition, const wxSize &  size = wxDefaultSize  )

inline

Definition at line 305 of file RealtimeEffectPanel.cpp.

      {
         Create(parent, effectPicker, winid, pos, size);
      }

References size.

Member Function Documentation

Create()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::Create ( wxWindow *  parent, RealtimeEffectPicker *  effectPicker, wxWindowID  winid, const wxPoint &  pos = wxDefaultPosition, const wxSize &  size = wxDefaultSize  )

inline

Definition at line 314 of file RealtimeEffectPanel.cpp.

      {
         mEffectPicker = effectPicker;
         
         //Prevents flickering and paint order issues
         MovableControl::SetBackgroundStyle(wxBG_STYLE_PAINT);
         MovableControl::Create(parent, winid, pos, size, wxNO_BORDER | wxWANTS_CHARS);
 
         Bind(wxEVT_PAINT, &RealtimeEffectControl::OnPaint, this);
         Bind(wxEVT_SET_FOCUS, &RealtimeEffectControl::OnFocusChange, this);
         Bind(wxEVT_KILL_FOCUS, &RealtimeEffectControl::OnFocusChange, this);
 
         auto sizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
 
         //On/off button
         auto enableButton = safenew ThemedAButtonWrapper<AButton>(this);
         enableButton->SetTranslatableLabel(XO("Power"));
         enableButton->SetImageIndices(0, bmpEffectOff, bmpEffectOff, bmpEffectOn, bmpEffectOn, bmpEffectOff);
         enableButton->SetButtonToggles(true);
         enableButton->SetBackgroundColorIndex(clrEffectListItemBackground);
         mEnableButton = enableButton;
 
         enableButton->Bind(wxEVT_BUTTON, [this](wxCommandEvent&) {
 
            mEffectState->SetActive(mEnableButton->IsDown());
            if (mProject)
               UndoManager::Get(*mProject).MarkUnsaved();
         });
 
         //Central button with effect name, show settings
         const auto optionsButton = safenew ThemedAButtonWrapper<AButton>(this, wxID_ANY);
         optionsButton->SetImageIndices(0,
            bmpHButtonNormal,
            bmpHButtonHover,
            bmpHButtonDown,
            bmpHButtonHover,
            bmpHButtonDisabled);
         optionsButton->SetBackgroundColorIndex(clrEffectListItemBackground);
         optionsButton->SetForegroundColorIndex(clrTrackPanelText);
         optionsButton->SetButtonType(AButton::TextButton);
         optionsButton->Bind(wxEVT_BUTTON, &RealtimeEffectControl::OnOptionsClicked, this);
 
         //Remove/replace effect
         auto changeButton = safenew ThemedAButtonWrapper<AButton>(this);
         changeButton->SetImageIndices(0, bmpMoreNormal, bmpMoreHover, bmpMoreDown, bmpMoreHover, bmpMoreDisabled);
         changeButton->SetBackgroundColorIndex(clrEffectListItemBackground);
         changeButton->SetTranslatableLabel(XO("Replace effect"));
         changeButton->Bind(wxEVT_BUTTON, &RealtimeEffectControl::OnChangeButtonClicked, this);
         
         auto dragArea = safenew wxStaticBitmap(this, wxID_ANY, theTheme.Bitmap(bmpDragArea));
         dragArea->Disable();
         sizer->Add(dragArea, 0, wxLEFT | wxCENTER, 5);
         sizer->Add(enableButton, 0, wxLEFT | wxCENTER, 5);
         sizer->Add(optionsButton, 1, wxLEFT | wxCENTER, 5);
         sizer->Add(changeButton, 0, wxLEFT | wxRIGHT | wxCENTER, 5);
         mChangeButton = changeButton;
         mOptionsButton = optionsButton;
 
         auto vSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
         vSizer->Add(sizer.release(), 0, wxUP | wxDOWN | wxEXPAND, 10);
 
         SetSizer(vSizer.release());
 
#if wxUSE_ACCESSIBILITY
         SetAccessible(safenew RealtimeEffectControlAx(this));
#endif
      }

References ThemeBase::Bitmap(), MovableControl::Create(), UndoManager::Get(), UndoManager::MarkUnsaved(), safenew, size, AButton::TextButton, theTheme, and XO().

Here is the call graph for this function:

GetEffectName()

TranslatableString anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::GetEffectName ( ) const

inline

Precondition

mEffectState != nullptr

Definition at line 392 of file RealtimeEffectPanel.cpp.

      {
         const auto &ID = mEffectState->GetID();
         const auto desc = GetPlugin(ID);
         return desc
            ? desc->GetSymbol().Msgid()
            : XO("%s (missing)")
               .Format(PluginManager::GetEffectNameFromID(ID).GET());
      }

References anonymous_namespace{ExportPCM.cpp}::desc, PluginManager::GetEffectNameFromID(), and XO().

Here is the call graph for this function:

GetPlugin()

static const PluginDescriptor * anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::GetPlugin ( const PluginID &  ID )

inlinestatic

Definition at line 386 of file RealtimeEffectPanel.cpp.

                                                                   {
         auto desc = PluginManager::Get().GetPlugin(ID);
         return desc;
      }

References anonymous_namespace{ExportPCM.cpp}::desc, PluginManager::Get(), and PluginManager::GetPlugin().

Here is the call graph for this function:

OnChangeButtonClicked()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnChangeButtonClicked ( wxCommandEvent &  event )

inline

i18n-hint: undo history record first parameter - realtime effect name

Definition at line 484 of file RealtimeEffectPanel.cpp.

      {
         if(!mTrack || mProject == nullptr)
            return;
         if(mEffectState == nullptr)
            return;//not initialized
 
         const auto effectID = mEffectPicker->PickEffect(mChangeButton, mEffectState->GetID());
         if(!effectID)
            return;//nothing
         
         if(effectID->empty())
         {
            RemoveFromList();
            return;
         }
         
         auto &em = RealtimeEffectManager::Get(*mProject);
         auto oIndex = em.FindState(&*mTrack, mEffectState);
         if (!oIndex)
            return;
 
         auto oldName = GetEffectName();
         auto &project = *mProject;
         auto trackName = mTrack->GetName();
         if (auto state = AudioIO::Get()
            ->ReplaceState(project, &*mTrack, *oIndex, *effectID)
         ){
            // Message subscription took care of updating the button text
            // and destroyed `this`!
            auto effect = state->GetEffect();
            assert(effect); // postcondition of ReplaceState
            ProjectHistory::Get(project).PushState(
               /*i18n-hint: undo history,
                first and second parameters - realtime effect names
                */
               XO("Replaced %s with %s")
                  .Format(oldName, effect->GetName()),
               XO("Replace %s").Format(oldName));
         }
      }

References AudioIO::Get(), ProjectHistory::Get(), RealtimeEffectManager::Get(), project, ProjectHistory::PushState(), and XO().

Here is the call graph for this function:

OnFocusChange()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnFocusChange ( wxFocusEvent &  evt )

inline

Definition at line 545 of file RealtimeEffectPanel.cpp.

      {
         Refresh(false);
         evt.Skip();
      }

OnOptionsClicked()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnOptionsClicked ( wxCommandEvent &  event )

inline

TODO: effect is not available

Definition at line 464 of file RealtimeEffectPanel.cpp.

      {
         if(mProject == nullptr || mEffectState == nullptr)
            return;//not initialized
 
         const auto ID = mEffectState->GetID();
         const auto effectPlugin = EffectManager::Get().GetEffect(ID);
 
         if(effectPlugin == nullptr)
         {
            return;
         }
 
         auto& effectStateUI = RealtimeEffectStateUI::Get(*mEffectState);
 
         effectStateUI.UpdateTrackData(*mTrack);
         effectStateUI.Toggle( *mProject );
      }

References EffectManager::Get(), RealtimeEffectStateUI::Get(), and EffectManager::GetEffect().

Here is the call graph for this function:

OnPaint()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnPaint ( wxPaintEvent &  )

inline

Definition at line 528 of file RealtimeEffectPanel.cpp.

      {
         wxBufferedPaintDC dc(this);
         const auto rect = wxRect(GetSize());
 
         dc.SetPen(*wxTRANSPARENT_PEN);
         dc.SetBrush(GetBackgroundColour());
         dc.DrawRectangle(rect);
 
         dc.SetPen(theTheme.Colour(clrEffectListItemBorder));
         dc.SetBrush(theTheme.Colour(clrEffectListItemBorder));
         dc.DrawLine(rect.GetBottomLeft(), rect.GetBottomRight());
 
         if(HasFocus())
            AColor::DrawFocus(dc, GetClientRect().Deflate(3, 3));
      }

References ThemeBase::Colour(), AColor::DrawFocus(), and theTheme.

Here is the call graph for this function:

RemoveFromList()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::RemoveFromList ( )

inline

i18n-hint: undo history record first parameter - realtime effect name second parameter - track name

i18n-hint: undo history record first parameter - realtime effect name

Definition at line 437 of file RealtimeEffectPanel.cpp.

      {
         if(mProject == nullptr || mEffectState == nullptr)
            return;
 
         auto& ui = RealtimeEffectStateUI::Get(*mEffectState);
         // Don't need autosave for the effect that is being removed
         ui.Hide();
 
         auto effectName = GetEffectName();
         //After AudioIO::RemoveState call this will be destroyed
         auto project = mProject.get();
         auto trackName = mTrack->GetName();
 
         AudioIO::Get()->RemoveState(*project, &*mTrack, mEffectState);
         ProjectHistory::Get(*project).PushState(
            XO("Removed %s from %s").Format(effectName, trackName),
            XO("Remove %s").Format(effectName)
         );
      }

References AudioIO::Get(), ProjectHistory::Get(), RealtimeEffectStateUI::Get(), project, ProjectHistory::PushState(), AudioIO::RemoveState(), and XO().

Here is the call graph for this function:

SetEffect()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::SetEffect ( AudacityProject &  project, const std::shared_ptr< SampleTrack > &  track, const std::shared_ptr< RealtimeEffectState > &  pState  )

inline

Definition at line 402 of file RealtimeEffectPanel.cpp.

      {
         mProject = &project;
         mTrack = track;
         mEffectState = pState;
 
         mSubscription = mEffectState->Subscribe([this](RealtimeEffectStateChange state) {
            state == RealtimeEffectStateChange::EffectOn 
               ? mEnableButton->PushDown() 
               : mEnableButton->PopUp();
 
            if (mProject)
               ProjectHistory::Get(*mProject).ModifyState(false);
         });
 
         TranslatableString label;
         if (pState) {
            label = GetEffectName();
            mSettingsAccess = pState->GetAccess();
         }
         else
            mSettingsAccess.reset();
         if (mEnableButton)
            mSettingsAccess && mSettingsAccess->Get().extra.GetActive()
               ? mEnableButton->PushDown()
               : mEnableButton->PopUp();
         if (mOptionsButton)
         {
            mOptionsButton->SetTranslatableLabel(label);
            mOptionsButton->SetEnabled(pState && GetPlugin(pState->GetID()));
         }
      }

References EffectOn, ProjectHistory::Get(), label, ProjectHistory::ModifyState(), and project.

Here is the call graph for this function:

Member Data Documentation

mChangeButton

ThemedAButtonWrapper<AButton>* anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mChangeButton {nullptr}

private

Definition at line 296 of file RealtimeEffectPanel.cpp.

mEffectPicker

RealtimeEffectPicker* anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mEffectPicker { nullptr }

private

Definition at line 294 of file RealtimeEffectPanel.cpp.

mEffectState

std::shared_ptr<RealtimeEffectState> anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mEffectState

private

Definition at line 291 of file RealtimeEffectPanel.cpp.

mEnableButton

AButton* anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mEnableButton {nullptr}

private

Definition at line 297 of file RealtimeEffectPanel.cpp.

mOptionsButton

ThemedAButtonWrapper<AButton>* anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mOptionsButton {}

private

Definition at line 298 of file RealtimeEffectPanel.cpp.

mProject

wxWeakRef<AudacityProject> anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mProject

private

Definition at line 289 of file RealtimeEffectPanel.cpp.

mSettingsAccess

std::shared_ptr<EffectSettingsAccess> anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mSettingsAccess

private

Definition at line 292 of file RealtimeEffectPanel.cpp.

mSubscription

Observer::Subscription anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mSubscription

private

Definition at line 300 of file RealtimeEffectPanel.cpp.

mTrack

std::shared_ptr<SampleTrack> anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mTrack

private

Definition at line 290 of file RealtimeEffectPanel.cpp.

---

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

• RealtimeEffectPanel.cpp