The TrackPanel class coordinates updates and operations on the main part of the screen which contains multiple tracks. More...

#include <TrackPanel.h>

Inheritance diagram for TrackPanel:

[legend]

Collaboration diagram for TrackPanel:

[legend]

Classes
class	AudacityTimer
	Timer class dedicated to informing the TrackPanel that it is time to refresh some aspect of the screen. More...

Public Member Functions
	TrackPanel (wxWindow parent, wxWindowID id, const wxPoint &pos, const wxSize &size, const std::shared_ptr< TrackList > &tracks, ViewInfo viewInfo, AudacityProject project, AdornedRulerPanel ruler)

virtual	~TrackPanel ()

void	UpdatePrefs () override

void	OnAudioIO (AudioIOEvent)

void	OnPaint (wxPaintEvent &event)

void	OnMouseEvent (wxMouseEvent &event)

void	OnKeyDown (wxKeyEvent &event)

void	OnTrackListResizing (const TrackListEvent &event)

void	OnTrackListDeletion ()

void	UpdateViewIfNoTracks ()

double	GetMostRecentXPos ()

void	OnSize (wxSizeEvent &)

void	OnIdle (wxIdleEvent &event)

void	OnTimer (wxTimerEvent &event)
	AS: This gets called on our wx timer events. More...

void	OnSyncLockChange (struct SyncLockChangeMessage)

void	OnTrackFocusChange (struct TrackFocusChangeMessage)

void	OnUndoReset (struct UndoRedoMessage)

void	Refresh (bool eraseBackground=true, const wxRect rect=(const wxRect ) NULL) override

void	RefreshTrack (Track *trk, bool refreshbacking=true)

void	HandlePageUpKey ()

void	HandlePageDownKey ()

AudacityProject *	GetProject () const override

void	OnTrackMenu (Track *t=NULL)

std::shared_ptr< TrackPanelCell >	GetFocusedCell () override

void	SetFocusedCell () override

void	UpdateVRulers ()

void	UpdateVRuler (Track *t)

void	UpdateTrackVRuler (Track &t)

void	UpdateVRulerSize ()

size_t	GetSelectedTrackCount () const

void	MakeParentRedrawScrollbars ()

wxRect	FindTrackRect (const Track *target)

wxRect	FindFocusedTrackRect (const Track *target)

std::vector< wxRect >	FindRulerRects (const Channel &target)

const TrackList *	GetTracks () const

TrackList *	GetTracks ()

ViewInfo *	GetViewInfo ()

AdornedRulerPanel *	GetRuler ()

void	SetBackgroundCell (const std::shared_ptr< CommonTrackPanelCell > &pCell)

std::shared_ptr< CommonTrackPanelCell >	GetBackgroundCell ()

Public Member Functions inherited from CellularPanel
	CellularPanel (wxWindow parent, wxWindowID id, const wxPoint &pos, const wxSize &size, ViewInfo viewInfo, long style=wxTAB_TRAVERSAL\|wxNO_BORDER)

	~CellularPanel () override

virtual AudacityProject *	GetProject () const =0

virtual std::shared_ptr< TrackPanelNode >	Root ()=0

virtual std::shared_ptr< TrackPanelCell >	GetFocusedCell ()=0

virtual void	SetFocusedCell ()=0

virtual void	ProcessUIHandleResult (TrackPanelCell pClickedCell, TrackPanelCell pLatestCell, unsigned refreshResult)=0

virtual void	UpdateStatusMessage (const TranslatableString &)=0

void	Visit (Visitor &visitor)

void	VisitCells (const SimpleCellVisitor &visitor)

void	VisitPreorder (const SimpleNodeVisitor &visitor)

void	VisitPostorder (const SimpleNodeVisitor &visitor)

FoundCell	FindCell (int mouseX, int mouseY)

wxRect	FindRect (const TrackPanelCell &cell)

wxRect	FindRect (const std::function< bool(TrackPanelNode &) > &pred)

UIHandlePtr	Target ()

std::shared_ptr< TrackPanelCell >	LastCell () const

bool	IsMouseCaptured ()
	Determines if a modal tool is active. More...

wxCoord	MostRecentXCoord () const

void	HandleCursorForPresentMouseState (bool doHit=true)

void	Draw (TrackPanelDrawingContext &context, unsigned nPasses)

Public Member Functions inherited from OverlayPanel
	OverlayPanel (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, long style=wxTAB_TRAVERSAL\|wxNO_BORDER)

void	AddOverlay (const std::weak_ptr< Overlay > &pOverlay)

void	ClearOverlays ()

void	DrawOverlays (bool repaint_all, wxDC *pDC=nullptr)

Public Member Functions inherited from BackedPanel
	BackedPanel (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, long style)

	~BackedPanel ()

wxDC &	GetBackingDC ()

wxDC &	GetBackingDCForRepaint ()

void	ResizeBacking ()

void	RepairBitmap (wxDC &dc, wxCoord x, wxCoord y, wxCoord width, wxCoord height)

void	DisplayBitmap (wxDC &dc)

void	OnSize (wxSizeEvent &event)

Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()

	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

void	SetLabel (const TranslatableString &label)

void	SetName (const TranslatableString &name)

void	SetToolTip (const TranslatableString &toolTip)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Public Member Functions inherited from NonKeystrokeInterceptingWindow
virtual	~NonKeystrokeInterceptingWindow ()

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

static const TrackPanel &	Get (const AudacityProject &project)

static void	Destroy (AudacityProject &project)

Protected Member Functions
bool	IsAudioActive ()

void	UpdateSelectionDisplay ()

std::shared_ptr< TrackPanelNode >	Root () override

void	DrawTracks (wxDC *dc)

void	ProcessUIHandleResult (TrackPanelCell pClickedTrack, TrackPanelCell pLatestCell, unsigned refreshResult) override

void	UpdateStatusMessage (const TranslatableString &status) override

Protected Member Functions inherited from CellularPanel
bool	HasEscape ()

bool	CancelDragging (bool escaping)

void	DoContextMenu (std::shared_ptr< TrackPanelCell > pCell)

void	ClearTargets ()

Protected Attributes
Observer::Subscription	mTrackListSubscription

Observer::Subscription	mAudioIOSubscription

Observer::Subscription	mUndoSubscription

Observer::Subscription	mFocusChangeSubscription

Observer::Subscription	mRealtimeEffectManagerSubscription

Observer::Subscription	mSyncLockSubscription

Observer::Subscription	mProjectRulerInvalidatedSubscription

Observer::Subscription	mSelectionSubscription

std::shared_ptr< TrackList >	mTracks

AdornedRulerPanel *	mRuler

std::unique_ptr< TrackArtist >	mTrackArtist

TrackPanel::AudacityTimer	mTimer

int	mTimeCount

bool	mRefreshBacking

SelectedRegion	mLastDrawnSelectedRegion {}

std::shared_ptr< CommonTrackPanelCell >	mpBackground

Protected Attributes inherited from CellularPanel
ViewInfo *	mViewInfo

