RealtimeEffectStateUI Class Reference

UI state for realtime effect. More...

#include <RealtimeEffectStateUI.h>

Inheritance diagram for RealtimeEffectStateUI:

Collaboration diagram for RealtimeEffectStateUI:

Public Member Functions
	RealtimeEffectStateUI (RealtimeEffectState &state)
	~RealtimeEffectStateUI () override
bool	IsShown () const noexcept
void	Show (AudacityProject &project)
void	Hide (AudacityProject *project=nullptr)
void	Toggle (AudacityProject &project)
void	SetTargetName (const wxString &name)
void	AutoSave (AudacityProject &project)
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static RealtimeEffectStateUI &	Get (RealtimeEffectState &state)
static const RealtimeEffectStateUI &	Get (const RealtimeEffectState &state)

Private Member Functions
void	UpdateTitle ()
void	OnClose (wxCloseEvent &evt)

Private Attributes
RealtimeEffectState &	mRealtimeEffectState
wxWeakRef< EffectUIHost >	mEffectUIHost
TranslatableString	mEffectName
wxString	mTargetName
AudacityProject *	mpProject {}
Observer::Subscription	mProjectWindowDestroyedSubscription
Observer::Subscription	mParameterChangedSubscription

Detailed Description

UI state for realtime effect.

Definition at line 28 of file RealtimeEffectStateUI.h.

Constructor & Destructor Documentation

RealtimeEffectStateUI()

RealtimeEffectStateUI::RealtimeEffectStateUI ( RealtimeEffectState &  state )

explicit

Definition at line 38 of file RealtimeEffectStateUI.cpp.

    : mRealtimeEffectState(state)
{
}

~RealtimeEffectStateUI()

RealtimeEffectStateUI::~RealtimeEffectStateUI ( )

override

Definition at line 43 of file RealtimeEffectStateUI.cpp.

{
   Hide();
}

References Hide().

Here is the call graph for this function:

Member Function Documentation

AutoSave()

void RealtimeEffectStateUI::AutoSave

(

AudacityProject &

project

)

Definition at line 183 of file RealtimeEffectStateUI.cpp.

{
   ProjectHistory::AutoSave::Call(project);
}

References GlobalHook< AutoSave, void(AudacityProject &) >::Call(), and project.

Referenced by OnClose().

Here is the call graph for this function:

Here is the caller graph for this function:

Get() [1/2]

const RealtimeEffectStateUI & RealtimeEffectStateUI::Get ( const RealtimeEffectState &  state )

static

Definition at line 154 of file RealtimeEffectStateUI.cpp.

{
   return Get(const_cast<RealtimeEffectState&>(state));
}

References Get().

Here is the call graph for this function:

Get() [2/2]

RealtimeEffectStateUI & RealtimeEffectStateUI::Get ( RealtimeEffectState &  state )

static

Definition at line 148 of file RealtimeEffectStateUI.cpp.

{      
   return state.Get<RealtimeEffectStateUI&>(realtimeEffectStateUIFactory);
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), and anonymous_namespace{RealtimeEffectStateUI.cpp}::realtimeEffectStateUIFactory.

