WaveClipTrimHandle Class Reference

#include <WaveClipTrimHandle.h>

Inheritance diagram for WaveClipTrimHandle:

Collaboration diagram for WaveClipTrimHandle:

Classes
class	AdjustBetweenBorders
class	AdjustBorder
class	ClipTrimPolicy

Public Member Functions
	WaveClipTrimHandle (std::unique_ptr< ClipTrimPolicy > &clipTrimPolicy)
HitTestPreview	Preview (const TrackPanelMouseState &mouseState, AudacityProject *pProject) override
Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
Result	Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent) override
Result	Cancel (AudacityProject *pProject) 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 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 (std::weak_ptr< WaveClipTrimHandle > &holder, const std::shared_ptr< WaveTrack > &waveTrack, const AudacityProject *pProject, const TrackPanelMouseState &state)
static UIHandlePtr	HitTest (std::weak_ptr< WaveClipTrimHandle > &holder, WaveChannelView &view, const AudacityProject *pProject, const TrackPanelMouseState &state)
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)

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

Private Attributes
std::unique_ptr< ClipTrimPolicy >	mClipTrimPolicy {}

Static Private Attributes
static constexpr int	BoundaryThreshold = 5

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 19 of file WaveClipTrimHandle.h.

Constructor & Destructor Documentation

WaveClipTrimHandle()

WaveClipTrimHandle::WaveClipTrimHandle

(

std::unique_ptr< ClipTrimPolicy > &

clipTrimPolicy

)

Definition at line 373 of file WaveClipTrimHandle.cpp.

   : mClipTrimPolicy{ std::move(clipTrimPolicy) }
{
 
}

Member Function Documentation

Cancel()

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

overridevirtual

Implements UIHandle.

Definition at line 508 of file WaveClipTrimHandle.cpp.

{
   mClipTrimPolicy->Cancel();
   return RefreshCode::RefreshAll;
}

References mClipTrimPolicy, and RefreshCode::RefreshAll.

Click()

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

overridevirtual

Implements UIHandle.

Definition at line 483 of file WaveClipTrimHandle.cpp.

{
   if (!ProjectAudioIO::Get(*pProject).IsAudioActive())
   {
      if (mClipTrimPolicy->Init(event))
         return RefreshCode::RefreshNone;
   }
   return RefreshCode::Cancelled;
}

References RefreshCode::Cancelled, ProjectAudioIO::Get(), ProjectAudioIO::IsAudioActive(), mClipTrimPolicy, and RefreshCode::RefreshNone.

Here is the call graph for this function:

Drag()

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

overridevirtual

Implements UIHandle.

Definition at line 494 of file WaveClipTrimHandle.cpp.

{
   return mClipTrimPolicy->Trim(event, *project);
}

References mClipTrimPolicy, and project.

Draw()

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

overridevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 514 of file WaveClipTrimHandle.cpp.

{
   mClipTrimPolicy->Draw(context, rect, iPass);
}

References mClipTrimPolicy.

DrawingArea()

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

overridevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 519 of file WaveClipTrimHandle.cpp.

{
   return mClipTrimPolicy->DrawingArea(context, rect, panelRect, iPass);
}

References mClipTrimPolicy.

HitAnywhere()

UIHandlePtr WaveClipTrimHandle::HitAnywhere ( std::weak_ptr< WaveClipTrimHandle > &  holder, const std::shared_ptr< WaveTrack > &  waveTrack, const AudacityProject *  pProject, const TrackPanelMouseState &  state  )

static

Definition at line 386 of file WaveClipTrimHandle.cpp.

