AdjustClipBorder Class Reference

Inheritance diagram for AdjustClipBorder:

Collaboration diagram for AdjustClipBorder:

Public Types
using	AdjustHandler = std::function< void(WaveTrack::Interval &, double)>

Public Member Functions
	AdjustClipBorder (AdjustHandler adjustHandler, std::shared_ptr< WaveTrack > track, std::shared_ptr< WaveTrack::Interval > interval, bool adjustLeftBorder, bool isStretchMode, const ZoomInfo &zoomInfo)
bool	Init (const TrackPanelMouseEvent &event) override
UIHandle::Result	Drag (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 WaveClipAdjustBorderHandle::AdjustPolicy
virtual	~AdjustPolicy ()
virtual bool	Init (const TrackPanelMouseEvent &event)=0
virtual UIHandle::Result	Drag (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, const std::pair< double, double > range)

Private Attributes
std::shared_ptr< WaveTrack >	mTrack
std::shared_ptr< WaveTrack::Interval >	mInterval
int	mDragStartX { }
const bool	mAdjustingLeftBorder
const bool	mIsStretchMode
const double	mInitialBorderPosition
double	mBorderPosition
const std::pair< double, double >	mRange
AdjustHandler	mAdjustHandler
std::unique_ptr< SnapManager >	mSnapManager
SnapResults	mSnap

Detailed Description

Definition at line 125 of file WaveClipAdjustBorderHandle.cpp.

Member Typedef Documentation

AdjustHandler

using AdjustClipBorder::AdjustHandler = std::function<void(WaveTrack::Interval&, double)>

Definition at line 128 of file WaveClipAdjustBorderHandle.cpp.

Constructor & Destructor Documentation

AdjustClipBorder()

AdjustClipBorder::AdjustClipBorder ( AdjustHandler  adjustHandler, std::shared_ptr< WaveTrack >  track, std::shared_ptr< WaveTrack::Interval >  interval, bool  adjustLeftBorder, bool  isStretchMode, const ZoomInfo &  zoomInfo  )

inline

Definition at line 190 of file WaveClipAdjustBorderHandle.cpp.

      : mTrack { std::move(track) }
      , mInterval { std::move(interval) }
      , mAdjustingLeftBorder { adjustLeftBorder }
      , mIsStretchMode { isStretchMode }
      , mInitialBorderPosition { adjustLeftBorder ? mInterval->Start() :
                                             mInterval->End() }
      , mBorderPosition { mInitialBorderPosition }
      , mRange { GetLeftAdjustLimit( *mInterval, *mTrack, adjustLeftBorder, isStretchMode),
                 GetRightAdjustLimit(*mInterval, *mTrack, adjustLeftBorder, isStretchMode) }
      , mAdjustHandler { std::move(adjustHandler) }
   {
      assert(mRange.first <= mRange.second);
      if(const auto trackList = mTrack->GetOwner())
      {
         mSnapManager = std::make_unique<SnapManager>(
            *trackList->GetOwner(),
            FindSnapPoints(mTrack.get(), mRange),
            zoomInfo);
      }
   }

References FindSnapPoints(), mRange, mSnapManager, and mTrack.

Here is the call graph for this function:

Member Function Documentation

Cancel()

void AdjustClipBorder::Cancel ( )

inlineoverridevirtual

Implements WaveClipAdjustBorderHandle::AdjustPolicy.

Definition at line 288 of file WaveClipAdjustBorderHandle.cpp.

   {
      TrimTo(mInitialBorderPosition);
   }

References mInitialBorderPosition, and TrimTo().

Here is the call graph for this function:

Drag()

UIHandle::Result AdjustClipBorder::Drag ( const TrackPanelMouseEvent &  event, AudacityProject &  project  )

inlineoverridevirtual

Implements WaveClipAdjustBorderHandle::AdjustPolicy.

Definition at line 227 of file WaveClipAdjustBorderHandle.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) * mTrack->GetRate())).as_double()
         / mTrack->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;
         }
         mSnap = {};
      }
      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(), mAdjustingLeftBorder, 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:

Draw()

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

inlineoverridevirtual

Reimplemented from WaveClipAdjustBorderHandle::AdjustPolicy.

Definition at line 293 of file WaveClipAdjustBorderHandle.cpp.

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

References TrackPanelDrawingContext::dc, TrackArt::DrawSnapLines(), mSnap, SnapResults::outCoord, TrackArtist::PassSnapping, and SnapResults::Snapped().

Here is the call graph for this function:

DrawingArea()

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

inlineoverridevirtual

Reimplemented from WaveClipAdjustBorderHandle::AdjustPolicy.

Definition at line 302 of file WaveClipAdjustBorderHandle.cpp.

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

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

Here is the call graph for this function:

FindSnapPoints()

static SnapPointArray AdjustClipBorder::FindSnapPoints ( const WaveTrack *  currentTrack, const std::pair< double, double >  range  )

inlinestaticprivate

Definition at line 152 of file WaveClipAdjustBorderHandle.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))
         {
            if(track == currentTrack)
            {
               //skip track that interval belongs to
               continue;
            }
 
            for (const auto &interval : track->Intervals()) {
               addSnapPoint(interval->Start(), track);
               if(interval->Start() != interval->End())
                  addSnapPoint(interval->End(), track);
            }
         }
      }
      return result;
   }

