TrackArt Namespace Reference

Functions
AUDACITY_DLL_API wxRect	DrawClipAffordance (wxDC &dc, const wxRect &clipRect, bool highlight=false, bool selected=false)
AUDACITY_DLL_API bool	DrawClipTitle (wxDC &dc, const wxRect &affordanceRect, const wxString &title)
AUDACITY_DLL_API void	DrawClipEdges (wxDC &dc, const wxRect &clipRect, bool selected=false)
AUDACITY_DLL_API void	DrawClipFolded (wxDC &dc, const wxRect &rect)
AUDACITY_DLL_API void	DrawSyncLockTiles (TrackPanelDrawingContext &context, const wxRect &rect)
AUDACITY_DLL_API void	DrawBackgroundWithSelection (TrackPanelDrawingContext &context, const wxRect &rect, const Channel &channel, const wxBrush &selBrush, const wxBrush &unselBrush, bool useSelection=true, bool useBeatsAlternateColor=false)
	Helper: draws background with selection rect. More...
AUDACITY_DLL_API void	DrawCursor (TrackPanelDrawingContext &context, const wxRect &rect, const Track *track)
AUDACITY_DLL_API void	DrawNegativeOffsetTrackArrows (TrackPanelDrawingContext &context, const wxRect &rect)
AUDACITY_DLL_API wxString	TruncateText (wxDC &dc, const wxString &text, const int maxWidth)
AUDACITY_DLL_API void	DrawSnapLines (wxDC *dc, wxInt64 snap0, wxInt64 snap1)

Variables
static constexpr int	ClipFrameRadius { 6 }

Function Documentation

DrawBackgroundWithSelection()

void TrackArt::DrawBackgroundWithSelection	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect,
		const Channel &	channel,
		const wxBrush &	selBrush,
		const wxBrush &	unselBrush,
		bool	useSelection = true,
		bool	useBeatsAlternateColor = false
	)

Helper: draws background with selection rect.

Parameters

useBeatsAlternateColor

is only meaningful in Beats mode

Definition at line 648 of file TrackArt.cpp.

{
   const auto dc = &context.dc;
   const auto artist = TrackArtist::Get( context );
   const auto &selectedRegion = *artist->pSelectedRegion;
   const auto& zoomInfo = *artist->pZoomInfo;
 
 
   //MM: Draw background. We should optimize that a bit more.
   const double sel0 = useSelection ? selectedRegion.t0() : 0.0;
   const double sel1 = useSelection ? selectedRegion.t1() : 0.0;
 
   auto pTrack = dynamic_cast<const Track*>(&channel.GetChannelGroup());
   if (!pTrack)
      return;
   auto &track = *pTrack;
   BeatsGridlinePainter gridlinePainter(zoomInfo, GetProject(track));
 
   dc->SetPen(*wxTRANSPARENT_PEN);
 
   const auto& beatStrongBrush = artist->beatStrongBrush[useBeatsAlternateColor];
   const auto& beatStrongSelBrush = artist->beatStrongSelBrush[useBeatsAlternateColor];
   const auto& beatWeakBrush = artist->beatWeakBrush[useBeatsAlternateColor];
   const auto& beatWeakSelBrush = artist->beatWeakSelBrush[useBeatsAlternateColor];
   const auto& beatSepearatorPen = artist->beatSepearatorPen[useBeatsAlternateColor];
   const auto& barSepearatorPen = artist->barSepearatorPen[useBeatsAlternateColor];
 
   auto drawBgRect = [dc, &gridlinePainter, &rect](
                        const wxBrush& regularBrush,
                        const wxBrush& beatStrongBrush,
                        const wxBrush& beatWeakBrush, const wxRect& subRect)
   {
      if (!gridlinePainter.enabled)
      {
         // Track not selected; just draw background
         dc->SetBrush(regularBrush);
         dc->DrawRectangle(subRect);
      }
      else
      {
         gridlinePainter.DrawBackground(
            *dc, subRect, rect, beatStrongBrush, beatWeakBrush);
      }
   };
 
   if (SyncLock::IsSelectedOrSyncLockSelected(track)) {
      // Rectangles before, within, after the selection
      wxRect before = rect;
      wxRect within = rect;
      wxRect after = rect;
 
      before.width = (int)(zoomInfo.TimeToPosition(sel0) );
      if (before.GetRight() > rect.GetRight()) {
         before.width = rect.width;
      }
 
      if (before.width > 0) {
         drawBgRect(unselBrush, beatStrongBrush, beatWeakBrush, before);
 
         within.x = 1 + before.GetRight();
      }
      within.width = rect.x + (int)(zoomInfo.TimeToPosition(sel1) ) - within.x -1;
 
      if (within.GetRight() > rect.GetRight()) {
         within.width = 1 + rect.GetRight() - within.x;
      }
 
      // Bug 2389 - Selection can disappear
      // This handles case where no waveform is visible.
      if (within.width < 1)
         within.width = 1;
 
      if (within.width > 0) {
         if (track.GetSelected()) {
            drawBgRect(selBrush, beatStrongSelBrush, beatWeakSelBrush, within);
         }
         else {
            // Per condition above, track must be sync-lock selected
            drawBgRect(
               unselBrush, beatStrongBrush, beatWeakBrush, within);
            DrawSyncLockTiles( context, within );
         }
 
         after.x = 1 + within.GetRight();
      }
      else {
         // `within` not drawn; start where it would have gone
         after.x = within.x;
      }
 
      after.width = 1 + rect.GetRight() - after.x;
      if (after.width > 0)
         drawBgRect(
            unselBrush, beatStrongBrush, beatWeakBrush, after);
   }
   else
   {
      drawBgRect(
         unselBrush, beatStrongBrush, beatWeakBrush, rect);
   }
 
   if (gridlinePainter.enabled)
      gridlinePainter.DrawSeparators(*dc, rect, beatSepearatorPen, barSepearatorPen);
}

