#include <Viewport.h>

Inheritance diagram for Viewport:

Collaboration diagram for Viewport:

Public Member Functions
	Viewport (AudacityProject &project)

void	SetCallbacks (std::unique_ptr< ViewportCallbacks > pCallbacks)

double	ScrollingLowerBoundTime () const

void	DoScroll ()
	Cause refresh of viewport contents after setting scrolling or zooming. More...

void	ScrollToStart (bool extend)

void	ScrollToEnd (bool extend)

void	ScrollToTop ()

void	ScrollToBottom ()

void	ScrollIntoView (double pos)
	Center view horizontally at the given time, if it was not in bounds. More...

void	ScrollIntoView (int x)

void	OnScrollLeft ()

void	OnScrollRight ()

void	OnScrollLeftButton ()

void	OnScrollRightButton ()

void	OnScroll ()

bool	ScrollUpDown (int delta)

void	SetHorizontalThumb (double scrollto, bool doScroll=true)

void	Zoom (double pixelsPerSecond)
	Set timeline magnification; unchanged left edge time. More...

void	ZoomBy (double multiplier)
	Multiply the magnification; unchanged left edge time. More...

void	ZoomAboutSelection (double multiplier)

void	ZoomAboutCenter (double multiplier)
	Multiply timeline magnification, conserving the midpoint time if possible. More...

void	ZoomFitHorizontallyAndShowTrack (Track *pTrack)

void	ShowTrack (const Track &track)

double	GetZoomOfToFit () const
	Find pixels-per-second that would fit all tracks on the timeline. More...

void	ZoomFitHorizontally ()

void	ZoomFitVertically ()

void	ExpandAllTracks ()

void	CollapseAllTracks ()

void	UpdateScrollbarsForTracks ()

void	HandleResize ()

void	ReinitScrollbars ()

void	Redraw ()

void	SetToDefaultSize ()
	Send a message to the main window PARENT of the viewport, to resize. More...

Public Member Functions inherited from Observer::Publisher< ViewportMessage >
	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...

Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static Viewport &	Get (AudacityProject &project)

static const Viewport &	Get (const AudacityProject &project)

Private Member Functions
double	PixelWidthBeforeTime (double scrollto) const

void	FinishAutoScroll ()

void	OnUndoPushedModified ()

void	OnUndoRedo ()

void	OnUndoReset ()

Private Attributes
AudacityProject &	mProject

std::unique_ptr< ViewportCallbacks >	mpCallbacks {}

const Observer::Subscription	mSnappingChangedSubscription

const Observer::Subscription	mUndoSubscription

double	total { 1.0 }

wxInt64	sbarH { 0 }

wxInt64	sbarScreen { 1 }

wxInt64	sbarTotal { 1 }

double	sbarScale { 1.0 }

int	scrollStep { 16 }

bool	mAutoScrolling { false }

bool	mbInitializingScrollbar { false }

Additional Inherited Members
Public Types inherited from Observer::Publisher< ViewportMessage >
using	message_type = ViewportMessage

using	CallbackReturn = std::conditional_t< true, void, bool >

using	Callback = std::function< CallbackReturn(const ViewportMessage &) >
	Type of functions that can be connected to the Publisher. More...

Static Public Attributes inherited from Observer::Publisher< ViewportMessage >
static constexpr bool	notifies_all

Protected Member Functions inherited from Observer::Publisher< ViewportMessage >
CallbackReturn	Publish (const ViewportMessage &message)
	Send a message to connected callbacks. More...

Detailed Description

Definition at line 61 of file Viewport.h.

Constructor & Destructor Documentation

◆ Viewport()

Viewport::Viewport ( AudacityProject & project )

explicit

Definition at line 43 of file Viewport.cpp.

   : mProject{ project }
   , mSnappingChangedSubscription{
      ProjectSnap::Get(project).Subscribe([this](auto&){ Redraw(); }) }
   , mUndoSubscription{
      UndoManager::Get(project).Subscribe([this](UndoRedoMessage message){
         switch (message.type) {
         case UndoRedoMessage::Pushed:
         case UndoRedoMessage::Modified:
            return OnUndoPushedModified();
         case UndoRedoMessage::UndoOrRedo:
            return OnUndoRedo();
         case UndoRedoMessage::Reset:
            return OnUndoReset();
         default:
            return;
         }
      }) }
{
}

References Redraw().

Here is the call graph for this function:

Member Function Documentation

◆ CollapseAllTracks()

void Viewport::CollapseAllTracks ( )

Definition at line 739 of file Viewport.cpp.

{
   if (!mpCallbacks)
      return;
   auto &project = mProject;
   auto &tracks = TrackList::Get(project);
   for (auto t : tracks)
      mpCallbacks->SetMinimized(*t, true);
}

References TrackList::Get(), mpCallbacks, mProject, project, and tracks.

Referenced by anonymous_namespace{ViewMenus.cpp}::OnCollapseAllTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoScroll()

void Viewport::DoScroll ( )

Cause refresh of viewport contents after setting scrolling or zooming.

Definition at line 417 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get( project );
   const double lowerBound = ScrollingLowerBoundTime();
 
   auto width = viewInfo.GetTracksUsableWidth();
   const auto zoom = viewInfo.GetZoom();
   viewInfo.hpos = std::clamp(sbarH / zoom, lowerBound, std::max(lowerBound, total - width / zoom));
 
   const auto pos = mpCallbacks ? mpCallbacks->GetVerticalThumbPosition() : 0;
   viewInfo.vpos = pos * scrollStep;
 
   //mchinen: do not always set this project to be the active one.
   //a project may autoscroll while playing in the background
   //I think this is okay since OnMouseEvent has one of these.
   //SetActiveProject(this);
 
   if (!mAutoScrolling)
      Publish({ true, false, false });
}