References Track::GetOwner().

Referenced by AdjustClipBorder().

Here is the call graph for this function:

Here is the caller graph for this function:

Finish()

void AdjustClipBorder::Finish ( AudacityProject &  project )

inlineoverridevirtual

Implements WaveClipAdjustBorderHandle::AdjustPolicy.

Definition at line 261 of file WaveClipAdjustBorderHandle.cpp.

   {
      const auto dt = std::abs(mInitialBorderPosition - mBorderPosition);
      if (dt != 0)
      {
         if (mIsStretchMode)
         {
            WaveClipUIUtilities::PushClipSpeedChangedUndoState(
               project, 100.0 / mInterval->GetStretchRatio());
         }
         else if (mAdjustingLeftBorder)
         {
            /*i18n-hint: This is about trimming a clip, a length in seconds like "2.4 seconds" is shown*/
            ProjectHistory::Get(project).PushState(XO("Adjust left trim by %.02f seconds").Format(dt),
               /*i18n-hint: This is about trimming a clip, a length in seconds like "2.4s" is shown*/
                XO("Trim by %.02fs").Format(dt));
         }
         else
         {
            /*i18n-hint: This is about trimming a clip, a length in seconds like "2.4 seconds" is shown*/
            ProjectHistory::Get(project).PushState(XO("Adjust right trim by %.02f seconds").Format(dt),
            /*i18n-hint: This is about trimming a clip, a length in seconds like "2.4s" is shown*/
                XO("Trim by %.02fs").Format(dt));
         }
      }
   }

References ProjectHistory::Get(), mAdjustingLeftBorder, mBorderPosition, mInitialBorderPosition, mInterval, mIsStretchMode, project, WaveClipUIUtilities::PushClipSpeedChangedUndoState(), ProjectHistory::PushState(), and XO().

Here is the call graph for this function:

Init()

bool AdjustClipBorder::Init ( const TrackPanelMouseEvent &  event )

inlineoverridevirtual

Implements WaveClipAdjustBorderHandle::AdjustPolicy.

Definition at line 217 of file WaveClipAdjustBorderHandle.cpp.

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

References TrackPanelMouseEvent::event, and mDragStartX.

TrimTo()

void AdjustClipBorder::TrimTo ( double  t )

inlineprivate

Definition at line 144 of file WaveClipAdjustBorderHandle.cpp.

   {
      mBorderPosition = std::clamp(t, mRange.first, mRange.second);
      mAdjustHandler(*mInterval, mBorderPosition);
   }

References mAdjustHandler, mBorderPosition, mInterval, and mRange.

Referenced by Cancel(), and Drag().

Here is the caller graph for this function:

Member Data Documentation

mAdjustHandler

AdjustHandler AdjustClipBorder::mAdjustHandler

private

Definition at line 139 of file WaveClipAdjustBorderHandle.cpp.

Referenced by TrimTo().

mAdjustingLeftBorder

const bool AdjustClipBorder::mAdjustingLeftBorder

private

Definition at line 134 of file WaveClipAdjustBorderHandle.cpp.

Referenced by Drag(), and Finish().

mBorderPosition

double AdjustClipBorder::mBorderPosition

private

Definition at line 137 of file WaveClipAdjustBorderHandle.cpp.

Referenced by Finish(), and TrimTo().

mDragStartX

int AdjustClipBorder::mDragStartX { }

private

Definition at line 133 of file WaveClipAdjustBorderHandle.cpp.

Referenced by Drag(), and Init().

mInitialBorderPosition

const double AdjustClipBorder::mInitialBorderPosition

private

Definition at line 136 of file WaveClipAdjustBorderHandle.cpp.

Referenced by Cancel(), Drag(), and Finish().

mInterval

std::shared_ptr<WaveTrack::Interval> AdjustClipBorder::mInterval

private

Definition at line 132 of file WaveClipAdjustBorderHandle.cpp.

Referenced by Finish(), and TrimTo().

mIsStretchMode

const bool AdjustClipBorder::mIsStretchMode

private

Definition at line 135 of file WaveClipAdjustBorderHandle.cpp.

Referenced by Finish().

mRange

const std::pair<double, double> AdjustClipBorder::mRange

private

Definition at line 138 of file WaveClipAdjustBorderHandle.cpp.

Referenced by AdjustClipBorder(), Drag(), and TrimTo().

mSnap

SnapResults AdjustClipBorder::mSnap

private

Definition at line 142 of file WaveClipAdjustBorderHandle.cpp.

Referenced by Drag(), and Draw().

mSnapManager

std::unique_ptr<SnapManager> AdjustClipBorder::mSnapManager

private

Definition at line 141 of file WaveClipAdjustBorderHandle.cpp.

Referenced by AdjustClipBorder(), and Drag().

mTrack

std::shared_ptr<WaveTrack> AdjustClipBorder::mTrack

private

Definition at line 131 of file WaveClipAdjustBorderHandle.cpp.

Referenced by AdjustClipBorder(), and Drag().

---

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

• WaveClipAdjustBorderHandle.cpp