AdornedRulerPanel::PlayRegionAdjustingHandle Class Reference

Inheritance diagram for AdornedRulerPanel::PlayRegionAdjustingHandle:

Collaboration diagram for AdornedRulerPanel::PlayRegionAdjustingHandle:

Public Member Functions
	PlayRegionAdjustingHandle (AdornedRulerPanel *pParent, wxCoord xx, MenuChoice menuChoice, wxCursor *cursor, size_t numGuides=1)
	PlayRegionAdjustingHandle (AdornedRulerPanel *pParent, wxCoord xx, MenuChoice menuChoice, wxCursor cursor, size_t numGuides=1)
void	SetCursor (wxCursor cursor)
HitTestPreview	Preview (const TrackPanelMouseState &state, 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
bool	HasEscape (AudacityProject *pProject) const override
bool	Escape (AudacityProject *pProject) override
Public Member Functions inherited from AdornedRulerPanel::CommonRulerHandle
	CommonRulerHandle (AdornedRulerPanel *pParent, wxCoord xx, MenuChoice menuChoice)
std::shared_ptr< const Track >	FindTrack () const override
bool	Clicked () const
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)

Protected Member Functions
double	SnappedTime (AudacityProject &project, size_t ii)
std::pair< double, double >	SnappedTimes (AudacityProject &project)
void	Unsnap (bool use, AudacityProject *pProject)
virtual void	DoStartAdjust (AudacityProject &, double)=0
virtual void	DoAdjust (AudacityProject &)=0
void	SavePlayRegion (AudacityProject &project)
Protected Member Functions inherited from AdornedRulerPanel::CommonRulerHandle
bool	HandlesRightClick () override
	Whether the handle has any special right-button handling. More...
Result	Click (const TrackPanelMouseEvent &event, AudacityProject *) override
Result	Drag (const TrackPanelMouseEvent &, AudacityProject *) override
Result	Release (const TrackPanelMouseEvent &event, AudacityProject *, wxWindow *) override
double	Time (AudacityProject &project) const
void	StartPlay (AudacityProject &project, const wxMouseEvent &event)
Result	Cancel (AudacityProject *) override
void	Enter (bool, AudacityProject *) override

Private Attributes
wxCursor	mCursor
size_t	mNumGuides
SelectedRegion	mOldSelectedRegion
double	mOldStart = 0.0
double	mOldEnd = 0.0
bool	mWasActive = false
bool	mSaved = false
bool	mDragged = false

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned
using	Cell = TrackPanelCell
Static Public Member Functions inherited from AdornedRulerPanel::CommonRulerHandle
static UIHandle::Result	NeedChangeHighlight (const CommonRulerHandle &oldState, const CommonRulerHandle &newState)
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 Types inherited from AdornedRulerPanel::CommonRulerHandle
enum class	Button { None , Left , Right }
Protected Attributes inherited from AdornedRulerPanel::CommonRulerHandle
wxWeakRef< AdornedRulerPanel >	mParent
wxCoord	mX
wxCoord	mClickedX
MenuChoice	mChoice
Button	mClicked { Button::None }
Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 216 of file AdornedRulerPanel.cpp.

Constructor & Destructor Documentation

PlayRegionAdjustingHandle() [1/2]

AdornedRulerPanel::PlayRegionAdjustingHandle::PlayRegionAdjustingHandle ( AdornedRulerPanel *  pParent, wxCoord  xx, MenuChoice  menuChoice, wxCursor *  cursor, size_t  numGuides = 1  )

inline

Definition at line 218 of file AdornedRulerPanel.cpp.

   : CommonRulerHandle{ pParent, xx, menuChoice }
   , mNumGuides{ numGuides }
   {
      if (cursor) {
         mCursor = *cursor;
      }
   }

References mCursor.

PlayRegionAdjustingHandle() [2/2]

AdornedRulerPanel::PlayRegionAdjustingHandle::PlayRegionAdjustingHandle ( AdornedRulerPanel *  pParent, wxCoord  xx, MenuChoice  menuChoice, wxCursor  cursor, size_t  numGuides = 1  )

inline

Definition at line 230 of file AdornedRulerPanel.cpp.

   : CommonRulerHandle{ pParent, xx, menuChoice }
   , mCursor{ cursor }
   , mNumGuides{ numGuides }
   {}