References ViewInfo::Get(), mAutoScrolling, mpCallbacks, mProject, project, Observer::Publisher< ViewportMessage >::Publish(), sbarH, ScrollingLowerBoundTime(), scrollStep, and total.

Referenced by FinishAutoScroll(), OnScroll(), OnScrollLeftButton(), OnScrollRightButton(), ScrollUpDown(), and SetHorizontalThumb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ExpandAllTracks()

void Viewport::ExpandAllTracks ( )

Definition at line 729 of file Viewport.cpp.

{
   if (!mpCallbacks)
      return;
   auto &project = mProject;
   auto &tracks = TrackList::Get(project);
   for (auto t : tracks)
      mpCallbacks->SetMinimized(*t, false);
}

References TrackList::Get(), mpCallbacks, mProject, project, and tracks.

Referenced by anonymous_namespace{ViewMenus.cpp}::OnExpandAllTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FinishAutoScroll()

void Viewport::FinishAutoScroll ( )

private

Definition at line 69 of file Viewport.cpp.

{
   // Set a flag so we don't have to generate two update events
   mAutoScrolling = true;
 
   // Call our Scroll method which updates our ViewInfo variables
   // to reflect the positions of the scrollbars
   DoScroll();
 
   mAutoScrolling = false;
}

References DoScroll(), and mAutoScrolling.

Referenced by OnScrollLeft(), and OnScrollRight().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

Viewport & Viewport::Get ( AudacityProject & project )

static

Definition at line 33 of file Viewport.cpp.

{
   return project.AttachedObjects::Get<Viewport>(sKey);
}

References project, and sKey.

◆ Get() [2/2]

const Viewport & Viewport::Get ( const AudacityProject & project )

static

Definition at line 38 of file Viewport.cpp.

{
   return Get(const_cast<AudacityProject &>(project));
}

References Get(), and project.

Here is the call graph for this function:

◆ GetZoomOfToFit()

double Viewport::GetZoomOfToFit ( ) const

Find pixels-per-second that would fit all tracks on the timeline.

Definition at line 665 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &tracks = TrackList::Get(project);
   auto &viewInfo = ViewInfo::Get(project);
 
   const double end = tracks.GetEndTime();
   const double start = 0;
   const double len = end - start;
 
   if (len <= 0.0)
      return viewInfo.GetZoom();
 
   auto w = viewInfo.GetTracksUsableWidth();
   w -= 10;
   return w/len;
}

References details::end(), ViewInfo::Get(), TrackList::Get(), mProject, project, and tracks.

Referenced by ZoomFitHorizontally().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleResize()

void Viewport::HandleResize ( )

Definition at line 389 of file Viewport.cpp.

{
   BasicUI::CallAfter( [wthis = weak_from_this()]{
      if (auto This = wthis.lock()) {
         This->UpdateScrollbarsForTracks();
         This->Publish({ false, false, true });
      }
   });
}

References BasicUI::CallAfter().

Referenced by ProjectWindow::OnSize(), ProjectWindow::OnToolBarUpdate(), OnUndoRedo(), OnUndoReset(), TrackPanel::ProcessUIHandleResult(), and TrackPanel::UpdateViewIfNoTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnScroll()

void Viewport::OnScroll ( )

Definition at line 399 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get( project );
   const wxInt64 offset = PixelWidthBeforeTime(0.0);
   const auto pos = mpCallbacks ? mpCallbacks->GetHorizontalThumbPosition() : 0;
   sbarH = static_cast<wxInt64>(pos / sbarScale) - offset;
   DoScroll();
 
#ifndef __WXMAC__
   // Bug2179
   // This keeps the time ruler in sync with horizontal scrolling, without
   // making an undesirable compilation dependency of this source file on
   // the ruler
   BasicUI::Yield();
#endif
}

References DoScroll(), ViewInfo::Get(), mpCallbacks, mProject, PixelWidthBeforeTime(), project, sbarH, sbarScale, and BasicUI::Yield().

Referenced by ProjectWindow::OnScroll().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnScrollLeft()

void Viewport::OnScrollLeft ( )

This method handles general left-scrolling, either for drag-scrolling or when the scrollbar is clicked to the left of the thumb

Definition at line 104 of file Viewport.cpp.

{
   auto &project = mProject;
   wxInt64 pos = mpCallbacks ? mpCallbacks->GetHorizontalThumbPosition() : 0;
   const auto prevPos = pos;
   // move at least one scroll increment
   pos -= std::max<wxInt64>((sbarHjump * sbarScale), 1);
   pos = std::max<wxInt64>(pos, 0);
   sbarH -= sbarHjump;
   sbarH = std::max<wxInt64>(sbarH, -PixelWidthBeforeTime(0.0));
 
   if (mpCallbacks && pos != prevPos) {
      mpCallbacks->SetHorizontalThumbPosition(static_cast<int>(pos));
      FinishAutoScroll();
   }
}

References FinishAutoScroll(), mpCallbacks, mProject, PixelWidthBeforeTime(), project, sbarH, sbarHjump, and sbarScale.

Here is the call graph for this function:

◆ OnScrollLeftButton()

void Viewport::OnScrollLeftButton ( )

This handles the event when the left direction button on the scrollbar is depressed

Definition at line 144 of file Viewport.cpp.

{
   auto &project = mProject;
   wxInt64 pos = mpCallbacks ? mpCallbacks->GetHorizontalThumbPosition() : 0;
   const auto prevPos = pos;
   // move at least one scroll increment
   pos -= std::max<wxInt64>((sbarHjump * sbarScale), 1);
   pos = std::max<wxInt64>(pos, 0);
   sbarH -= sbarHjump;
   sbarH = std::max<wxInt64>(sbarH, -PixelWidthBeforeTime(0.0));
 
   if (mpCallbacks && pos != prevPos) {
      mpCallbacks->SetHorizontalThumbPosition(static_cast<int>(pos));
      DoScroll();
   }
}

