ProjectSelectionManager Class Reference

#include <ProjectSelectionManager.h>

Inheritance diagram for ProjectSelectionManager:

Collaboration diagram for ProjectSelectionManager:

Public Member Functions
	ProjectSelectionManager (AudacityProject &project)
	ProjectSelectionManager (const ProjectSelectionManager &) PROHIBITED
ProjectSelectionManager &	operator= (const ProjectSelectionManager &) PROHIBITED
	~ProjectSelectionManager () override
double	AS_GetRate () override
void	AS_SetRate (double rate) override
int	AS_GetSnapTo () override
void	AS_SetSnapTo (int snap) override
const NumericFormatSymbol &	AS_GetSelectionFormat () override
void	AS_SetSelectionFormat (const NumericFormatSymbol &format) override
const NumericFormatSymbol &	TT_GetAudioTimeFormat () override
void	TT_SetAudioTimeFormat (const NumericFormatSymbol &format) override
void	AS_ModifySelection (double &start, double &end, bool done) override
double	SSBL_GetRate () const override
const NumericFormatSymbol &	SSBL_GetFrequencySelectionFormatName () override
void	SSBL_SetFrequencySelectionFormatName (const NumericFormatSymbol &formatName) override
const NumericFormatSymbol &	SSBL_GetBandwidthSelectionFormatName () override
void	SSBL_SetBandwidthSelectionFormatName (const NumericFormatSymbol &formatName) override
void	SSBL_ModifySpectralSelection (double &bottom, double &top, bool done) override
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from SelectionBarListener
	SelectionBarListener ()
virtual	~SelectionBarListener ()
virtual double	AS_GetRate ()=0
virtual void	AS_SetRate (double rate)=0
virtual int	AS_GetSnapTo ()=0
virtual void	AS_SetSnapTo (int snap)=0
virtual const NumericFormatSymbol &	AS_GetSelectionFormat ()=0
virtual void	AS_SetSelectionFormat (const NumericFormatSymbol &format)=0
virtual void	AS_ModifySelection (double &start, double &end, bool done)=0
Public Member Functions inherited from SpectralSelectionBarListener
	SpectralSelectionBarListener ()
virtual	~SpectralSelectionBarListener ()
virtual double	SSBL_GetRate () const =0
virtual const NumericFormatSymbol &	SSBL_GetFrequencySelectionFormatName ()=0
virtual void	SSBL_SetFrequencySelectionFormatName (const NumericFormatSymbol &formatName)=0
virtual const NumericFormatSymbol &	SSBL_GetBandwidthSelectionFormatName ()=0
virtual void	SSBL_SetBandwidthSelectionFormatName (const NumericFormatSymbol &formatName)=0
virtual void	SSBL_ModifySpectralSelection (double &bottom, double &top, bool done)=0
Public Member Functions inherited from TimeToolBarListener
	TimeToolBarListener ()
virtual	~TimeToolBarListener ()
virtual const NumericFormatSymbol &	TT_GetAudioTimeFormat ()=0
virtual void	TT_SetAudioTimeFormat (const NumericFormatSymbol &format)=0

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

Private Member Functions
bool	SnapSelection ()

Private Attributes
AudacityProject &	mProject

Detailed Description

Definition at line 21 of file ProjectSelectionManager.h.

Constructor & Destructor Documentation

ProjectSelectionManager() [1/2]

ProjectSelectionManager::ProjectSelectionManager ( AudacityProject &  project )

explicit

Definition at line 50 of file ProjectSelectionManager.cpp.

   : mProject{ project }
{
}

ProjectSelectionManager() [2/2]

ProjectSelectionManager::ProjectSelectionManager

(

const ProjectSelectionManager &

)

~ProjectSelectionManager()

ProjectSelectionManager::~ProjectSelectionManager ( )

overridedefault

Member Function Documentation

AS_GetRate()

double ProjectSelectionManager::AS_GetRate ( )

overridevirtual

Implements SelectionBarListener.

Definition at line 91 of file ProjectSelectionManager.cpp.

{
   return ProjectRate::Get(mProject).GetRate();
}

References ProjectRate::Get(), ProjectRate::GetRate(), and mProject.

Here is the call graph for this function:

