WaveClipTrimHandle::AdjustBorder Class Reference

Inheritance diagram for WaveClipTrimHandle::AdjustBorder:

Collaboration diagram for WaveClipTrimHandle::AdjustBorder:

Public Member Functions
	AdjustBorder (const std::shared_ptr< WaveTrack > &track, const std::shared_ptr< WaveClip > &clip, bool leftBorder, const ZoomInfo &zoomInfo)
bool	Init (const TrackPanelMouseEvent &event) override
UIHandle::Result	Trim (const TrackPanelMouseEvent &event, AudacityProject &project) override
void	Finish (AudacityProject &project) override
void	Cancel () override
void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override
wxRect	DrawingArea (TrackPanelDrawingContext &, const wxRect &rect, const wxRect &panelRect, unsigned iPass) override
Public Member Functions inherited from WaveClipTrimHandle::ClipTrimPolicy
virtual	~ClipTrimPolicy ()
virtual bool	Init (const TrackPanelMouseEvent &event)=0
virtual UIHandle::Result	Trim (const TrackPanelMouseEvent &event, AudacityProject &project)=0
virtual void	Finish (AudacityProject &project)=0
virtual void	Cancel ()=0
virtual void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass)
virtual wxRect	DrawingArea (TrackPanelDrawingContext &, const wxRect &rect, const wxRect &panelRect, unsigned iPass)

Private Member Functions
void	TrimTo (double t)

Static Private Member Functions
static SnapPointArray	FindSnapPoints (const WaveTrack *currentTrack, WaveClip *adjustedClip, const std::pair< double, double > range)

Private Attributes
std::shared_ptr< WaveTrack >	mTrack
std::vector< std::shared_ptr< WaveClip > >	mClips
double	mInitialBorderPosition {}
int	mDragStartX { }
std::pair< double, double >	mRange
bool	mAdjustingLeftBorder
std::unique_ptr< SnapManager >	mSnapManager
SnapResults	mSnap

Detailed Description

Definition at line 48 of file WaveClipTrimHandle.cpp.

Constructor & Destructor Documentation

AdjustBorder()

WaveClipTrimHandle::AdjustBorder::AdjustBorder ( const std::shared_ptr< WaveTrack > &  track, const std::shared_ptr< WaveClip > &  clip, bool  leftBorder, const ZoomInfo &  zoomInfo  )

inline

Definition at line 124 of file WaveClipTrimHandle.cpp.

      : mTrack(track),
        mAdjustingLeftBorder(leftBorder)
   {
      auto clips = track->GetClips();
 
      wxASSERT(std::find(clips.begin(), clips.end(), clip) != clips.end());
 
      if (track->IsAlignedWithLeader() || track->GetLinkType() == Track::LinkType::Aligned)
         //find clips in other channels which are also should be trimmed
         mClips = FindClipsInChannels(clip->GetPlayStartTime(), clip->GetPlayEndTime(), track.get());
      else
         mClips.push_back(clip);
 
      if (mAdjustingLeftBorder)
      {
         auto left = clip->GetSequenceStartTime();
         for (const auto& other : clips)
            if (other->GetPlayStartTime() < clip->GetPlayStartTime() && other->GetPlayEndTime() > left)
               left = other->GetPlayEndTime();
         //not less than 1 sample length
         mRange = std::make_pair(left, clip->GetPlayEndTime() - 1.0 / clip->GetRate());
 
         mInitialBorderPosition = mClips[0]->GetPlayStartTime();
      }
      else
      {
         auto right = clip->GetSequenceEndTime();
         for (const auto& other : clips)
            if (other->GetPlayStartTime() > clip->GetPlayStartTime() && other->GetPlayStartTime() < right)
               right = other->GetPlayStartTime();
         //not less than 1 sample length
         mRange = std::make_pair(clip->GetPlayStartTime() + 1.0 / clip->GetRate(), right);
 
         mInitialBorderPosition = mClips[0]->GetPlayEndTime();
      }
 
      if(const auto trackList = track->GetOwner())
      {
         mSnapManager = std::make_unique<SnapManager>(
            *trackList->GetOwner(),
            FindSnapPoints(track.get(), clip.get(), mRange),
            zoomInfo);
      }
   }

References ChannelGroup::Aligned, anonymous_namespace{WaveClipTrimHandle.cpp}::FindClipsInChannels(), FindSnapPoints(), mAdjustingLeftBorder, mClips, mInitialBorderPosition, mRange, and mSnapManager.

Here is the call graph for this function:

Member Function Documentation

Cancel()

void WaveClipTrimHandle::AdjustBorder::Cancel ( )

inlineoverridevirtual

Implements WaveClipTrimHandle::ClipTrimPolicy.

Definition at line 239 of file WaveClipTrimHandle.cpp.

   {
      TrimTo(mInitialBorderPosition);
   }

References mInitialBorderPosition, and TrimTo().