References DoScroll(), mpCallbacks, mProject, PixelWidthBeforeTime(), project, sbarH, sbarHjump, and sbarScale.

Referenced by ProjectWindow::OnScrollLeftButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnScrollRight()

void Viewport::OnScrollRight ( )

This method handles general right-scrolling, either for drag-scrolling or when the scrollbar is clicked to the right of the thumb

Definition at line 121 of file Viewport.cpp.

{
   auto &project = mProject;
   wxInt64 pos = mpCallbacks ? mpCallbacks->GetHorizontalThumbPosition() : 0;
   const auto prevPos = pos;
   // move at least one scroll increment
   // use wxInt64 for calculation to prevent temporary overflow
   pos += std::max<wxInt64>((sbarHjump * sbarScale), 1);
   wxInt64 max = mpCallbacks
      ? mpCallbacks->GetHorizontalRange()
         - mpCallbacks->GetHorizontalThumbSize()
      : 0;
   pos = std::min(pos, max);
   sbarH += sbarHjump;
   sbarH = std::min<wxInt64>(sbarH,
      sbarTotal - PixelWidthBeforeTime(0.0) - sbarScreen);
 
   if (mpCallbacks && pos != prevPos) {
      mpCallbacks->SetHorizontalThumbPosition(static_cast<int>(pos));
      FinishAutoScroll();
   }
}

References FinishAutoScroll(), min(), mpCallbacks, mProject, PixelWidthBeforeTime(), project, sbarH, sbarHjump, sbarScale, sbarScreen, and sbarTotal.

Here is the call graph for this function:

◆ OnScrollRightButton()

void Viewport::OnScrollRightButton ( )

This handles the event when the right direction button on the scrollbar is depressed

Definition at line 161 of file Viewport.cpp.

{
   auto &project = mProject;
   wxInt64 pos = mpCallbacks ? mpCallbacks->GetHorizontalThumbPosition() : 0;
   const auto prevPos = pos;
   // move at least one scroll increment
   // use wxInt64 for calculation to prevent temporary overflow
   pos += std::max<wxInt64>((sbarHjump * sbarScale), 1);
   wxInt64 max = mpCallbacks
      ? mpCallbacks->GetHorizontalRange()
         - mpCallbacks->GetHorizontalThumbSize()
      : 0;
   pos = std::min(pos, max);
   sbarH += sbarHjump;
   sbarH = std::min<wxInt64>(sbarH,
      sbarTotal - PixelWidthBeforeTime(0.0) - sbarScreen);
 
   if (mpCallbacks && pos != prevPos) {
      mpCallbacks->SetHorizontalThumbPosition(static_cast<int>(pos));
      DoScroll();
   }
}

References DoScroll(), min(), mpCallbacks, mProject, PixelWidthBeforeTime(), project, sbarH, sbarHjump, sbarScale, sbarScreen, and sbarTotal.

Referenced by ProjectWindow::OnScrollRightButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnUndoPushedModified()

void Viewport::OnUndoPushedModified ( )

private

Definition at line 767 of file Viewport.cpp.

{
   Redraw();
}

References Redraw().

Here is the call graph for this function:

◆ OnUndoRedo()

void Viewport::OnUndoRedo ( )

private

Definition at line 772 of file Viewport.cpp.

{
   HandleResize();
   Redraw();
}

References HandleResize(), and Redraw().

Here is the call graph for this function:

◆ OnUndoReset()

void Viewport::OnUndoReset ( )

private

Definition at line 778 of file Viewport.cpp.

{
   HandleResize();
   // Redraw();  // Should we do this here too?
}

References HandleResize().

Here is the call graph for this function:

◆ PixelWidthBeforeTime()

double Viewport::PixelWidthBeforeTime ( double scrollto ) const

private

Definition at line 191 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get( project );
   const double lowerBound = ScrollingLowerBoundTime();
   return
      // Ignoring fisheye is correct here
      viewInfo.TimeRangeToPixelWidth(scrollto - lowerBound);
}

References ViewInfo::Get(), mProject, project, and ScrollingLowerBoundTime().

Referenced by OnScroll(), OnScrollLeft(), OnScrollLeftButton(), OnScrollRight(), OnScrollRightButton(), SetHorizontalThumb(), and UpdateScrollbarsForTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Redraw()

void Viewport::Redraw ( )

Definition at line 749 of file Viewport.cpp.

{
   // Delay it until after channel views update their Y coordinates in response
   // to TrackList mesages
   BasicUI::CallAfter([wthis = weak_from_this()]{
      if (auto This = wthis.lock()) {
         This->UpdateScrollbarsForTracks();
         This->Publish({ true, false, false });
      }
   });
}

References BasicUI::CallAfter().

Referenced by CommandDispatch::DoAudacityCommand(), MixerTrackCluster::OnButton_Mute(), MixerTrackCluster::OnButton_Solo(), AudacityApp::OnExceptionInMainLoop(), CommandHandler::OnReceiveCommand(), LabelDialog::OnSelectCell(), ToolsToolBar::OnToolChanged(), OnUndoPushedModified(), OnUndoRedo(), and Viewport().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReinitScrollbars()

void Viewport::ReinitScrollbars ( )

inline

Definition at line 172 of file Viewport.h.

172{ mbInitializingScrollbar = true; }

Viewport::mbInitializingScrollbar

bool mbInitializingScrollbar

Definition: Viewport.h:215