References TrackPanelDrawingContext::dc, DrawSyncLockTiles(), TrackArtist::Get(), Channel::GetChannelGroup(), anonymous_namespace{TrackArt.cpp}::GetProject(), SyncLock::IsSelectedOrSyncLockSelected(), ZoomInfo::TimeToPosition(), and within().

Referenced by SpectrumView::DoDraw(), WaveformView::DoDraw(), LabelTrackView::Draw(), NoteTrackAffordanceControls::Draw(), NoteTrackView::Draw(), and WaveTrackAffordanceControls::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawClipAffordance()

wxRect TrackArt::DrawClipAffordance	(	wxDC &	dc,
		const wxRect &	clipRect,
		bool	highlight = false,
		bool	selected = false
	)

Definition at line 223 of file TrackArt.cpp.

{
   //To make sure that roundings do not overlap each other
   auto clipFrameRadius = std::min(ClipFrameRadius, clipRect.width / 2);
 
   std::optional<wxRect> clippedClipRect;
   const auto affordanceRect =
      ::GetClipAffordanceRect(dc, clipRect, clippedClipRect);
   //Fix #1689: visual glitches appear on attempt to draw a rectangle
   //larger than 0x7FFFFFF pixels wide (value was discovered
   //by manual testing, and maybe depends on OS being used), but
   //it's very unlikely that such huge rectangle will be ever fully visible
   //on the screen, so we can safely reduce its size to be slightly larger than
   //clipping rectangle, and avoid that problem
   auto drawingRect = clipRect;
   if (clippedClipRect)
   {
       //to make sure that rounding happends outside the clipping rectangle
       drawingRect.SetLeft(std::max(
          clipRect.GetLeft(),
          clippedClipRect->GetLeft() - clipFrameRadius - 1));
       drawingRect.SetRight(std::min(
          clipRect.GetRight(),
          clippedClipRect->GetRight() + clipFrameRadius + 1));
   }
 
   if (selected)
   {
      wxRect strokeRect{
         drawingRect.x - ClipSelectionStrokeSize,
         drawingRect.y,
         drawingRect.width + ClipSelectionStrokeSize * 2,
         drawingRect.height + clipFrameRadius };
      dc.SetBrush(*wxTRANSPARENT_BRUSH);
      AColor::UseThemeColour(&dc, clrClipAffordanceStroke, clrClipAffordanceStroke);
      dc.DrawRoundedRectangle(strokeRect, clipFrameRadius);
   }
 
   AColor::UseThemeColour(&dc, highlight ? clrClipAffordanceActiveBrush : clrClipAffordanceInactiveBrush, clrClipAffordanceOutlinePen);
   dc.DrawRoundedRectangle(
      wxRect(
         drawingRect.x,
         drawingRect.y + ClipSelectionStrokeSize,
         drawingRect.width,
         drawingRect.height + clipFrameRadius
      ), clipFrameRadius
   );
 
   return affordanceRect;
}

