#include <TimeShiftHandle.h>

Inheritance diagram for TimeShiftHandle:

Collaboration diagram for TimeShiftHandle:

Public Member Functions
	TimeShiftHandle (std::shared_ptr< Track > pTrack, bool gripHit)

TimeShiftHandle &	operator= (TimeShiftHandle &&)=default

bool	IsGripHit () const

virtual	~TimeShiftHandle ()

std::shared_ptr< const Track >	FindTrack () const override

void	Enter (bool forward, AudacityProject *) override

Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) override

Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject) override

HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject) override

Result	Release (const TrackPanelMouseEvent &event, AudacityProject pProject, wxWindow pParent) override

Result	Cancel (AudacityProject *pProject) override

bool	StopsOnKeystroke () override

bool	Clicked () const

std::shared_ptr< Track >	GetTrack () const

Public Member Functions inherited from UIHandle
virtual	~UIHandle ()=0

virtual void	Enter (bool forward, AudacityProject *pProject)

virtual bool	HasRotation () const

virtual bool	Rotate (bool forward)

virtual bool	HasEscape (AudacityProject *pProject) const

virtual bool	Escape (AudacityProject *pProject)

virtual bool	HandlesRightClick ()
	Whether the handle has any special right-button handling. More...

virtual Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0

virtual Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0

virtual HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject)=0

virtual Result	Release (const TrackPanelMouseEvent &event, AudacityProject pProject, wxWindow pParent)=0

virtual Result	Cancel (AudacityProject *pProject)=0

virtual bool	StopsOnKeystroke ()

virtual void	OnProjectChange (AudacityProject *pProject)

virtual std::shared_ptr< const Track >	FindTrack () const =0

virtual bool	IsDragging () const

Result	GetChangeHighlight () const

void	SetChangeHighlight (Result val)

Public Member Functions inherited from TrackPanelDrawable
virtual	~TrackPanelDrawable ()=0

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

virtual wxRect	DrawingArea (TrackPanelDrawingContext &context, const wxRect &rect, const wxRect &panelRect, unsigned iPass)

Static Public Member Functions
static UIHandlePtr	HitAnywhere (std::weak_ptr< TimeShiftHandle > &holder, const std::shared_ptr< Track > &pTrack, bool gripHit)

static UIHandlePtr	HitTest (std::weak_ptr< TimeShiftHandle > &holder, const wxMouseState &state, const wxRect &rect, const std::shared_ptr< Track > &pTrack)

Static Public Member Functions inherited from UIHandle
static UIHandle::Result	NeedChangeHighlight (const UIHandle &, const UIHandle &)

static std::shared_ptr< const Track >	TrackFromChannel (const std::shared_ptr< const Channel > &pChannel)
	A frequent convenience in the definition of UIHandles. More...

Static Public Member Functions inherited from TrackPanelDrawable
static wxRect	MaximizeWidth (const wxRect &rect, const wxRect &panelRect)

static wxRect	MaximizeHeight (const wxRect &rect, const wxRect &panelRect)

Protected Member Functions
bool	WasMoved () const

Private Member Functions
	TimeShiftHandle (const TimeShiftHandle &)=delete

void	DoSlideVertical (ViewInfo &viewInfo, wxCoord xx, TrackList &trackList, Track *dstTrack, double &desiredSlideAmount)

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

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

Static Private Member Functions
static HitTestPreview	HitPreview (const AudacityProject *pProject, bool unsafe)

Private Attributes
wxRect	mRect {}

bool	mDidSlideVertically {}

bool	mSlideUpDownOnly {}

bool	mSnapPreferRightEdge {}

std::shared_ptr< SnapManager >	mSnapManager {}

ClipMoveState	mClipMoveState {}

bool	mGripHit {}

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned

using	Cell = TrackPanelCell

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 292 of file TimeShiftHandle.h.

Constructor & Destructor Documentation

◆ TimeShiftHandle() [1/2]

TimeShiftHandle::TimeShiftHandle ( const TimeShiftHandle & )

privatedelete

◆ TimeShiftHandle() [2/2]

