Defines a selected portion of a project. More...

#include <SelectedRegion.h>

Public Member Functions
	SelectedRegion ()

	SelectedRegion (double t0, double t1)

	SelectedRegion (const SelectedRegion &x)

SelectedRegion &	operator= (const SelectedRegion &x)

double	t0 () const

double	t1 () const

double	duration () const

bool	isPoint () const

bool	setT0 (double t, bool maySwap=true)

bool	setT1 (double t, bool maySwap=true)

bool	setTimes (double t0, double t1)

bool	moveT0 (double delta, bool maySwap=true)

bool	moveT1 (double delta, bool maySwap=true)

void	move (double delta)

void	collapseToT0 ()

void	collapseToT1 ()

void	WriteXMLAttributes (XMLWriter &xmlFile, const char legacyT0Name=sDefaultT0Name, const char legacyT1Name=sDefaultT1Name) const

bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &value, const char legacyT0Name=sDefaultT0Name, const char legacyT1Name=sDefaultT1Name)

bool	ensureOrdering ()

Static Public Member Functions
static XMLMethodRegistryBase::Mutators< SelectedRegion >	Mutators (const char legacyT0Name, const char legacyT1Name)

Static Public Attributes
static const int	UndefinedFrequency = -1

static const char *	sDefaultT0Name = "selStart"

static const char *	sDefaultT1Name = "selEnd"

Private Attributes
double	mT0

double	mT1

Friends
bool	operator== (const SelectedRegion &lhs, const SelectedRegion &rhs)

Detailed Description

Defines a selected portion of a project.

This includes starting and ending times, and other optional information such as a frequency range, but not the set of selected tracks.

Maintains the invariants that ending time is not less than starting time and that starting and ending frequencies, when both defined, are also correctly ordered.

Definition at line 38 of file SelectedRegion.h.

Constructor & Destructor Documentation

◆ SelectedRegion() [1/3]

SelectedRegion::SelectedRegion ( )

inline

Definition at line 46 of file SelectedRegion.h.

      : mT0(0.0)
      , mT1(0.0)
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
      , mF0(UndefinedFrequency)
      , mF1(UndefinedFrequency)
#endif
   {}

◆ SelectedRegion() [2/3]

SelectedRegion::SelectedRegion	(	double	t0,
		double	t1
	)

inline

Definition at line 55 of file SelectedRegion.h.

      : mT0(t0)
      , mT1(t1)
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
      , mF0(UndefinedFrequency)
      , mF1(UndefinedFrequency)
#endif
   { ensureOrdering(); }

◆ SelectedRegion() [3/3]

SelectedRegion::SelectedRegion ( const SelectedRegion & x )

inline

Definition at line 70 of file SelectedRegion.h.

      : mT0(x.mT0)
      , mT1(x.mT1)
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
      , mF0(x.mF0)
      , mF1(x.mF1)
#endif
   {}

Member Function Documentation

◆ collapseToT0()

void SelectedRegion::collapseToT0 ( )

inline

Definition at line 160 of file SelectedRegion.h.

160{ mT1 = mT0; }

Referenced by NotifyingSelectedRegion::collapseToT0().

Here is the caller graph for this function:

◆ collapseToT1()

void SelectedRegion::collapseToT1 ( )

inline

Definition at line 162 of file SelectedRegion.h.

162{ mT0 = mT1; }

Referenced by NotifyingSelectedRegion::collapseToT1().

Here is the caller graph for this function:

◆ duration()

double SelectedRegion::duration ( ) const

inline

Definition at line 96 of file SelectedRegion.h.

96{ return mT1 - mT0; }

◆ ensureOrdering()

bool SelectedRegion::ensureOrdering ( )

inline

Definition at line 235 of file SelectedRegion.h.

   {
      if (mT1 < mT0) {
         const double t = mT1;
         mT1 = mT0;
         mT0 = t;
         return true;
      }
      else
         return false;
   }

◆ HandleXMLAttribute()

bool SelectedRegion::HandleXMLAttribute	(	const std::string_view &	attr,
		const XMLAttributeValueView &	value,
		const char *	legacyT0Name = `sDefaultT0Name`,
		const char *	legacyT1Name = `sDefaultT1Name`
	)

Definition at line 39 of file SelectedRegion.cpp.

{
   // Keep this function consistent with the table in the next!
   typedef bool (SelectedRegion::*Setter)(double, bool);
   Setter setter = 0;
   if (attr == legacyT0Name)
      setter = &SelectedRegion::setT0;
   else if (attr == legacyT1Name)
      setter = &SelectedRegion::setT1;
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
   else if (attr == sDefaultF0Name)
      setter = &SelectedRegion::setF0;
   else if (attr == sDefaultF1Name)
      setter = &SelectedRegion::setF1;
#endif
   else
      return false;
 
   double dblValue;
 
   if (!value.TryGet(dblValue))
      return false;
 
   // False means don't flip time or frequency boundaries
   (void)(this->*setter)(dblValue, false);
   return true;
}