wxMouseState	mLastMouseState

Additional Inherited Members
Public Types inherited from CellularPanel
using	SimpleCellVisitor = std::function< void(const wxRect &rect, TrackPanelCell &cell) >

using	SimpleNodeVisitor = std::function< void(const wxRect &rect, TrackPanelNode &node) >

Private Member Functions inherited from PrefsListener
	PrefsListener ()

virtual	~PrefsListener ()

virtual void	UpdatePrefs ()=0

virtual void	UpdateSelectedPrefs (int id)

Static Private Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Detailed Description

The TrackPanel class coordinates updates and operations on the main part of the screen which contains multiple tracks.

It uses many other classes, but in particular it uses the TrackInfo class to draw the controls area on the left of a track, and the TrackArtist class to draw the actual waveforms.

Note that in some of the older code here, "Label" means the TrackInfo plus the vertical ruler. Confusing relative to LabelTrack labels.

The TrackPanel manages multiple tracks and their TrackInfos.

Note that with stereo tracks there will be one TrackInfo being used by two wavetracks.

This is a diagram of TrackPanel's division of one (non-stereo) track rectangle. Total height equals ChannelView::GetHeight()'s value. Total width is the wxWindow's width. Each character that is not . represents one pixel.

Inset space of this track, and top inset of the next track, are used to draw the focus highlight.

Top inset of the right channel of a stereo track, and bottom shadow line of the left channel, are used for the channel separator.

"Margin" is a term used for inset plus border (top and left) or inset plus shadow plus border (right and bottom).

GetVRulerOffset() counts columns from the left edge up to and including controls, and is a constant.

GetVRulerWidth() is variable – all tracks have the same ruler width at any time, but that width may be adjusted when tracks change their vertical scales.

GetLeftOffset() counts columns up to and including the VRuler and one more, the "one pixel" column.

Cell for label has a rectangle that OMITS left, top, and bottom margins

Cell for vruler has a rectangle right of the label, up to and including the One Pixel column, and OMITS top and bottom margins

Cell() for track returns a rectangle with x == GetLeftOffset(), and OMITS right, top, and bottom margins

+------------— ... ---— ... ------------------— ... ... ----------—+

Top Inset
+---------— ... ---— ... ------------------— ... ... -------—+

| L|+-Border-— ... ---— ... ------------------— ... ... -Border-+ |R | | e||+-------— ... -++— ... -+++--------------— ... ... ----—+| |i | | f|B| || ||| |BS|g | | t|o| Controls || V |O| The good stuff |oh|h | | |r| || R |n| |ra|t | | I|d| || u |e| |dd| | | n|e| || l | | |eo|I | | s|r| || e |P| |rw|n | | e||| || r |i| ||||s | | t||| || |x| ||||e | | ||| || |e| ||||t | | ||| || |l| |||| | | ||| || ||| |||| |

. ... .. ... .... . . ... .. ... .... . . ... .. ... .... .

| ||| || ||| |||| | | ||+-------— -++– ... -+++--------------— ... ... ----—+||| | | |+-Border-— ... --— ... ------------------— ... ... -Border-+|| | | | Shadow-— ... --— ... ------------------— ... ... –Shadow-+| |

Definition at line 59 of file TrackPanel.h.

Constructor & Destructor Documentation

◆ TrackPanel()

TrackPanel::TrackPanel	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos,
		const wxSize &	size,
		const std::shared_ptr< TrackList > &	tracks,
		ViewInfo *	viewInfo,
		AudacityProject *	project,
		AdornedRulerPanel *	ruler
	)

Definition at line 257 of file TrackPanel.cpp.

   : CellularPanel(parent, id, pos, size, viewInfo,
                   wxWANTS_CHARS | wxNO_BORDER),
     mTracks(tracks),
     mRuler(ruler),
     mTrackArtist(nullptr),
     mRefreshBacking(false)
#ifndef __WXGTK__   //Get rid if this pragma for gtk
#pragma warning( default: 4355 )
#endif
{
   SetLayoutDirection(wxLayout_LeftToRight);
   SetLabel(XO("Track Panel"));
   SetName(XO("Track Panel"));
   SetBackgroundStyle(wxBG_STYLE_PAINT);
 
#if wxUSE_ACCESSIBILITY
   // Inject finder of track rectangles into the accessibility helper
   {
      const auto finder = [
         weakThis = wxWeakRef<TrackPanel>{ this }
      ] (const Track &track) -> wxRect {
         if (weakThis)
            return weakThis->FindTrackRect(&track);
         return {};
      };
      auto &focus = TrackFocus::Get(*GetProject());
      auto &viewport = Viewport::Get(*GetProject());
      TrackPanelAx *pAx{};
      SetAccessible(pAx =
         safenew TrackPanelAx{
            viewport.weak_from_this(), focus.weak_from_this(), finder });
      focus.SetCallbacks(std::make_unique<TrackPanelAx::Adapter>(pAx));
   }
#endif
 
   mTrackArtist = std::make_unique<TrackArtist>( this );
 
   mTimeCount = 0;
   mTimer.parent = this;
   // Timer is started after the window is visible
   ProjectWindow::Get( *GetProject() ).Bind(wxEVT_IDLE,
      &TrackPanel::OnIdle, this);
 
   // Register for tracklist updates
   mTrackListSubscription = PendingTracks::Get(*GetProject())
   .Subscribe([this](const TrackListEvent &event){
      switch (event.mType) {
      case TrackListEvent::RESIZING:
      case TrackListEvent::ADDITION:
         OnTrackListResizing(event); break;
      case TrackListEvent::DELETION:
         OnTrackListDeletion(); break;
      default:
         break;
      }
   });
 
   auto theProject = GetProject();
   mSyncLockSubscription = SyncLockState::Get(*theProject)
      .Subscribe(*this, &TrackPanel::OnSyncLockChange);
 
   mFocusChangeSubscription = TrackFocus::Get(*theProject)
      .Subscribe(*this, &TrackPanel::OnTrackFocusChange);
 
   mUndoSubscription = UndoManager::Get(*theProject)
      .Subscribe(*this, &TrackPanel::OnUndoReset);
 
   mAudioIOSubscription =
      AudioIO::Get()->Subscribe(*this, &TrackPanel::OnAudioIO);
 
   mRealtimeEffectManagerSubscription = RealtimeEffectManager::Get(*theProject)
      .Subscribe([this](const RealtimeEffectManagerMessage& msg)
      {
         if (auto pTrack = dynamic_cast<Track *>(msg.group))
            //update "effects" button
            RefreshTrack(pTrack);
      });
 
   mProjectRulerInvalidatedSubscription =
      ProjectTimeRuler::Get(*theProject).GetRuler().Subscribe([this](auto mode) { Refresh(); });
   mSelectionSubscription = viewInfo->selectedRegion
      .Subscribe([this](auto&){ Refresh(false); });
 
   UpdatePrefs();
}