Member Function Documentation

Cancel()

Result AdornedRulerPanel::PlayRegionAdjustingHandle::Cancel ( AudacityProject *  pProject )

inlineoverridevirtual

Restore state as before SavePlayRegion()

Reimplemented from AdornedRulerPanel::CommonRulerHandle.

Definition at line 309 of file AdornedRulerPanel.cpp.

   {
      using namespace RefreshCode;
      auto result = CommonRulerHandle::Cancel(pProject);
      if (!mSaved)
         return result;
 
      auto &viewInfo = ViewInfo::Get(*pProject);
      viewInfo.selectedRegion = mOldSelectedRegion;
      auto &playRegion = viewInfo.playRegion;
      playRegion.SetTimes(mOldStart, mOldEnd);
      if (!mWasActive)
         playRegion.SetActive(false);
 
      return RefreshAll;
   }

References AdornedRulerPanel::CommonRulerHandle::Cancel(), ViewInfo::Get(), mOldEnd, mOldSelectedRegion, mOldStart, mSaved, mWasActive, and RefreshCode::RefreshAll.

Here is the call graph for this function:

DoAdjust()

virtual void AdornedRulerPanel::PlayRegionAdjustingHandle::DoAdjust ( AudacityProject &  )

protectedpure virtual

Implemented in AdornedRulerPanel::MovePlayRegionHandle, AdornedRulerPanel::ResizePlayRegionHandle, and AdornedRulerPanel::NewPlayRegionHandle.

Referenced by Drag(), and Unsnap().

Here is the caller graph for this function:

DoStartAdjust()

virtual void AdornedRulerPanel::PlayRegionAdjustingHandle::DoStartAdjust ( AudacityProject &  , double    )

protectedpure virtual

Implemented in AdornedRulerPanel::ResizePlayRegionHandle, AdornedRulerPanel::NewPlayRegionHandle, and AdornedRulerPanel::MovePlayRegionHandle.

Referenced by Drag().

Here is the caller graph for this function:

Drag()

Result AdornedRulerPanel::PlayRegionAdjustingHandle::Drag ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject  )

inlineoverridevirtual

Reimplemented from AdornedRulerPanel::CommonRulerHandle.

Definition at line 257 of file AdornedRulerPanel.cpp.

   {
      using namespace RefreshCode;
      auto result = CommonRulerHandle::Drag(event, pProject);
      if (0 != (result & Cancelled) || mClicked != Button::Left)
         return result;
 
      auto &ruler = AdornedRulerPanel::Get(*pProject);
      mX = event.event.m_x;
      ruler.UpdateQuickPlayPos(event.event.m_x);
 
      if (!mDragged) {
         if (fabs(mX - mClickedX) < SELECT_TOLERANCE_PIXEL)
            // Don't start a drag yet for a small mouse movement
            return RefreshNone;
         SavePlayRegion(*pProject);
         const auto time = SnappedTime(*pProject, 0);
         DoStartAdjust(*pProject, time);
         mDragged = true;
      }
      else
         DoAdjust(*pProject);
 
      if (AdornedRulerPanel::Get( *pProject ).mPlayRegionDragsSelection)
         DragSelection(*pProject);
 
      return RefreshAll;
   }

References Cancelled, DoAdjust(), DoStartAdjust(), AdornedRulerPanel::CommonRulerHandle::Drag(), AdornedRulerPanel::DragSelection(), TrackPanelMouseEvent::event, AdornedRulerPanel::Get(), AdornedRulerPanel::CommonRulerHandle::Left, AdornedRulerPanel::CommonRulerHandle::mClicked, AdornedRulerPanel::CommonRulerHandle::mClickedX, mDragged, AdornedRulerPanel::mPlayRegionDragsSelection, AdornedRulerPanel::CommonRulerHandle::mX, RefreshCode::RefreshAll, RefreshCode::RefreshNone, anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler(), SavePlayRegion(), SELECT_TOLERANCE_PIXEL, and SnappedTime().

Here is the call graph for this function:

Escape()

bool AdornedRulerPanel::PlayRegionAdjustingHandle::Escape ( AudacityProject *  pProject )

inlineoverridevirtual

Reimplemented from UIHandle.

Definition at line 337 of file AdornedRulerPanel.cpp.

   {
      if (HasEscape(pProject)) {
         Unsnap(false, pProject);
         return true;
      }
      return false;
   }