Referenced by ProjectFileManager::OpenProjectFile().

Here is the caller graph for this function:

◆ ScrollingLowerBoundTime()

double Viewport::ScrollingLowerBoundTime ( ) const

Definition at line 184 of file Viewport.cpp.

{
   return 0;
}

Referenced by DoScroll(), PixelWidthBeforeTime(), and UpdateScrollbarsForTracks().

Here is the caller graph for this function:

◆ ScrollIntoView() [1/2]

void Viewport::ScrollIntoView ( double pos )

Center view horizontally at the given time, if it was not in bounds.

Definition at line 84 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get( project );
   auto w = viewInfo.GetTracksUsableWidth();
 
   int pixel = viewInfo.TimeToPosition(pos);
   if (pixel < 0 || pixel >= w) {
      SetHorizontalThumb(viewInfo.OffsetTimeByPixels(pos, -(w / 2)));
      Publish({ true, false, false });
   }
}

References ViewInfo::Get(), mProject, project, Observer::Publisher< ViewportMessage >::Publish(), and SetHorizontalThumb().

Referenced by LabelTrackView::DoKeyDown(), LabelTrackView::KeyDown(), ScrollIntoView(), and ScrollToEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScrollIntoView() [2/2]

void Viewport::ScrollIntoView ( int x )

Center the view horizontally at the given pixel position relative to the left edge, if it was not in bounds

Definition at line 97 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get( project );
   ScrollIntoView(viewInfo.PositionToTime(x, viewInfo.GetLeftOffset()));
}

References ViewInfo::Get(), mProject, project, and ScrollIntoView().

Here is the call graph for this function:

◆ ScrollToBottom()

void Viewport::ScrollToBottom ( )

Definition at line 552 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &tracks = TrackList::Get(project);
   auto &viewInfo = ViewInfo::Get(project);
 
   auto range = tracks.Any();
   int trackHeight = 0;
   const auto getHeight = [this](auto pTrack){
      return mpCallbacks ? mpCallbacks->GetTrackHeight(*pTrack) : 0;
   };
   if (!range.empty()) {
      trackHeight = getHeight(*range.rbegin());
      --range.second;
   }
   int trackTop =
      range.sum(getHeight);
   const auto size =
      mpCallbacks ? mpCallbacks->ViewportSize() : std::pair{ 1, 1 };
   const auto [width, height] = size;
   const auto step = scrollStep;
   const int delta = ((trackTop + trackHeight - height) - viewInfo.vpos
      + step) / step;
   ScrollUpDown(delta);
   Publish({ true, false, false });
}

References ViewInfo::Get(), TrackList::Get(), mpCallbacks, mProject, project, Observer::Publisher< ViewportMessage >::Publish(), scrollStep, ScrollUpDown(), size, and tracks.

Here is the call graph for this function:

◆ ScrollToEnd()

void Viewport::ScrollToEnd ( bool extend )

This method 'fast-forwards' the track, by setting the cursor to the end of the samples on the selected track and scrolling the window to fit the end on its right side (maintaining current zoom). If extend is true, it will extend the right edge of the selection to the end (holding left edge constant), otherwise it will move both left and right edge of selection to the end

Definition at line 537 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &tracks = TrackList::Get(project);
   auto &viewInfo = ViewInfo::Get(project);
   double len = tracks.GetEndTime();
 
   viewInfo.selectedRegion.setT1(len, false);
   if (!extend)
      viewInfo.selectedRegion.setT0(len);
 
   // Make sure the end of the track is visible
   ScrollIntoView(len);
}

References ViewInfo::Get(), TrackList::Get(), mProject, project, ScrollIntoView(), and tracks.

Referenced by ControlToolBar::OnFF().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScrollToStart()

void Viewport::ScrollToStart ( bool extend )

This method 'rewinds' the track, by setting the cursor to 0 and scrolling the window to fit 0 on the left side of it (maintaining current zoom). If extend is true, it will extend the left edge of the selection to 0 (holding right edge constant), otherwise it will move both left and right edge of selection to 0

Definition at line 519 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get( project );
   viewInfo.selectedRegion.setT0(0, false);
   if (!extend)
      viewInfo.selectedRegion.setT1(0);
 
   SetHorizontalThumb(0);
}

References ViewInfo::Get(), mProject, project, and SetHorizontalThumb().

Referenced by ControlToolBar::OnRewind().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScrollToTop()

void Viewport::ScrollToTop ( )

Definition at line 530 of file Viewport.cpp.

{
   if (mpCallbacks)
      mpCallbacks->SetVerticalThumbPosition(0);
}

References mpCallbacks.

Referenced by ZoomFitVertically().

Here is the caller graph for this function:

◆ ScrollUpDown()

bool Viewport::ScrollUpDown ( int delta )

Definition at line 221 of file Viewport.cpp.

{
   int oldPos = mpCallbacks ? mpCallbacks->GetVerticalThumbPosition() : 0;
   int pos = oldPos + delta;
   int max = mpCallbacks
      ? mpCallbacks->GetVerticalRange() - mpCallbacks->GetVerticalThumbSize()
      : 0;
 
   // Can be negative in case of only one track
   if (max < 0)
      max = 0;
 
   if (pos > max)
      pos = max;
   else if (pos < 0)
      pos = 0;
 
   if (pos != oldPos)
   {
      if (mpCallbacks)
         mpCallbacks->SetVerticalThumbPosition(pos);
 
      DoScroll();
      return true;
   }
   else
      return false;
}

References DoScroll(), and mpCallbacks.

Referenced by ScrollToBottom(), and ShowTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetCallbacks()

void Viewport::SetCallbacks ( std::unique_ptr< ViewportCallbacks > pCallbacks )