References anonymous_namespace{Scrubbing.cpp}::finder, AudioIO::Get(), TrackFocus::Get(), UndoManager::Get(), RealtimeEffectManager::Get(), SyncLockState::Get(), PendingTracks::Get(), Viewport::Get(), ProjectTimeRuler::Get(), ProjectWindow::Get(), GetProject(), ProjectTimeRuler::GetRuler(), RealtimeEffectManagerMessage::group, mAudioIOSubscription, mFocusChangeSubscription, mProjectRulerInvalidatedSubscription, mRealtimeEffectManagerSubscription, mSelectionSubscription, mSyncLockSubscription, mTimeCount, mTimer, mTrackArtist, mTrackListSubscription, TrackListEvent::mType, mUndoSubscription, OnAudioIO(), OnIdle(), OnSyncLockChange(), OnTrackFocusChange(), OnUndoReset(), TrackPanel::AudacityTimer::parent, Refresh(), RefreshTrack(), safenew, ViewInfo::selectedRegion, wxPanelWrapper::SetLabel(), wxPanelWrapper::SetName(), Observer::Publisher< Message, NotifyAll >::Subscribe(), UpdatePrefs(), and XO().

Here is the call graph for this function:

◆ ~TrackPanel()

TrackPanel::~TrackPanel ( )

virtual

Definition at line 351 of file TrackPanel.cpp.

{
   mTimer.Stop();
 
   // This can happen if a label is being edited and the user presses
   // ALT+F4 or Command+Q
   if (HasCapture())
      ReleaseMouse();
}

References mTimer.

Member Function Documentation

◆ Destroy()

void TrackPanel::Destroy ( AudacityProject & project )

static

Definition at line 244 of file TrackPanel.cpp.