TimeShiftHandle::TimeShiftHandle	(	std::shared_ptr< Track >	pTrack,
		bool	gripHit
	)

Definition at line 32 of file TimeShiftHandle.cpp.

   : mGripHit{ gripHit }
{
   mClipMoveState.mCapturedTrack = pTrack;
}

References ClipMoveState::mCapturedTrack, and mClipMoveState.

◆ ~TimeShiftHandle()

TimeShiftHandle::~TimeShiftHandle ( )

virtual

Definition at line 114 of file TimeShiftHandle.cpp.

115{

116}

Member Function Documentation

◆ Cancel()

UIHandle::Result TimeShiftHandle::Cancel ( AudacityProject * pProject )

overridevirtual

Implements UIHandle.

Definition at line 962 of file TimeShiftHandle.cpp.

{
   if(mClipMoveState.initialized)
   {
      ProjectHistory::Get( *pProject ).RollbackState();
      return RefreshCode::RefreshAll;
   }
   return RefreshCode::RefreshNone;
}

References ProjectHistory::Get(), ClipMoveState::initialized, mClipMoveState, RefreshCode::RefreshAll, RefreshCode::RefreshNone, and ProjectHistory::RollbackState().

Referenced by Drag(), and Release().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Click()

UIHandle::Result TimeShiftHandle::Click	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

overridevirtual

Implements UIHandle.

Definition at line 457 of file TimeShiftHandle.cpp.

{
   using namespace RefreshCode;
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   if ( unsafe )
      return Cancelled;
 
   const wxMouseEvent &event = evt.event;
   const wxRect &rect = evt.rect;
   auto &viewInfo = ViewInfo::Get( *pProject );
 
   const auto pView =
      std::dynamic_pointer_cast<CommonTrackPanelCell>(evt.pCell);
   const auto pTrack = pView ? pView->FindTrack() : nullptr;
   if (!pTrack)
      return RefreshCode::Cancelled;
 
   mClipMoveState.clear();
   mDidSlideVertically = false;
 
   const bool multiToolModeActive =
      (ToolCodes::multiTool == ProjectSettings::Get( *pProject ).GetTool());
 
   const double clickTime =
      viewInfo.PositionToTime(event.m_x, rect.x);
 
   auto pShifter = MakeTrackShifter::Call(*pTrack, *pProject);
 
   auto hitTestResult = TrackShifter::HitTestResult::Track;
   if (!event.ShiftDown()) {
      TrackShifter::HitTestParams params{
         rect, event.m_x, event.m_y
      };
      hitTestResult = pShifter->HitTest( clickTime, viewInfo, &params );
      switch( hitTestResult ) {
      case TrackShifter::HitTestResult::Miss:
         return Cancelled;
      default:
         break;
      }
   }
   else {
      // just do shifting of one whole track
   }
 
   auto &trackList = TrackList::Get(*pProject);
   mClipMoveState.Init(*pProject, *pTrack,
      hitTestResult, move(pShifter), clickTime,
      viewInfo, trackList,
      SyncLockState::Get( *pProject ).IsSyncLocked() );
 
   mSlideUpDownOnly = event.CmdDown() && !multiToolModeActive;
   mRect = rect;
   mClipMoveState.mMouseClickX = event.m_x;
   mSnapManager =
   std::make_shared<SnapManager>(*trackList.GetOwner(),
       FindCandidates( trackList, mClipMoveState.shifters ),
       viewInfo);
   mClipMoveState.snapLeft = -1;
   mClipMoveState.snapRight = -1;
   auto pInterval = mClipMoveState.CapturedInterval();
   mSnapPreferRightEdge = pInterval &&
      (fabs(clickTime - pInterval->End()) <
       fabs(clickTime - pInterval->Start()));
 
   return RefreshNone;
}