References anonymous_namespace{SelectedRegion.cpp}::sDefaultF0Name, anonymous_namespace{SelectedRegion.cpp}::sDefaultF1Name, setT0(), setT1(), and XMLAttributeValueView::TryGet().

Referenced by LabelTrack::HandleXMLTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isPoint()

bool SelectedRegion::isPoint ( ) const

inline

Definition at line 97 of file SelectedRegion.h.

97{ return mT1 <= mT0; }

Referenced by ExportMultipleDialog::ExportMultipleByLabel().

Here is the caller graph for this function:

◆ move()

void SelectedRegion::move ( double delta )

inline

Definition at line 155 of file SelectedRegion.h.

                           {
      mT0 += delta;
      mT1 += delta;
   }

Referenced by NotifyingSelectedRegion::move().

Here is the caller graph for this function:

◆ moveT0()

bool SelectedRegion::moveT0	(	double	delta,
		bool	maySwap = `true`
	)

inline

Definition at line 146 of file SelectedRegion.h.

                                                  {
      return setT0(mT0 + delta, maySwap);
   }

◆ moveT1()

bool SelectedRegion::moveT1	(	double	delta,
		bool	maySwap = `true`
	)

inline

Definition at line 151 of file SelectedRegion.h.

                                                  {
      return setT1(mT1 + delta, maySwap);
   }

◆ Mutators()

XMLMethodRegistryBase::Mutators< SelectedRegion > SelectedRegion::Mutators	(	const char *	legacyT0Name,
		const char *	legacyT1Name
	)

static

Definition at line 70 of file SelectedRegion.cpp.

{
   // Keep this table consistent with the previous function!
   return {
      { legacyT0Name, [=](auto &selectedRegion, auto value){
         selectedRegion
            .HandleXMLAttribute(legacyT0Name, value,
                                legacyT0Name, legacyT1Name);
      } },
      { legacyT1Name, [=](auto &selectedRegion, auto value){
         selectedRegion
            .HandleXMLAttribute(legacyT1Name, value,
                                legacyT0Name, legacyT1Name);
      } },
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
      { sDefaultF0Name, [=](auto &selectedRegion, auto value){
         selectedRegion
            .HandleXMLAttribute(sDefaultF0Name, value, "", "");
      } },
      { sDefaultF1Name, [=](auto &selectedRegion, auto value){
         selectedRegion
            .HandleXMLAttribute(sDefaultF1Name, value, "", "");
      } },
#endif
   };
};

References anonymous_namespace{SelectedRegion.cpp}::sDefaultF0Name, and anonymous_namespace{SelectedRegion.cpp}::sDefaultF1Name.

Referenced by NotifyingSelectedRegion::Mutators().

Here is the caller graph for this function:

◆ operator=()

SelectedRegion & SelectedRegion::operator= ( const SelectedRegion & x )

inline

Definition at line 79 of file SelectedRegion.h.

   {
      if (this != &x) {
         mT0 = x.mT0;
         mT1 = x.mT1;
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
         mF0 = x.mF0;
         mF1 = x.mF1;
#endif
      }
      return *this;
   }

References mT0, and mT1.

◆ setT0()

bool SelectedRegion::setT0	(	double	t,
		bool	maySwap = `true`
	)

inline

Definition at line 115 of file SelectedRegion.h.

                                             {
      mT0 = t;
      if (maySwap)
         return ensureOrdering();
      else {
         if (mT1 < mT0)
            mT1 = mT0;
         return false;
      }
   }

Referenced by LabelStruct::AdjustEdge(), HandleXMLAttribute(), LabelDialog::OnChangeStime(), and NotifyingSelectedRegion::setT0().

Here is the caller graph for this function:

◆ setT1()

bool SelectedRegion::setT1	(	double	t,
		bool	maySwap = `true`
	)

inline

Definition at line 127 of file SelectedRegion.h.

                                             {
      mT1 = t;
      if (maySwap)
         return ensureOrdering();
      else {
         if (mT1 < mT0)
            mT0 = mT1;
         return false;
      }
   }

Referenced by LabelStruct::AdjustEdge(), HandleXMLAttribute(), LabelDialog::OnChangeEtime(), and NotifyingSelectedRegion::setT1().

Here is the caller graph for this function:

◆ setTimes()

bool SelectedRegion::setTimes	(	double	t0,
		double	t1
	)

inline

Definition at line 139 of file SelectedRegion.h.

                                       {
      mT0 = t0;
      mT1 = t1;
      return ensureOrdering();
   }

Referenced by LabelStruct::Import(), LabelStruct::LabelStruct(), LabelStruct::MoveLabel(), EffectUIHost::OnPlay(), and NotifyingSelectedRegion::setTimes().

Here is the caller graph for this function:

◆ t0()

double SelectedRegion::t0 ( ) const

inline

Definition at line 94 of file SelectedRegion.h.

94{ return mT0; }

