CutlineHandle Class Reference

#include <CutlineHandle.h>

Inheritance diagram for CutlineHandle:

Collaboration diagram for CutlineHandle:

Public Member Functions
	CutlineHandle (const std::shared_ptr< WaveTrack > &pTrack, WaveTrackLocation location)
CutlineHandle &	operator= (const CutlineHandle &)=default
virtual	~CutlineHandle ()
const WaveTrackLocation &	GetLocation ()
std::shared_ptr< WaveTrack >	GetTrack ()
void	Enter (bool forward, AudacityProject *) override
bool	HandlesRightClick () override
	Whether the handle has any special right-button handling. More...
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
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)
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 (const AudacityProject *pProject, bool cutline, UIHandlePtr ptr)
static UIHandlePtr	HitTest (std::weak_ptr< CutlineHandle > &holder, const wxMouseState &state, const wxRect &rect, const AudacityProject *pProject, const std::shared_ptr< WaveTrack > &pTrack)
Static Public Member Functions inherited from UIHandle
static UIHandle::Result	NeedChangeHighlight (const UIHandle &, const UIHandle &)
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)

Private Types
enum	Operation { Merge , Expand , Remove }

Private Member Functions
	CutlineHandle (const CutlineHandle &)=delete

Static Private Member Functions
static HitTestPreview	HitPreview (bool cutline, bool unsafe)

Private Attributes
std::shared_ptr< WaveTrack >	mpTrack {}
Operation	mOperation { Merge }
double	mStartTime {}
double	mEndTime {}
WaveTrackLocation	mLocation {}

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 21 of file CutlineHandle.h.

Member Enumeration Documentation

Operation

enum CutlineHandle::Operation

private

Enumerator
Merge
Expand
Remove

Definition at line 70 of file CutlineHandle.h.

{ Merge, Expand, Remove };

Constructor & Destructor Documentation

CutlineHandle() [1/2]

CutlineHandle::CutlineHandle ( const CutlineHandle &  )

privatedelete

CutlineHandle() [2/2]

CutlineHandle::CutlineHandle ( const std::shared_ptr< WaveTrack > &  pTrack, WaveTrackLocation  location  )

explicit

Definition at line 25 of file CutlineHandle.cpp.

   : mpTrack{ pTrack }
   , mLocation{ location }
{
}

~CutlineHandle()

CutlineHandle::~CutlineHandle ( )

virtual

Definition at line 115 of file CutlineHandle.cpp.

{
}

Member Function Documentation

Cancel()

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

overridevirtual

Implements UIHandle.

Definition at line 246 of file CutlineHandle.cpp.

{
   using namespace RefreshCode;
   UIHandle::Result result = RefreshCell;
   ProjectHistory::Get( *pProject ).RollbackState();
   if (mOperation == Expand) {
      AudacityProject &project = *pProject;
      auto &selectedRegion = ViewInfo::Get( project ).selectedRegion;
      selectedRegion.setTimes( mStartTime, mEndTime );
   }
   return result;
}

References Expand, ProjectHistory::Get(), ViewInfo::Get(), mEndTime, mOperation, mStartTime, RefreshCode::RefreshCell, ProjectHistory::RollbackState(), ViewInfo::selectedRegion, and NotifyingSelectedRegion::setTimes().

Here is the call graph for this function:

Click()

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

overridevirtual

Someone has just clicked the mouse. What do we do?

Implements UIHandle.

Definition at line 124 of file CutlineHandle.cpp.