References AttachedVirtualFunction< Tag, Return, This, Arguments >::Call(), Cancelled, RefreshCode::Cancelled, ClipMoveState::CapturedInterval(), ClipMoveState::clear(), TrackPanelMouseEvent::event, anonymous_namespace{TimeShiftHandle.cpp}::FindCandidates(), ProjectAudioIO::Get(), ViewInfo::Get(), SyncLockState::Get(), TrackList::Get(), ProjectSettings::Get(), ProjectSettings::GetTool(), ClipMoveState::Init(), ProjectAudioIO::IsAudioActive(), SyncLockState::IsSyncLocked(), mClipMoveState, mDidSlideVertically, TrackShifter::Miss, ClipMoveState::mMouseClickX, mRect, mSlideUpDownOnly, mSnapManager, mSnapPreferRightEdge, ToolCodes::multiTool, params, TrackPanelMouseEvent::pCell, TrackPanelMouseEvent::rect, RefreshCode::RefreshNone, ClipMoveState::shifters, ClipMoveState::snapLeft, ClipMoveState::snapRight, and TrackShifter::Track.

Referenced by AffordanceHandle::Click().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Clicked()

bool TimeShiftHandle::Clicked ( ) const

Definition at line 48 of file TimeShiftHandle.cpp.

{
   return mClipMoveState.initialized;
}

References ClipMoveState::initialized, and mClipMoveState.

Referenced by AffordanceHandle::Preview().

Here is the caller graph for this function:

◆ DoSlideVertical()

void TimeShiftHandle::DoSlideVertical	(	ViewInfo &	viewInfo,
		wxCoord	xx,
		TrackList &	trackList,
		Track *	dstTrack,
		double &	desiredSlideAmount
	)

private

Definition at line 725 of file TimeShiftHandle.cpp.

{
   Correspondence correspondence;
 
   // See if captured track corresponds to another
   auto &capturedTrack = *mClipMoveState.mCapturedTrack;
   if (!FindCorrespondence(
      correspondence, trackList, capturedTrack, *dstTrack, mClipMoveState ))
      return;
 
   // Try to extend the correpondence
   auto tryExtend = [&](bool forward) {
      auto range = trackList.Any();
      auto begin = range.begin(), end = range.end();
      auto pCaptured = trackList.Find(&capturedTrack);
      auto pDst = trackList.Find(dstTrack);
      // Scan for more correspondences
      while (true) {
         // Remember that TrackIter wraps circularly to the end iterator when
         // decrementing it
 
         // First move to a track with moving intervals and
         // without a correspondent
         do
            forward ? ++pCaptured : --pCaptured;
         while (pCaptured != end &&
            (correspondence.count(*pCaptured) ||
             mClipMoveState.shifters[*pCaptured]->MovingIntervals().empty()));
         if (pCaptured == end)
            break;
 
         // Change the choice of possible correspondent track too
         do
            forward ? ++pDst : --pDst;
         while (pDst != end && correspondence.count(*pDst));
         if (pDst == end)
            break;
 
         // Make correspondence if we can
         if (!FindCorrespondence(
            correspondence, trackList, **pCaptured, **pDst, mClipMoveState))
            break;
      }
   };
   // Try extension, backward first, then forward
   // (anticipating the case of dragging a label that is under a clip)
   tryExtend(false);
   tryExtend(true);
 
   // Having passed that test, remove clips temporarily from their
   // tracks, so moving clips don't interfere with each other
   // when we call CanInsertClip()
   TemporaryClipRemover remover{ mClipMoveState };
 
   // Now check that the move is possible
   auto slideAmount = desiredSlideAmount;
   // The test for tolerance will need review with FishEye!
   // The tolerance is supposed to be the time for twenty pixels,
   // i.e. twenty pixel tolerance at current zoom.
   double tolerance =
      viewInfo.PositionToTime(xx + 10) - viewInfo.PositionToTime(xx - 10);
   bool ok = CheckFit( mClipMoveState, correspondence, remover.detached,
      tolerance, slideAmount /*in,out*/ );
 
   if (!ok) {
      // Failure, even with using tolerance.
      remover.Reinsert( nullptr, .0 );
      return;
   }
 
   remover.Reinsert( &correspondence, slideAmount );
 
   if (mClipMoveState.movingSelection)
      viewInfo.selectedRegion.move( slideAmount );
 
   // Make the offset permanent; start from a "clean slate"
   mClipMoveState.mCapturedTrack = dstTrack->SharedPointer();
   mClipMoveState.mMouseClickX = xx;
   mDidSlideVertically = true;
   desiredSlideAmount = .0;
}