Here is the call graph for this function:

Draw()

void WaveClipTrimHandle::AdjustBorder::Draw ( TrackPanelDrawingContext &  context, const wxRect &  rect, unsigned  iPass  )

inlineoverridevirtual

Reimplemented from WaveClipTrimHandle::ClipTrimPolicy.

Definition at line 244 of file WaveClipTrimHandle.cpp.

   {
      if(iPass == TrackArtist::PassSnapping && mSnap.Snapped())
      {
         auto &dc = context.dc;
         SnapManager::Draw(&dc, rect.x + mSnap.outCoord, -1);
      }
   }

References TrackPanelDrawingContext::dc, SnapManager::Draw(), mSnap, SnapResults::outCoord, TrackArtist::PassSnapping, and SnapResults::Snapped().

Here is the call graph for this function:

DrawingArea()

wxRect WaveClipTrimHandle::AdjustBorder::DrawingArea ( TrackPanelDrawingContext &  , const wxRect &  rect, const wxRect &  panelRect, unsigned  iPass  )

inlineoverridevirtual

Reimplemented from WaveClipTrimHandle::ClipTrimPolicy.

Definition at line 253 of file WaveClipTrimHandle.cpp.

   {
      if(iPass == TrackArtist::PassSnapping)
        return MaximizeHeight(rect, panelRect);
      return rect;
   }

References TrackPanelDrawable::MaximizeHeight(), and TrackArtist::PassSnapping.

Here is the call graph for this function:

FindSnapPoints()

static SnapPointArray WaveClipTrimHandle::AdjustBorder::FindSnapPoints ( const WaveTrack *  currentTrack, WaveClip *  adjustedClip, const std::pair< double, double >  range  )

inlinestaticprivate

Definition at line 78 of file WaveClipTrimHandle.cpp.

   {
      SnapPointArray result;
 
      auto addSnapPoint = [&](double t, const Track* track)
      {
         if(t > range.second || t < range.first)
            return;
 
         for(const auto& snapPoint : result)
            if(snapPoint.t == t)
               return;
         result.emplace_back(t, track);
      };
 
      if(const auto trackList = currentTrack->GetOwner())
      {
         for(const auto track : as_const(*trackList).Leaders())
         {
            const auto isSameTrack = (track == currentTrack) ||
               (track->GetLinkType() == Track::LinkType::Aligned && *trackList->FindLeader(currentTrack) == track) ||
               (currentTrack->GetLinkType() == Track::LinkType::Aligned && *trackList->FindLeader(track) == currentTrack);
            for(const auto& interval : track->Intervals())
            {
               if(isSameTrack)
               {
                  auto waveTrackIntervalData =
                     std::dynamic_pointer_cast<const WaveTrack::Interval>(
                        interval);
                  if(waveTrackIntervalData->GetClip(0).get() == adjustedClip)
                  //exclude boundaries of the adjusted clip
                     continue;
               }
               addSnapPoint(interval->Start(), track);
               if(interval->Start() != interval->End())
                  addSnapPoint(interval->End(), track);
            }
         }
      }
      return result;
   }

References ChannelGroup::Aligned, Track::GetLinkType(), and Track::GetOwner().

Referenced by AdjustBorder().

Here is the call graph for this function:

Here is the caller graph for this function:

Finish()

void WaveClipTrimHandle::AdjustBorder::Finish ( AudacityProject &  project )

inlineoverridevirtual

Implements WaveClipTrimHandle::ClipTrimPolicy.

Definition at line 220 of file WaveClipTrimHandle.cpp.

   {
      if (mClips[0]->GetPlayStartTime() != mInitialBorderPosition)
      {
         if (mAdjustingLeftBorder)
         {
            auto dt = std::abs(mClips[0]->GetPlayStartTime() - mInitialBorderPosition);
            ProjectHistory::Get(project).PushState(XO("Clip-Trim-Left"),
                XO("Moved by %.02f").Format(dt));
         }
         else
         {
            auto dt = std::abs(mInitialBorderPosition - mClips[0]->GetPlayEndTime());
            ProjectHistory::Get(project).PushState(XO("Clip-Trim-Right"),
                XO("Moved by %.02f").Format(dt));
         }
      }
   }

References ProjectHistory::Get(), mAdjustingLeftBorder, mClips, mInitialBorderPosition, project, ProjectHistory::PushState(), and XO().

Here is the call graph for this function:

Init()

bool WaveClipTrimHandle::AdjustBorder::Init ( const TrackPanelMouseEvent &  event )

inlineoverridevirtual

Implements WaveClipTrimHandle::ClipTrimPolicy.

Definition at line 174 of file WaveClipTrimHandle.cpp.

   {
      if (event.event.LeftDown())
      {
         mDragStartX = event.event.GetX();
         return true;
      }
      return false;
   }

References TrackPanelMouseEvent::event, and mDragStartX.

