#include <WaveClipAdjustBorderHandle.h>

Inheritance diagram for WaveClipAdjustBorderHandle:

Collaboration diagram for WaveClipAdjustBorderHandle:

Classes
class	AdjustPolicy

Public Member Functions
	WaveClipAdjustBorderHandle (std::unique_ptr< AdjustPolicy > &adjustPolicy, std::shared_ptr< const WaveTrack > pTrack, bool stretchMode, bool leftBorder)

	~WaveClipAdjustBorderHandle () override

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

	WaveClipAdjustBorderHandle (WaveClipAdjustBorderHandle &&) noexcept

WaveClipAdjustBorderHandle &	operator= (WaveClipAdjustBorderHandle &&) noexcept

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)

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< WaveClipAdjustBorderHandle > &holder, const std::shared_ptr< WaveTrack > &waveTrack, const AudacityProject *pProject, const TrackPanelMouseState &state)

static UIHandlePtr	HitTest (std::weak_ptr< WaveClipAdjustBorderHandle > &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 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)

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

static HitTestPreview	HitPreviewStretch (const AudacityProject *, bool unsafe, bool isLeftBorder)

Private Attributes
std::unique_ptr< AdjustPolicy >	mAdjustPolicy {}

std::shared_ptr< const WaveTrack >	mpTrack

bool	mIsStretchMode

bool	mIsLeftBorder

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 WaveClipAdjustBorderHandle.h.

Constructor & Destructor Documentation

◆ WaveClipAdjustBorderHandle() [1/2]

WaveClipAdjustBorderHandle::WaveClipAdjustBorderHandle	(	std::unique_ptr< AdjustPolicy > &	adjustPolicy,
		std::shared_ptr< const WaveTrack >	pTrack,
		bool	stretchMode,
		bool	leftBorder
	)

Definition at line 346 of file WaveClipAdjustBorderHandle.cpp.

   : mAdjustPolicy{ std::move(adjustPolicy) }
   , mpTrack{ move(pTrack) }
   , mIsStretchMode{stretchMode}
   , mIsLeftBorder{leftBorder}
{
 
}

◆ ~WaveClipAdjustBorderHandle()

WaveClipAdjustBorderHandle::~WaveClipAdjustBorderHandle ( )

overridedefault

◆ WaveClipAdjustBorderHandle() [2/2]

WaveClipAdjustBorderHandle::WaveClipAdjustBorderHandle ( WaveClipAdjustBorderHandle && )

defaultnoexcept

Member Function Documentation

◆ Cancel()

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

overridevirtual

Implements UIHandle.

Definition at line 523 of file WaveClipAdjustBorderHandle.cpp.

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

References mAdjustPolicy, and RefreshCode::RefreshAll.

◆ Click()

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

overridevirtual

Implements UIHandle.

Definition at line 498 of file WaveClipAdjustBorderHandle.cpp.

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

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

Here is the call graph for this function:

◆ Drag()

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

overridevirtual

Implements UIHandle.

Definition at line 509 of file WaveClipAdjustBorderHandle.cpp.

{
   return mAdjustPolicy->Drag(event, *project);
}

References mAdjustPolicy, and project.

◆ Draw()

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

overridevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 529 of file WaveClipAdjustBorderHandle.cpp.

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

References mAdjustPolicy.

◆ DrawingArea()

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

overridevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 534 of file WaveClipAdjustBorderHandle.cpp.

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

References mAdjustPolicy.

◆ FindTrack()

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

overridevirtual

Returns: pointer to associated track, if any

Implements UIHandle.

Definition at line 361 of file WaveClipAdjustBorderHandle.cpp.

{
   return mpTrack;
}

References mpTrack.

◆ HitAnywhere()

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

static

Definition at line 377 of file WaveClipAdjustBorderHandle.cpp.