{
   auto *pPanel = GetAttachedWindows(project).Find<TrackPanel>( sKey );
   if (pPanel) {
      pPanel->wxWindow::Destroy();
      GetAttachedWindows(project).Assign(sKey, nullptr);
   }
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Assign(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Find(), GetAttachedWindows(), project, and anonymous_namespace{TrackPanel.cpp}::sKey.

Referenced by ProjectManager::OnCloseWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawTracks()

void TrackPanel::DrawTracks ( wxDC * dc )

protected

Draw the actual track areas. We only draw the borders and the little buttons and menues and whatnot here, the actual contents of each track are drawn by the TrackArtist.

Definition at line 838 of file TrackPanel.cpp.

{
   wxRegion region = GetUpdateRegion();
 
   const wxRect clip = GetRect();
 
   const SelectedRegion &sr = mViewInfo->selectedRegion;
   mTrackArtist->pSelectedRegion = &sr;
   const auto &pendingTracks = PendingTracks::Get(*GetProject());
   mTrackArtist->pPendingTracks = &pendingTracks;
   mTrackArtist->pZoomInfo = mViewInfo;
   TrackPanelDrawingContext context {
      *dc, Target(), mLastMouseState, mTrackArtist.get()
   };
 
   // Don't draw a bottom margin here.
 
   const auto &settings = ProjectSettings::Get( *GetProject() );
   bool bMultiToolDown =
      (ToolCodes::multiTool == settings.GetTool());
   bool envelopeFlag   =
      bMultiToolDown || (ToolCodes::envelopeTool == settings.GetTool());
   bool bigPointsFlag  =
      bMultiToolDown || (ToolCodes::drawTool == settings.GetTool());
   bool sliderFlag     = bMultiToolDown;
   bool brushFlag   = false;
#ifdef EXPERIMENTAL_BRUSH_TOOL
   brushFlag   = (ToolCodes::brushTool == settings.GetTool());
#endif
 
   const bool hasSolo = GetTracks()->Any<PlayableTrack>()
      .any_of( [&](const PlayableTrack *pt) {
         pt = static_cast<const PlayableTrack *>(
            &pendingTracks.SubstitutePendingChangedTrack(*pt));
         return pt->GetSolo();
      } );
 
   mTrackArtist->drawEnvelope = envelopeFlag;
   mTrackArtist->bigPoints = bigPointsFlag;
   mTrackArtist->drawSliders = sliderFlag;
   mTrackArtist->onBrushTool = brushFlag;
   mTrackArtist->hasSolo = hasSolo;
 
   this->CellularPanel::Draw( context, TrackArtist::NPasses );
}

References TrackList::Any(), CellularPanel::Draw(), ToolCodes::drawTool, ToolCodes::envelopeTool, PendingTracks::Get(), ProjectSettings::Get(), GetProject(), PlayableTrack::GetSolo(), GetTracks(), CellularPanel::mLastMouseState, mTrackArtist, ToolCodes::multiTool, CellularPanel::mViewInfo, TrackArtist::NPasses, ViewInfo::selectedRegion, settings(), and CellularPanel::Target().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindFocusedTrackRect()

wxRect TrackPanel::FindFocusedTrackRect ( const Track * target )

Returns: includes what's in FindTrackRect(target) and the focus ring area around it. If target is nullptr, returns empty rectangle.

Definition at line 1508 of file TrackPanel.cpp.

{
   auto rect = FindTrackRect(target);
   if (rect != wxRect{}) {
      // Enlarge horizontally.
      // PRL:  perhaps it's one pixel too much each side, including some gray
      // beyond the yellow?
      rect.x = 0;
      GetClientSize(&rect.width, nullptr);
 
      // Enlarge vertically, enough to enclose the yellow focus border pixels
      // The the outermost ring of gray pixels is included on three sides
      // but not the top (should that be fixed?)
 
      // (Note that TrackPanel paints its focus over the "top margin" of the
      // rectangle allotted to the track, according to ChannelView::GetY() and
      // ChannelView::GetHeight(), but also over the margin of the next track.)
 
      rect.height += kBottomMargin;
      int dy = kTopMargin - 1;
      rect.Inflate( 0, dy );
 
      // Note that this rectangle does not coincide with any one of
      // the nodes in the subdivision.
   }
   return rect;
}

References FindTrackRect(), kBottomMargin, and kTopMargin.

Here is the call graph for this function:

◆ FindRulerRects()

std::vector< wxRect > TrackPanel::FindRulerRects ( const Channel & target )

Returns: extents of the vertical rulers of one channel, top to bottom. (There may be multiple sub-views, each with a ruler.) If target is nullptr, returns an empty vector.

Definition at line 1536 of file TrackPanel.cpp.

{
   std::vector<wxRect> results;
   VisitCells( [&](const wxRect &rect, TrackPanelCell &visited) {
      if (auto pRuler = dynamic_cast<const ChannelVRulerControls*>(&visited))
         if (auto pView = pRuler->GetChannelView())
            if (pView->FindChannel().get() == &target)
               results.push_back(rect);
   } );
   return results;
}

References CellularPanel::VisitCells().

Here is the call graph for this function:

◆ FindTrackRect()

wxRect TrackPanel::FindTrackRect ( const Track * target )

Returns: includes track control panel, and the vertical ruler, and the proper track area of all channels, and the separators between them. If target is nullptr, returns empty rectangle.

Definition at line 1499 of file TrackPanel.cpp.

{
   return CellularPanel::FindRect( [&] ( TrackPanelNode &node ) {
      if (auto pGroup = dynamic_cast<const LabeledChannelGroup*>( &node ))
         return pGroup->mpTrack.get() == target;
      return false;
   } );
}

References CellularPanel::FindRect().

Referenced by FindFocusedTrackRect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

TrackPanel & TrackPanel::Get ( AudacityProject & project )

static

Definition at line 234 of file TrackPanel.cpp.

{
   return GetAttachedWindows(project).Get< TrackPanel >( sKey );
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), GetAttachedWindows(), project, and anonymous_namespace{TrackPanel.cpp}::sKey.

Here is the call graph for this function:

◆ Get() [2/2]

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

static

Definition at line 239 of file TrackPanel.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ GetBackgroundCell()

std::shared_ptr< CommonTrackPanelCell > TrackPanel::GetBackgroundCell ( )

Definition at line 890 of file TrackPanel.cpp.

{
   return mpBackground;
}

References mpBackground.

Referenced by GetFocusedCell().

Here is the caller graph for this function:

◆ GetFocusedCell()

std::shared_ptr< TrackPanelCell > TrackPanel::GetFocusedCell ( )

overridevirtual

Implements CellularPanel.

Definition at line 1548 of file TrackPanel.cpp.

{
   auto pTrack = TrackFocus::Get(*GetProject()).Get();
   return pTrack
      ? ChannelView::Get(*pTrack->GetChannel(0)).shared_from_this()
      : GetBackgroundCell();
}

References TrackFocus::Get(), ChannelView::Get(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), GetBackgroundCell(), and GetProject().

Referenced by OnTrackFocusChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMostRecentXPos()

double TrackPanel::GetMostRecentXPos ( )

Definition at line 762 of file TrackPanel.cpp.

{
   return mViewInfo->PositionToTime(
      MostRecentXCoord(), mViewInfo->GetLeftOffset());
}

References ZoomInfo::GetLeftOffset(), CellularPanel::MostRecentXCoord(), CellularPanel::mViewInfo, and ZoomInfo::PositionToTime().

Here is the call graph for this function:

◆ GetProject()

AudacityProject * TrackPanel::GetProject ( ) const

overridevirtual

Gets the pointer to the AudacityProject that goes with this track panel.

Implements CellularPanel.

Definition at line 372 of file TrackPanel.cpp.

{
   auto window = GetParent();
 
   while(window != nullptr)
   {
      if(const auto projectWindow = dynamic_cast<ProjectWindow*>(window))
         return projectWindow->FindProject().get();
 
      window = window->GetParent();
   }
   return nullptr;
}

Referenced by DrawTracks(), GetFocusedCell(), HandlePageDownKey(), HandlePageUpKey(), IsAudioActive(), MakeParentRedrawScrollbars(), OnIdle(), OnMouseEvent(), OnTimer(), OnTrackListDeletion(), OnUndoReset(), ProcessUIHandleResult(), Refresh(), SetFocusedCell(), TrackPanel(), UpdateStatusMessage(), and UpdateViewIfNoTracks().

Here is the caller graph for this function:

◆ GetRuler()

AdornedRulerPanel * TrackPanel::GetRuler ( )

inline

Definition at line 166 of file TrackPanel.h.

166{ return mRuler;}

◆ GetSelectedTrackCount()

size_t TrackPanel::GetSelectedTrackCount ( ) const

Definition at line 655 of file TrackPanel.cpp.

{
   return GetTracks()->Selected().size();
}

References GetTracks(), and TrackList::Selected().

Here is the call graph for this function:

◆ GetTracks() [1/2]

TrackList * TrackPanel::GetTracks ( )

inline

Definition at line 164 of file TrackPanel.h.

164{ return mTracks.get(); }

◆ GetTracks() [2/2]

const TrackList * TrackPanel::GetTracks ( ) const

inline

Definition at line 163 of file TrackPanel.h.

163{ return mTracks.get(); }

Referenced by DrawTracks(), GetSelectedTrackCount(), ProcessUIHandleResult(), UpdateVRulers(), and UpdateVRulerSize().

Here is the caller graph for this function:

◆ GetViewInfo()

ViewInfo * TrackPanel::GetViewInfo ( )

inline

Definition at line 165 of file TrackPanel.h.

165{ return mViewInfo;}

References CellularPanel::mViewInfo.

◆ HandlePageDownKey()

void TrackPanel::HandlePageDownKey ( )

Definition at line 623 of file TrackPanel.cpp.

{
   Viewport::Get(*GetProject())
      .SetHorizontalThumb(mViewInfo->GetScreenEndTime());
}

References Viewport::Get(), GetProject(), ZoomInfo::GetScreenEndTime(), CellularPanel::mViewInfo, and Viewport::SetHorizontalThumb().

Referenced by OnKeyDown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandlePageUpKey()

void TrackPanel::HandlePageUpKey ( )

Definition at line 617 of file TrackPanel.cpp.

{
   Viewport::Get(*GetProject())
      .SetHorizontalThumb(2 * mViewInfo->hpos - mViewInfo->GetScreenEndTime());
}

References Viewport::Get(), GetProject(), ZoomInfo::GetScreenEndTime(), ZoomInfo::hpos, CellularPanel::mViewInfo, and Viewport::SetHorizontalThumb().

Referenced by OnKeyDown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsAudioActive()

bool TrackPanel::IsAudioActive ( )

protected

Definition at line 629 of file TrackPanel.cpp.

{
   AudacityProject *p = GetProject();
   return ProjectAudioIO::Get( *p ).IsAudioActive();
}

References ProjectAudioIO::Get(), GetProject(), and ProjectAudioIO::IsAudioActive().

Referenced by OnTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeParentRedrawScrollbars()

void TrackPanel::MakeParentRedrawScrollbars ( )

Definition at line 532 of file TrackPanel.cpp.

{
   Viewport::Get(*GetProject()).UpdateScrollbarsForTracks();
}

References Viewport::Get(), GetProject(), and Viewport::UpdateScrollbarsForTracks().

Referenced by OnTrackListResizing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnAudioIO()

void TrackPanel::OnAudioIO ( AudioIOEvent evt )

Definition at line 825 of file TrackPanel.cpp.

{
   if (evt.type == AudioIOEvent::MONITOR || evt.type == AudioIOEvent::PAUSE)
      return;
   // Some hit tests want to change their cursor to and from the ban symbol
   CallAfter( [this]{ CellularPanel::HandleCursorForPresentMouseState(); } );
}

References BasicUI::CallAfter(), CellularPanel::HandleCursorForPresentMouseState(), AudioIOEvent::MONITOR, AudioIOEvent::PAUSE, and AudioIOEvent::type.

Referenced by TrackPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnIdle()

void TrackPanel::OnIdle ( wxIdleEvent & event )

Definition at line 394 of file TrackPanel.cpp.

{
   event.Skip();
   // The window must be ready when the timer fires (#1401)
   if (IsShownOnScreen())
   {
      mTimer.Start(std::chrono::milliseconds{kTimerInterval}.count(), FALSE);
 
      // Timer is started, we don't need the event anymore
      GetProjectFrame( *GetProject() ).Unbind(wxEVT_IDLE,
         &TrackPanel::OnIdle, this);
   }
   else
   {
      // Get another idle event, wx only guarantees we get one
      // event after "some other normal events occur"
      event.RequestMore();
   }
}

References GetProject(), GetProjectFrame(), kTimerInterval, mTimer, and OnIdle().

Referenced by OnIdle(), and TrackPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnKeyDown()

void TrackPanel::OnKeyDown ( wxKeyEvent & event )

Definition at line 712 of file TrackPanel.cpp.

{
   switch (event.GetKeyCode())
   {
      // Allow PageUp and PageDown keys to
      //scroll the Track Panel left and right
   case WXK_PAGEUP:
      HandlePageUpKey();
      return;
 
   case WXK_PAGEDOWN:
      HandlePageDownKey();
      return;
 
   default:
      // fall through to base class handler
      event.Skip();
   }
}

References HandlePageDownKey(), and HandlePageUpKey().

Here is the call graph for this function:

◆ OnMouseEvent()

void TrackPanel::OnMouseEvent ( wxMouseEvent & event )

Definition at line 732 of file TrackPanel.cpp.

{
   if (event.LeftDown()) {
      // wxTimers seem to be a little unreliable, so this
      // "primes" it to make sure it keeps going for a while...
 
      // When this timer fires, we call TrackPanel::OnTimer and
      // possibly update the screen for offscreen scrolling.
      mTimer.Stop();
      mTimer.Start(std::chrono::milliseconds{kTimerInterval}.count(), FALSE);
   }
 
 
   if (event.ButtonUp()) {
      //ShowTrack should be called after processing the up-click.
      this->CallAfter( [this, event]{
         const auto foundCell = FindCell(event.m_x, event.m_y);
         const auto t = FindTrack( foundCell.pCell.get() );
         if (t) {
            auto &focus = TrackFocus::Get(*GetProject());
            focus.Set(t.get());
            Viewport::Get(*GetProject()).ShowTrack(*t);
         }
      } );
   }
 
   // Must also fall through to base class handler
   event.Skip();
}

References BasicUI::CallAfter(), CellularPanel::FindCell(), anonymous_namespace{TrackPanel.cpp}::FindTrack(), TrackFocus::Get(), Viewport::Get(), GetProject(), kTimerInterval, mTimer, and Viewport::ShowTrack().

Here is the call graph for this function:

◆ OnPaint()

void TrackPanel::OnPaint ( wxPaintEvent & event )

AS: OnPaint( ) is called during the normal course of completing a repaint operation.

Definition at line 483 of file TrackPanel.cpp.

{
   // If the selected region changes - we must repaint the tracks, because the
   // selection is baked into track image
   if (mLastDrawnSelectedRegion != mViewInfo->selectedRegion)
   {
      mRefreshBacking = true;
      mLastDrawnSelectedRegion = mViewInfo->selectedRegion;
   }
 
   auto sw =
      FrameStatistics::CreateStopwatch(FrameStatistics::SectionID::TrackPanel);
 
   {
      wxPaintDC dc(this);
 
      // Retrieve the damage rectangle
      wxRect box = GetUpdateRegion().GetBox();
 
      // Recreate the backing bitmap if we have a full refresh
      // (See TrackPanel::Refresh())
      if (mRefreshBacking || (box == GetRect()))
      {
         // Reset (should a mutex be used???)
         mRefreshBacking = false;
 
         // Redraw the backing bitmap
         DrawTracks(&GetBackingDCForRepaint());
 
         // Copy it to the display
         DisplayBitmap(dc);
      }
      else
      {
         // Copy full, possibly clipped, damage rectangle
         RepairBitmap(dc, box.x, box.y, box.width, box.height);
      }
 
      // Done with the clipped DC
 
      // Drawing now goes directly to the client area.
      // DrawOverlays() may need to draw outside the clipped region.
      // (Used to make a NEW, separate wxClientDC, but that risks flashing
      // problems on Mac.)
      dc.DestroyClippingRegion();
      DrawOverlays(true, &dc);
   }
}

References FrameStatistics::CreateStopwatch(), BackedPanel::DisplayBitmap(), OverlayPanel::DrawOverlays(), DrawTracks(), BackedPanel::GetBackingDCForRepaint(), mLastDrawnSelectedRegion, mRefreshBacking, CellularPanel::mViewInfo, BackedPanel::RepairBitmap(), ViewInfo::selectedRegion, and FrameStatistics::TrackPanel.

Here is the call graph for this function:

◆ OnSize()

void TrackPanel::OnSize ( wxSizeEvent & evt )

Definition at line 386 of file TrackPanel.cpp.

{
   evt.Skip();
   const auto &size = evt.GetSize();
   mViewInfo->SetWidth( size.GetWidth() );
   mViewInfo->SetHeight( size.GetHeight() );
}

References CellularPanel::mViewInfo, ViewInfo::SetHeight(), ZoomInfo::SetWidth(), and size.

Here is the call graph for this function:

◆ OnSyncLockChange()

void TrackPanel::OnSyncLockChange ( struct SyncLockChangeMessage )

Definition at line 468 of file TrackPanel.cpp.

{
   Refresh(false);
}

References Refresh().

Referenced by TrackPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnTimer()

void TrackPanel::OnTimer ( wxTimerEvent & event )

AS: This gets called on our wx timer events.

Definition at line 415 of file TrackPanel.cpp.

{
   mTimeCount++;
 
   AudacityProject *const p = GetProject();
   auto &window = ProjectWindow::Get( *p );
   auto &viewport = Viewport::Get(*p);
 
   auto &projectAudioIO = ProjectAudioIO::Get( *p );
   auto gAudioIO = AudioIO::Get();
 
   // Check whether we were playing or recording, but the stream has stopped.
   if (projectAudioIO.GetAudioIOToken()>0 && !IsAudioActive())
   {
      //the stream may have been started up after this one finished (by some other project)
      //in that case reset the buttons don't stop the stream
      auto &projectAudioManager = ProjectAudioManager::Get( *p );
      projectAudioManager.Stop(!gAudioIO->IsStreamActive());
   }
 
   // Next, check to see if we were playing or recording
   // audio, but now Audio I/O is completely finished.
   if (projectAudioIO.GetAudioIOToken()>0 &&
         !gAudioIO->IsAudioTokenActive(projectAudioIO.GetAudioIOToken()))
   {
      projectAudioIO.SetAudioIOToken(0);
      viewport.Redraw();
   }
   if (mLastDrawnSelectedRegion != mViewInfo->selectedRegion) {
      UpdateSelectionDisplay();
   }
 
   // Notify listeners for timer ticks
   window.GetPlaybackScroller().OnTimer();
 
   DrawOverlays(false);
   mRuler->DrawOverlays(false);
 
   if(IsAudioActive() && gAudioIO->GetNumCaptureChannels()) {
 
      // Periodically update the display while recording
 
      if ((mTimeCount % 5) == 0) {
         // Must tell OnPaint() to recreate the backing bitmap
         // since we've not done a full refresh.
         mRefreshBacking = true;
         Refresh( false );
      }
   }
   if(mTimeCount > 1000)
      mTimeCount = 0;
}

References OverlayPanel::DrawOverlays(), AudioIO::Get(), ProjectAudioIO::Get(), Viewport::Get(), ProjectAudioManager::Get(), ProjectWindow::Get(), GetProject(), IsAudioActive(), mLastDrawnSelectedRegion, mRefreshBacking, mRuler, mTimeCount, CellularPanel::mViewInfo, Refresh(), ViewInfo::selectedRegion, and UpdateSelectionDisplay().

Here is the call graph for this function:

◆ OnTrackFocusChange()

void TrackPanel::OnTrackFocusChange ( struct TrackFocusChangeMessage message )

Definition at line 1564 of file TrackPanel.cpp.

{
   if (message.focusPanel)
      SetFocus();
   if (auto cell = GetFocusedCell())
      Refresh(false);
}

References TrackFocusChangeMessage::focusPanel, GetFocusedCell(), Refresh(), and BasicUI::SetFocus().

Referenced by TrackPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnTrackListDeletion()

void TrackPanel::OnTrackListDeletion ( )

Definition at line 697 of file TrackPanel.cpp.

{
   // copy shared_ptr for safety, as in HandleClick
   auto handle = Target();
   if (handle) {
      handle->OnProjectChange(GetProject());
   }
 
   // If the focused track disappeared but there are still other tracks,
   // this reassigns focus.
   TrackFocus( *GetProject() ).Get();
 
   UpdateVRulerSize();
}

References TrackFocus::Get(), GetProject(), CellularPanel::Target(), and UpdateVRulerSize().

Here is the call graph for this function:

◆ OnTrackListResizing()

void TrackPanel::OnTrackListResizing ( const TrackListEvent & event )

Definition at line 684 of file TrackPanel.cpp.

{
   auto t = e.mpTrack.lock();
   // A deleted track can trigger the event.  In which case do nothing here.
   // A deleted track can have a valid pointer but no owner, bug 2060
   if( t && t->HasOwner() )
      UpdateVRuler(t.get());
 
   // fix for bug 2477
   MakeParentRedrawScrollbars();
}

References MakeParentRedrawScrollbars(), TrackListEvent::mpTrack, and UpdateVRuler().

Here is the call graph for this function:

◆ OnTrackMenu()

void TrackPanel::OnTrackMenu ( Track * t = NULL )

Definition at line 1017 of file TrackPanel.cpp.

{
   CellularPanel::DoContextMenu(
      t ? ChannelView::Get(*t->GetChannel(0)).shared_from_this() : nullptr);
}

References CellularPanel::DoContextMenu(), ChannelView::Get(), and ChannelGroup::GetChannel().

Here is the call graph for this function:

◆ OnUndoReset()

void TrackPanel::OnUndoReset ( struct UndoRedoMessage message )

Definition at line 473 of file TrackPanel.cpp.

{
   if (message.type == UndoRedoMessage::Reset) {
      TrackFocus::Get( *GetProject() ).Set( nullptr );
      Refresh( false );
   }
}

References TrackFocus::Get(), GetProject(), Refresh(), UndoRedoMessage::Reset, and UndoRedoMessage::type.

Referenced by TrackPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessUIHandleResult()

void TrackPanel::ProcessUIHandleResult	(	TrackPanelCell *	pClickedTrack,
		TrackPanelCell *	pLatestCell,
		unsigned	refreshResult
	)

overrideprotectedvirtual

Implements CellularPanel.

Definition at line 549 of file TrackPanel.cpp.

{
   const auto panel = this;
   auto pLatestTrack = FindTrack( pLatestCell ).get();
 
   // This precaution checks that the track is not only nonnull, but also
   // really owned by the track list
   auto pClickedTrack = GetTracks()->Lock(
      std::weak_ptr<Track>{ FindTrack( pClickedCell ) }
   ).get();
 
   // TODO:  make a finer distinction between refreshing the track control area,
   // and the waveform area.  As it is, redraw both whenever you must redraw either.
 
   // Copy data from the underlying tracks to the pending tracks that are
   // really displayed
   PendingTracks::Get(*panel->GetProject()).UpdatePendingTracks();
 
   using namespace RefreshCode;
 
   if (refreshResult & DestroyedCell) {
      panel->UpdateViewIfNoTracks();
      // Beware stale pointer!
      if (pLatestTrack == pClickedTrack)
         pLatestTrack = nullptr;
      pClickedTrack = nullptr;
   }
 
   if (pClickedTrack && (refreshResult & RefreshCode::UpdateVRuler))
      panel->UpdateVRuler(pClickedTrack);
 
   if (refreshResult & RefreshCode::DrawOverlays) {
      panel->DrawOverlays(false);
      mRuler->DrawOverlays(false);
   }
 
   // Refresh all if told to do so, or if told to refresh a track that
   // is not known.
   const bool refreshAll =
      (    (refreshResult & RefreshAll)
       || ((refreshResult & RefreshCell) && !pClickedTrack)
       || ((refreshResult & RefreshLatestCell) && !pLatestTrack));
 
   if (refreshAll)
      panel->Refresh(false);
   else {
      if (refreshResult & RefreshCell)
         panel->RefreshTrack(pClickedTrack);
      if (refreshResult & RefreshLatestCell)
         panel->RefreshTrack(pLatestTrack);
   }
 
   if (refreshResult & FixScrollbars)
      panel->MakeParentRedrawScrollbars();
 
   if (refreshResult & Resize)
      Viewport::Get(*GetProject()).HandleResize();
 
   if ((refreshResult & RefreshCode::EnsureVisible) && pClickedTrack) {
      auto & focus = TrackFocus::Get(*GetProject());
      focus.Set(pClickedTrack);
      if (const auto pFocus = focus.Get())
         Viewport::Get(*GetProject()).ShowTrack(*pFocus);
   }
}

References RefreshCode::DestroyedCell, RefreshCode::DrawOverlays, OverlayPanel::DrawOverlays(), RefreshCode::EnsureVisible, anonymous_namespace{TrackPanel.cpp}::FindTrack(), RefreshCode::FixScrollbars, TrackFocus::Get(), PendingTracks::Get(), Viewport::Get(), GetProject(), GetTracks(), Viewport::HandleResize(), TrackList::Lock(), mRuler, RefreshCode::RefreshAll, RefreshCode::RefreshCell, RefreshCode::RefreshLatestCell, RefreshCode::Resize, Viewport::ShowTrack(), PendingTracks::UpdatePendingTracks(), and RefreshCode::UpdateVRuler.

Here is the call graph for this function:

◆ Refresh()

void TrackPanel::Refresh	(	bool	eraseBackground = `true`,
		const wxRect *	rect = `(const wxRect *) NULL`
	)

override

This method overrides Refresh() of wxWindow so that the boolean play indicator can be set to false, so that an old play indicator that is no longer there won't get XORed (to erase it), thus redrawing it on the TrackPanel

Definition at line 802 of file TrackPanel.cpp.

{
   // Tell OnPaint() to refresh the backing bitmap.
   //
   // Originally I had the check within the OnPaint() routine and it
   // was working fine.  That was until I found that, even though a full
   // refresh was requested, Windows only set the onscreen portion of a
   // window as damaged.
   //
   // So, if any part of the trackpanel was off the screen, full refreshes
   // didn't work and the display got corrupted.
   if( !rect || ( *rect == GetRect() ) )
   {
      mRefreshBacking = true;
   }
   wxWindow::Refresh(eraseBackground, rect);
 
   CallAfter([this]{
      if (GetProject())
         CellularPanel::HandleCursorForPresentMouseState(); } );
}

References BasicUI::CallAfter(), GetProject(), CellularPanel::HandleCursorForPresentMouseState(), and mRefreshBacking.

Referenced by OnSyncLockChange(), SelectHandle::TimerHandler::OnTimer(), OnTimer(), OnTrackFocusChange(), OnUndoReset(), RefreshTrack(), anonymous_namespace{ToolsToolBar.cpp}::SetTool(), TrackPanel(), UpdatePrefs(), UpdateSelectionDisplay(), and UpdateVRulerSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RefreshTrack()

void TrackPanel::RefreshTrack	(	Track *	trk,
		bool	refreshbacking = `true`
	)

Definition at line 768 of file TrackPanel.cpp.

{
   if (!trk)
      return;
 
   auto height = ChannelView::GetChannelGroupHeight(trk);
 
   // Set rectangle top according to the scrolling position, `vpos`
   // Subtract the inset (above) and shadow (below) from the height of the
   // rectangle, but not the border
   // This matters because some separators do paint over the border
   auto &view = ChannelView::Get(*trk->GetChannel(0));
   const auto top =
      -mViewInfo->vpos + view.GetCumulativeHeightBefore() + kTopInset;
   height -= (kTopInset + kShadowThickness);
 
   // Width also subtracts insets (left and right) plus shadow (right)
   const auto left = kLeftInset;
   const auto width = GetRect().GetWidth()
      - (kLeftInset + kRightInset + kShadowThickness);
 
   wxRect rect(left, top, width, height);
 
   if( refreshbacking )
      mRefreshBacking = true;
 
   Refresh( false, &rect );
}

References ChannelView::Get(), ChannelGroup::GetChannel(), ChannelView::GetChannelGroupHeight(), kLeftInset, kRightInset, kShadowThickness, kTopInset, mRefreshBacking, CellularPanel::mViewInfo, Refresh(), and ViewInfo::vpos.

Referenced by MixerTrackCluster::HandleSliderGain(), MixerTrackCluster::HandleSliderPan(), MixerTrackCluster::HandleSliderVelocity(), MixerTrackCluster::OnButton_Mute(), anonymous_namespace{WaveTrackAffordanceControls.cpp}::OnEditClipName(), PitchAndSpeedDialog::SetSemitoneShift(), anonymous_namespace{TrackMenus.cpp}::SetTrackGain(), anonymous_namespace{TrackMenus.cpp}::SetTrackPan(), and TrackPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Root()

std::shared_ptr< TrackPanelNode > TrackPanel::Root ( )

overrideprotectedvirtual

Implements CellularPanel.

Definition at line 1487 of file TrackPanel.cpp.

{
   // Root and other subgroup objects are throwaways.
   // They might instead be cached to avoid repeated allocation.
   // That cache would need invalidation when there is addition, deletion, or
   // permutation of tracks, or change of width of the vertical rulers.
   return std::make_shared< MainGroup >( *this );
}

◆ SetBackgroundCell()

void TrackPanel::SetBackgroundCell ( const std::shared_ptr< CommonTrackPanelCell > & pCell )

Definition at line 884 of file TrackPanel.cpp.

{
   mpBackground = pCell;
}

References mpBackground.

◆ SetFocusedCell()

void TrackPanel::SetFocusedCell ( )

overridevirtual

Implements CellularPanel.

Definition at line 1556 of file TrackPanel.cpp.

{
   // This may have a side-effect of assigning a focus if there was none
   auto& trackFocus = TrackFocus::Get(*GetProject());
   trackFocus.Set(trackFocus.Get());
   KeyboardCapture::Capture(this);
}

References KeyboardCapture::Capture(), TrackFocus::Get(), and GetProject().

Here is the call graph for this function:

◆ UpdatePrefs()

void TrackPanel::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 361 of file TrackPanel.cpp.

{
   // All vertical rulers must be recalculated since the minimum and maximum
   // frequencies may have been changed.
   UpdateVRulers();
 
   Refresh();
}

References Refresh(), and UpdateVRulers().

Referenced by TrackPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateSelectionDisplay()

void TrackPanel::UpdateSelectionDisplay ( )

protected

Definition at line 644 of file TrackPanel.cpp.

{
   // Full refresh since the label area may need to indicate
   // newly selected tracks.
   Refresh(false);
 
   // Make sure the ruler follows suit.
   mRuler->DrawSelection();
}

References AdornedRulerPanel::DrawSelection(), mRuler, and Refresh().

Referenced by OnTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateStatusMessage()

void TrackPanel::UpdateStatusMessage ( const TranslatableString & status )

overrideprotectedvirtual

Implements CellularPanel.

Definition at line 635 of file TrackPanel.cpp.

{
   auto status = st;
   if (HasEscape())
      /* i18n-hint Esc is a key on the keyboard */
      status.Join( XO("(Esc to cancel)"), " " );
   ProjectStatus::Get( *GetProject() ).Set( status );
}

References ProjectStatus::Get(), GetProject(), CellularPanel::HasEscape(), TranslatableString::Join(), ProjectStatus::Set(), and XO().

Here is the call graph for this function:

◆ UpdateTrackVRuler()

void TrackPanel::UpdateTrackVRuler ( Track & t )

Definition at line 957 of file TrackPanel.cpp.

{
   auto heights = FindAdjustedChannelHeights(t);
 
   wxRect rect(mViewInfo->GetVRulerOffset(),
            0,
            mViewInfo->GetVRulerWidth(),
            0);
 
   auto pHeight = heights.begin();
   for (auto pChannel : t.Channels()) {
      auto &view = ChannelView::Get(*pChannel);
      const auto height = *pHeight++;
      rect.SetHeight(height);
      const auto subViews = view.GetSubViews(rect);
      if (subViews.empty())
         continue;
 
      auto iter = subViews.begin(), end = subViews.end(), next = iter;
      auto yy = iter->first;
      wxSize vRulerSize{ 0, 0 };
      auto &size = view.vrulerSize;
      for (; iter != end; iter = next) {
         ++next;
         auto nextY = (next == end)
            ? height
            : next->first;
         rect.SetHeight(nextY - yy);
         // This causes ruler size in the track to be reassigned:
         ChannelVRulerControls::Get(*iter->second).UpdateRuler(rect);
         // But we want to know the maximum width and height over all sub-views:
         vRulerSize.IncTo({ size.first, size.second });
         yy = nextY;
      }
      size = { vRulerSize.x, vRulerSize.y };
   }
}

References ChannelGroup::Channels(), details::end(), anonymous_namespace{TrackPanel.cpp}::FindAdjustedChannelHeights(), ChannelView::Get(), ChannelVRulerControls::Get(), ZoomInfo::GetVRulerOffset(), ZoomInfo::GetVRulerWidth(), CellularPanel::mViewInfo, size, and ChannelVRulerControls::UpdateRuler().

Referenced by UpdateVRuler(), and UpdateVRulers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateViewIfNoTracks()

void TrackPanel::UpdateViewIfNoTracks ( )

Definition at line 660 of file TrackPanel.cpp.

{
   if (mTracks->empty())
   {
      // BG: There are no more tracks on screen
      //BG: Set zoom to normal
      mViewInfo->SetZoom(ZoomInfo::GetDefaultZoom());
 
      //STM: Set selection to 0,0
      //PRL: and default the rest of the selection information
      mViewInfo->selectedRegion = SelectedRegion();
 
      // PRL:  Following causes the time ruler to align 0 with left edge.
      // Bug 972
      mViewInfo->hpos = 0;
 
      Viewport::Get(*GetProject()).HandleResize();
      //STM: Clear message if all tracks are removed
      ProjectStatus::Get( *GetProject() ).Set({});
   }
}

References ProjectStatus::Get(), Viewport::Get(), ZoomInfo::GetDefaultZoom(), GetProject(), Viewport::HandleResize(), ZoomInfo::hpos, mTracks, CellularPanel::mViewInfo, ViewInfo::selectedRegion, ProjectStatus::Set(), and ZoomInfo::SetZoom().

Here is the call graph for this function:

◆ UpdateVRuler()

void TrackPanel::UpdateVRuler ( Track * t )

Definition at line 949 of file TrackPanel.cpp.

{
   if (t)
      UpdateTrackVRuler(*t);
 
   UpdateVRulerSize();
}

References UpdateTrackVRuler(), and UpdateVRulerSize().

Referenced by OnTrackListResizing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateVRulers()

void TrackPanel::UpdateVRulers ( )

Definition at line 941 of file TrackPanel.cpp.

{
   for (auto t : GetTracks()->Any<WaveTrack>())
      UpdateTrackVRuler(*t);
 
   UpdateVRulerSize();
}

References GetTracks(), UpdateTrackVRuler(), and UpdateVRulerSize().

Referenced by UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateVRulerSize()

void TrackPanel::UpdateVRulerSize ( )

Definition at line 995 of file TrackPanel.cpp.

{
   auto trackRange = GetTracks()->Any();
   if (trackRange) {
      wxSize s{ 0, 0 };
      // Find maximum width over all channels
      for (auto t : trackRange)
         for (auto pChannel : t->Channels()) {
            const auto &size = ChannelView::Get(*pChannel).vrulerSize;
            s.IncTo({ size.first, size.second });
         }
 
      if (mViewInfo->GetVRulerWidth() != s.GetWidth()) {
         mViewInfo->SetVRulerWidth(s.GetWidth());
         mRuler->SetLeftOffset(
            mViewInfo->GetLeftOffset());  // bevel on AdornedRuler
         mRuler->Refresh();
      }
   }
   Refresh(false);
}

References TrackList::Any(), ChannelView::Get(), ZoomInfo::GetLeftOffset(), GetTracks(), ZoomInfo::GetVRulerWidth(), mRuler, CellularPanel::mViewInfo, AdornedRulerPanel::Refresh(), Refresh(), AdornedRulerPanel::SetLeftOffset(), ZoomInfo::SetVRulerWidth(), size, and ChannelView::vrulerSize.

TrackPanel::AudacityTimer TrackPanel::mTimer

protected

Referenced by OnIdle(), OnMouseEvent(), TrackPanel(), and ~TrackPanel().

◆ mTrackArtist

std::unique_ptr<TrackArtist> TrackPanel::mTrackArtist

protected

Definition at line 195 of file TrackPanel.h.

Referenced by DrawTracks(), and TrackPanel().

◆ mTrackListSubscription

Observer::Subscription TrackPanel::mTrackListSubscription

protected

Definition at line 181 of file TrackPanel.h.

Referenced by TrackPanel().

◆ mTracks

std::shared_ptr<TrackList> TrackPanel::mTracks

protected

Definition at line 191 of file TrackPanel.h.

Referenced by UpdateViewIfNoTracks().

◆ mUndoSubscription

Observer::Subscription TrackPanel::mUndoSubscription

protected

Definition at line 183 of file TrackPanel.h.

Referenced by TrackPanel().

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TrackPanel()

◆ ~TrackPanel()

Member Function Documentation

◆ Destroy()

◆ DrawTracks()

◆ FindFocusedTrackRect()

◆ FindRulerRects()

◆ FindTrackRect()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetBackgroundCell()

◆ GetFocusedCell()

◆ GetMostRecentXPos()

◆ GetProject()

◆ GetRuler()

◆ GetSelectedTrackCount()

◆ GetTracks() [1/2]

◆ GetTracks() [2/2]

◆ GetViewInfo()

◆ HandlePageDownKey()

◆ HandlePageUpKey()

◆ IsAudioActive()

◆ MakeParentRedrawScrollbars()

◆ OnAudioIO()

◆ OnIdle()

◆ OnKeyDown()

◆ OnMouseEvent()

◆ OnPaint()

◆ OnSize()

◆ OnSyncLockChange()

◆ OnTimer()

◆ OnTrackFocusChange()

◆ OnTrackListDeletion()

◆ OnTrackListResizing()

◆ OnTrackMenu()

◆ OnUndoReset()

◆ ProcessUIHandleResult()

◆ Refresh()

◆ RefreshTrack()

◆ Root()

◆ SetBackgroundCell()

◆ SetFocusedCell()

◆ UpdatePrefs()

◆ UpdateSelectionDisplay()

◆ UpdateStatusMessage()

◆ UpdateTrackVRuler()

◆ UpdateViewIfNoTracks()

◆ UpdateVRuler()

◆ UpdateVRulers()

◆ UpdateVRulerSize()

Member Data Documentation

◆ mAudioIOSubscription

◆ mFocusChangeSubscription

◆ mLastDrawnSelectedRegion

◆ mpBackground

◆ mProjectRulerInvalidatedSubscription

◆ mRealtimeEffectManagerSubscription

◆ mRefreshBacking

◆ mRuler

◆ mSelectionSubscription

◆ mSyncLockSubscription

◆ mTimeCount

◆ mTimer

◆ mTrackArtist

◆ mTrackListSubscription

◆ mTracks

◆ mUndoSubscription