Definition at line 64 of file Viewport.cpp.

{
   mpCallbacks = move(pCallbacks);
}

References mpCallbacks.

Referenced by ProjectWindow::ProjectWindow().

Here is the caller graph for this function:

◆ SetHorizontalThumb()

void Viewport::SetHorizontalThumb	(	double	scrollto,
		bool	doScroll = `true`
	)

Definition at line 201 of file Viewport.cpp.

{
   if (!mpCallbacks)
      return;
   auto &project = mProject;
   const auto unscaled = PixelWidthBeforeTime(scrollto);
   const int max = std::max(
      0, mpCallbacks->GetHorizontalRange() -
            mpCallbacks->GetHorizontalThumbSize());
   const int pos = std::clamp<int>(floor(0.5 + unscaled * sbarScale), 0, max);
   mpCallbacks->SetHorizontalThumbPosition(pos);
   sbarH = floor(0.5 + unscaled - PixelWidthBeforeTime(0.0));
   sbarH = std::clamp<wxInt64>(
      sbarH, -PixelWidthBeforeTime(0.0),
      std::max(sbarTotal - PixelWidthBeforeTime(0.0) - sbarScreen, 0.));
 
   if (doScroll)
      DoScroll();
}

References DoScroll(), mpCallbacks, mProject, PixelWidthBeforeTime(), project, sbarH, sbarScale, sbarScreen, and sbarTotal.

Referenced by LOFImportFileHandle::doDurationAndScrollOffset(), TrackPanel::HandlePageDownKey(), TrackPanel::HandlePageUpKey(), ScrollIntoView(), ScrollToStart(), Zoom(), ZoomAboutCenter(), ZoomAboutSelection(), and ZoomFitHorizontally().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetToDefaultSize()

void Viewport::SetToDefaultSize ( )

Send a message to the main window PARENT of the viewport, to resize.

Definition at line 761 of file Viewport.cpp.

{
   if (mpCallbacks)
      mpCallbacks->SetToDefaultSize();
}

References mpCallbacks.

Referenced by anonymous_namespace{PluginMenus.cpp}::OnResetConfig().

Here is the caller graph for this function:

◆ ShowTrack()

void Viewport::ShowTrack ( const Track & track )

Definition at line 456 of file Viewport.cpp.

{
   auto &viewInfo = ViewInfo::Get(mProject);
 
   int trackTop = 0;
   int trackHeight = 0;
   for (auto it : TrackList::Get(mProject)) {
      trackTop += trackHeight;
      trackHeight = mpCallbacks ? mpCallbacks->GetTrackHeight(*it) : 0;
 
      if (it == &track) {
         //We have found the track we want to ensure is visible.
 
         //Get the size of the trackpanel.
         const auto size =
            mpCallbacks ? mpCallbacks->ViewportSize() : std::pair{ 1, 1 };
         auto [width, height] = size;
 
         if (trackTop < viewInfo.vpos) {
            height = viewInfo.vpos - trackTop + scrollStep;
            height /= scrollStep;
            ScrollUpDown(-height);
         }
         else if (trackTop + trackHeight > viewInfo.vpos + height) {
            height = (trackTop + trackHeight) - (viewInfo.vpos + height);
            height = (height + scrollStep + 1) / scrollStep;
            ScrollUpDown(height);
         }
 
         break;
      }
   }
 
   Publish({ true, false, false });
}

References ViewInfo::Get(), TrackList::Get(), mpCallbacks, mProject, Observer::Publisher< ViewportMessage >::Publish(), scrollStep, ScrollUpDown(), and size.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateScrollbarsForTracks()

void Viewport::UpdateScrollbarsForTracks ( )

Change scrollbar bounds in response to changes in the TrackList, and sometimes rescroll to the top or left and repaint the whole view