{
   const auto rect = state.rect;
 
   const auto px = state.state.m_x;
 
   auto& zoomInfo = ViewInfo::Get(*pProject);
 
   std::shared_ptr<WaveTrack::Interval> leftInterval;
   std::shared_ptr<WaveTrack::Interval> rightInterval;
 
   //Test left and right boundaries of each clip
   //to determine which kind of adjustment is
   //more appropriate
   for (const auto &interval : waveTrack->Intervals()) {
      const auto& clip = *interval;
      if(!WaveChannelView::ClipDetailsVisible(clip, zoomInfo, rect))
         continue;
 
      auto clipRect = ClipParameters::GetClipRect(clip, zoomInfo, rect);
      if(std::abs(px - clipRect.GetLeft()) <= BoundaryThreshold * 2)
         rightInterval = interval;
      else if (std::abs(px - clipRect.GetRight()) <= BoundaryThreshold * 2)
         leftInterval = interval;
   }
 
   std::shared_ptr<WaveTrack::Interval> adjustedInterval;
   bool adjustLeftBorder {false};
   if (leftInterval && rightInterval)
   {
      //between adjacent clips
      if(ClipParameters::GetClipRect(*leftInterval, zoomInfo, rect).GetRight() > px)
      {
         adjustedInterval = leftInterval;
         adjustLeftBorder = false;
      }
      else
      {
         adjustedInterval = rightInterval;
         adjustLeftBorder = true;
      }
   }
   else
   {
      adjustedInterval = leftInterval ? leftInterval : rightInterval;
      if (adjustedInterval)
      {
         //single clip case, determine the border,
         //hit testing area differs from one
         //used for general case
         const auto clipRect = ClipParameters::GetClipRect(*adjustedInterval, zoomInfo, rect);
         if (std::abs(px - clipRect.GetLeft()) <= BoundaryThreshold)
            adjustLeftBorder = true;
         else if (std::abs(px - clipRect.GetRight()) <= BoundaryThreshold)
            adjustLeftBorder = false;
         else
            adjustedInterval.reset();
      }
   }
 
   if(adjustedInterval)
   {
      const auto isStretchMode = state.state.AltDown();
      AdjustClipBorder::AdjustHandler adjustHandler = isStretchMode
         ? (adjustLeftBorder ? StretchLeftTo : StretchRightTo)
         : (adjustLeftBorder ? TrimLeftTo : TrimRightTo);
 
      std::unique_ptr<AdjustPolicy> policy =
         std::make_unique<AdjustClipBorder>(
            adjustHandler, waveTrack, adjustedInterval, adjustLeftBorder,
            isStretchMode, zoomInfo);
 
      return AssignUIHandlePtr(
         holder,
         std::make_shared<WaveClipAdjustBorderHandle>(policy, waveTrack,
            isStretchMode,
            adjustLeftBorder));
   }
   return { };
}

References AssignUIHandlePtr(), BoundaryThreshold, WaveChannelView::ClipDetailsVisible(), ViewInfo::Get(), ClipParameters::GetClipRect(), TrackPanelMouseState::rect, TrackPanelMouseState::state, anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::StretchLeftTo(), anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::StretchRightTo(), anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::TrimLeftTo(), and anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::TrimRightTo().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HitPreviewStretch()

HitTestPreview WaveClipAdjustBorderHandle::HitPreviewStretch	(	const AudacityProject *	,
		bool	unsafe,
		bool	isLeftBorder
	)

staticprivate

Definition at line 328 of file WaveClipAdjustBorderHandle.cpp.

{
   static auto disabledCursor =
      MakeCursor(wxCURSOR_NO_ENTRY, DisabledCursorXpm, 16, 16);
   static auto stretchCursorLeft =
      MakeCursor(wxCURSOR_SIZEWE, ClipStretchLeftXpm, 16, 16);
   static auto stretchCursorRight =
      MakeCursor(wxCURSOR_SIZEWE, ClipStretchRightXpm, 16, 16);
   auto message = XO("Click and drag to stretch clip");
 
   return {
      message,
      (unsafe
         ? &*disabledCursor
         : &*(isLeftBorder ? stretchCursorLeft : stretchCursorRight))
   };
}

References MakeCursor(), and XO().

Referenced by Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HitPreviewTrim()

HitTestPreview WaveClipAdjustBorderHandle::HitPreviewTrim	(	const AudacityProject *	,
		bool	unsafe,
		bool	isLeftBorder
	)

staticprivate

Definition at line 310 of file WaveClipAdjustBorderHandle.cpp.