References TrackList::Any(), details::begin(), anonymous_namespace{TimeShiftHandle.cpp}::CheckFit(), details::end(), TrackList::Find(), anonymous_namespace{TimeShiftHandle.cpp}::FindCorrespondence(), forward, ClipMoveState::mCapturedTrack, mClipMoveState, mDidSlideVertically, ClipMoveState::mMouseClickX, NotifyingSelectedRegion::move(), ClipMoveState::movingSelection, ZoomInfo::PositionToTime(), ViewInfo::selectedRegion, Track::SharedPointer(), and ClipMoveState::shifters.

Referenced by Drag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Drag()

UIHandle::Result TimeShiftHandle::Drag	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

overridevirtual

Implements UIHandle.

Definition at line 809 of file TimeShiftHandle.cpp.

{
   using namespace RefreshCode;
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   if (unsafe) {
      this->Cancel(pProject);
      return RefreshAll | Cancelled;
   }
 
   const wxMouseEvent &event = evt.event;
   auto &viewInfo = ViewInfo::Get( *pProject );
 
   auto &trackList = TrackList::Get(*pProject);
   ChannelView *trackView = dynamic_cast<ChannelView*>(evt.pCell.get());
   const auto pChannel = trackView ? trackView->FindChannel() : nullptr;
   auto track = pChannel
      ? dynamic_cast<Track *>(&pChannel->GetChannelGroup())
      : nullptr;
 
   // Uncommenting this permits drag to continue to work even over the controls area
   /*
   track = static_cast<CommonTrackPanelCell*>(evt.pCell)->FindTrack().get();
   */
 
   if (!track) {
      // Allow sliding if the pointer is not over any track, but only if x is
      // within the bounds of the tracks area.
      if (event.m_x >= mRect.GetX() &&
         event.m_x < mRect.GetX() + mRect.GetWidth())
          track = mClipMoveState.mCapturedTrack.get();
   }
 
   // May need a shared_ptr to reassign mCapturedTrack below
   auto pTrack = Track::SharedPointer( track );
   if (!pTrack)
      return RefreshCode::RefreshNone;
 
   // GM: slide now implementing snap-to
   // samples functionality based on sample rate.
 
   // Start by undoing the current slide amount; everything
   // happens relative to the original horizontal position of
   // each clip...
   mClipMoveState.DoHorizontalOffset( -mClipMoveState.hSlideAmount );
 
   if ( mClipMoveState.movingSelection ) {
      // Slide the selection, too
      viewInfo.selectedRegion.move( -mClipMoveState.hSlideAmount );
   }
   mClipMoveState.hSlideAmount = 0.0;
 
   double desiredSlideAmount = 0.0;
   if(!mSlideUpDownOnly)
   {
      desiredSlideAmount =
         viewInfo.PositionToTime(event.m_x) -
         viewInfo.PositionToTime(mClipMoveState.mMouseClickX);
 
      if (!mClipMoveState.shifters.empty())
         desiredSlideAmount =
            mClipMoveState.shifters[track]->QuantizeOffset(desiredSlideAmount);
   }
 
   if(mClipMoveState.mCapturedTrack != pTrack)
   {
      // Scroll during vertical drag.
      // If the mouse is over a track that isn't the captured track,
      // decide which tracks the captured clips should go to.
      // Viewport::Get(*pProject).ShowTrack(pTrack); //vvv Gale says this has problems on Linux, per bug 393 thread. Revert for 2.0.2.
 
      //move intervals with new start/end times
      DoSlideVertical(
         viewInfo, event.m_x, trackList, pTrack.get(), desiredSlideAmount);
   }
 
   if(!mSlideUpDownOnly)
   {
      AdjustToSnap(viewInfo, mRect.x,
         mSnapManager.get(),
         mSnapPreferRightEdge,
         mClipMoveState,
         desiredSlideAmount);
   }
 
   if (desiredSlideAmount == 0.0)
      return RefreshAll;
 
   // Note that mouse dragging doesn't use TrackShifter::HintOffsetLarger()
 
   mClipMoveState.DoSlideHorizontal( desiredSlideAmount );
 
   if (mClipMoveState.movingSelection) {
      // Slide the selection, too
      viewInfo.selectedRegion.move( mClipMoveState.hSlideAmount );
   }
 
   return RefreshAll;
}