Definition at line 250 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &tracks = TrackList::Get( project );
   auto &viewInfo = ViewInfo::Get( project );
 
   // To decide whether to repaint the view
   bool refresh = false;
   bool rescroll = false;
 
   // Gather inputs
   const int totalHeight =
      (mpCallbacks ? mpCallbacks->GetTotalHeight(tracks) : 0) + 32;
 
   // (From Debian...at least I think this is the change corresponding
   // to this comment)
   //
   // (2.) GTK critical warning "IA__gtk_range_set_range: assertion
   // 'min < max' failed" because of negative numbers as result of window
   // size checking. Added a sanity check that straightens up the numbers
   // in edge cases.
   const auto panelWidth = std::max(0, viewInfo.GetTracksUsableWidth());
   const auto panelHeight = std::max(0, viewInfo.GetHeight());
 
   // Whether scrollbars are visible now
   const bool oldhstate = (viewInfo.GetScreenEndTime() - viewInfo.hpos) < total;
   const bool oldvstate = panelHeight < totalHeight;
 
   auto &pendingTracks = PendingTracks::Get(mProject);
   const auto LastTime = std::accumulate(tracks.begin(), tracks.end(),
      viewInfo.selectedRegion.t1(),
      [&pendingTracks](double acc, const Track *track){
         // Iterate over pending changed tracks if present.
         track = &pendingTracks.SubstitutePendingChangedTrack(*track);
         return std::max(acc, track->GetEndTime());
      });
 
   const double screen = viewInfo.GetScreenEndTime() - viewInfo.hpos;
   const double halfScreen = screen / 2.0;
 
   const double lowerBound = ScrollingLowerBoundTime();
   const double additional = screen / 4.0;
 
   total = LastTime + additional;
 
   // Don't remove time from total that's still on the screen
   total = std::max(total, viewInfo.hpos + screen);
 
   // Scroll the view later if needed to respect the lower bound
   if (viewInfo.hpos < lowerBound) {
      viewInfo.hpos = lowerBound;
      rescroll = true;
   }
 
   // To compute new horizontal scrollbar settings
   sbarTotal = static_cast<wxInt64>(total * viewInfo.GetZoom());
   sbarScreen = static_cast<wxInt64>(panelWidth);
   sbarH = static_cast<wxInt64>(viewInfo.GetBeforeScreenWidth());
 
   // PRL:  Can someone else find a more elegant solution to bug 812, than
   // introducing this boolean member variable?
   // Setting mVSbar earlier, in HandlXMLTag, didn't succeed in restoring
   // the vertical scrollbar to its saved position.  So defer that till now.
   // mbInitializingScrollbar should be true only at the start of the life
   // of an AudacityProject reopened from disk.
   if (!mbInitializingScrollbar)
      viewInfo.vpos =
         (mpCallbacks ? mpCallbacks->GetVerticalThumbPosition() : 0)
         * scrollStep;
   mbInitializingScrollbar = false;
 
   // Constrain new top of visible area
   viewInfo.vpos = std::clamp(viewInfo.vpos, 0, totalHeight - 1);
 
   // Decide whether the tracks are large enough to scroll for the zoom level
   // and heights
   bool newhstate =
      (viewInfo.GetScreenEndTime() - viewInfo.hpos) < total;
   bool newvstate = panelHeight < totalHeight;
 
   // Hide scrollbar thumbs and buttons if not scrollable
   if (mpCallbacks) {
      mpCallbacks->ShowHorizontalScrollbar(newhstate);
      mpCallbacks->ShowVerticalScrollbar(newvstate);
   }
 
   // When not scrollable in either axis, align viewport to top or left and
   // repaint it later
   if (!newvstate && viewInfo.vpos != 0) {
      viewInfo.vpos = 0;
 
      refresh = true;
      rescroll = false;
   }
   if (!newhstate && sbarH != 0) {
      sbarH = 0;
 
      refresh = true;
      rescroll = false;
   }
 
   // wxScrollbar only supports int values but we need a greater range, so
   // we scale the scrollbar coordinates on demand. We only do this if we
   // would exceed the int range, so we can always use the maximum resolution
   // available.
 
   // Don't use the full 2^31 max int range but a bit less, so rounding
   // errors in calculations do not overflow max int
   wxInt64 maxScrollbarRange = (wxInt64)(2147483647 * 0.999);
   if (sbarTotal > maxScrollbarRange)
      sbarScale = (static_cast<double>(maxScrollbarRange)) / sbarTotal;
   else
      sbarScale = 1.0; // use maximum resolution
 
   {
      auto scaledSbarH = static_cast<int>(sbarH * sbarScale);
      auto scaledSbarScreen = static_cast<int>(sbarScreen * sbarScale);
      auto scaledSbarTotal = static_cast<int>(sbarTotal * sbarScale);
      const auto offset =
         static_cast<int>(floor(0.5 + sbarScale * PixelWidthBeforeTime(0.0)));
 
      if (mpCallbacks)
         mpCallbacks->SetHorizontalScrollbar(
            scaledSbarH + offset, scaledSbarScreen, scaledSbarTotal,
            scaledSbarScreen, true);
   }
 
   if (mpCallbacks)
      mpCallbacks->SetVerticalScrollbar(viewInfo.vpos / scrollStep,
         panelHeight / scrollStep,
         totalHeight / scrollStep,
         panelHeight / scrollStep, true);
 
   rescroll = (rescroll &&
       (viewInfo.GetScreenEndTime() - viewInfo.hpos) < total);
   Publish({ (refresh || rescroll),
      (oldhstate != newhstate || oldvstate != newvstate), false });
}

References ViewInfo::Get(), PendingTracks::Get(), TrackList::Get(), mbInitializingScrollbar, mpCallbacks, mProject, PixelWidthBeforeTime(), project, Observer::Publisher< ViewportMessage >::Publish(), sbarH, sbarScale, sbarScreen, sbarTotal, ScrollingLowerBoundTime(), scrollStep, total, and tracks.

Referenced by TrackPanel::MakeParentRedrawScrollbars(), Zoom(), and ZoomBy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Zoom()

void Viewport::Zoom ( double pixelsPerSecond )

Set timeline magnification; unchanged left edge time.

Definition at line 493 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get( project );
   viewInfo.SetZoom(pixelsPerSecond);
   UpdateScrollbarsForTracks();
   // See if we can center the selection on screen, and have it actually fit.
   // tOnLeft is the amount of time we would need before the selection left edge to center it.
   float t0 = viewInfo.selectedRegion.t0();
   float t1 = viewInfo.selectedRegion.t1();
   float tAvailable = viewInfo.GetScreenEndTime() - viewInfo.hpos;
   float tOnLeft = (tAvailable - t0 + t1)/2.0;
   // Bug 1292 (Enh) is effectively a request to do this scrolling of  the selection into view.
   // If tOnLeft is positive, then we have room for the selection, so scroll to it.
   if (tOnLeft >= 0)
      SetHorizontalThumb(t0 - tOnLeft);
}

References ViewInfo::Get(), mProject, project, SetHorizontalThumb(), and UpdateScrollbarsForTracks().

Referenced by ZoomFitHorizontally().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ZoomAboutCenter()

void Viewport::ZoomAboutCenter ( double multiplier )

Multiply timeline magnification, conserving the midpoint time if possible.

Definition at line 648 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get( project );
 
   //Zoom() may change these, so record original values:
   const double origLeft = viewInfo.hpos;
   const double origWidth = viewInfo.GetScreenEndTime() - origLeft;
 
   ZoomBy(multiplier);
   const double newWidth = viewInfo.GetScreenEndTime() - viewInfo.hpos;
 
   const double newh = origLeft + (origWidth - newWidth) / 2;
   // newh = (newh > 0) ? newh : 0;
   SetHorizontalThumb(newh);
}