{
   static auto disabledCursor =
      MakeCursor(wxCURSOR_NO_ENTRY, DisabledCursorXpm, 16, 16);
   static auto trimCursorLeft =
      MakeCursor(wxCURSOR_SIZEWE, ClipTrimLeftXpm , 16, 16);
   static auto trimCursorRight =
      MakeCursor(wxCURSOR_SIZEWE, ClipTrimRightXpm, 16, 16);
   auto message = XO("Click and drag to move clip boundary in time");
 
   return {
      message,
      (unsafe
         ? &*disabledCursor
         : &*(isLeftBorder ? trimCursorLeft : trimCursorRight))
   };
}

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 WaveClipAdjustBorderHandle::HitTest	(	std::weak_ptr< WaveClipAdjustBorderHandle > &	holder,
		WaveChannelView &	view,
		const AudacityProject *	pProject,
		const TrackPanelMouseState &	state
	)

static

Definition at line 462 of file WaveClipAdjustBorderHandle.cpp.

{
    auto waveChannel = view.FindWaveChannel();
    // For multichannel tracks, show adjustment handle only for the topmost
    // channel
    if (waveChannel->GetChannelIndex() != 0)
        return {};
 
    std::vector<UIHandlePtr> results;
 
    const auto rect = state.rect;
 
    auto py = state.state.m_y;
 
    if (py >= rect.GetTop() &&
        py <= (rect.GetTop() + static_cast<int>(rect.GetHeight() * 0.3)))
    {
        return HitAnywhere(holder,
            waveChannel->GetTrack().SharedPointer<WaveTrack>(),
            pProject, state);
    }
    return {};
}

References WaveChannelView::FindWaveChannel(), 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:

◆ operator=()

WaveClipAdjustBorderHandle & WaveClipAdjustBorderHandle::operator= ( WaveClipAdjustBorderHandle && )

defaultnoexcept

◆ Preview()

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

overridevirtual

Implements UIHandle.

Definition at line 490 of file WaveClipAdjustBorderHandle.cpp.

{
   const bool unsafe = ProjectAudioIO::Get(*pProject).IsAudioActive();
   return mIsStretchMode
      ? HitPreviewStretch(pProject, unsafe, mIsLeftBorder)
      : HitPreviewTrim(pProject, unsafe, mIsLeftBorder);
}

References ProjectAudioIO::Get(), HitPreviewStretch(), HitPreviewTrim(), ProjectAudioIO::IsAudioActive(), mIsLeftBorder, and mIsStretchMode.

Here is the call graph for this function:

◆ Release()

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

overridevirtual

Implements UIHandle.

Definition at line 515 of file WaveClipAdjustBorderHandle.cpp.

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

References mAdjustPolicy, project, and RefreshCode::RefreshAll.

Member Data Documentation

◆ BoundaryThreshold

constexpr int WaveClipAdjustBorderHandle::BoundaryThreshold = 5

staticconstexprprivate

Definition at line 25 of file WaveClipAdjustBorderHandle.h.

Referenced by HitAnywhere().

◆ mAdjustPolicy

std::unique_ptr<AdjustPolicy> WaveClipAdjustBorderHandle::mAdjustPolicy {}

private

Definition at line 30 of file WaveClipAdjustBorderHandle.h.

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

◆ mIsLeftBorder

bool WaveClipAdjustBorderHandle::mIsLeftBorder

private

Definition at line 33 of file WaveClipAdjustBorderHandle.h.

Referenced by Preview().

◆ mIsStretchMode

bool WaveClipAdjustBorderHandle::mIsStretchMode

private

Definition at line 32 of file WaveClipAdjustBorderHandle.h.

Referenced by Preview().

◆ mpTrack

std::shared_ptr<const WaveTrack> WaveClipAdjustBorderHandle::mpTrack

private

Definition at line 31 of file WaveClipAdjustBorderHandle.h.

Referenced by FindTrack().

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

Classes

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WaveClipAdjustBorderHandle() [1/2]

◆ ~WaveClipAdjustBorderHandle()

◆ WaveClipAdjustBorderHandle() [2/2]

Member Function Documentation

◆ Cancel()

◆ Click()

◆ Drag()

◆ Draw()

◆ DrawingArea()

◆ FindTrack()

◆ HitAnywhere()

◆ HitPreviewStretch()

◆ HitPreviewTrim()

◆ HitTest()

◆ operator=()

◆ Preview()

◆ Release()

Member Data Documentation

◆ BoundaryThreshold

◆ mAdjustPolicy

◆ mIsLeftBorder

◆ mIsStretchMode

◆ mpTrack