References anonymous_namespace{TimeShiftHandle.cpp}::AdjustToSnap(), Cancel(), Cancelled, ClipMoveState::DoHorizontalOffset(), ClipMoveState::DoSlideHorizontal(), DoSlideVertical(), TrackPanelMouseEvent::event, CommonChannelCell::FindChannel(), ProjectAudioIO::Get(), ViewInfo::Get(), TrackList::Get(), ClipMoveState::hSlideAmount, ProjectAudioIO::IsAudioActive(), ClipMoveState::mCapturedTrack, mClipMoveState, ClipMoveState::mMouseClickX, ClipMoveState::movingSelection, mRect, mSlideUpDownOnly, mSnapManager, mSnapPreferRightEdge, TrackPanelMouseEvent::pCell, RefreshCode::RefreshAll, RefreshCode::RefreshNone, Track::SharedPointer(), and ClipMoveState::shifters.

Referenced by AffordanceHandle::Drag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Draw()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 972 of file TimeShiftHandle.cpp.

{
   if ( iPass == TrackArtist::PassSnapping ) {
      auto &dc = context.dc;
      // Draw snap guidelines if we have any
      if ( mSnapManager ) {
         TrackArt::DrawSnapLines(
            &dc, mClipMoveState.snapLeft, mClipMoveState.snapRight);
      }
   }
}

References TrackPanelDrawingContext::dc, TrackArt::DrawSnapLines(), mClipMoveState, mSnapManager, TrackArtist::PassSnapping, ClipMoveState::snapLeft, and ClipMoveState::snapRight.

Here is the call graph for this function:

◆ DrawingArea()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 986 of file TimeShiftHandle.cpp.

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

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

Here is the call graph for this function:

◆ Enter()

void TimeShiftHandle::Enter	(	bool	forward,
		AudacityProject *
	)

overridevirtual

Reimplemented from UIHandle.

Definition at line 53 of file TimeShiftHandle.cpp.

{
#ifdef EXPERIMENTAL_TRACK_PANEL_HIGHLIGHTING
   mChangeHighlight = RefreshCode::RefreshCell;
#endif
}

References UIHandle::mChangeHighlight, and RefreshCode::RefreshCell.

Referenced by AffordanceHandle::Enter().

Here is the caller graph for this function:

◆ FindTrack()

std::shared_ptr< const Track > TimeShiftHandle::FindTrack ( ) const

overridevirtual

Returns: pointer to associated track, if any

Implements UIHandle.

Definition at line 118 of file TimeShiftHandle.cpp.

{
   return GetTrack();
}

References GetTrack().

Here is the call graph for this function:

◆ GetTrack()

std::shared_ptr< Track > TimeShiftHandle::GetTrack ( ) const

Definition at line 38 of file TimeShiftHandle.cpp.

{
   return mClipMoveState.mCapturedTrack;
}

References ClipMoveState::mCapturedTrack, and mClipMoveState.

Referenced by FindTrack(), NoteTrackAffordanceHandle::SelectAt(), and AffordanceHandle::UpdateTrackSelection().

Here is the caller graph for this function:

◆ HitAnywhere()

UIHandlePtr TimeShiftHandle::HitAnywhere	(	std::weak_ptr< TimeShiftHandle > &	holder,
		const std::shared_ptr< Track > &	pTrack,
		bool	gripHit
	)

static

Definition at line 80 of file TimeShiftHandle.cpp.

{
   auto result = std::make_shared<TimeShiftHandle>( pTrack, gripHit );
   result = AssignUIHandlePtr(holder, result);
   return result;
}

References AssignUIHandlePtr().

Referenced by WaveChannelView::DoDetailedHitTest(), CommonChannelView::HitTest(), and HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HitPreview()

HitTestPreview TimeShiftHandle::HitPreview	(	const AudacityProject *	pProject,
		bool	unsafe
	)

staticprivate

