ProjectSelectionManager Class Reference

This object is useful mostly as an observer of others in the project. More...

#include <ProjectSelectionManager.h>

Inheritance diagram for ProjectSelectionManager:

Collaboration diagram for ProjectSelectionManager:

Public Member Functions
	ProjectSelectionManager (AudacityProject &project)
	ProjectSelectionManager (const ProjectSelectionManager &)=delete
ProjectSelectionManager &	operator= (const ProjectSelectionManager &)=delete
	~ProjectSelectionManager () override
void	ModifySelection (double &start, double &end, bool done)
void	ModifySpectralSelection (double nyquist, double &bottom, double &top, bool done)
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static ProjectSelectionManager &	Get (AudacityProject &project)
static const ProjectSelectionManager &	Get (const AudacityProject &project)

Private Member Functions
void	OnFormatsChanged (ProjectNumericFormatsEvent)
void	SetSelectionFormat (const NumericFormatID &format)
void	SetAudioTimeFormat (const NumericFormatID &format)
void	SetFrequencySelectionFormatName (const NumericFormatID &formatName)
void	SetBandwidthSelectionFormatName (const NumericFormatID &formatName)
void	SnapSelection ()

Private Attributes
Observer::Subscription	mFormatsSubscription
AudacityProject &	mProject
Observer::Subscription	mSnappingChangedSubscription
Observer::Subscription	mTimeSignatureChangedSubscription
Observer::Subscription	mProjectRateChangedSubscription

Detailed Description

This object is useful mostly as an observer of others in the project.

It listens for changes of selection formats and snap-to choices, and reacts by updating persistent preferences, and updating the time selection to be consistent with those choices.

Definition at line 28 of file ProjectSelectionManager.h.

Constructor & Destructor Documentation

ProjectSelectionManager() [1/2]

ProjectSelectionManager::ProjectSelectionManager ( AudacityProject &  project )

explicit

Definition at line 41 of file ProjectSelectionManager.cpp.

    : mProject { project }
    , mSnappingChangedSubscription { ProjectSnap::Get(project).Subscribe(
         [this](auto&)
         {
            SnapSelection();
         })}
    , mTimeSignatureChangedSubscription {
       ProjectTimeSignature::Get(project).Subscribe([this](auto&)
                                                    { SnapSelection(); }) }
    , mProjectRateChangedSubscription { ProjectRate::Get(project).Subscribe(
         [this](auto&) { SnapSelection(); }) } 
 
{
   // Be consistent with ProjectNumericFormats
   auto &formats = ProjectNumericFormats::Get(mProject);
   SetSelectionFormat(formats.GetSelectionFormat());
   SetAudioTimeFormat(formats.GetAudioTimeFormat());
   SetFrequencySelectionFormatName(formats.GetFrequencySelectionFormatName());
   SetBandwidthSelectionFormatName(formats.GetBandwidthSelectionFormatName());
 
   // And stay consistent
   mFormatsSubscription = ProjectNumericFormats::Get(project)
      .Subscribe(*this, &ProjectSelectionManager::OnFormatsChanged);
}

References SnapSelection().

Here is the call graph for this function:

ProjectSelectionManager() [2/2]

ProjectSelectionManager::ProjectSelectionManager ( const ProjectSelectionManager &  )

delete

~ProjectSelectionManager()

ProjectSelectionManager::~ProjectSelectionManager ( )

overridedefault

Member Function Documentation

Get() [1/2]

ProjectSelectionManager & ProjectSelectionManager::Get ( AudacityProject &  project )

static

Definition at line 28 of file ProjectSelectionManager.cpp.

{
   return project.AttachedObjects::Get< ProjectSelectionManager >(
      sProjectSelectionManagerKey );
}

References project, and sProjectSelectionManagerKey.

Referenced by SelectFrequenciesCommand::Apply(), Get(), SelectionBar::ModifySelection(), and SpectralSelectionBar::ModifySpectralSelection().

Here is the caller graph for this function:

Get() [2/2]

const ProjectSelectionManager & ProjectSelectionManager::Get ( const AudacityProject &  project )

static

Definition at line 35 of file ProjectSelectionManager.cpp.

{
   return Get( const_cast< AudacityProject & >( project ) );
}

References Get(), and project.

Here is the call graph for this function:

ModifySelection()

void ProjectSelectionManager::ModifySelection	(	double &	start,
		double &	end,
		bool	done
	)

Definition at line 121 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &history = ProjectHistory::Get( project );
   auto &viewInfo = ViewInfo::Get( project );
   viewInfo.selectedRegion.setTimes(start, end);
   if (done)
      history.ModifyState(false);
}

References details::end(), ProjectHistory::Get(), ViewInfo::Get(), mProject, and project.

Here is the call graph for this function:

ModifySpectralSelection()

void ProjectSelectionManager::ModifySpectralSelection	(	double	nyquist,
		double &	bottom,
		double &	top,
		bool	done
	)

Definition at line 147 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &history = ProjectHistory::Get(project);
   auto &viewInfo = ViewInfo::Get(project);
   if (bottom >= 0.0)
      bottom = std::min(nyquist, bottom);
   if (top >= 0.0)
      top = std::min(nyquist, top);
   viewInfo.selectedRegion.setFrequencies(bottom, top);
   if (done)
      history.ModifyState(false);
}

References ProjectHistory::Get(), ViewInfo::Get(), min(), mProject, and project.

Referenced by SelectFrequenciesCommand::Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

OnFormatsChanged()

void ProjectSelectionManager::OnFormatsChanged ( ProjectNumericFormatsEvent  evt )

private