AS_GetSelectionFormat()

const NumericFormatSymbol & ProjectSelectionManager::AS_GetSelectionFormat ( )

overridevirtual

Implements SelectionBarListener.

Definition at line 130 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &formats = ProjectNumericFormats::Get( project );
   return formats.GetSelectionFormat();
}

References ProjectNumericFormats::Get(), and mProject.

Here is the call graph for this function:

AS_GetSnapTo()

int ProjectSelectionManager::AS_GetSnapTo ( )

overridevirtual

Implements SelectionBarListener.

Definition at line 103 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &settings = ProjectSettings::Get( project );
   return settings.GetSnapTo();
}

References ProjectSettings::Get(), mProject, and settings().

Here is the call graph for this function:

AS_ModifySelection()

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

overridevirtual

Implements SelectionBarListener.

Definition at line 173 of file ProjectSelectionManager.cpp.

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

References PackedArray::end(), ProjectHistory::Get(), ViewInfo::Get(), TrackPanel::Get(), and mProject.

Here is the call graph for this function:

AS_SetRate()

void ProjectSelectionManager::AS_SetRate ( double  rate )

overridevirtual

Implements SelectionBarListener.

Definition at line 96 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   ProjectRate::Get( project ).SetRate( rate );
   SelectionBar::Get( project ).SetRate(rate);
}

References ProjectRate::Get(), SelectionBar::Get(), mProject, ProjectRate::SetRate(), and SelectionBar::SetRate().

Referenced by anonymous_namespace{PluginMenus.cpp}::OnResetConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

AS_SetSelectionFormat()

void ProjectSelectionManager::AS_SetSelectionFormat ( const NumericFormatSymbol &  format )

overridevirtual

Implements SelectionBarListener.

Definition at line 137 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &formats = ProjectNumericFormats::Get( project );
   formats.SetSelectionFormat( format );
 
   gPrefs->Write(wxT("/SelectionFormat"), format.Internal());
   gPrefs->Flush();
 
   if (SnapSelection())
      TrackPanel::Get( project ).Refresh(false);
 
   SelectionBar::Get( project ).SetSelectionFormat(format);
}

References FileConfig::Flush(), format, ProjectNumericFormats::Get(), SelectionBar::Get(), TrackPanel::Get(), gPrefs, mProject, TrackPanel::Refresh(), SelectionBar::SetSelectionFormat(), SnapSelection(), and wxT().

Here is the call graph for this function:

AS_SetSnapTo()

void ProjectSelectionManager::AS_SetSnapTo ( int  snap )

overridevirtual

Implements SelectionBarListener.

Definition at line 110 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &settings = ProjectSettings::Get( project );
   auto &window = ProjectWindow::Get( project );
 
   settings.SetSnapTo( snap );
 
// LLL: TODO - what should this be changed to???
// GetCommandManager()->Check(wxT("Snap"), mSnapTo);
   gPrefs->Write(wxT("/SnapTo"), snap);
   gPrefs->Flush();
 
   SnapSelection();
 
   window.RedrawProject();
 
   SelectionBar::Get( project ).SetSnapTo(snap);
}

References FileConfig::Flush(), ProjectSettings::Get(), ProjectWindow::Get(), SelectionBar::Get(), gPrefs, mProject, SelectionBar::SetSnapTo(), settings(), SnapSelection(), and wxT().

Referenced by anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), SelectActions::Handler::OnSnapToNearest(), SelectActions::Handler::OnSnapToOff(), SelectActions::Handler::OnSnapToPrior(), and anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

Get() [1/2]

ProjectSelectionManager & ProjectSelectionManager::Get ( AudacityProject &  project )

static

Definition at line 37 of file ProjectSelectionManager.cpp.

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

References sProjectSelectionManagerKey.

Referenced by SelectFrequenciesCommand::Apply(), Get(), AUPImportFileHandle::Import(), ProjectManager::New(), anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), SelectActions::Handler::OnSnapToNearest(), SelectActions::Handler::OnSnapToOff(), SelectActions::Handler::OnSnapToPrior(), ProjectFileManager::OpenProjectFile(), and anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::PopulateOrExchange().

Here is the caller graph for this function:

Get() [2/2]

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