Definition at line 60 of file TimeShiftHandle.cpp.

{
   static auto disabledCursor =
      ::MakeCursor(wxCURSOR_NO_ENTRY, DisabledCursorXpm, 16, 16);
   static auto slideCursor =
      MakeCursor(wxCURSOR_SIZEWE, TimeCursorXpm, 16, 16);
   // TODO: Should it say "track or clip" ?  Non-wave tracks can move, or clips in a wave track.
   // TODO: mention effects of shift (move all clips of selected wave track) and ctrl (move vertically only) ?
   //  -- but not all of that is available in multi tool.
   auto message = XO("Click and drag to move a track in time");
 
   return {
      message,
      (unsafe
       ? &*disabledCursor
       : &*slideCursor)
   };
}

References MakeCursor(), and XO().

Referenced by Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HitTest()

UIHandlePtr TimeShiftHandle::HitTest	(	std::weak_ptr< TimeShiftHandle > &	holder,
		const wxMouseState &	state,
		const wxRect &	rect,
		const std::shared_ptr< Track > &	pTrack
	)

static

method that tells us if the mouse event landed on a time-slider that allows us to time shift the sequence. (Those are the two "grips" drawn at left and right edges for multi tool mode.)

Definition at line 89 of file TimeShiftHandle.cpp.

{
 
   // Perhaps we should delegate this to TrackArtist as only TrackArtist
   // knows what the real sizes are??
 
   // The drag Handle width includes border, width and a little extra margin.
   const int adjustedDragHandleWidth = 14;
   // The hotspot for the cursor isn't at its centre.  Adjust for this.
   const int hotspotOffset = 5;
 
   // We are doing an approximate test here - is the mouse in the right or left border?
   if (!(state.m_x + hotspotOffset < rect.x + adjustedDragHandleWidth ||
       state.m_x + hotspotOffset >= rect.x + rect.width - adjustedDragHandleWidth))
      return {};
 
   return HitAnywhere( holder, pTrack, true );
}

References HitAnywhere().

Referenced by WaveformView::DetailedHitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsGripHit()

bool TimeShiftHandle::IsGripHit ( ) const

inline

Definition at line 303 of file TimeShiftHandle.h.

303{ return mGripHit; }

Referenced by WaveformView::DoDraw().

Here is the caller graph for this function:

◆ operator=()

TimeShiftHandle & TimeShiftHandle::operator= ( TimeShiftHandle && )

default

◆ Preview()

HitTestPreview TimeShiftHandle::Preview	(	const TrackPanelMouseState &	state,
		AudacityProject *	pProject
	)

overridevirtual

Implements UIHandle.

Definition at line 909 of file TimeShiftHandle.cpp.

{
   // After all that, it still may be unsafe to drag.
   // Even if so, make an informative cursor change from default to "banned."
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   return HitPreview(pProject, unsafe);
}

References ProjectAudioIO::Get(), HitPreview(), and ProjectAudioIO::IsAudioActive().

Here is the call graph for this function:

◆ Release()

UIHandle::Result TimeShiftHandle::Release	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject,
		wxWindow *	pParent
	)

overridevirtual

Implements UIHandle.

Definition at line 918 of file TimeShiftHandle.cpp.

{
   using namespace RefreshCode;
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   if (unsafe)
      return this->Cancel(pProject);
 
   Result result = RefreshNone;
 
   // Do not draw yellow lines
   if ( mClipMoveState.snapLeft != -1 || mClipMoveState.snapRight != -1) {
      mClipMoveState.snapLeft = mClipMoveState.snapRight = -1;
      result |= RefreshAll;
   }
 
   if ( !mDidSlideVertically && mClipMoveState.hSlideAmount == 0 )
      return result;
 
   for ( auto &pair : mClipMoveState.shifters )
      if (!pair.second->FinishMigration())
         MigrationFailure();
 
   TranslatableString msg;
   bool consolidate;
   if (mDidSlideVertically) {
      msg = XO("Moved clips to another track");
      consolidate = false;
   }
   else {
      msg = ( mClipMoveState.hSlideAmount > 0
         ? XO("Time shifted tracks/clips right %.02f seconds")
         : XO("Time shifted tracks/clips left %.02f seconds")
      )
         .Format( fabs( mClipMoveState.hSlideAmount ) );
      consolidate = true;
   }
   ProjectHistory::Get( *pProject ).PushState(msg, XO("Move Clip"),
      consolidate ? (UndoPush::CONSOLIDATE) : (UndoPush::NONE));
 
   return result | FixScrollbars;
}