Referenced by LabelTrack::AddLabel(), ClipParameters::ClipParameters(), NotifyingSelectedRegion::collapseToT0(), NotifyingSelectedRegion::collapseToT1(), LabelTrackView::DialogForLabelName(), AdornedRulerPanel::DoSelectionChange(), ExportMultipleDialog::ExportMultipleByLabel(), LabelTrack::FindNextLabel(), LabelTrack::FindPrevLabel(), anonymous_namespace{LabelMenus.cpp}::GetRegionsByLabel(), LabelDialog::OnChangeEtime(), EffectUIHost::OnPlay(), EffectUIHost::OnPlayback(), SelectActions::Handler::OnSelectionRestore(), ProjectAudioManager::PlayPlayRegion(), TransportUtilities::PlayPlayRegionAndWait(), NotifyingSelectedRegion::setT0(), NotifyingSelectedRegion::setTimes(), and LabelDialog::TransferDataToWindow().

Here is the caller graph for this function:

◆ t1()

double SelectedRegion::t1 ( ) const

inline

Definition at line 95 of file SelectedRegion.h.

95{ return mT1; }

Referenced by ClipParameters::ClipParameters(), NotifyingSelectedRegion::collapseToT0(), NotifyingSelectedRegion::collapseToT1(), AdornedRulerPanel::DoSelectionChange(), ExportMultipleDialog::ExportMultipleByLabel(), anonymous_namespace{LabelMenus.cpp}::GetRegionsByLabel(), LabelDialog::OnChangeStime(), EffectUIHost::OnPlay(), SelectActions::Handler::OnSelectionRestore(), ProjectAudioManager::PlayPlayRegion(), TransportUtilities::PlayPlayRegionAndWait(), NotifyingSelectedRegion::setT1(), NotifyingSelectedRegion::setTimes(), and LabelDialog::TransferDataToWindow().

Here is the caller graph for this function:

◆ WriteXMLAttributes()

void SelectedRegion::WriteXMLAttributes	(	XMLWriter &	xmlFile,
		const char *	legacyT0Name = `sDefaultT0Name`,
		const char *	legacyT1Name = `sDefaultT1Name`
	)		const

Definition at line 24 of file SelectedRegion.cpp.

{
   xmlFile.WriteAttr(legacyT0Name, t0(), 10);
   xmlFile.WriteAttr(legacyT1Name, t1(), 10);
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
   if (f0() >= 0)
      xmlFile.WriteAttr(sDefaultF0Name, f0(), 10);
   if (f1() >= 0)
      xmlFile.WriteAttr(sDefaultF1Name, f1(), 10);
#endif
}

References anonymous_namespace{SelectedRegion.cpp}::sDefaultF0Name, and anonymous_namespace{SelectedRegion.cpp}::sDefaultF1Name.

Friends And Related Function Documentation

◆ operator==

bool operator==	(	const SelectedRegion &	lhs,
		const SelectedRegion &	rhs
	)

friend

Definition at line 270 of file SelectedRegion.h.

   {
      return
            lhs.mT0 == rhs.mT0
         && lhs.mT1 == rhs.mT1
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
         && lhs.mF0 == rhs.mF0
         && lhs.mF1 == rhs.mF1
#endif
      ;
   }

Member Data Documentation

◆ mT0

double SelectedRegion::mT0

private

Definition at line 283 of file SelectedRegion.h.

Referenced by operator=().

◆ mT1

double SelectedRegion::mT1

private

Definition at line 284 of file SelectedRegion.h.

Referenced by operator=().

◆ sDefaultT0Name

const char * SelectedRegion::sDefaultT0Name = "selStart"

static

Definition at line 209 of file SelectedRegion.h.

◆ sDefaultT1Name

const char * SelectedRegion::sDefaultT1Name = "selEnd"

static

Definition at line 210 of file SelectedRegion.h.

◆ UndefinedFrequency

const int SelectedRegion::UndefinedFrequency = -1

static

Definition at line 44 of file SelectedRegion.h.

Referenced by SelectHandle::AdjustFreqSelection(), NumericEditor::Create(), EffectBase::DoEffect(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), LabelStruct::Export(), and SelectHandle::StartFreqSelection().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SelectedRegion() [1/3]

◆ SelectedRegion() [2/3]

◆ SelectedRegion() [3/3]

Member Function Documentation

◆ collapseToT0()

◆ collapseToT1()

◆ duration()

◆ ensureOrdering()

◆ HandleXMLAttribute()

◆ isPoint()

◆ move()

◆ moveT0()

◆ moveT1()

◆ Mutators()

◆ operator=()

◆ setT0()

◆ setT1()

◆ setTimes()

◆ t0()

◆ t1()

◆ WriteXMLAttributes()

Friends And Related Function Documentation

◆ operator==

Member Data Documentation

◆ mT0

◆ mT1

◆ sDefaultT0Name

◆ sDefaultT1Name

◆ UndefinedFrequency