static

Definition at line 44 of file ProjectSelectionManager.cpp.

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

References Get().

Here is the call graph for this function:

operator=()

ProjectSelectionManager & ProjectSelectionManager::operator=

(

const ProjectSelectionManager &

)

SnapSelection()

bool ProjectSelectionManager::SnapSelection ( )

private

Definition at line 57 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &formats = ProjectNumericFormats::Get( project );
   auto &settings = ProjectSettings::Get( project );
   auto &window = ProjectWindow::Get( project );
   auto snapTo = settings.GetSnapTo();
   if (snapTo != SNAP_OFF) {
      auto &viewInfo = ViewInfo::Get( project );
      auto &selectedRegion = viewInfo.selectedRegion;
      NumericConverter nc(NumericConverter::TIME,
         formats.GetSelectionFormat(), 0, ProjectRate::Get(project).GetRate());
      const bool nearest = (snapTo == SNAP_NEAREST);
 
      const double oldt0 = selectedRegion.t0();
      const double oldt1 = selectedRegion.t1();
 
      nc.ValueToControls(oldt0, nearest);
      nc.ControlsToValue();
      const double t0 = nc.GetValue();
 
      nc.ValueToControls(oldt1, nearest);
      nc.ControlsToValue();
      const double t1 = nc.GetValue();
 
      if (t0 != oldt0 || t1 != oldt1) {
         selectedRegion.setTimes(t0, t1);
         return true;
      }
   }
 
   return false;
}

References NumericConverter::ControlsToValue(), ProjectNumericFormats::Get(), ProjectRate::Get(), ViewInfo::Get(), ProjectSettings::Get(), ProjectWindow::Get(), ProjectRate::GetRate(), NumericConverter::GetValue(), mProject, settings(), SNAP_NEAREST, SNAP_OFF, NumericConverter::TIME, and NumericConverter::ValueToControls().

Referenced by AS_SetSelectionFormat(), and AS_SetSnapTo().

Here is the call graph for this function:

Here is the caller graph for this function:

SSBL_GetBandwidthSelectionFormatName()

const NumericFormatSymbol & ProjectSelectionManager::SSBL_GetBandwidthSelectionFormatName ( )

overridevirtual

Implements SpectralSelectionBarListener.

Definition at line 222 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &formats = ProjectNumericFormats::Get( project );
   return formats.GetBandwidthSelectionFormatName();
}

References ProjectNumericFormats::Get(), and mProject.

Here is the call graph for this function:

SSBL_GetFrequencySelectionFormatName()

const NumericFormatSymbol & ProjectSelectionManager::SSBL_GetFrequencySelectionFormatName ( )

overridevirtual

Implements SpectralSelectionBarListener.

Definition at line 197 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &formats = ProjectNumericFormats::Get( project );
   return formats.GetFrequencySelectionFormatName();
}

References ProjectNumericFormats::Get(), and mProject.

Here is the call graph for this function:

SSBL_GetRate()

double ProjectSelectionManager::SSBL_GetRate ( ) const

overridevirtual

Implements SpectralSelectionBarListener.

Definition at line 187 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &tracks = TrackList::Get( project );
   // Return maximum of project rate and all track rates.
   return std::max( ProjectRate::Get( project ).GetRate(),
      tracks.Any<const WaveTrack>().max( &WaveTrack::GetRate ) );
}

References ProjectRate::Get(), TrackList::Get(), anonymous_namespace{TimeTrack.cpp}::GetRate(), WaveTrack::GetRate(), and mProject.

Referenced by SSBL_ModifySpectralSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

SSBL_ModifySpectralSelection()

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

overridevirtual

Implements SpectralSelectionBarListener.

Definition at line 246 of file ProjectSelectionManager.cpp.

{
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
   auto &project = mProject;
   auto &history = ProjectHistory::Get( project );
   auto &trackPanel = TrackPanel::Get( project );
   auto &viewInfo = ViewInfo::Get( project );
 
   double nyq = SSBL_GetRate() / 2.0;
   if (bottom >= 0.0)
      bottom = std::min(nyq, bottom);
   if (top >= 0.0)
      top = std::min(nyq, top);
   viewInfo.selectedRegion.setFrequencies(bottom, top);
   trackPanel.Refresh(false);
   if (done) {
      history.ModifyState(false);
   }
#else
   bottom; top; done;
#endif
}

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

