ChangeClipSpeedDialog Class Reference

#include <ChangeClipSpeedDialog.h>

Inheritance diagram for ChangeClipSpeedDialog:

Collaboration diagram for ChangeClipSpeedDialog:

Public Member Functions
	ChangeClipSpeedDialog (WaveTrack &track, WaveTrack::Interval &interval, wxWindow *parent=nullptr)
	~ChangeClipSpeedDialog () override
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	PopulateOrExchange (ShuttleGui &s)
void	OnOk ()
bool	SetClipSpeedFromDialog ()

Private Attributes
WaveTrack &	mTrack
WaveTrack::Interval &	mTrackInterval
double	mClipSpeed
double	mOldClipSpeed

Detailed Description

Definition at line 18 of file ChangeClipSpeedDialog.h.

Constructor & Destructor Documentation

ChangeClipSpeedDialog()

ChangeClipSpeedDialog::ChangeClipSpeedDialog	(	WaveTrack &	track,
		WaveTrack::Interval &	interval,
		wxWindow *	parent = nullptr
	)

Definition at line 19 of file ChangeClipSpeedDialog.cpp.

    : wxDialogWrapper(
         parent, wxID_ANY, XO("Change Speed"), wxDefaultPosition, { 480, 250 },
         wxDEFAULT_DIALOG_STYLE)
    , mTrack { waveTrack }
    , mTrackInterval { interval }
    , mClipSpeed { 100.0 / interval.GetStretchRatio() }
    , mOldClipSpeed { mClipSpeed }
{
   ShuttleGui s(this, eIsCreating);
 
   s.StartVerticalLay();
   {
      PopulateOrExchange(s);
   }
   s.EndVerticalLay();
 
   // TODO: Tolerance?
   // Stretch ratio of 
   assert(mOldClipSpeed > 0.0);
 
   Layout();
   Fit();
   Centre();
 
   Bind(
      wxEVT_CHAR_HOOK,
      [this](auto& evt)
      {
         if (!IsEscapeKey(evt))
         {
            evt.Skip();
            return;
         }
 
         EndModal(wxID_CANCEL);
      });
}

~ChangeClipSpeedDialog()

ChangeClipSpeedDialog::~ChangeClipSpeedDialog ( )

overridedefault

Member Function Documentation

OnOk()

void ChangeClipSpeedDialog::OnOk ( )

private

Definition at line 108 of file ChangeClipSpeedDialog.cpp.

{
   if (SetClipSpeedFromDialog())
      EndModal(wxID_OK);
}

References SetClipSpeedFromDialog().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void ChangeClipSpeedDialog::PopulateOrExchange ( ShuttleGui &  s )

private

Definition at line 61 of file ChangeClipSpeedDialog.cpp.

{
   s.StartInvisiblePanel(15);
   s.StartVerticalLay(wxEXPAND, 1);
   {
      s.SetBorder(1);
      s.StartHorizontalLay(wxEXPAND);
      {
         s.AddPrompt(XO("Clip speed"));
         s.AddSpace(0, 0, 1);
         s.Name(XO("Clip speed"))
            .NameSuffix(Verbatim("%"))
            .TieNumericTextBox({}, mClipSpeed, 14, true)
            ->Bind(wxEVT_TEXT_ENTER, [this](auto&) { OnOk(); });
 
         s.AddFixedText(Verbatim("%"));
      }
      s.EndMultiColumn();
   }
   s.EndHorizontalLay();
   s.EndInvisiblePanel();
 
   s.StartHorizontalLay(wxEXPAND, 0);
   {
      s.StartInvisiblePanel(14);
      {
         s.SetBorder(2);
         s.StartHorizontalLay(wxEXPAND, 0);
         {
            s.AddSpace(0, 0, 1);
 
            s.AddButton(XXO("&Cancel"))
               ->Bind(wxEVT_BUTTON, [this](auto&) { EndModal(wxID_CANCEL); });
 
            s.AddSpace(4, 0, 0);
 
            auto okBtn = s.AddButton(XXO("&Ok"));
            okBtn->Bind(wxEVT_BUTTON, [this](auto&) { OnOk(); });
            okBtn->SetDefault();
         }
         s.EndHorizontalLay();
      }
      s.EndInvisiblePanel();
   }
   s.EndHorizontalLay();
}