References HasEscape(), and Unsnap().

Here is the call graph for this function:

HasEscape()

bool AdornedRulerPanel::PlayRegionAdjustingHandle::HasEscape ( AudacityProject *  pProject ) const

inlineoverridevirtual

Reimplemented from UIHandle.

Definition at line 329 of file AdornedRulerPanel.cpp.

   {
      auto &ruler = AdornedRulerPanel::Get(*pProject);
      auto values = ruler.mIsSnapped;
      auto identity = [](auto x){ return x; }; // in the C++20 standard...
      return std::any_of( values, values + ruler.mNumGuides, identity );
   }

References AdornedRulerPanel::Get(), anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler(), and values.

Referenced by Escape().

Here is the call graph for this function:

Here is the caller graph for this function:

Preview()

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

inlineoverridevirtual

Implements UIHandle.

Definition at line 244 of file AdornedRulerPanel.cpp.

   {
      mParent->SetNumGuides(mNumGuides);
      const auto message = XO("Click and drag to define a looping region.");
      return {
         message,
         &mCursor,
         message
      };
   }

References mCursor, mNumGuides, AdornedRulerPanel::CommonRulerHandle::mParent, and XO().

Here is the call graph for this function:

Release()

Result AdornedRulerPanel::PlayRegionAdjustingHandle::Release ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject, wxWindow *  pParent  )

inlineoverridevirtual

Reimplemented from AdornedRulerPanel::CommonRulerHandle.

Definition at line 287 of file AdornedRulerPanel.cpp.

   {
      using namespace RefreshCode;
      auto result = CommonRulerHandle::Release(event, pProject, pParent);
 
      if (mClicked == Button::Left && !mDragged && !mParent->mIsRecording)
         StartPlay(*pProject, event.event);
 
      if (!mDragged || 0 != (result & Cancelled))
         return result;
 
      // Set the play region endpoints correctly even if not strictly needed
      auto &viewInfo = ViewInfo::Get( *pProject );
      auto &playRegion = viewInfo.playRegion;
      playRegion.Order();
 
      return result;
   }

References Cancelled, TrackPanelMouseEvent::event, ViewInfo::Get(), AdornedRulerPanel::CommonRulerHandle::Left, AdornedRulerPanel::CommonRulerHandle::mClicked, mDragged, AdornedRulerPanel::CommonRulerHandle::mParent, AdornedRulerPanel::CommonRulerHandle::Release(), and AdornedRulerPanel::CommonRulerHandle::StartPlay().

Here is the call graph for this function:

SavePlayRegion()

void AdornedRulerPanel::PlayRegionAdjustingHandle::SavePlayRegion ( AudacityProject &  project )

inlineprotected

Definition at line 387 of file AdornedRulerPanel.cpp.

   {
      auto &viewInfo = ViewInfo::Get(project);
      mOldSelectedRegion = viewInfo.selectedRegion;
      auto &playRegion = viewInfo.playRegion;
      mWasActive = playRegion.Active();
      mOldStart = playRegion.GetLastActiveStart();
      mOldEnd = playRegion.GetLastActiveEnd();
      if (!mWasActive)
         playRegion.SetActive(true);
      mSaved = true;
   }

References ViewInfo::Get(), mOldEnd, mOldSelectedRegion, mOldStart, mSaved, mWasActive, and project.

Referenced by Drag().

Here is the call graph for this function:

Here is the caller graph for this function:

SetCursor()

void AdornedRulerPanel::PlayRegionAdjustingHandle::SetCursor ( wxCursor  cursor )

inline

Definition at line 239 of file AdornedRulerPanel.cpp.

   {
      mCursor = cursor;
   }

References mCursor.

Referenced by AdornedRulerPanel::MovePlayRegionHandle::MovePlayRegionHandle().

Here is the caller graph for this function:

SnappedTime()

double AdornedRulerPanel::PlayRegionAdjustingHandle::SnappedTime ( AudacityProject &  project, size_t  ii  )

inlineprotected

Definition at line 348 of file AdornedRulerPanel.cpp.

   {
      const auto &ruler = AdornedRulerPanel::Get(project);
      bool isSnapped = ruler.mIsSnapped[ii];
      return isSnapped
         ? ruler.mQuickPlayPos[ii]
         : ruler.mQuickPlayPosUnsnapped[ii];
   }