References ViewInfo::Get(), mProject, project, SetHorizontalThumb(), and ZoomBy().

Here is the call graph for this function:

◆ ZoomAboutSelection()

void Viewport::ZoomAboutSelection ( double multiplier )

Multiply timeline magnification, conserving a selected portion that incompletely fills the width, if possible; else like ZoomAboutCenter

Definition at line 579 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get( project );
 
   // DMM: Here's my attempt to get logical zooming behavior
   // when there's a selection that's currently at least
   // partially on-screen
 
   const double endTime = viewInfo.GetScreenEndTime();
   const double duration = endTime - viewInfo.hpos;
 
   bool selectionIsOnscreen =
      (viewInfo.selectedRegion.t0() < endTime) &&
      (viewInfo.selectedRegion.t1() >= viewInfo.hpos);
 
   bool selectionFillsScreen =
      (viewInfo.selectedRegion.t0() < viewInfo.hpos) &&
      (viewInfo.selectedRegion.t1() > endTime);
 
   if (selectionIsOnscreen && !selectionFillsScreen) {
      // Start with the center of the selection
      double selCenter = (viewInfo.selectedRegion.t0() +
                          viewInfo.selectedRegion.t1()) / 2;
 
      // If the selection center is off-screen, pick the
      // center of the part that is on-screen.
      if (selCenter < viewInfo.hpos)
         selCenter = viewInfo.hpos +
                     (viewInfo.selectedRegion.t1() - viewInfo.hpos) / 2;
      if (selCenter > endTime)
         selCenter = endTime -
            (endTime - viewInfo.selectedRegion.t0()) / 2;
 
      // Zoom in
      ZoomBy(multiplier);
      const double newDuration =
         viewInfo.GetScreenEndTime() - viewInfo.hpos;
 
      // Recenter on selCenter
      SetHorizontalThumb(selCenter - newDuration / 2);
      return;
   }
 
 
   double origLeft = viewInfo.hpos;
   double origWidth = duration;
   ZoomBy(multiplier);
 
   const double newDuration =
      viewInfo.GetScreenEndTime() - viewInfo.hpos;
   double newh = origLeft + (origWidth - newDuration) / 2;
 
   // MM: Commented this out because it was confusing users
   /*
   // make sure that the *right-hand* end of the selection is
   // no further *left* than 1/3 of the way across the screen
   if (viewInfo.selectedRegion.t1() < newh + viewInfo.screen / 3)
      newh = viewInfo.selectedRegion.t1() - viewInfo.screen / 3;
 
   // make sure that the *left-hand* end of the selection is
   // no further *right* than 2/3 of the way across the screen
   if (viewInfo.selectedRegion.t0() > newh + viewInfo.screen * 2 / 3)
      newh = viewInfo.selectedRegion.t0() - viewInfo.screen * 2 / 3;
   */
 
   SetHorizontalThumb(newh);
}

References ViewInfo::Get(), mProject, project, SetHorizontalThumb(), and ZoomBy().

Here is the call graph for this function:

◆ ZoomBy()

void Viewport::ZoomBy ( double multiplier )

Multiply the magnification; unchanged left edge time.

Definition at line 511 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get( project );
   viewInfo.ZoomBy(multiplier);
   UpdateScrollbarsForTracks();
}

References ViewInfo::Get(), mProject, project, and UpdateScrollbarsForTracks().

Referenced by LOFImportFileHandle::doDurationAndScrollOffset(), ZoomAboutCenter(), and ZoomAboutSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ZoomFitHorizontally()

void Viewport::ZoomFitHorizontally ( )

Set horizontal zoom according to the extents of the tracks, and scroll to the start

Definition at line 683 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get(project);
   auto &tracks = TrackList::Get(project);
 
   const double start = 0;
 
   Zoom(GetZoomOfToFit());
   SetHorizontalThumb(start);
}

References ViewInfo::Get(), TrackList::Get(), GetZoomOfToFit(), mProject, project, SetHorizontalThumb(), tracks, and Zoom().

Referenced by ZoomFitHorizontallyAndShowTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ZoomFitHorizontallyAndShowTrack()

void Viewport::ZoomFitHorizontallyAndShowTrack ( Track * pTrack )

