SelectedRegion Class Reference

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
double	f0 () const
double	f1 () const
double	fc () 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 ()
bool	setF0 (double f, bool maySwap=true)
bool	setF1 (double f, bool maySwap=true)
bool	setFrequencies (double f0, double f1)
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 Member Functions
bool	ensureFrequencyOrdering ()

Private Attributes
double	mT0
double	mT1
double	mF0
double	mF1

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)
      , mF0(UndefinedFrequency)
      , mF1(UndefinedFrequency)
   {}

SelectedRegion() [2/3]

SelectedRegion::SelectedRegion ( double  t0, double  t1  )

inline

Definition at line 53 of file SelectedRegion.h.

      : mT0(t0)
      , mT1(t1)
      , mF0(UndefinedFrequency)
      , mF1(UndefinedFrequency)
   { ensureOrdering(); }

SelectedRegion() [3/3]

SelectedRegion::SelectedRegion ( const SelectedRegion &  x )

inline

Definition at line 66 of file SelectedRegion.h.

      : mT0(x.mT0)
      , mT1(x.mT1)
      , mF0(x.mF0)
      , mF1(x.mF1)
   {}

Member Function Documentation

collapseToT0()

void SelectedRegion::collapseToT0 ( )

inline

Definition at line 150 of file SelectedRegion.h.

{ mT1 = mT0; }

Referenced by NotifyingSelectedRegion::collapseToT0().

Here is the caller graph for this function:

collapseToT1()

void SelectedRegion::collapseToT1 ( )

inline

Definition at line 152 of file SelectedRegion.h.

{ mT0 = mT1; }

Referenced by NotifyingSelectedRegion::collapseToT1().

Here is the caller graph for this function:

duration()

double SelectedRegion::duration ( ) const

inline

Definition at line 88 of file SelectedRegion.h.

{ return mT1 - mT0; }

ensureFrequencyOrdering()

bool SelectedRegion::ensureFrequencyOrdering ( )

inlineprivate

Definition at line 237 of file SelectedRegion.h.

   {
      if (mF1 < 0)
         mF1 = UndefinedFrequency;
      if (mF0 < 0)
         mF0 = UndefinedFrequency;
 
      if (mF0 != UndefinedFrequency &&
          mF1 != UndefinedFrequency &&
          mF1 < mF0) {
         const double t = mF1;
         mF1 = mF0;
         mF0 = t;
         return true;
      }
      else
         return false;
   }

ensureOrdering()

bool SelectedRegion::ensureOrdering ( )

inline

Definition at line 223 of file SelectedRegion.h.

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

f0()

double SelectedRegion::f0 ( ) const

inline

Definition at line 91 of file SelectedRegion.h.

{ return mF0; }

Referenced by LabelStruct::Export(), LabelDialog::OnChangeHfreq(), NotifyingSelectedRegion::setF0(), NotifyingSelectedRegion::setFrequencies(), and LabelDialog::TransferDataToWindow().

Here is the caller graph for this function:

f1()

double SelectedRegion::f1 ( ) const

inline

Definition at line 92 of file SelectedRegion.h.

{ return mF1; }

Referenced by LabelStruct::Export(), LabelDialog::OnChangeLfreq(), NotifyingSelectedRegion::setF1(), NotifyingSelectedRegion::setFrequencies(), and LabelDialog::TransferDataToWindow().

Here is the caller graph for this function:

fc()

double SelectedRegion::fc ( ) const

inline

Definition at line 93 of file SelectedRegion.h.

                     {
      if (mF0 == UndefinedFrequency ||
          mF1 == UndefinedFrequency)
          return UndefinedFrequency;
      else
         return sqrt(mF0 * mF1);
   };

References staffpad::audio::simd::sqrt().

Here is the call graph for this function:

HandleXMLAttribute()

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

Definition at line 37 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;
   else if (attr == sDefaultF0Name)
      setter = &SelectedRegion::setF0;
   else if (attr == sDefaultF1Name)
      setter = &SelectedRegion::setF1;
   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, setF0(), setF1(), 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 89 of file SelectedRegion.h.

{ return mT1 <= mT0; }

Referenced by ExportAudioDialog::UpdateLabelExportSettings().

Here is the caller graph for this function:

move()

void SelectedRegion::move ( double  delta )

inline

Definition at line 145 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 136 of file SelectedRegion.h.

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

moveT1()

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

inline

Definition at line 141 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 66 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);
      } },
      { sDefaultF0Name, [=](auto &selectedRegion, auto value){
         selectedRegion
            .HandleXMLAttribute(sDefaultF0Name, value, "", "");
      } },
      { sDefaultF1Name, [=](auto &selectedRegion, auto value){
         selectedRegion
            .HandleXMLAttribute(sDefaultF1Name, value, "", "");
      } },
   };
};

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 73 of file SelectedRegion.h.

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

References mF0, mF1, mT0, and mT1.

setF0()

bool SelectedRegion::setF0 ( double  f, bool  maySwap = true  )

inline