Referenced by SelectFrequenciesCommand::Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

SSBL_SetBandwidthSelectionFormatName()

void ProjectSelectionManager::SSBL_SetBandwidthSelectionFormatName ( const NumericFormatSymbol &  formatName )

overridevirtual

Implements SpectralSelectionBarListener.

Definition at line 229 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &formats = ProjectNumericFormats::Get( project );
 
   formats.SetBandwidthSelectionFormatName( formatName );
 
   gPrefs->Write(wxT("/BandwidthSelectionFormatName"),
      formatName.Internal());
   gPrefs->Flush();
 
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
   SpectralSelectionBar::Get( project ).SetBandwidthSelectionFormatName(formatName);
#endif
}

References FileConfig::Flush(), ProjectNumericFormats::Get(), SpectralSelectionBar::Get(), gPrefs, ComponentInterfaceSymbol::Internal(), mProject, SpectralSelectionBar::SetBandwidthSelectionFormatName(), and wxT().

Here is the call graph for this function:

SSBL_SetFrequencySelectionFormatName()

void ProjectSelectionManager::SSBL_SetFrequencySelectionFormatName ( const NumericFormatSymbol &  formatName )

overridevirtual

Implements SpectralSelectionBarListener.

Definition at line 204 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &formats = ProjectNumericFormats::Get( project );
 
   formats.SetFrequencySelectionFormatName( formatName );
 
   gPrefs->Write(wxT("/FrequencySelectionFormatName"),
                 formatName.Internal());
   gPrefs->Flush();
 
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
   SpectralSelectionBar::Get( project ).SetFrequencySelectionFormatName(formatName);
#endif
}

References FileConfig::Flush(), ProjectNumericFormats::Get(), SpectralSelectionBar::Get(), gPrefs, ComponentInterfaceSymbol::Internal(), mProject, SpectralSelectionBar::SetFrequencySelectionFormatName(), and wxT().

Here is the call graph for this function:

TT_GetAudioTimeFormat()

const NumericFormatSymbol & ProjectSelectionManager::TT_GetAudioTimeFormat ( )

overridevirtual

Implements TimeToolBarListener.

Definition at line 153 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &formats = ProjectNumericFormats::Get( project );
   return formats.GetAudioTimeFormat();
}

References ProjectNumericFormats::Get(), and mProject.

Here is the call graph for this function:

TT_SetAudioTimeFormat()

void ProjectSelectionManager::TT_SetAudioTimeFormat ( const NumericFormatSymbol &  format )

overridevirtual

Implements TimeToolBarListener.

Definition at line 160 of file ProjectSelectionManager.cpp.

{
   auto &project = mProject;
   auto &formats = ProjectNumericFormats::Get( project );
   formats.SetAudioTimeFormat( format );
 
   gPrefs->Write(wxT("/AudioTimeFormat"), format.Internal());
   gPrefs->Flush();
 
   TimeToolBar::Get( project ).SetAudioTimeFormat(format);
}

References FileConfig::Flush(), format, ProjectNumericFormats::Get(), TimeToolBar::Get(), gPrefs, mProject, TimeToolBar::SetAudioTimeFormat(), and wxT().

Here is the call graph for this function:

Member Data Documentation

mProject

AudacityProject& ProjectSelectionManager::mProject

private

Definition at line 62 of file ProjectSelectionManager.h.

Referenced by AS_GetRate(), AS_GetSelectionFormat(), AS_GetSnapTo(), AS_ModifySelection(), AS_SetRate(), AS_SetSelectionFormat(), AS_SetSnapTo(), SnapSelection(), SSBL_GetBandwidthSelectionFormatName(), SSBL_GetFrequencySelectionFormatName(), SSBL_GetRate(), SSBL_ModifySpectralSelection(), SSBL_SetBandwidthSelectionFormatName(), SSBL_SetFrequencySelectionFormatName(), TT_GetAudioTimeFormat(), and TT_SetAudioTimeFormat().

---

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

• ProjectSelectionManager.h
• ProjectSelectionManager.cpp