References ClipFrameRadius, ClipSelectionStrokeSize, anonymous_namespace{TrackArt.cpp}::GetClipAffordanceRect(), min(), and AColor::UseThemeColour().

Referenced by NoteTrackAffordanceControls::Draw(), and WaveTrackAffordanceControls::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawClipEdges()

void TrackArt::DrawClipEdges	(	wxDC &	dc,
		const wxRect &	clipRect,
		bool	selected = false
	)

Definition at line 309 of file TrackArt.cpp.

{
   dc.SetBrush(*wxTRANSPARENT_BRUSH);
   {
      AColor::UseThemeColour(&dc, -1, clrClipAffordanceOutlinePen);
      AColor::Line(dc,
         clipRect.GetLeft(), clipRect.GetTop(),
         clipRect.GetLeft(), clipRect.GetBottom());
      AColor::Line(dc,
         clipRect.GetRight(), clipRect.GetTop(),
         clipRect.GetRight(), clipRect.GetBottom());
   }
   if(selected)
   {
      if constexpr (ClipSelectionStrokeSize == 1)
      {
         AColor::UseThemeColour(&dc, -1, clrClipAffordanceStroke);
         AColor::Line(dc,
            clipRect.GetLeft() - ClipSelectionStrokeSize, clipRect.GetTop(),
            clipRect.GetLeft() - ClipSelectionStrokeSize, clipRect.GetBottom());
         AColor::Line(dc,
            clipRect.GetRight() + ClipSelectionStrokeSize, clipRect.GetTop(),
            clipRect.GetRight() + ClipSelectionStrokeSize, clipRect.GetBottom());
      }
      else if constexpr (ClipSelectionStrokeSize > 1)
      {
         AColor::UseThemeColour(&dc, clrClipAffordanceStroke, clrClipAffordanceStroke);
         dc.DrawRectangle(wxRect(
            clipRect.GetLeft() - ClipSelectionStrokeSize, clipRect.GetTop(),
            ClipSelectionStrokeSize, clipRect.GetHeight()));
         dc.DrawRectangle(wxRect(
            clipRect.GetRight() + 1, clipRect.GetTop(),
            ClipSelectionStrokeSize, clipRect.GetHeight()));
      }
   }
}

References ClipSelectionStrokeSize, AColor::Line(), and AColor::UseThemeColour().

Referenced by anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), and anonymous_namespace{NoteTrackView.cpp}::DrawNoteTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawClipFolded()

void TrackArt::DrawClipFolded	(	wxDC &	dc,
		const wxRect &	rect
	)

Definition at line 346 of file TrackArt.cpp.

{
   AColor::UseThemeColour(&dc, clrClipAffordanceOutlinePen);
   dc.DrawRectangle(rect);
}

References AColor::UseThemeColour().

Referenced by WaveTrackAffordanceControls::Draw(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), and anonymous_namespace{WaveformView.cpp}::DrawClipWaveform().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawClipTitle()

bool TrackArt::DrawClipTitle	(	wxDC &	dc,
		const wxRect &	affordanceRect,
		const wxString &	title
	)

Definition at line 289 of file TrackArt.cpp.

{
   if (affordanceRect.IsEmpty())
      return false;
   else if (title.empty())
      return true;
   const auto truncatedTitle = ::GetTruncatedTitle(dc, title, affordanceRect);
   if (truncatedTitle.empty())
      return false;
   const auto titleRect =
      GetClipTruncatedTitleRect(dc, affordanceRect, truncatedTitle);
   const auto alignLeft =
      wxTheApp->GetLayoutDirection() == wxLayout_LeftToRight;
   dc.DrawLabel(
      truncatedTitle, titleRect,
      (alignLeft ? wxALIGN_LEFT : wxALIGN_RIGHT) | wxALIGN_CENTER_VERTICAL);
   return true;
}

References anonymous_namespace{TrackArt.cpp}::GetClipTruncatedTitleRect(), anonymous_namespace{TrackArt.cpp}::GetTruncatedTitle(), and title.

Referenced by NoteTrackAffordanceControls::Draw(), and WaveTrackAffordanceControls::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawCursor()

void TrackArt::DrawCursor	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect,
		const Track *	track
	)