{
    const auto rect = state.rect;
 
    auto px = state.state.m_x;
 
    auto& zoomInfo = ViewInfo::Get(*pProject);
 
    std::shared_ptr<WaveClip> leftClip;
    std::shared_ptr<WaveClip> rightClip;
 
    //Test left and right boundaries of each clip
    //to determine which type of trimming should be applied
    //and input for the policy
    for (auto& clip : waveTrack->GetClips())
    {
        if (!WaveChannelView::ClipDetailsVisible(*clip, zoomInfo, rect))
           continue;
 
        auto clipRect = ClipParameters::GetClipRect(*clip.get(), zoomInfo, rect);
        
        //double the hit testing area in case if clip are close to each other
        if (std::abs(px - clipRect.GetLeft()) <= BoundaryThreshold * 2)
           rightClip = clip;
        else if (std::abs(px - clipRect.GetRight()) <= BoundaryThreshold * 2)
           leftClip = clip;
    }
 
    std::unique_ptr<ClipTrimPolicy> clipTrimPolicy;
    if (leftClip && rightClip)
    {
       //between adjacent clips
       if(ClipParameters::GetClipRect(*leftClip, zoomInfo, rect).GetRight() > px)
         clipTrimPolicy = std::make_unique<AdjustBorder>(waveTrack, leftClip, false, zoomInfo);//right border
       else
         clipTrimPolicy = std::make_unique<AdjustBorder>(waveTrack, rightClip, true, zoomInfo);//left border
    }
    else
    {
       auto clip = leftClip ? leftClip : rightClip;
       if (clip)
       {
          //single clip case, determine the border,
          //hit testing area differs from one
          //used for general case
          auto clipRect = ClipParameters::GetClipRect(*clip.get(), zoomInfo, rect);
          if (std::abs(px - clipRect.GetLeft()) <= BoundaryThreshold)
             clipTrimPolicy = std::make_unique<AdjustBorder>(waveTrack, clip, true, zoomInfo);
          else if (std::abs(px - clipRect.GetRight()) <= BoundaryThreshold)
             clipTrimPolicy = std::make_unique<AdjustBorder>(waveTrack, clip, false, zoomInfo);
       }
    }
 
    if(clipTrimPolicy)
      return AssignUIHandlePtr(
         holder,
         std::make_shared<WaveClipTrimHandle>(clipTrimPolicy)
      );
    return { };
}

References AssignUIHandlePtr(), BoundaryThreshold, WaveChannelView::ClipDetailsVisible(), ViewInfo::Get(), ClipParameters::GetClipRect(), TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Referenced by WaveTrackAffordanceControls::HitTest(), and HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

HitPreview()

HitTestPreview WaveClipTrimHandle::HitPreview ( const AudacityProject *  , bool  unsafe  )

staticprivate

Definition at line 356 of file WaveClipTrimHandle.cpp.

{
    static auto disabledCursor =
        ::MakeCursor(wxCURSOR_NO_ENTRY, DisabledCursorXpm, 16, 16);
    static auto slideCursor =
        MakeCursor(wxCURSOR_SIZEWE, TimeCursorXpm, 16, 16);
    auto message = XO("Click and drag to move clip boundary 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 WaveClipTrimHandle::HitTest ( std::weak_ptr< WaveClipTrimHandle > &  holder, WaveChannelView &  view, const AudacityProject *  pProject, const TrackPanelMouseState &  state  )

static

Definition at line 451 of file WaveClipTrimHandle.cpp.

{
    auto waveTrack = std::dynamic_pointer_cast<WaveTrack>(view.FindTrack());
    //For multichannel tracks, show trim handle only for the leader track
    if (!waveTrack->IsLeader() && waveTrack->IsAlignedWithLeader())
        return {};
 
    std::vector<UIHandlePtr> results;
 
    const auto rect = state.rect;
 
    auto px = state.state.m_x;
    auto py = state.state.m_y;
 
    if (py >= rect.GetTop() && 
        py <= (rect.GetTop() + static_cast<int>(rect.GetHeight() * 0.3)))
    {
        return HitAnywhere(holder, waveTrack, pProject, state);
    }
    return {};
}

References CommonTrackPanelCell::FindTrack(), HitAnywhere(), TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Referenced by WaveChannelSubView::DoDetailedHitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

Preview()

HitTestPreview WaveClipTrimHandle::Preview ( const TrackPanelMouseState &  mouseState, AudacityProject *  pProject  )

overridevirtual

Implements UIHandle.

Definition at line 477 of file WaveClipTrimHandle.cpp.

{
    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 WaveClipTrimHandle::Release ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject, wxWindow *  pParent  )

overridevirtual

Implements UIHandle.

Definition at line 500 of file WaveClipTrimHandle.cpp.

{
   mClipTrimPolicy->Finish(*project);
   return RefreshCode::RefreshAll;
}

References mClipTrimPolicy, project, and RefreshCode::RefreshAll.

Member Data Documentation

BoundaryThreshold

constexpr int WaveClipTrimHandle::BoundaryThreshold = 5

staticconstexprprivate

Definition at line 21 of file WaveClipTrimHandle.h.

Referenced by HitAnywhere().

mClipTrimPolicy

std::unique_ptr<ClipTrimPolicy> WaveClipTrimHandle::mClipTrimPolicy {}

private

Definition at line 50 of file WaveClipTrimHandle.h.

Referenced by Cancel(), Click(), Drag(), Draw(), DrawingArea(), and Release().

---

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

• WaveClipTrimHandle.h
• WaveClipTrimHandle.cpp