References ShuttleGuiBase::AddButton(), ShuttleGuiBase::AddFixedText(), ShuttleGuiBase::AddPrompt(), ShuttleGui::AddSpace(), ShuttleGuiBase::EndHorizontalLay(), ShuttleGuiBase::EndInvisiblePanel(), ShuttleGuiBase::EndMultiColumn(), mClipSpeed, ShuttleGui::Name(), ShuttleGui::NameSuffix(), OnOk(), ShuttleGuiBase::SetBorder(), ShuttleGuiBase::StartHorizontalLay(), ShuttleGuiBase::StartInvisiblePanel(), ShuttleGuiBase::StartVerticalLay(), ShuttleGuiBase::TieNumericTextBox(), Verbatim(), XO(), and XXO().

Referenced by SetClipSpeedFromDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

SetClipSpeedFromDialog()

bool ChangeClipSpeedDialog::SetClipSpeedFromDialog ( )

private

Definition at line 114 of file ChangeClipSpeedDialog.cpp.

{
   {
      ShuttleGui S(this, eIsGettingFromDialog);
      PopulateOrExchange(S);
   }
 
   if (mClipSpeed <= 0.0)
   {
      BasicUI::ShowErrorDialog(
         /* i18n-hint: Title of an error message shown, when invalid clip speed is set */
         wxWidgetsWindowPlacement { this }, XO("Invalid clip speed"),
         XO("Clip speed must be a positive value"), {});
 
      return false;
   }
 
   const auto nextClip = mTrack.GetNextInterval(mTrackInterval, PlaybackDirection::forward);
   const auto maxEndTime = nextClip != nullptr ?
                              nextClip->Start() :
                              std::numeric_limits<double>::infinity();
 
   const auto start = mTrackInterval.Start();
   const auto end = mTrackInterval.End();
 
   const auto expectedEndTime =
      start + (end - start) * mOldClipSpeed / mClipSpeed;
 
   if (expectedEndTime >= maxEndTime)
   {
      BasicUI::ShowErrorDialog(
         wxWidgetsWindowPlacement { this }, XO("Invalid clip speed"),
         XO("There is not enough space to stretch the clip to the selected speed"), {});
 
      return false;
   }
 
   mTrackInterval.StretchRightTo(expectedEndTime);
   mOldClipSpeed = mClipSpeed = 100 / mTrackInterval.GetStretchRatio();
 
   {
      ShuttleGui S(this, eIsSettingToDialog);
      PopulateOrExchange(S);
   }
 
   return true;
}

References eIsGettingFromDialog, eIsSettingToDialog, ChannelGroupInterval::End(), PackedArray::end(), forward, WaveTrack::GetNextInterval(), WaveTrack::Interval::GetStretchRatio(), mClipSpeed, mOldClipSpeed, mTrack, mTrackInterval, PopulateOrExchange(), S, BasicUI::ShowErrorDialog(), ChannelGroupInterval::Start(), WaveTrack::Interval::StretchRightTo(), and XO().

Referenced by OnOk().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mClipSpeed

double ChangeClipSpeedDialog::mClipSpeed

private

Definition at line 36 of file ChangeClipSpeedDialog.h.

Referenced by PopulateOrExchange(), and SetClipSpeedFromDialog().

mOldClipSpeed

double ChangeClipSpeedDialog::mOldClipSpeed

private

Definition at line 37 of file ChangeClipSpeedDialog.h.

Referenced by SetClipSpeedFromDialog().

mTrack

WaveTrack& ChangeClipSpeedDialog::mTrack

private

Definition at line 34 of file ChangeClipSpeedDialog.h.

Referenced by SetClipSpeedFromDialog().

mTrackInterval

WaveTrack::Interval& ChangeClipSpeedDialog::mTrackInterval

private

Definition at line 35 of file ChangeClipSpeedDialog.h.

Referenced by SetClipSpeedFromDialog().

---

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

• ChangeClipSpeedDialog.h
• ChangeClipSpeedDialog.cpp