Definition at line 155 of file SelectedRegion.h.

                                             {
      if (f < 0)
         f = UndefinedFrequency;
      mF0 = f;
      if (maySwap)
         return ensureFrequencyOrdering();
      else {
         if (mF1 >= 0 && mF1 < mF0)
            mF1 = mF0;
         return false;
      }
   }

Referenced by HandleXMLAttribute(), LabelDialog::OnChangeLfreq(), and NotifyingSelectedRegion::setF0().

Here is the caller graph for this function:

setF1()

bool SelectedRegion::setF1 ( double  f, bool  maySwap = true  )

inline

Definition at line 169 of file SelectedRegion.h.

                                             {
      if (f < 0)
         f = UndefinedFrequency;
      mF1 = f;
      if (maySwap)
         return ensureFrequencyOrdering();
      else {
         if (mF0 >= 0 && mF1 < mF0)
            mF0 = mF1;
         return false;
      }
   }

Referenced by HandleXMLAttribute(), LabelDialog::OnChangeHfreq(), and NotifyingSelectedRegion::setF1().

Here is the caller graph for this function:

setFrequencies()

bool SelectedRegion::setFrequencies ( double  f0, double  f1  )

inline

Definition at line 183 of file SelectedRegion.h.

   {
      mF0 = f0;
      mF1 = f1;
      return ensureFrequencyOrdering();
   }

Referenced by LabelStruct::Import(), and NotifyingSelectedRegion::setFrequencies().

Here is the caller graph for this function:

setT0()

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

inline

Definition at line 105 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 117 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 129 of file SelectedRegion.h.

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

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

Here is the caller graph for this function:

t0()

double SelectedRegion::t0 ( ) const

inline

Definition at line 86 of file SelectedRegion.h.

{ return mT0; }

Referenced by LabelTrack::AddLabel(), NotifyingSelectedRegion::collapseToT0(), NotifyingSelectedRegion::collapseToT1(), LabelTrackView::DialogForLabelName(), AdornedRulerPanel::DoSelectionChange(), LabelTrack::FindNextLabel(), LabelTrack::FindPrevLabel(), anonymous_namespace{LabelMenus.cpp}::GetRegionsByLabel(), anonymous_namespace{SpectrumView.cpp}::GetSelectedSampleIndices(), LabelDialog::OnChangeEtime(), SelectActions::Handler::OnSelectionRestore(), ProjectAudioManager::PlayPlayRegion(), TransportUtilities::PlayPlayRegionAndWait(), NotifyingSelectedRegion::setT0(), NotifyingSelectedRegion::setTimes(), LabelDialog::TransferDataToWindow(), and ExportAudioDialog::UpdateLabelExportSettings().

Here is the caller graph for this function:

t1()

double SelectedRegion::t1 ( ) const

inline

Definition at line 87 of file SelectedRegion.h.

{ return mT1; }

Referenced by NotifyingSelectedRegion::collapseToT0(), NotifyingSelectedRegion::collapseToT1(), AdornedRulerPanel::DoSelectionChange(), anonymous_namespace{LabelMenus.cpp}::GetRegionsByLabel(), anonymous_namespace{SpectrumView.cpp}::GetSelectedSampleIndices(), LabelDialog::OnChangeStime(), SelectActions::Handler::OnSelectionRestore(), ProjectAudioManager::PlayPlayRegion(), TransportUtilities::PlayPlayRegionAndWait(), NotifyingSelectedRegion::setT1(), NotifyingSelectedRegion::setTimes(), LabelDialog::TransferDataToWindow(), and ExportAudioDialog::UpdateLabelExportSettings().

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);
   if (f0() >= 0)
      xmlFile.WriteAttr(sDefaultF0Name, f0(), 10);
   if (f1() >= 0)
      xmlFile.WriteAttr(sDefaultF1Name, f1(), 10);
}

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 256 of file SelectedRegion.h.

   {
      return
            lhs.mT0 == rhs.mT0
         && lhs.mT1 == rhs.mT1
         && lhs.mF0 == rhs.mF0
         && lhs.mF1 == rhs.mF1
      ;
   }

Member Data Documentation

mF0

double SelectedRegion::mF0

private

Definition at line 269 of file SelectedRegion.h.

Referenced by operator=().

mF1

double SelectedRegion::mF1

private

Definition at line 270 of file SelectedRegion.h.

Referenced by operator=().

mT0

double SelectedRegion::mT0

private

Definition at line 267 of file SelectedRegion.h.

Referenced by operator=().

mT1

double SelectedRegion::mT1

private

Definition at line 268 of file SelectedRegion.h.

Referenced by operator=().

sDefaultT0Name

const char * SelectedRegion::sDefaultT0Name = "selStart"

static

Definition at line 197 of file SelectedRegion.h.

sDefaultT1Name

const char * SelectedRegion::sDefaultT1Name = "selEnd"

static

Definition at line 198 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(), SpectralSelectionBar::ModifySpectralSelection(), anonymous_namespace{SpectrumView.cpp}::Handler::OnToggleSpectralSelection(), SpectralSelectionBar::Populate(), and SelectHandle::StartFreqSelection().

---

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

• SelectedRegion.h
• SelectedRegion.cpp