References Cancel(), CONSOLIDATE, RefreshCode::FixScrollbars, ProjectAudioIO::Get(), ProjectHistory::Get(), ClipMoveState::hSlideAmount, ProjectAudioIO::IsAudioActive(), mClipMoveState, mDidSlideVertically, anonymous_namespace{TimeShiftHandle.cpp}::MigrationFailure(), NONE, ProjectHistory::PushState(), RefreshCode::RefreshAll, RefreshCode::RefreshNone, ClipMoveState::shifters, ClipMoveState::snapLeft, ClipMoveState::snapRight, and XO().

Referenced by AffordanceHandle::Release().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StopsOnKeystroke()

bool TimeShiftHandle::StopsOnKeystroke ( )

inlineoverridevirtual

Reimplemented from UIHandle.

Definition at line 335 of file TimeShiftHandle.h.

335{ return true; }

◆ WasMoved()

bool TimeShiftHandle::WasMoved ( ) const

protected

Definition at line 43 of file TimeShiftHandle.cpp.

{
    return mDidSlideVertically || (mClipMoveState.initialized && mClipMoveState.wasMoved);
}

References ClipMoveState::initialized, mClipMoveState, mDidSlideVertically, and ClipMoveState::wasMoved.

Referenced by AffordanceHandle::Release().

Here is the caller graph for this function:

Member Data Documentation

◆ mClipMoveState

ClipMoveState TimeShiftHandle::mClipMoveState {}

private

Definition at line 375 of file TimeShiftHandle.h.

Referenced by Cancel(), Click(), Clicked(), DoSlideVertical(), Drag(), Draw(), GetTrack(), Release(), TimeShiftHandle(), and WasMoved().

◆ mDidSlideVertically

bool TimeShiftHandle::mDidSlideVertically {}

private

Definition at line 364 of file TimeShiftHandle.h.

Referenced by Click(), DoSlideVertical(), Release(), and WasMoved().

◆ mGripHit

bool TimeShiftHandle::mGripHit {}

private

Definition at line 376 of file TimeShiftHandle.h.

◆ mRect

wxRect TimeShiftHandle::mRect {}

private

Definition at line 362 of file TimeShiftHandle.h.

Referenced by Click(), and Drag().

◆ mSlideUpDownOnly

bool TimeShiftHandle::mSlideUpDownOnly {}

private

Definition at line 365 of file TimeShiftHandle.h.

Referenced by Click(), and Drag().

◆ mSnapManager

std::shared_ptr<SnapManager> TimeShiftHandle::mSnapManager {}

private

Definition at line 373 of file TimeShiftHandle.h.

Referenced by Click(), Drag(), and Draw().

◆ mSnapPreferRightEdge

bool TimeShiftHandle::mSnapPreferRightEdge {}

private

Definition at line 367 of file TimeShiftHandle.h.

Referenced by Click(), and Drag().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TimeShiftHandle() [1/2]

◆ TimeShiftHandle() [2/2]

◆ ~TimeShiftHandle()

Member Function Documentation

◆ Cancel()

◆ Click()

◆ Clicked()

◆ DoSlideVertical()

◆ Drag()

◆ Draw()

◆ DrawingArea()

◆ Enter()

◆ FindTrack()

◆ GetTrack()

◆ HitAnywhere()

◆ HitPreview()

◆ HitTest()

◆ IsGripHit()

◆ operator=()

◆ Preview()

◆ Release()

◆ StopsOnKeystroke()

◆ WasMoved()

Member Data Documentation

◆ mClipMoveState

◆ mDidSlideVertically

◆ mGripHit

◆ mRect

◆ mSlideUpDownOnly

◆ mSnapManager

◆ mSnapPreferRightEdge