References AdornedRulerPanel::Get(), project, and anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler().

Referenced by AdornedRulerPanel::ResizePlayRegionHandle::DoAdjust(), AdornedRulerPanel::NewPlayRegionHandle::DoAdjust(), and Drag().

Here is the call graph for this function:

Here is the caller graph for this function:

SnappedTimes()

std::pair< double, double > AdornedRulerPanel::PlayRegionAdjustingHandle::SnappedTimes ( AudacityProject &  project )

inlineprotected

Definition at line 357 of file AdornedRulerPanel.cpp.

   {
      const auto &ruler = AdornedRulerPanel::Get(project);
      for (size_t ii = 0; ii < ruler.mNumGuides; ++ii)
         if (ruler.mIsSnapped[ii]) {
            double time0 = ruler.mQuickPlayPos[ii];
            double delta = time0 - ruler.mQuickPlayPosUnsnapped[ii];
            double time1 = ruler.mQuickPlayPosUnsnapped[1 - ii] + delta;
            if (ii == 1)
               return { time1, time0 };
            else
               return { time0, time1 };
         }
      // No snap
      return { ruler.mQuickPlayPos[0], ruler.mQuickPlayPos[1] };
   }

References AdornedRulerPanel::Get(), project, and anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler().

Referenced by AdornedRulerPanel::MovePlayRegionHandle::DoAdjust().

Here is the call graph for this function:

Here is the caller graph for this function:

Unsnap()

void AdornedRulerPanel::PlayRegionAdjustingHandle::Unsnap ( bool  use, AudacityProject *  pProject  )

inlineprotected

Definition at line 374 of file AdornedRulerPanel.cpp.

   {
      auto &ruler = AdornedRulerPanel::Get(*pProject);
      std::fill( ruler.mIsSnapped, ruler.mIsSnapped + ruler.mNumGuides, false );
      // Repaint to turn the snap lines on or off
      mChangeHighlight = RefreshCode::RefreshAll;
      if (Clicked())
         DoAdjust(*pProject);
   }

References AdornedRulerPanel::CommonRulerHandle::Clicked(), DoAdjust(), AdornedRulerPanel::Get(), UIHandle::mChangeHighlight, RefreshCode::RefreshAll, and anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler().

Referenced by Escape().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCursor

wxCursor AdornedRulerPanel::PlayRegionAdjustingHandle::mCursor

private

Definition at line 402 of file AdornedRulerPanel.cpp.

Referenced by PlayRegionAdjustingHandle(), Preview(), and SetCursor().

mDragged

bool AdornedRulerPanel::PlayRegionAdjustingHandle::mDragged = false

private

Definition at line 409 of file AdornedRulerPanel.cpp.

Referenced by Drag(), and Release().

mNumGuides

size_t AdornedRulerPanel::PlayRegionAdjustingHandle::mNumGuides

private

Definition at line 403 of file AdornedRulerPanel.cpp.

Referenced by Preview().

mOldEnd

double AdornedRulerPanel::PlayRegionAdjustingHandle::mOldEnd = 0.0

private

Definition at line 406 of file AdornedRulerPanel.cpp.

Referenced by Cancel(), and SavePlayRegion().

mOldSelectedRegion

SelectedRegion AdornedRulerPanel::PlayRegionAdjustingHandle::mOldSelectedRegion

private

Definition at line 405 of file AdornedRulerPanel.cpp.

Referenced by Cancel(), and SavePlayRegion().

mOldStart

double AdornedRulerPanel::PlayRegionAdjustingHandle::mOldStart = 0.0

private

Definition at line 406 of file AdornedRulerPanel.cpp.

Referenced by Cancel(), and SavePlayRegion().

mSaved

bool AdornedRulerPanel::PlayRegionAdjustingHandle::mSaved = false

private

Definition at line 408 of file AdornedRulerPanel.cpp.

Referenced by Cancel(), and SavePlayRegion().

mWasActive

bool AdornedRulerPanel::PlayRegionAdjustingHandle::mWasActive = false

private

Definition at line 407 of file AdornedRulerPanel.cpp.

Referenced by Cancel(), and SavePlayRegion().

---

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

• AdornedRulerPanel.cpp