{
   using namespace RefreshCode;
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   if ( unsafe )
      return Cancelled;
 
   const wxMouseEvent &event = evt.event;
   auto &viewInfo = ViewInfo::Get( *pProject );
 
   // Can affect the track by merging clips, expanding a cutline, or
   // deleting a cutline.
   // All the change is done at button-down.  Button-up just commits the undo item.
 
 
   // FIXME: Disable this and return true when CutLines aren't showing?
   // (Don't use gPrefs-> for the fix as registry access is slow).
 
   // Cutline data changed on either branch, so refresh the track display.
   UIHandle::Result result = RefreshCell;
 
   if (event.LeftDown())
   {
      if (mLocation.typ == WaveTrackLocation::locationCutLine)
      {
         mOperation = Expand;
         mStartTime = viewInfo.selectedRegion.t0();
         mEndTime = viewInfo.selectedRegion.t1();
 
         // When user presses left button on cut line, expand the line again
         double cutlineStart = 0, cutlineEnd = 0;
         double *pCutlineStart = &cutlineStart, *pCutlineEnd = &cutlineEnd;
 
         for (auto channel :
              TrackList::Channels(mpTrack.get())) {
            channel->ExpandCutLine(
               mLocation.pos, pCutlineStart, pCutlineEnd);
            if ( channel == mpTrack.get() )
               pCutlineStart = pCutlineEnd = nullptr;
         }
 
         viewInfo.selectedRegion.setTimes(cutlineStart, cutlineEnd);
      }
      else if (mLocation.typ == WaveTrackLocation::locationMergePoint) {
         const double pos = mLocation.pos;
         for (auto channel :
              TrackList::Channels(mpTrack.get())) {
            // Don't assume correspondence of merge points across channels!
            int idx = FindMergeLine(channel, pos);
            if (idx >= 0) {
               auto location =
                  WaveTrackLocations::Get(*channel).Get()[idx];
               channel->MergeClips(
                  location.clipidx1, location.clipidx2);
            }
         }
 
         mOperation = Merge;
      }
   }
   else if (event.RightDown())
   {
      bool removed = false;
      for (auto channel :
           TrackList::Channels(mpTrack.get()))
         removed = channel->RemoveCutLine(mLocation.pos) || removed;
 
      if (!removed)
         // Nothing happened, make no Undo item
         return Cancelled;
 
      mOperation = Remove;
   }
   else
      result = RefreshNone;
 
   return result;
}

References RefreshCode::Cancelled, TrackList::Channels(), TrackPanelMouseEvent::event, Expand, anonymous_namespace{CutlineHandle.cpp}::FindMergeLine(), WaveTrackLocations::Get(), ProjectAudioIO::Get(), ViewInfo::Get(), ProjectAudioIO::IsAudioActive(), WaveTrackLocation::locationCutLine, WaveTrackLocation::locationMergePoint, mEndTime, Merge, mLocation, mOperation, mpTrack, mStartTime, WaveTrackLocation::pos, RefreshCode::RefreshCell, RefreshCode::RefreshNone, Remove, and WaveTrackLocation::typ.

Here is the call graph for this function:

Drag()

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

overridevirtual

Implements UIHandle.

Definition at line 205 of file CutlineHandle.cpp.

{
   return RefreshCode::RefreshNone;
}

References RefreshCode::RefreshNone.

Enter()

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

overridevirtual

Reimplemented from UIHandle.

Definition at line 32 of file CutlineHandle.cpp.

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

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

GetLocation()

const WaveTrackLocation & CutlineHandle::GetLocation ( )

inline

Definition at line 43 of file CutlineHandle.h.

{ return mLocation; }

References mLocation.

GetTrack()

std::shared_ptr< WaveTrack > CutlineHandle::GetTrack ( )

inline

Definition at line 44 of file CutlineHandle.h.

{ return mpTrack; }

References mpTrack.

Referenced by WaveTrackSubView::DrawBoldBoundaries().

Here is the caller graph for this function:

HandlesRightClick()

bool CutlineHandle::HandlesRightClick ( )

overridevirtual

Whether the handle has any special right-button handling.

If not, then Click() will not be called for right click. Default is always false

Reimplemented from UIHandle.

Definition at line 119 of file CutlineHandle.cpp.

{
   return true;
}

HitAnywhere()

static UIHandlePtr CutlineHandle::HitAnywhere ( const AudacityProject *  pProject, bool  cutline, UIHandlePtr  ptr  )

static

HitPreview()

HitTestPreview CutlineHandle::HitPreview ( bool  cutline, bool  unsafe  )

staticprivate

Definition at line 39 of file CutlineHandle.cpp.