Definition at line 756 of file TrackArt.cpp.

{
   const auto dc = &context.dc;
   const auto artist = TrackArtist::Get(context);
   const auto& selectedRegion = *artist->pSelectedRegion;
 
   if (selectedRegion.isPoint())
   {
       const auto& zoomInfo = *artist->pZoomInfo;
       auto x = static_cast<int>(zoomInfo.TimeToPosition(selectedRegion.t0(), rect.x));
       if (x >= rect.GetLeft() && x <= rect.GetRight())
       {
          AColor::CursorColor(dc);
          AColor::Line(*dc, x, rect.GetTop(), x, rect.GetBottom());
       }
   }
}

References AColor::CursorColor(), TrackPanelDrawingContext::dc, TrackArtist::Get(), AColor::Line(), and ZoomInfo::TimeToPosition().

Referenced by anonymous_namespace{TrackPanel.cpp}::ChannelStack::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawNegativeOffsetTrackArrows()

void TrackArt::DrawNegativeOffsetTrackArrows	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect
	)

Definition at line 143 of file TrackArt.cpp.

{
   auto &dc = context.dc;
 
   // Draws two black arrows on the left side of the track to
   // indicate the user that the track has been time-shifted
   // to the left beyond t=0.0.
 
   dc.SetPen(*wxBLACK_PEN);
   AColor::Line(dc,
                rect.x + 2, rect.y + 6,
                rect.x + 8, rect.y + 6);
   AColor::Line(dc,
                rect.x + 2, rect.y + 6,
                rect.x + 6, rect.y + 2);
   AColor::Line(dc,
                rect.x + 2, rect.y + 6,
                rect.x + 6, rect.y + 10);
   AColor::Line(dc,
                rect.x + 2, rect.y + rect.height - 8,
                rect.x + 8, rect.y + rect.height - 8);
   AColor::Line(dc,
                rect.x + 2, rect.y + rect.height - 8,
                rect.x + 6, rect.y + rect.height - 4);
   AColor::Line(dc,
                rect.x + 2, rect.y + rect.height - 8,
                rect.x + 6, rect.y + rect.height - 12);
}

References TrackPanelDrawingContext::dc, and AColor::Line().

Referenced by anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), and anonymous_namespace{NoteTrackView.cpp}::DrawNoteTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawSnapLines()

void TrackArt::DrawSnapLines	(	wxDC *	dc,
		wxInt64	snap0,
		wxInt64	snap1
	)

Definition at line 775 of file TrackArt.cpp.

{
   AColor::SnapGuidePen(dc);
   if (snap0 >= 0)
      AColor::Line(*dc, (int)snap0, 0, (int)snap0, 30000);
   if (snap1 >= 0)
      AColor::Line(*dc, (int)snap1, 0, (int)snap1, 30000);
}

References AColor::Line(), and AColor::SnapGuidePen().

Referenced by AdjustClipBorder::Draw(), SelectHandle::Draw(), and TimeShiftHandle::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawSyncLockTiles()

void TrackArt::DrawSyncLockTiles	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect
	)

Definition at line 365 of file TrackArt.cpp.