Trim()

UIHandle::Result WaveClipTrimHandle::AdjustBorder::Trim ( const TrackPanelMouseEvent &  event, AudacityProject &  project  )

inlineoverridevirtual

Implements WaveClipTrimHandle::ClipTrimPolicy.

Definition at line 184 of file WaveClipTrimHandle.cpp.

   {
      const auto eventX = event.event.GetX();
      const auto dx = eventX - mDragStartX;
 
      const auto& viewInfo = ViewInfo::Get(project);
 
      const auto eventT = viewInfo.PositionToTime(viewInfo.TimeToPosition(mInitialBorderPosition, event.rect.x) + dx, event.rect.x);
 
      const auto offset = sampleCount(floor((eventT - mInitialBorderPosition) * mClips[0]->GetRate())).as_double() / mClips[0]->GetRate();
      const auto t = std::clamp(mInitialBorderPosition + offset, mRange.first, mRange.second);
      const auto wasSnapped = mSnap.Snapped();
      if(mSnapManager)
         mSnap = mSnapManager->Snap(mTrack.get(), t, !mAdjustingLeftBorder);
      if(mSnap.Snapped())
      {
         if(mSnap.outTime >= mRange.first && mSnap.outTime <= mRange.second)
         {
            //Make sure that outTime belongs to the adjustment range after snapping
            TrimTo(mSnap.outTime);
            return RefreshCode::RefreshAll;
         }
         else
         {
            //Otherwise snapping cannot be performed
            mSnap = {};
            TrimTo(t);
         }
      }
      else
         TrimTo(t);
      //If there was a snap line, make sure it is removed
      //from the screen by redrawing whole TrackPanel
      return wasSnapped ? RefreshCode::RefreshAll : RefreshCode::RefreshCell;
   }

References sampleCount::as_double(), ViewInfo::Get(), anonymous_namespace{TimeTrack.cpp}::GetRate(), mAdjustingLeftBorder, mClips, mDragStartX, mInitialBorderPosition, mRange, mSnap, mSnapManager, mTrack, SnapResults::outTime, project, TrackPanelMouseEvent::rect, RefreshCode::RefreshAll, RefreshCode::RefreshCell, SnapResults::Snapped(), and TrimTo().

Here is the call graph for this function:

TrimTo()

void WaveClipTrimHandle::AdjustBorder::TrimTo ( double  t )

inlineprivate

Definition at line 60 of file WaveClipTrimHandle.cpp.

   {
      t = std::clamp(t, mRange.first, mRange.second);
      if (mAdjustingLeftBorder)
      {
         for (auto& clip : mClips)
            clip->TrimLeftTo(t);
      }
      else
      {
         for (auto& clip : mClips)
            clip->TrimRightTo(t);
      }
   }

References mAdjustingLeftBorder, mClips, and mRange.

Referenced by Cancel(), and Trim().

Here is the caller graph for this function:

Member Data Documentation

mAdjustingLeftBorder

bool WaveClipTrimHandle::AdjustBorder::mAdjustingLeftBorder

private

Definition at line 55 of file WaveClipTrimHandle.cpp.

Referenced by AdjustBorder(), Finish(), Trim(), and TrimTo().

mClips

std::vector<std::shared_ptr<WaveClip> > WaveClipTrimHandle::AdjustBorder::mClips

private

Definition at line 51 of file WaveClipTrimHandle.cpp.

Referenced by AdjustBorder(), Finish(), Trim(), and TrimTo().

mDragStartX

int WaveClipTrimHandle::AdjustBorder::mDragStartX { }

private

Definition at line 53 of file WaveClipTrimHandle.cpp.

Referenced by Init(), and Trim().

mInitialBorderPosition

double WaveClipTrimHandle::AdjustBorder::mInitialBorderPosition {}

private

Definition at line 52 of file WaveClipTrimHandle.cpp.

Referenced by AdjustBorder(), Cancel(), Finish(), and Trim().

mRange

std::pair<double, double> WaveClipTrimHandle::AdjustBorder::mRange

private

Definition at line 54 of file WaveClipTrimHandle.cpp.

Referenced by AdjustBorder(), Trim(), and TrimTo().

mSnap

SnapResults WaveClipTrimHandle::AdjustBorder::mSnap

private

Definition at line 58 of file WaveClipTrimHandle.cpp.

Referenced by Draw(), and Trim().

mSnapManager

std::unique_ptr<SnapManager> WaveClipTrimHandle::AdjustBorder::mSnapManager

private

Definition at line 57 of file WaveClipTrimHandle.cpp.

Referenced by AdjustBorder(), and Trim().

mTrack

std::shared_ptr<WaveTrack> WaveClipTrimHandle::AdjustBorder::mTrack

private

Definition at line 50 of file WaveClipTrimHandle.cpp.

Referenced by Trim().

---

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

• WaveClipTrimHandle.cpp