ProjectWindow::PlaybackScroller Class Reference

#include <ProjectWindow.h>

Inheritance diagram for ProjectWindow::PlaybackScroller:

Collaboration diagram for ProjectWindow::PlaybackScroller:

Public Types
enum class	Mode { Off , Refresh , Pinned , Right }
Public Types inherited from Observer::Publisher< PlaybackScrollerMessage >
using	message_type = PlaybackScrollerMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const PlaybackScrollerMessage &) >
	Type of functions that can be connected to the Publisher. More...

Public Member Functions
	PlaybackScroller (AudacityProject *project)
Mode	GetMode () const
void	Activate (Mode mode)
double	GetRecentStreamTime () const
void	OnTimer ()
Public Member Functions inherited from Observer::Publisher< PlaybackScrollerMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Private Attributes
AudacityProject *	mProject
Mode	mMode { Mode::Off }
double	mRecentStreamTime { -1.0 }

Additional Inherited Members
Static Public Attributes inherited from Observer::Publisher< PlaybackScrollerMessage >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< PlaybackScrollerMessage >
CallbackReturn	Publish (const PlaybackScrollerMessage &message)
	Send a message to connected callbacks. More...

Detailed Description

Definition at line 80 of file ProjectWindow.h.

Member Enumeration Documentation

Mode

enum class ProjectWindow::PlaybackScroller::Mode

strong

Enumerator
Off
Refresh
Pinned
Right

Definition at line 86 of file ProjectWindow.h.

                      {
         Off,
         Refresh,
         Pinned,
         Right,
      };

Constructor & Destructor Documentation

PlaybackScroller()

ProjectWindow::PlaybackScroller::PlaybackScroller ( AudacityProject *  project )

explicit

Definition at line 1237 of file ProjectWindow.cpp.

: mProject(project)
{
}

Member Function Documentation

Activate()

void ProjectWindow::PlaybackScroller::Activate ( Mode  mode )

inline

Definition at line 94 of file ProjectWindow.h.

      {
         mMode = mode;
      }

Referenced by ControlToolBar::StartScrolling(), ControlToolBar::StartScrollingIfPreferred(), and ControlToolBar::StopScrolling().

Here is the caller graph for this function:

GetMode()

Mode ProjectWindow::PlaybackScroller::GetMode ( ) const

inline

Definition at line 93 of file ProjectWindow.h.

{ return mMode; }

GetRecentStreamTime()

double ProjectWindow::PlaybackScroller::GetRecentStreamTime ( ) const

inline

Definition at line 99 of file ProjectWindow.h.

{ return mRecentStreamTime; }

OnTimer()

void ProjectWindow::PlaybackScroller::OnTimer

(

)

Definition at line 1242 of file ProjectWindow.cpp.

{
   auto gAudioIO = AudioIO::Get();
   mRecentStreamTime = gAudioIO->GetStreamTime();
 
   auto cleanup = finally([&]{
      // Propagate the message to other listeners bound to this
      this->Publish({});
   });
 
   if(!ProjectAudioIO::Get( *mProject ).IsAudioActive())
      return;
   else if (mMode == Mode::Refresh) {
      // PRL:  see comments in Scrubbing.cpp for why this is sometimes needed.
      // These unnecessary refreshes cause wheel rotation events to be delivered more uniformly
      // to the application, so scrub speed control is smoother.
      // (So I see at least with OS 10.10 and wxWidgets 3.0.2.)
      // Is there another way to ensure that than by refreshing?
      auto &trackPanel = GetProjectPanel( *mProject );
      trackPanel.Refresh(false);
   }
   else if (mMode != Mode::Off) {
      // Pan the view, so that we put the play indicator at some fixed
      // fraction of the window width.
 
      auto &viewInfo = ViewInfo::Get( *mProject );
      auto &trackPanel = GetProjectPanel( *mProject );
      const int posX = viewInfo.TimeToPosition(mRecentStreamTime);
      auto width = viewInfo.GetTracksUsableWidth();
      int deltaX;
      switch (mMode)
      {
         default:
            wxASSERT(false);
            /* fallthru */
         case Mode::Pinned:
            deltaX =
               posX - width * TracksPrefs::GetPinnedHeadPositionPreference();
            break;
         case Mode::Right:
            deltaX = posX - width;        break;
      }
      viewInfo.hpos =
         viewInfo.OffsetTimeByPixels(viewInfo.hpos, deltaX, true);
         // Can't scroll too far left
         viewInfo.hpos = std::max(0.0, viewInfo.hpos);
      trackPanel.Refresh(false);
   }
}

References AudioIO::Get(), ProjectAudioIO::Get(), ViewInfo::Get(), TracksPrefs::GetPinnedHeadPositionPreference(), GetProjectPanel(), ProjectAudioIO::IsAudioActive(), and Observer::Publisher< ProjectWindowDestroyedMessage >::Publish().

Here is the call graph for this function:

Member Data Documentation

mMode

Mode ProjectWindow::PlaybackScroller::mMode { Mode::Off }

private

Definition at line 105 of file ProjectWindow.h.

mProject

AudacityProject* ProjectWindow::PlaybackScroller::mProject

private

Definition at line 104 of file ProjectWindow.h.

mRecentStreamTime

double ProjectWindow::PlaybackScroller::mRecentStreamTime { -1.0 }

private

Definition at line 109 of file ProjectWindow.h.

---

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

• ProjectWindow.h
• ProjectWindow.cpp