Fit horizontally; scroll vertically so that the given track (or if that's null, the first selected track, or if none such, the first track) is visible

Definition at line 439 of file Viewport.cpp.

{
   auto &project = mProject;
   auto &tracks = TrackList::Get( project );
 
   ZoomFitHorizontally();
 
   if (!pTrack)
      pTrack = *tracks.Selected().begin();
   if (!pTrack)
      pTrack = *tracks.begin();
   if (pTrack) {
      TrackFocus::Get(project).Set(pTrack, true);
      ShowTrack(*pTrack);
   }
}

References TrackFocus::Get(), TrackList::Get(), mProject, project, ShowTrack(), tracks, and ZoomFitHorizontally().

Referenced by anonymous_namespace{ImportMIDI.cpp}::DoImportMIDI(), ApplyMacroDialog::OnApplyToFiles(), and ProjectFileManager::OpenFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ZoomFitVertically()

void Viewport::ZoomFitVertically ( )

Give uncollapsed audio tracks equal height, fitting into the view if possible, and scroll to the top

Definition at line 695 of file Viewport.cpp.

{
   if (!mpCallbacks)
      return;
   auto &project = mProject;
   auto &viewInfo = ViewInfo::Get(project);
   auto &tracks = TrackList::Get(project);
 
   // Only nonminimized audio tracks will be resized
   // Assume all channels of the track have the same minimization state
   auto range = tracks.Any<AudioTrack>()
      - [this](const Track *pTrack){
         return mpCallbacks->IsTrackMinimized(*pTrack); };
   auto count = static_cast<int>(range.sum(&Track::NChannels));
   if (count == 0)
      return;
 
   // Find total height to apportion
   auto height = viewInfo.GetHeight();
   height -= 28;
 
   // The height of minimized and non-audio tracks cannot be apportioned
   const auto fn = [this](const Track *pTrack){
      return mpCallbacks->GetTrackHeight(*pTrack);
   };
   height -= tracks.Any().sum(fn) - range.sum(fn);
   height /= count;
   height = std::max<int>(mpCallbacks->MinimumTrackHeight(), height);
   for (auto t : range)
      mpCallbacks->SetChannelHeights(*t, height);
 
   ScrollToTop();
}

References fn, ViewInfo::Get(), TrackList::Get(), mpCallbacks, mProject, ChannelGroup::NChannels(), project, ScrollToTop(), and tracks.

Referenced by anonymous_namespace{TracksPrefs.cpp}::Handler::Handler().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mAutoScrolling

bool Viewport::mAutoScrolling { false }

private

Definition at line 214 of file Viewport.h.

Referenced by DoScroll(), and FinishAutoScroll().

◆ mbInitializingScrollbar

bool Viewport::mbInitializingScrollbar { false }

private

Definition at line 215 of file Viewport.h.

Referenced by UpdateScrollbarsForTracks().

◆ mpCallbacks

std::unique_ptr<ViewportCallbacks> Viewport::mpCallbacks {}

private

Definition at line 191 of file Viewport.h.

Referenced by CollapseAllTracks(), DoScroll(), ExpandAllTracks(), OnScroll(), OnScrollLeft(), OnScrollLeftButton(), OnScrollRight(), OnScrollRightButton(), ScrollToBottom(), ScrollToTop(), ScrollUpDown(), SetCallbacks(), SetHorizontalThumb(), SetToDefaultSize(), ShowTrack(), UpdateScrollbarsForTracks(), and ZoomFitVertically().

◆ mProject

AudacityProject& Viewport::mProject

private

◆ mSnappingChangedSubscription

const Observer::Subscription Viewport::mSnappingChangedSubscription

private

Definition at line 194 of file Viewport.h.

◆ mUndoSubscription

const Observer::Subscription Viewport::mUndoSubscription

private

Definition at line 195 of file Viewport.h.

◆ sbarH

wxInt64 Viewport::sbarH { 0 }

private

Definition at line 201 of file Viewport.h.

Referenced by DoScroll(), OnScroll(), OnScrollLeft(), OnScrollLeftButton(), OnScrollRight(), OnScrollRightButton(), SetHorizontalThumb(), and UpdateScrollbarsForTracks().

◆ sbarScale

double Viewport::sbarScale { 1.0 }

private

Definition at line 209 of file Viewport.h.

Referenced by OnScroll(), OnScrollLeft(), OnScrollLeftButton(), OnScrollRight(), OnScrollRightButton(), SetHorizontalThumb(), and UpdateScrollbarsForTracks().

◆ sbarScreen

wxInt64 Viewport::sbarScreen { 1 }

private

Definition at line 202 of file Viewport.h.

Referenced by OnScrollRight(), OnScrollRightButton(), SetHorizontalThumb(), and UpdateScrollbarsForTracks().

◆ sbarTotal

wxInt64 Viewport::sbarTotal { 1 }

private

Definition at line 203 of file Viewport.h.

Referenced by OnScrollRight(), OnScrollRightButton(), SetHorizontalThumb(), and UpdateScrollbarsForTracks().

◆ scrollStep

int Viewport::scrollStep { 16 }

private

Definition at line 212 of file Viewport.h.

Referenced by DoScroll(), ScrollToBottom(), ShowTrack(), and UpdateScrollbarsForTracks().

◆ total

double Viewport::total { 1.0 }

private

Definition at line 198 of file Viewport.h.

Referenced by DoScroll(), and UpdateScrollbarsForTracks().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Viewport()

Member Function Documentation

◆ CollapseAllTracks()

◆ DoScroll()

◆ ExpandAllTracks()

◆ FinishAutoScroll()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetZoomOfToFit()

◆ HandleResize()

◆ OnScroll()

◆ OnScrollLeft()

◆ OnScrollLeftButton()

◆ OnScrollRight()

◆ OnScrollRightButton()

◆ OnUndoPushedModified()

◆ OnUndoRedo()

◆ OnUndoReset()

◆ PixelWidthBeforeTime()

◆ Redraw()

◆ ReinitScrollbars()

◆ ScrollingLowerBoundTime()

◆ ScrollIntoView() [1/2]

◆ ScrollIntoView() [2/2]

◆ ScrollToBottom()

◆ ScrollToEnd()

◆ ScrollToStart()

◆ ScrollToTop()

◆ ScrollUpDown()

◆ SetCallbacks()

◆ SetHorizontalThumb()

◆ SetToDefaultSize()

◆ ShowTrack()

◆ UpdateScrollbarsForTracks()

◆ Zoom()

◆ ZoomAboutCenter()

◆ ZoomAboutSelection()

◆ ZoomBy()

◆ ZoomFitHorizontally()

◆ ZoomFitHorizontallyAndShowTrack()

◆ ZoomFitVertically()

Member Data Documentation

◆ mAutoScrolling

◆ mbInitializingScrollbar

◆ mpCallbacks

◆ mProject

◆ mSnappingChangedSubscription

◆ mUndoSubscription

◆ sbarH

◆ sbarScale

◆ sbarScreen

◆ sbarTotal

◆ scrollStep

◆ total