{
   const auto dc = &context.dc;
 
   wxBitmap syncLockBitmap(theTheme.Image(bmpSyncLockSelTile));
 
   // Grid spacing is a bit smaller than actual image size
   int gridW = syncLockBitmap.GetWidth() - 6;
   int gridH = syncLockBitmap.GetHeight() - 8;
 
   // Horizontal position within the grid, modulo its period
   int blockX = (rect.x / gridW) % 5;
 
   // Amount to offset drawing of first column
   int xOffset = rect.x % gridW;
   if (xOffset < 0) xOffset += gridW;
 
   // Check if we're missing an extra column to the left (this can happen
   // because the tiles are bigger than the grid spacing)
   bool extraCol = false;
   if (syncLockBitmap.GetWidth() - gridW > xOffset) {
      extraCol = true;
      xOffset += gridW;
      blockX = (blockX - 1) % 5;
   }
   // Make sure blockX is non-negative
   if (blockX < 0) blockX += 5;
 
   int xx = 0;
   while (xx < rect.width) {
      int width = syncLockBitmap.GetWidth() - xOffset;
      if (xx + width > rect.width)
         width = rect.width - xx;
 
      //
      // Draw each row in this column
      //
 
      // Vertical position in the grid, modulo its period
      int blockY = (rect.y / gridH) % 5;
 
      // Amount to offset drawing of first row
      int yOffset = rect.y % gridH;
      if (yOffset < 0) yOffset += gridH;
 
      // Check if we're missing an extra row on top (this can happen because
      // the tiles are bigger than the grid spacing)
      bool extraRow = false;
      if (syncLockBitmap.GetHeight() - gridH > yOffset) {
         extraRow = true;
         yOffset += gridH;
         blockY = (blockY - 1) % 5;
      }
      // Make sure blockY is non-negative
      if (blockY < 0) blockY += 5;
 
      int yy = 0;
      while (yy < rect.height)
      {
         int height = syncLockBitmap.GetHeight() - yOffset;
         if (yy + height > rect.height)
            height = rect.height - yy;
 
         // AWD: draw blocks according to our pattern
         if ((blockX == 0 && blockY == 0) || (blockX == 2 && blockY == 1) ||
             (blockX == 4 && blockY == 2) || (blockX == 1 && blockY == 3) ||
             (blockX == 3 && blockY == 4))
         {
 
            // Do we need to get a sub-bitmap?
            if (width != syncLockBitmap.GetWidth() || height != syncLockBitmap.GetHeight()) {
               wxBitmap subSyncLockBitmap =
                  syncLockBitmap.GetSubBitmap(wxRect(xOffset, yOffset, width, height));
               dc->DrawBitmap(subSyncLockBitmap, rect.x + xx, rect.y + yy, true);
            }
            else {
               dc->DrawBitmap(syncLockBitmap, rect.x + xx, rect.y + yy, true);
            }
         }
 
         // Updates for next row
         if (extraRow) {
            // Second offset row, still at y = 0; no more extra rows
            yOffset -= gridH;
            extraRow = false;
         }
         else {
            // Move on in y, no more offset rows
            yy += gridH - yOffset;
            yOffset = 0;
         }
         blockY = (blockY + 1) % 5;
      }
 
      // Updates for next column
      if (extraCol) {
         // Second offset column, still at x = 0; no more extra columns
         xOffset -= gridW;
         extraCol = false;
      }
      else {
         // Move on in x, no more offset rows
         xx += gridW - xOffset;
         xOffset = 0;
      }
      blockX = (blockX + 1) % 5;
   }
}

References TrackPanelDrawingContext::dc, ThemeBase::Image(), and theTheme.

Referenced by DrawBackgroundWithSelection(), and anonymous_namespace{WaveformView.cpp}::DrawWaveformBackground().

Here is the call graph for this function:

Here is the caller graph for this function:

TruncateText()

wxString TrackArt::TruncateText	(	wxDC &	dc,
		const wxString &	text,
		const int	maxWidth
	)

Definition at line 173 of file TrackArt.cpp.

{
   static const wxString ellipsis = "\u2026";
 
   if (dc.GetTextExtent(text).GetWidth() <= maxWidth)
       return text;
 
   auto left = 0;
   //no need to check text + '...'
   auto right = static_cast<int>(text.Length() - 2);
 
   while (left <= right)
   {
      auto middle = (left + right) / 2;
      auto str = text.SubString(0, middle).Trim() + ellipsis;
      auto strWidth = dc.GetTextExtent(str).GetWidth();
      if (strWidth < maxWidth)
         //if left == right (== middle), then exit loop
         //with right equals to the last known index for which
         //strWidth < maxWidth
         left = middle + 1;
      else if (strWidth > maxWidth)
         //if right == left (== middle), then exit loop with
         //right equals to (left - 1), which is the last known
         //index for which (strWidth < maxWidth) or -1
         right = middle - 1;
      else
         return str;
   }
   if (right >= 0)
      return text.SubString(0, right).Trim() + ellipsis;
 
   return wxEmptyString;
}

References str.

Referenced by CommonTrackInfo::CloseTitleDrawFunction(), anonymous_namespace{TrackArt.cpp}::GetTruncatedTitle(), and AButton::OnPaint().

Here is the caller graph for this function:

Variable Documentation

ClipFrameRadius

constexpr int TrackArt::ClipFrameRadius { 6 }

staticconstexpr

Definition at line 24 of file TrackArt.h.

Referenced by DrawClipAffordance(), and anonymous_namespace{TrackArt.cpp}::GetAffordanceTitleRect().