#include <ClipPitchAndSpeedButtonHandle.h>

Inheritance diagram for ClipPitchAndSpeedButtonHandle:

Collaboration diagram for ClipPitchAndSpeedButtonHandle:

Public Types
enum class	Type { Speed , Pitch }

Public Types inherited from UIHandle
using	Result = unsigned

using	Cell = TrackPanelCell

Public Member Functions
	ClipPitchAndSpeedButtonHandle (Type type, const std::shared_ptr< WaveTrack > &track, const std::shared_ptr< WaveTrack::Interval > &clip)

Public Member Functions inherited from HighlitClipButtonHandle
	HighlitClipButtonHandle (ClipButtonId id, std::shared_ptr< WaveTrack > track, std::shared_ptr< WaveTrack::Interval > clip)

void	Enter (bool forward, AudacityProject *pProject) override

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

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

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

Result	Cancel (AudacityProject *pProject) override

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

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

virtual void	DoDraw (const wxRect &args, wxDC &dc)=0

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)

Private Member Functions
Result	DoRelease (const TrackPanelMouseEvent &event, AudacityProject pProject, wxWindow pParent) override

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

void	DoDraw (const wxRect &rect, wxDC &dc) override

Private Attributes
Type	mType

Additional Inherited Members
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 inherited from HighlitClipButtonHandle
virtual Result	DoRelease (const TrackPanelMouseEvent &event, AudacityProject pProject, wxWindow pParent)=0

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

UIHandle::Result	SelectAt (const TrackPanelMouseEvent &event, AudacityProject *project)

Protected Attributes inherited from HighlitClipButtonHandle
ClipButtonId	mButtonId

std::shared_ptr< WaveTrack >	mTrack

std::shared_ptr< WaveTrack::Interval >	mClip

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Audacity: A Digital Audio Editor

ClipPitchAndSpeedButtonHandle.h

Matthieu Hodgkinson

Definition at line 15 of file ClipPitchAndSpeedButtonHandle.h.

Member Enumeration Documentation

◆ Type

enum class ClipPitchAndSpeedButtonHandle::Type

strong

Enumerator
Speed
Pitch

Definition at line 18 of file ClipPitchAndSpeedButtonHandle.h.

   {
      Speed,
      Pitch
   };

Constructor & Destructor Documentation

◆ ClipPitchAndSpeedButtonHandle()

ClipPitchAndSpeedButtonHandle::ClipPitchAndSpeedButtonHandle	(	Type	type,
		const std::shared_ptr< WaveTrack > &	track,
		const std::shared_ptr< WaveTrack::Interval > &	clip
	)

Definition at line 108 of file ClipPitchAndSpeedButtonHandle.cpp.

    : HighlitClipButtonHandle { type == Type::Pitch ? ClipButtonId::Pitch :
                                                      ClipButtonId::Speed,
                                track, clip }
    , mType { type }
{
}

References Pitch, and Speed.

Member Function Documentation

◆ DoDraw()

void ClipPitchAndSpeedButtonHandle::DoDraw	(	const wxRect &	rect,
		wxDC &	dc
	)

overrideprivatevirtual

Implements HighlitClipButtonHandle.

Definition at line 178 of file ClipPitchAndSpeedButtonHandle.cpp.

{
   const ClipInterface& clip = *mClip;
   ClipButtonDrawingArgs args { rect, clip, dc };
   if (mType == Type::Pitch)
      ClipButtonSpecializations<ClipButtonId::Pitch>::DrawOnClip(args);
   else
      ClipButtonSpecializations<ClipButtonId::Speed>::DrawOnClip(args);
}

References ClipButtonSpecializations< id >::DrawOnClip(), HighlitClipButtonHandle::mClip, mType, and Pitch.

Here is the call graph for this function:

◆ DoRelease()

UIHandle::Result ClipPitchAndSpeedButtonHandle::DoRelease	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject,
		wxWindow *	pParent
	)

overrideprivatevirtual

Implements HighlitClipButtonHandle.

Definition at line 118 of file ClipPitchAndSpeedButtonHandle.cpp.

{
   if (event.event.CmdDown())
   {
      if (mType == Type::Pitch)
      {
         mClip->SetCentShift(0);
         ProjectHistory::Get(*pProject).PushState(
            XO("Reset Clip Pitch"), XO("Reset Clip Pitch"));
      }
      else if (!TimeStretching::SetClipStretchRatio(*mTrack, *mClip, 1))
      {
         BasicUI::ShowErrorDialog(
            wxWidgetsWindowPlacement { pParent }, XO("Not enough space"),
            XO("There is not enough space to expand the clip to its original speed."),
            {});
         return RefreshCode::RefreshNone;
      }
      else
      {
         WaveClipUIUtilities::SelectClip(*pProject, *mClip);
         ProjectHistory::Get(*pProject).PushState(
            XO("Reset Clip Speed"), XO("Reset Clip Speed"));
      }
   }
   else
   {
      const auto focusedGroup = mType == Type::Pitch ?
                                   PitchAndSpeedDialogGroup::Pitch :
                                   PitchAndSpeedDialogGroup::Speed;
      BasicUI::CallAfter([project = pProject->weak_from_this(), track = mTrack,
                          clip = mClip, focusedGroup] {
         if (auto pProject = project.lock())
            PitchAndSpeedDialog::Get(*pProject)
               .Retarget(track, clip)
               .SetFocus(focusedGroup);
      });
   }
   return RefreshCode::RefreshNone;
}

References BasicUI::CallAfter(), TrackPanelMouseEvent::event, ProjectHistory::Get(), HighlitClipButtonHandle::mClip, HighlitClipButtonHandle::mTrack, mType, Pitch, Pitch, project, ProjectHistory::PushState(), RefreshCode::RefreshNone, WaveClipUIUtilities::SelectClip(), TimeStretching::SetClipStretchRatio(), BasicUI::ShowErrorDialog(), Speed, and XO().

Here is the call graph for this function:

◆ Preview()

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

overrideprivatevirtual

Implements UIHandle.

Definition at line 161 of file ClipPitchAndSpeedButtonHandle.cpp.

{
   const auto ctrlDown = state.state.CmdDown();
   const bool macOs = wxPlatformInfo::Get().GetOperatingSystemId() & wxOS_MAC;
   if (mType == Type::Pitch)
      return { ctrlDown ? XO("Click to reset clip pitch.") :
               macOs ? XO("Click to change clip pitch, Cmd + click to reset.") :
                       XO("Click to change clip pitch, Ctrl + click to reset."),
               nullptr };
   else
      return { ctrlDown ? XO("Click to reset clip speed.") :
               macOs ? XO("Click to change clip speed, Cmd + click to reset.") :
                       XO("Click to change clip speed, Ctrl + click to reset."),
               nullptr };
}

References BasicUI::Get(), mType, Pitch, TrackPanelMouseState::state, and XO().

Here is the call graph for this function:

Member Data Documentation

◆ mType

Type ClipPitchAndSpeedButtonHandle::mType

private

Definition at line 38 of file ClipPitchAndSpeedButtonHandle.h.

Referenced by DoDraw(), DoRelease(), and Preview().

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ ClipPitchAndSpeedButtonHandle()

Member Function Documentation

◆ DoDraw()

◆ DoRelease()

◆ Preview()

Member Data Documentation

◆ mType