{
   static auto disabledCursor =
      ::MakeCursor(wxCURSOR_NO_ENTRY, DisabledCursorXpm, 16, 16);
   static wxCursor arrowCursor{ wxCURSOR_ARROW };
   return {
      (cutline
       ? XO("Left-Click to expand, Right-Click to remove")
       : XO("Left-Click to merge clips")),
      (unsafe
       ? &*disabledCursor
       : &arrowCursor)
   };
}

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 CutlineHandle::HitTest ( std::weak_ptr< CutlineHandle > &  holder, const wxMouseState &  state, const wxRect &  rect, const AudacityProject *  pProject, const std::shared_ptr< WaveTrack > &  pTrack  )

static

method that tells us if the mouse event landed on an editable Cutline

Definition at line 96 of file CutlineHandle.cpp.

{
   auto &viewInfo = ViewInfo::Get( *pProject );
 
   WaveTrackLocation location;
   if (!IsOverCutline(viewInfo, pTrack.get(), rect, state, &location))
      return {};
 
   auto result = std::make_shared<CutlineHandle>( pTrack, location );
   result = AssignUIHandlePtr( holder, result );
   return result;
}

References AssignUIHandlePtr(), ViewInfo::Get(), and anonymous_namespace{CutlineHandle.cpp}::IsOverCutline().

Referenced by WaveTrackSubView::DoDetailedHitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

CutlineHandle & CutlineHandle::operator= ( const CutlineHandle &  )

default

Preview()

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

overridevirtual

Implements UIHandle.

Definition at line 211 of file CutlineHandle.cpp.

{
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   auto bCutline = (mLocation.typ == WaveTrackLocation::locationCutLine);
   return HitPreview( bCutline, unsafe );
}

References ProjectAudioIO::Get(), HitPreview(), ProjectAudioIO::IsAudioActive(), WaveTrackLocation::locationCutLine, mLocation, and WaveTrackLocation::typ.

Here is the call graph for this function:

Release()

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

overridevirtual

Implements UIHandle.

Definition at line 219 of file CutlineHandle.cpp.

{
   UIHandle::Result result = RefreshCode::RefreshNone;
 
   // Only now commit the result to the undo stack
   switch (mOperation) {
   default:
      wxASSERT(false);
   case Merge:
      ProjectHistory::Get( *pProject )
         .PushState(XO("Merged Clips"), XO("Merge"), UndoPush::CONSOLIDATE);
      break;
   case Expand:
      ProjectHistory::Get( *pProject )
         .PushState(XO("Expanded Cut Line"), XO("Expand"));
      break;
   case Remove:
      ProjectHistory::Get( *pProject )
         .PushState(XO("Removed Cut Line"), XO("Remove"));
      break;
   }
 
   // Nothing to do for the display
   return result;
}

References CONSOLIDATE, Expand, ProjectHistory::Get(), Merge, mOperation, ProjectHistory::PushState(), RefreshCode::RefreshNone, Remove, and XO().

Here is the call graph for this function:

StopsOnKeystroke()

bool CutlineHandle::StopsOnKeystroke ( )

inlineoverridevirtual

Reimplemented from UIHandle.

Definition at line 66 of file CutlineHandle.h.

{ return true; }

Member Data Documentation

mEndTime

double CutlineHandle::mEndTime {}

private

Definition at line 72 of file CutlineHandle.h.

Referenced by Cancel(), and Click().

mLocation

WaveTrackLocation CutlineHandle::mLocation {}

private

Definition at line 73 of file CutlineHandle.h.

Referenced by Click(), GetLocation(), and Preview().

mOperation

Operation CutlineHandle::mOperation { Merge }

private

Definition at line 71 of file CutlineHandle.h.

Referenced by Cancel(), Click(), and Release().

mpTrack

std::shared_ptr<WaveTrack> CutlineHandle::mpTrack {}

private

Definition at line 69 of file CutlineHandle.h.

Referenced by Click(), and GetTrack().

mStartTime

double CutlineHandle::mStartTime {}

private

Definition at line 72 of file CutlineHandle.h.

Referenced by Cancel(), and Click().

---

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

• CutlineHandle.h
• CutlineHandle.cpp