ScrubbingOverlay Class Reference

Inheritance diagram for ScrubbingOverlay:

Collaboration diagram for ScrubbingOverlay:

Public Member Functions
	ScrubbingOverlay (AudacityProject *project)
Public Member Functions inherited from Overlay
	Overlay ()=default
	Overlay (const Overlay &)=delete
Overlay &	operator= (const Overlay &)=delete
virtual	~Overlay ()=0
virtual unsigned	SequenceNumber () const =0
	This number determines an ordering of overlays, so that those with higher numbers overpaint those with lower numbers that intersect. More...
std::pair< wxRect, bool >	GetRectangle (wxSize size)
virtual std::pair< wxRect, bool >	DoGetRectangle (wxSize size)=0
virtual void	Erase (wxDC &dc, wxDC &src)
virtual void	Draw (OverlayPanel &panel, wxDC &dc)=0
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Private Member Functions
unsigned	SequenceNumber () const override
	This number determines an ordering of overlays, so that those with higher numbers overpaint those with lower numbers that intersect. More...
std::pair< wxRect, bool >	DoGetRectangle (wxSize size) override
void	Draw (OverlayPanel &panel, wxDC &dc) override
void	OnTimer (Observer::Message)
const Scrubber &	GetScrubber () const
Scrubber &	GetScrubber ()

Private Attributes
AudacityProject *	mProject
Observer::Subscription	mSubscription
wxRect	mLastScrubRect
wxRect	mNextScrubRect
wxString	mLastScrubSpeedText
wxString	mNextScrubSpeedText

Detailed Description

Definition at line 29 of file ScrubUI.cpp.

Constructor & Destructor Documentation

ScrubbingOverlay()

ScrubbingOverlay::ScrubbingOverlay ( AudacityProject *  project )

explicit

Definition at line 54 of file ScrubUI.cpp.

   : mProject(project)
   , mLastScrubRect()
   , mNextScrubRect()
   , mLastScrubSpeedText()
   , mNextScrubSpeedText()
{
   mSubscription = ProjectWindow::Get( *mProject ).GetPlaybackScroller()
      .Subscribe(*this, &ScrubbingOverlay::OnTimer);
}

References ProjectWindow::Get(), ProjectWindow::GetPlaybackScroller(), mSubscription, OnTimer(), and Observer::Publisher< Message, NotifyAll >::Subscribe().

Here is the call graph for this function:

Member Function Documentation

DoGetRectangle()

std::pair< wxRect, bool > ScrubbingOverlay::DoGetRectangle ( wxSize  size )

overrideprivatevirtual

Implements Overlay.

Definition at line 70 of file ScrubUI.cpp.

{
   wxRect rect(mLastScrubRect);
   const bool outdated =
      (mLastScrubRect != mNextScrubRect) ||
      (!mLastScrubRect.IsEmpty() && !GetScrubber().ShouldDrawScrubSpeed()) ||
      (mLastScrubSpeedText != mNextScrubSpeedText);
   return std::make_pair(
      rect,
      outdated
   );
}

References GetScrubber(), mLastScrubRect, mLastScrubSpeedText, mNextScrubRect, mNextScrubSpeedText, and Scrubber::ShouldDrawScrubSpeed().

Here is the call graph for this function:

Draw()

void ScrubbingOverlay::Draw ( OverlayPanel &  panel, wxDC &  dc  )

overrideprivatevirtual

Implements Overlay.

Definition at line 83 of file ScrubUI.cpp.

