WaveClip::ClearSequenceFinisher Class Reference

Fix consistency of cutlines and envelope after deleting from Sequences. More...

Collaboration diagram for WaveClip::ClearSequenceFinisher:

Public Member Functions
	ClearSequenceFinisher () noexcept=default
	ClearSequenceFinisher (WaveClip *pClip, double t0, double t1, double clip_t0, double clip_t1) noexcept
ClearSequenceFinisher &	operator= (ClearSequenceFinisher &&other)
	~ClearSequenceFinisher () noexcept
void	Commit () noexcept

Private Member Functions
ClearSequenceFinisher &	operator= (const ClearSequenceFinisher &other)=default

Private Attributes
WaveClip *	pClip {}
double	t0 {}
double	t1 {}
double	clip_t0 {}
double	clip_t1 {}
bool	committed = false

Detailed Description

Fix consistency of cutlines and envelope after deleting from Sequences.

This is like a finally object

Definition at line 890 of file WaveClip.h.

Constructor & Destructor Documentation

ClearSequenceFinisher() [1/2]

WaveClip::ClearSequenceFinisher::ClearSequenceFinisher ( )

defaultnoexcept

ClearSequenceFinisher() [2/2]

WaveClip::ClearSequenceFinisher::ClearSequenceFinisher ( WaveClip *  pClip, double  t0, double  t1, double  clip_t0, double  clip_t1  )

inlinenoexcept

Definition at line 899 of file WaveClip.h.

         : pClip{ pClip }
         , t0{ t0 }, t1{ t1 }, clip_t0{ clip_t0 }, clip_t1{ clip_t1 }
      {}

~ClearSequenceFinisher()

WaveClip::ClearSequenceFinisher::~ClearSequenceFinisher ( )

noexcept

Definition at line 1357 of file WaveClip.cpp.

{
   if (!pClip || !committed)
      return;
 
   // use No-fail-guarantee in the remaining
 
   // msmeyer
   //
   // Delete all cutlines that are within the given area, if any.
   //
   // Note that when cutlines are active, two functions are used:
   // Clear() and ClearAndAddCutLine(). ClearAndAddCutLine() is called
   // whenever the user directly calls a command that removes some audio, e.g.
   // "Cut" or "Clear" from the menu. This command takes care about recursive
   // preserving of cutlines within clips. Clear() is called when internal
   // operations want to remove audio. In the latter case, it is the right
   // thing to just remove all cutlines within the area.
   //
 
   // May DELETE as we iterate, so don't use range-for
   for (auto it = pClip->mCutLines.begin(); it != pClip->mCutLines.end();)
   {
      WaveClip* clip = it->get();
      double cutlinePosition =
         pClip->GetSequenceStartTime() + clip->GetSequenceStartTime();
      if (cutlinePosition >= t0 && cutlinePosition <= t1)
      {
         // This cutline is within the area, DELETE it
         it = pClip->mCutLines.erase(it);
      }
      else
      {
         if (cutlinePosition >= t1)
         {
            clip->ShiftBy(clip_t0 - clip_t1);
         }
         ++it;
      }
   }
 
   // Collapse envelope
   auto sampleTime = 1.0 / pClip->GetRate();
   pClip->GetEnvelope().CollapseRegion(t0, t1, sampleTime);
}

References clip_t0, clip_t1, Envelope::CollapseRegion(), committed, WaveClip::GetEnvelope(), WaveClip::GetRate(), WaveClip::GetSequenceStartTime(), WaveClip::mCutLines, pClip, WaveClip::ShiftBy(), t0, and t1.

Here is the call graph for this function:

Member Function Documentation

Commit()

void WaveClip::ClearSequenceFinisher::Commit ( )

inlinenoexcept

Definition at line 911 of file WaveClip.h.

{ committed = true; }

Referenced by WaveClip::Clear(), WaveClip::ClearLeft(), WaveClip::ClearRight(), WaveClip::InsertSilence(), and WaveClip::Paste().

Here is the caller graph for this function:

operator=() [1/2]

ClearSequenceFinisher & WaveClip::ClearSequenceFinisher::operator= ( ClearSequenceFinisher &&  other )

inline

Definition at line 904 of file WaveClip.h.

      {
         *this = other;
         other.pClip = nullptr;
         return *this;
      }

References pClip.

operator=() [2/2]

ClearSequenceFinisher & WaveClip::ClearSequenceFinisher::operator= ( const ClearSequenceFinisher &  other )

privatedefault

Member Data Documentation

clip_t0

double WaveClip::ClearSequenceFinisher::clip_t0 {}

private

Definition at line 917 of file WaveClip.h.

Referenced by ~ClearSequenceFinisher().

clip_t1

double WaveClip::ClearSequenceFinisher::clip_t1 {}

private

Definition at line 917 of file WaveClip.h.

Referenced by ~ClearSequenceFinisher().

committed

bool WaveClip::ClearSequenceFinisher::committed = false

private

Definition at line 918 of file WaveClip.h.

Referenced by ~ClearSequenceFinisher().

pClip

WaveClip* WaveClip::ClearSequenceFinisher::pClip {}

private

Definition at line 916 of file WaveClip.h.

Referenced by operator=(), and ~ClearSequenceFinisher().

t0

double WaveClip::ClearSequenceFinisher::t0 {}

private

Definition at line 917 of file WaveClip.h.

Referenced by ~ClearSequenceFinisher().

t1

double WaveClip::ClearSequenceFinisher::t1 {}

private

Definition at line 917 of file WaveClip.h.

Referenced by ~ClearSequenceFinisher().

---

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

• WaveClip.h
• WaveClip.cpp