Definition at line 90 of file ProjectSelectionManager.cpp.

{
   auto &formats = ProjectNumericFormats::Get(mProject);
   switch (evt.type) {
   case ProjectNumericFormatsEvent::ChangedSelectionFormat:
      return SetSelectionFormat(formats.GetSelectionFormat());
   case ProjectNumericFormatsEvent::ChangedAudioTimeFormat:
      return SetAudioTimeFormat(formats.GetAudioTimeFormat());
   case ProjectNumericFormatsEvent::ChangedFrequencyFormat:
      return SetFrequencySelectionFormatName(
         formats.GetFrequencySelectionFormatName());
   case ProjectNumericFormatsEvent::ChangedBandwidthFormat:
      return SetBandwidthSelectionFormatName(
         formats.GetBandwidthSelectionFormatName());
   default:
      break;
   }
}

References ProjectNumericFormatsEvent::ChangedAudioTimeFormat, ProjectNumericFormatsEvent::ChangedBandwidthFormat, ProjectNumericFormatsEvent::ChangedFrequencyFormat, ProjectNumericFormatsEvent::ChangedSelectionFormat, ProjectNumericFormats::Get(), mProject, SetAudioTimeFormat(), SetBandwidthSelectionFormatName(), SetFrequencySelectionFormatName(), SetSelectionFormat(), and ProjectNumericFormatsEvent::type.

Here is the call graph for this function:

operator=()

ProjectSelectionManager & ProjectSelectionManager::operator= ( const ProjectSelectionManager &  )

delete

SetAudioTimeFormat()

void ProjectSelectionManager::SetAudioTimeFormat ( const NumericFormatID &  format )

private

Definition at line 115 of file ProjectSelectionManager.cpp.

{
   gPrefs->Write(wxT("/AudioTimeFormat"), format.GET());
   gPrefs->Flush();
}

References audacity::BasicSettings::Flush(), anonymous_namespace{ExportPCM.cpp}::format, gPrefs, audacity::BasicSettings::Write(), and wxT().

Referenced by OnFormatsChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

SetBandwidthSelectionFormatName()

void ProjectSelectionManager::SetBandwidthSelectionFormatName ( const NumericFormatID &  formatName )

private

Definition at line 140 of file ProjectSelectionManager.cpp.

{
   gPrefs->Write(wxT("/BandwidthSelectionFormatName"), formatName.GET());
   gPrefs->Flush();
}

References audacity::BasicSettings::Flush(), Identifier::GET(), gPrefs, audacity::BasicSettings::Write(), and wxT().

Referenced by OnFormatsChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

SetFrequencySelectionFormatName()

void ProjectSelectionManager::SetFrequencySelectionFormatName ( const NumericFormatID &  formatName )

private

Definition at line 132 of file ProjectSelectionManager.cpp.

{
   gPrefs->Write(wxT("/FrequencySelectionFormatName"),
                 formatName.GET());
   gPrefs->Flush();
}

References audacity::BasicSettings::Flush(), Identifier::GET(), gPrefs, audacity::BasicSettings::Write(), and wxT().

Referenced by OnFormatsChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

SetSelectionFormat()

void ProjectSelectionManager::SetSelectionFormat ( const NumericFormatID &  format )

private

Definition at line 109 of file ProjectSelectionManager.cpp.

{
   gPrefs->Write(wxT("/SelectionFormat"), format);
   gPrefs->Flush();
}

References audacity::BasicSettings::Flush(), anonymous_namespace{ExportPCM.cpp}::format, gPrefs, audacity::BasicSettings::Write(), and wxT().

Referenced by OnFormatsChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

SnapSelection()

void ProjectSelectionManager::SnapSelection ( )

private

Definition at line 69 of file ProjectSelectionManager.cpp.

{   
   auto& project = mProject;
   auto& projectSnap = ProjectSnap::Get(mProject);
 
   if (projectSnap.GetSnapMode() == SnapMode::SNAP_OFF)
      return;
 
   auto& viewInfo = ViewInfo::Get(project);
   auto& selectedRegion = viewInfo.selectedRegion;
 
   const double oldt0 = selectedRegion.t0();
   const double oldt1 = selectedRegion.t1();
 
   const double t0 = projectSnap.SnapTime(oldt0).time;
   const double t1 = projectSnap.SnapTime(oldt1).time;
 
   if (t0 != oldt0 || t1 != oldt1)
      selectedRegion.setTimes(t0, t1);
}

References ProjectSnap::Get(), ViewInfo::Get(), mProject, project, and SNAP_OFF.

Referenced by ProjectSelectionManager().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mFormatsSubscription

Observer::Subscription ProjectSelectionManager::mFormatsSubscription

private

Definition at line 57 of file ProjectSelectionManager.h.

mProject

AudacityProject& ProjectSelectionManager::mProject

private

Definition at line 58 of file ProjectSelectionManager.h.

Referenced by ModifySelection(), ModifySpectralSelection(), OnFormatsChanged(), and SnapSelection().

mProjectRateChangedSubscription

Observer::Subscription ProjectSelectionManager::mProjectRateChangedSubscription

private

Definition at line 62 of file ProjectSelectionManager.h.

mSnappingChangedSubscription

Observer::Subscription ProjectSelectionManager::mSnappingChangedSubscription

private

Definition at line 60 of file ProjectSelectionManager.h.

mTimeSignatureChangedSubscription

Observer::Subscription ProjectSelectionManager::mTimeSignatureChangedSubscription

private

Definition at line 61 of file ProjectSelectionManager.h.

---

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

• ProjectSelectionManager.h
• ProjectSelectionManager.cpp