{
   mLastScrubRect = mNextScrubRect;
   mLastScrubSpeedText = mNextScrubSpeedText;
 
   Scrubber &scrubber = GetScrubber();
   if (!scrubber.ShouldDrawScrubSpeed())
      return;
 
   static const wxFont labelFont(24, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
   dc.SetFont(labelFont);
 
   // These two colors were previously saturated red and green.  However
   // we have a rule to try to only use red for reserved purposes of
   //  (a) Recording
   //  (b) Error alerts
   // So they were changed to 'orange' and 'lime'.
   static const wxColour clrNoScroll(215, 162, 0), clrScroll(0, 204, 153);
   if (scrubber.IsScrollScrubbing())
      dc.SetTextForeground(clrScroll);
   else
      dc.SetTextForeground(clrNoScroll);
 
   dc.DrawText(mLastScrubSpeedText, mLastScrubRect.GetX(), mLastScrubRect.GetY());
}

References GetScrubber(), Scrubber::IsScrollScrubbing(), mLastScrubRect, mLastScrubSpeedText, mNextScrubRect, mNextScrubSpeedText, and Scrubber::ShouldDrawScrubSpeed().

Here is the call graph for this function:

GetScrubber() [1/2]

Scrubber & ScrubbingOverlay::GetScrubber ( )

private

Definition at line 196 of file ScrubUI.cpp.

{
   return Scrubber::Get( *mProject );
}

References Scrubber::Get(), and mProject.

Here is the call graph for this function:

GetScrubber() [2/2]

const Scrubber & ScrubbingOverlay::GetScrubber ( ) const

private

Definition at line 191 of file ScrubUI.cpp.

{
   return Scrubber::Get( *mProject );
}

References Scrubber::Get(), and mProject.

Referenced by DoGetRectangle(), Draw(), and OnTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

OnTimer()

void ScrubbingOverlay::OnTimer ( Observer::Message  )

private

Definition at line 109 of file ScrubUI.cpp.

{
   Scrubber &scrubber = GetScrubber();
   const auto isScrubbing = scrubber.IsScrubbing();
   auto &ruler = AdornedRulerPanel::Get( *mProject );
   auto position = ::wxGetMousePosition();
 
   if (scrubber.IsSpeedPlaying() || scrubber.IsKeyboardScrubbing())
      return;
 
   {
      if(scrubber.HasMark()) {
         auto xx = ruler.ScreenToClient(position).x;
         ruler.UpdateQuickPlayPos( xx );
 
         if (!isScrubbing)
            // Really start scrub if motion is far enough
            scrubber.MaybeStartScrubbing(xx);
      }
 
      if (!isScrubbing) {
         mNextScrubRect = wxRect();
         return;
      }
      else
         ruler.DrawBothOverlays();
   }
 
   if (!scrubber.ShouldDrawScrubSpeed()) {
      mNextScrubRect = wxRect();
   }
   else {
      auto &trackPanel = GetProjectPanel( *mProject );
      auto &viewInfo = ViewInfo::Get( *mProject );
      int panelWidth, panelHeight;
      trackPanel.GetSize(&panelWidth, &panelHeight);
 
      // Where's the mouse?
      position = trackPanel.ScreenToClient(position);
 
      const bool seeking = scrubber.Seeks() || scrubber.TemporarilySeeks();
 
      // Find the text
      const double maxScrubSpeed = GetScrubber().GetMaxScrubSpeed();
      const double speed =
         scrubber.IsScrollScrubbing()
         ? scrubber.FindScrubSpeed( seeking,
             ViewInfo::Get( *mProject )
                .PositionToTime(position.x, viewInfo.GetLeftOffset()))
         : maxScrubSpeed;
 
      const wxChar *format =
         scrubber.IsScrollScrubbing()
         ? seeking
            ? wxT("%+.2fX")
            : wxT("%+.2f")
         : wxT("%.2f");
 
      mNextScrubSpeedText = wxString::Format(format, speed);
 
      // Find the origin for drawing text
      wxCoord width, height;
      {
         wxClientDC dc( &trackPanel );
         static const wxFont labelFont(24, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
         dc.SetFont(labelFont);
         dc.GetTextExtent(mNextScrubSpeedText, &width, &height);
      }
      const auto xx =
         std::max(0, std::min(panelWidth - width, position.x - width / 2));
 
      // Put the text above the cursor, if it fits.
      enum { offset = 20 };
      auto yy = position.y - height + offset;
      if (yy < 0)
         yy += height + 2 * offset;
      yy = std::max(0, std::min(panelHeight - height, yy));
 
      mNextScrubRect = wxRect(xx, yy, width, height);
   }
}

References Scrubber::FindScrubSpeed(), anonymous_namespace{ExportPCM.cpp}::format, ViewInfo::Get(), AdornedRulerPanel::Get(), Scrubber::GetMaxScrubSpeed(), GetProjectPanel(), GetScrubber(), Scrubber::HasMark(), Scrubber::IsKeyboardScrubbing(), Scrubber::IsScrollScrubbing(), Scrubber::IsScrubbing(), Scrubber::IsSpeedPlaying(), Scrubber::MaybeStartScrubbing(), min(), mNextScrubRect, mNextScrubSpeedText, mProject, anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler(), Scrubber::Seeks(), Scrubber::ShouldDrawScrubSpeed(), Scrubber::TemporarilySeeks(), and wxT().

Referenced by ScrubbingOverlay().

Here is the call graph for this function:

Here is the caller graph for this function:

SequenceNumber()

unsigned ScrubbingOverlay::SequenceNumber ( ) const

overrideprivatevirtual

This number determines an ordering of overlays, so that those with higher numbers overpaint those with lower numbers that intersect.

Implements Overlay.

Definition at line 65 of file ScrubUI.cpp.

{
   return 40;
}

Member Data Documentation

mLastScrubRect

wxRect ScrubbingOverlay::mLastScrubRect

private

Definition at line 50 of file ScrubUI.cpp.

Referenced by DoGetRectangle(), and Draw().

mLastScrubSpeedText

wxString ScrubbingOverlay::mLastScrubSpeedText

private

Definition at line 51 of file ScrubUI.cpp.

Referenced by DoGetRectangle(), and Draw().

mNextScrubRect

wxRect ScrubbingOverlay::mNextScrubRect

private

Definition at line 50 of file ScrubUI.cpp.

Referenced by DoGetRectangle(), Draw(), and OnTimer().

mNextScrubSpeedText

wxString ScrubbingOverlay::mNextScrubSpeedText

private

Definition at line 51 of file ScrubUI.cpp.

Referenced by DoGetRectangle(), Draw(), and OnTimer().

mProject

AudacityProject* ScrubbingOverlay::mProject

private

Definition at line 47 of file ScrubUI.cpp.

Referenced by GetScrubber(), and OnTimer().

mSubscription

Observer::Subscription ScrubbingOverlay::mSubscription

private

Definition at line 48 of file ScrubUI.cpp.

Referenced by ScrubbingOverlay().

---

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

• ScrubUI.cpp