Referenced by Get(), RealtimeEffectListWindow::OnEffectListItemChange(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnOptionsClicked(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::RemoveFromList(), and anonymous_namespace{RealtimeEffectPanel.cpp}::VisitRealtimeEffectStateUIs().

Here is the call graph for this function:

Here is the caller graph for this function:

Hide()

void RealtimeEffectStateUI::Hide

(

AudacityProject *

project = nullptr

)

Definition at line 123 of file RealtimeEffectStateUI.cpp.

{
   if (mEffectUIHost != nullptr)
   {
      mpProject = project; // May reassign as null to skip autosave in OnClose
      // EffectUIHost calls Destroy in OnClose handler
      mEffectUIHost->Close();
      mEffectUIHost = {};
   }
}

References mEffectUIHost, mpProject, and project.

Referenced by Show(), Toggle(), and ~RealtimeEffectStateUI().

Here is the caller graph for this function:

IsShown()

bool RealtimeEffectStateUI::IsShown ( ) const

noexcept

Definition at line 48 of file RealtimeEffectStateUI.cpp.

{
   return mEffectUIHost != nullptr;
}

References mEffectUIHost.

Referenced by Toggle().

Here is the caller graph for this function:

OnClose()

void RealtimeEffectStateUI::OnClose ( wxCloseEvent &  evt )

private

Definition at line 188 of file RealtimeEffectStateUI.cpp.

{
   auto next = GetNextHandler();
   mEffectUIHost->RemoveEventHandler(this);
   auto pProject = mpProject;
   mpProject = nullptr;
   if (pProject)
      AutoSave(*pProject);
 
   // Pass the event through to the dialog
   if (next)
      next->ProcessEvent(evt);
}

References AutoSave(), mEffectUIHost, and mpProject.

Here is the call graph for this function:

SetTargetName()

void RealtimeEffectStateUI::SetTargetName

(

const wxString &

name

)

Sets the display name of the target, that will help distinguish effect UI among others.

Definition at line 142 of file RealtimeEffectStateUI.cpp.

{
   mTargetName = targetName;
   UpdateTitle();
}

References mTargetName, and UpdateTitle().

Here is the call graph for this function:

Show()

void RealtimeEffectStateUI::Show

(

AudacityProject &

project

)

Definition at line 53 of file RealtimeEffectStateUI.cpp.

{
   if (mEffectUIHost != nullptr && mEffectUIHost->IsShown())
   {
      // Bring the host to front
      mEffectUIHost->Raise();
      return;
   }
 
   const auto ID = mRealtimeEffectState.GetID();
   const auto effectPlugin =
      dynamic_cast<EffectBase*>(EffectManager::Get().GetEffect(ID));
 
   if (effectPlugin == nullptr)
      return;
 
   const auto client = dynamic_cast<EffectUIServices *>(effectPlugin);
 
   // Effect has no client interface
   if (client == nullptr)
      return;
 
   auto& projectWindow = ProjectWindow::Get(project);
 
   std::shared_ptr<EffectInstance> pInstance;
 
   auto access = mRealtimeEffectState.GetAccess();
 
   // EffectUIHost invokes shared_from_this on access
   Destroy_ptr<EffectUIHost> dlg(safenew EffectUIHost(
      &projectWindow, project, *effectPlugin, *client, pInstance, *access,
      mRealtimeEffectState.shared_from_this()));
 
   if (!dlg->Initialize())
      return;
 
   // Dialog is owned by its parent now!
   mEffectUIHost = dlg.release();
 
   UpdateTitle();
 
   client->ShowClientInterface(*effectPlugin,
      projectWindow, *mEffectUIHost, mEffectUIHost->GetEditor(), false);
 
   // The dialog was modal? That shouldn't have happened
   if (mEffectUIHost == nullptr || !mEffectUIHost->IsShown())
   {
      assert(false);
      mEffectUIHost = {};
   }
 
   if (mEffectUIHost) {
      mEffectUIHost->PushEventHandler(this);
      mpProject = &project;
   }
 
   mProjectWindowDestroyedSubscription = projectWindow.Subscribe(
      [this, &project](ProjectWindowDestroyedMessage) {
         // This achieves autosave on close of project before other important
         // project state is destroyed
         Hide(&project);
      });
 
   mParameterChangedSubscription = mEffectUIHost->GetEditor()->Subscribe(
      [this](auto) { if (mpProject) {  // This can be null if closing an effect without making changes.
                        UndoManager::Get(*mpProject).MarkUnsaved();
                     }
                   });
}

References EffectManager::Get(), UndoManager::Get(), ProjectWindow::Get(), RealtimeEffectState::GetAccess(), EffectManager::GetEffect(), RealtimeEffectState::GetID(), Hide(), UndoManager::MarkUnsaved(), mEffectUIHost, mParameterChangedSubscription, mpProject, mProjectWindowDestroyedSubscription, mRealtimeEffectState, project, safenew, and UpdateTitle().

Referenced by Toggle().

Here is the call graph for this function:

Here is the caller graph for this function:

Toggle()

void RealtimeEffectStateUI::Toggle

(

AudacityProject &

project

)

Definition at line 134 of file RealtimeEffectStateUI.cpp.

{
   if(IsShown())
      Hide(&project);
   else
      Show(project);
}

References Hide(), IsShown(), project, and Show().

Here is the call graph for this function:

UpdateTitle()

void RealtimeEffectStateUI::UpdateTitle ( )

private

Definition at line 159 of file RealtimeEffectStateUI.cpp.

{
   if (mEffectUIHost == nullptr)
      return;
 
   if (mEffectName.empty())
   {
      const auto ID = mRealtimeEffectState.GetID();
      const auto effectPlugin = EffectManager::Get().GetEffect(ID);
 
      if (effectPlugin != nullptr)
         mEffectName = effectPlugin->GetDefinition().GetName();
   }
 
   const auto title =
      mTargetName.empty() ?
         mEffectName :
         /* i18n-hint: First %s is an effect name, second is a track name */
         XO("%s - %s").Format(mEffectName, mTargetName);
 
   mEffectUIHost->SetTitle(title);
   mEffectUIHost->SetName(title);
}

References TranslatableString::empty(), EffectManager::Get(), EffectManager::GetEffect(), RealtimeEffectState::GetID(), mEffectName, mEffectUIHost, mRealtimeEffectState, mTargetName, title, and XO().

Referenced by SetTargetName(), and Show().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mEffectName

TranslatableString RealtimeEffectStateUI::mEffectName

private

Definition at line 60 of file RealtimeEffectStateUI.h.

Referenced by UpdateTitle().

mEffectUIHost

wxWeakRef<EffectUIHost> RealtimeEffectStateUI::mEffectUIHost

private

Definition at line 58 of file RealtimeEffectStateUI.h.

Referenced by Hide(), IsShown(), OnClose(), Show(), and UpdateTitle().

mParameterChangedSubscription

Observer::Subscription RealtimeEffectStateUI::mParameterChangedSubscription

private

Definition at line 65 of file RealtimeEffectStateUI.h.

Referenced by Show().

mpProject

AudacityProject* RealtimeEffectStateUI::mpProject {}

private

Definition at line 62 of file RealtimeEffectStateUI.h.

Referenced by Hide(), OnClose(), and Show().

mProjectWindowDestroyedSubscription

Observer::Subscription RealtimeEffectStateUI::mProjectWindowDestroyedSubscription

private

Definition at line 64 of file RealtimeEffectStateUI.h.

Referenced by Show().

mRealtimeEffectState

RealtimeEffectState& RealtimeEffectStateUI::mRealtimeEffectState

private

Definition at line 56 of file RealtimeEffectStateUI.h.

Referenced by Show(), and UpdateTitle().

mTargetName

wxString RealtimeEffectStateUI::mTargetName

private

Definition at line 61 of file RealtimeEffectStateUI.h.

Referenced by SetTargetName(), and UpdateTitle().

---

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

• RealtimeEffectStateUI.h
• RealtimeEffectStateUI.cpp