This class handles the actual rendering of WaveTracks (both waveforms and spectra), NoteTracks, LabelTracks and TimeTracks. More...

#include <TrackArtist.h>

Inheritance diagram for TrackArtist:

[legend]

Collaboration diagram for TrackArtist:

[legend]

Public Types
enum	: unsigned { PassTracks , PassMargins , PassBorders , PassControls , PassZooming , PassBackground , PassFocus , PassSnapping , NPasses }

Public Member Functions
	TrackArtist (TrackPanel *parent_)

	~TrackArtist ()

void	SetColours (int iColorIndex)

void	UpdatePrefs () override

void	UpdateSelectedPrefs (int id) override

Static Public Member Functions
static TrackArtist *	Get (TrackPanelDrawingContext &)

Public Attributes
TrackPanel *	parent

float	mdBrange

bool	mShowClipping

int	mSampleDisplay

wxBrush	blankBrush

wxBrush	unselectedBrush

wxBrush	selectedBrush

wxBrush	sampleBrush

wxBrush	selsampleBrush

wxBrush	dragsampleBrush

wxBrush	muteSampleBrush

wxBrush	blankSelectedBrush

wxBrush	envelopeBackgroundBrush

wxBrush	clipAffordanceBackgroundBrush

wxBrush	clipAffordanceBackgroundSelBrush

wxPen	blankPen

wxPen	unselectedPen

wxPen	selectedPen

wxPen	samplePen

wxPen	rmsPen

wxPen	muteRmsPen

wxPen	selsamplePen

wxPen	muteSamplePen

wxPen	odProgressNotYetPen

wxPen	odProgressDonePen

wxPen	clippedPen

wxPen	muteClippedPen

wxPen	blankSelectedPen

wxPen	beatSepearatorPen [2]

wxPen	barSepearatorPen [2]

wxBrush	beatStrongBrush [2]

wxBrush	beatWeakBrush [2]

wxBrush	beatStrongSelBrush [2]

wxBrush	beatWeakSelBrush [2]

const SelectedRegion *	pSelectedRegion {}

ZoomInfo *	pZoomInfo {}

const PendingTracks *	pPendingTracks {}

bool	drawEnvelope { false }

bool	bigPoints { false }

bool	drawSliders { false }

bool	onBrushTool { false }

bool	hasSolo { false }

Additional Inherited Members
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

This class handles the actual rendering of WaveTracks (both waveforms and spectra), NoteTracks, LabelTracks and TimeTracks.

It's actually a little harder than it looks, because for waveforms at least it needs to cache the samples that are currently on-screen.

How Audacity Redisplay Works
Roger Dannenberg
Oct 2010
In my opinion, the bitmap should contain only the waveform, note, and label images along with gray selection highlights. The track info (sliders, buttons, title, etc.), track selection highlight, cursor, and indicator should be drawn in the normal way, and clipping regions should be used to avoid excessive copying of bitmaps (say, when sliders move), or excessive redrawing of track info widgets (say, when scrolling occurs). This is a fairly tricky code change since it requires careful specification of what and where redraw should take place when any state changes. One surprising finding is that NoteTrack display is slow compared to WaveTrack display. Each note takes some time to gather attributes and select colors, and while audio draws two amplitudes per horizontal pixels, large MIDI scores can have more notes than horizontal pixels. This can make slider changes very sluggish, but this can also be a problem with many audio tracks.

Definition at line 40 of file TrackArtist.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : unsigned

Enumerator
PassTracks
PassMargins
PassBorders
PassControls
PassZooming
PassBackground
PassFocus
PassSnapping
NPasses

Definition at line 44 of file TrackArtist.h.

        : unsigned {
      PassTracks,
      PassMargins,
      PassBorders,
      PassControls,
      PassZooming,
      PassBackground,
      PassFocus,
      PassSnapping,
      
      NPasses
   };

Constructor & Destructor Documentation

◆ TrackArtist()

TrackArtist::TrackArtist ( TrackPanel * parent_ )

Definition at line 66 of file TrackArtist.cpp.

   : parent( parent_ )
{
   mdBrange = DecibelScaleCutoff.GetDefault();
   mShowClipping = false;
   mSampleDisplay = 1;// Stem plots by default.
 
   SetColours(0);
 
   UpdatePrefs();
}

References DecibelScaleCutoff, Setting< T >::GetDefault(), mdBrange, mSampleDisplay, mShowClipping, SetColours(), and UpdatePrefs().

Here is the call graph for this function:

◆ ~TrackArtist()

TrackArtist::~TrackArtist ( )

Definition at line 78 of file TrackArtist.cpp.

79{

80}

Member Function Documentation

◆ Get()

TrackArtist * TrackArtist::Get ( TrackPanelDrawingContext & context )

static

Definition at line 82 of file TrackArtist.cpp.

{
   return static_cast< TrackArtist* >( context.pUserData );
}

References TrackPanelDrawingContext::pUserData.

Here is the caller graph for this function:

◆ SetColours()

void TrackArtist::SetColours ( int iColorIndex )

Definition at line 87 of file TrackArtist.cpp.

{
   theTheme.SetBrushColour( blankBrush,      clrBlank );
   theTheme.SetBrushColour( unselectedBrush, clrUnselected);
   theTheme.SetBrushColour( selectedBrush,   clrSelected);
   theTheme.SetBrushColour( sampleBrush,     clrSample);
   theTheme.SetBrushColour( selsampleBrush,  clrSelSample);
   theTheme.SetBrushColour( dragsampleBrush, clrDragSample);
   theTheme.SetBrushColour( blankSelectedBrush, clrBlankSelected);
   theTheme.SetBrushColour( envelopeBackgroundBrush, clrEnvelopeBackground);
   theTheme.SetBrushColour( clipAffordanceBackgroundBrush, clrBlank);
   theTheme.SetBrushColour( clipAffordanceBackgroundSelBrush, clrBlankSelected);
 
   theTheme.SetPenColour(   blankPen,        clrBlank);
   theTheme.SetPenColour(   unselectedPen,   clrUnselected);
   theTheme.SetPenColour(   selectedPen,     clrSelected);
   theTheme.SetPenColour(   muteSamplePen,   clrMuteSample);
   theTheme.SetPenColour(   odProgressDonePen, clrProgressDone);
   theTheme.SetPenColour(   odProgressNotYetPen, clrProgressNotYet);
   theTheme.SetPenColour(   clippedPen,      clrClipped);
   theTheme.SetPenColour(   muteClippedPen,  clrMuteClipped);
   theTheme.SetPenColour(   blankSelectedPen,clrBlankSelected);
 
   theTheme.SetPenColour(   selsamplePen,    clrSelSample);
   theTheme.SetPenColour(   muteRmsPen,      clrMuteRms);
 
   theTheme.SetPenColour( beatSepearatorPen[0], clrBeatSeparatorPen );
   theTheme.SetPenColour( beatSepearatorPen[1], clrBeatSeparatorPen );
   theTheme.SetPenColour( barSepearatorPen[0], clrBarSeparatorPen );
   theTheme.SetPenColour( barSepearatorPen[1], clrBarSeparatorPen );
   theTheme.SetBrushColour( beatStrongBrush[0], clrBeatFillStrongBrush );
   theTheme.SetBrushColour( beatStrongBrush[1], clrBeatFillStrongBrush );
   theTheme.SetBrushColour( beatWeakBrush[0], clrBeatFillWeakBrush );
   theTheme.SetBrushColour( beatWeakBrush[1], clrBeatFillWeakBrush );
   theTheme.SetBrushColour( beatStrongSelBrush[0], clrBeatFillStrongSelBrush );
   theTheme.SetBrushColour( beatStrongSelBrush[1], clrBeatFillStrongSelBrush );
   theTheme.SetBrushColour( beatWeakSelBrush[0], clrBeatFillWeakSelBrush );
   theTheme.SetBrushColour( beatWeakSelBrush[1], clrBeatFillWeakSelBrush );
 
   ChangeLightness(beatSepearatorPen[1], 90);
   ChangeLightness(barSepearatorPen[1], 90);
   ChangeLightness(beatStrongBrush[1], 90);
   ChangeLightness(beatWeakBrush[1], 90);
   ChangeLightness(beatStrongSelBrush[1], 90);
   ChangeLightness(beatWeakSelBrush[1], 90);
   ChangeLightness(clipAffordanceBackgroundBrush, 90 );
   ChangeLightness(clipAffordanceBackgroundSelBrush, 90);
 
   switch( iColorIndex %4 )
   {
      default:
      case 0:
         theTheme.SetPenColour(   samplePen,       clrSample);
         theTheme.SetPenColour(   rmsPen,          clrRms);
         break;
      case 1: // RED
         theTheme.SetPenColour(   samplePen,       clrSample2);
         theTheme.SetPenColour(   rmsPen,          clrRms2);
         break;
      case 2: // GREEN
         theTheme.SetPenColour(   samplePen,       clrSample3);
         theTheme.SetPenColour(   rmsPen,          clrRms3);
         break;
      case 3: //BLACK
         theTheme.SetPenColour(   samplePen,       clrSample4);
         theTheme.SetPenColour(   rmsPen,          clrRms4);
         break;
 
   }
}

References barSepearatorPen, beatSepearatorPen, beatStrongBrush, beatStrongSelBrush, beatWeakBrush, beatWeakSelBrush, blankBrush, blankPen, blankSelectedBrush, blankSelectedPen, anonymous_namespace{TrackArtist.cpp}::ChangeLightness(), clipAffordanceBackgroundBrush, clipAffordanceBackgroundSelBrush, clippedPen, dragsampleBrush, envelopeBackgroundBrush, muteClippedPen, muteRmsPen, muteSamplePen, odProgressDonePen, odProgressNotYetPen, rmsPen, sampleBrush, samplePen, selectedBrush, selectedPen, selsampleBrush, selsamplePen, ThemeBase::SetBrushColour(), ThemeBase::SetPenColour(), theTheme, unselectedBrush, and unselectedPen.

Referenced by TrackArtist(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdatePrefs()

void TrackArtist::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 164 of file TrackArtist.cpp.

{
   mdBrange = DecibelScaleCutoff.Read();
   mSampleDisplay = TracksPrefs::SampleViewChoice();
 
   UpdateSelectedPrefs( ShowClippingPrefsID() );
 
   SetColours(0);
}

References DecibelScaleCutoff, mdBrange, mSampleDisplay, Setting< T >::Read(), TracksPrefs::SampleViewChoice(), SetColours(), ShowClippingPrefsID(), and UpdateSelectedPrefs().

Referenced by TrackArtist().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateSelectedPrefs()

void TrackArtist::UpdateSelectedPrefs ( int id )

overridevirtual

Reimplemented from PrefsListener.

Definition at line 158 of file TrackArtist.cpp.

{
   if( id == ShowClippingPrefsID())
      mShowClipping = gPrefs->Read(wxT("/GUI/ShowClipping"), mShowClipping);
}

References gPrefs, mShowClipping, audacity::BasicSettings::Read(), ShowClippingPrefsID(), and wxT().

Referenced by UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ barSepearatorPen

wxPen TrackArtist::barSepearatorPen[2]

Definition at line 99 of file TrackArtist.h.

Referenced by SetColours().

◆ beatSepearatorPen

wxPen TrackArtist::beatSepearatorPen[2]

Definition at line 98 of file TrackArtist.h.

Referenced by SetColours().

◆ beatStrongBrush

wxBrush TrackArtist::beatStrongBrush[2]

Definition at line 100 of file TrackArtist.h.

Referenced by SetColours().

◆ beatStrongSelBrush

wxBrush TrackArtist::beatStrongSelBrush[2]

Definition at line 102 of file TrackArtist.h.

Referenced by SetColours().

◆ beatWeakBrush

wxBrush TrackArtist::beatWeakBrush[2]

Definition at line 101 of file TrackArtist.h.

Referenced by SetColours().

◆ beatWeakSelBrush

wxBrush TrackArtist::beatWeakSelBrush[2]

Definition at line 103 of file TrackArtist.h.

Referenced by SetColours().

◆ bigPoints

bool TrackArtist::bigPoints { false }

Definition at line 121 of file TrackArtist.h.

◆ blankBrush

wxBrush TrackArtist::blankBrush

Definition at line 73 of file TrackArtist.h.

Referenced by SetColours().

◆ blankPen

wxPen TrackArtist::blankPen

Definition at line 84 of file TrackArtist.h.

Referenced by SetColours().

◆ blankSelectedBrush

wxBrush TrackArtist::blankSelectedBrush

Definition at line 80 of file TrackArtist.h.

Referenced by SetColours().

◆ blankSelectedPen

wxPen TrackArtist::blankSelectedPen

Definition at line 96 of file TrackArtist.h.

Referenced by SetColours().

◆ clipAffordanceBackgroundBrush

wxBrush TrackArtist::clipAffordanceBackgroundBrush

Definition at line 82 of file TrackArtist.h.

Referenced by SetColours().

◆ clipAffordanceBackgroundSelBrush

wxBrush TrackArtist::clipAffordanceBackgroundSelBrush

Definition at line 83 of file TrackArtist.h.

Referenced by SetColours().

◆ clippedPen

wxPen TrackArtist::clippedPen

Definition at line 94 of file TrackArtist.h.

Referenced by SetColours().

◆ dragsampleBrush

wxBrush TrackArtist::dragsampleBrush

Definition at line 78 of file TrackArtist.h.

Referenced by SetColours().

◆ drawEnvelope

bool TrackArtist::drawEnvelope { false }

Definition at line 120 of file TrackArtist.h.

◆ drawSliders

bool TrackArtist::drawSliders { false }

Definition at line 122 of file TrackArtist.h.

◆ envelopeBackgroundBrush

wxBrush TrackArtist::envelopeBackgroundBrush

Definition at line 81 of file TrackArtist.h.

Referenced by SetColours().

◆ hasSolo

bool TrackArtist::hasSolo { false }

Definition at line 124 of file TrackArtist.h.

◆ mdBrange

float TrackArtist::mdBrange

Definition at line 69 of file TrackArtist.h.

Referenced by TrackArtist(), and UpdatePrefs().

◆ mSampleDisplay

int TrackArtist::mSampleDisplay

Definition at line 71 of file TrackArtist.h.

Referenced by TrackArtist(), and UpdatePrefs().

◆ mShowClipping

bool TrackArtist::mShowClipping

Definition at line 70 of file TrackArtist.h.

Referenced by TrackArtist(), and UpdateSelectedPrefs().

◆ muteClippedPen

wxPen TrackArtist::muteClippedPen

Definition at line 95 of file TrackArtist.h.

Referenced by SetColours().

◆ muteRmsPen

wxPen TrackArtist::muteRmsPen

Definition at line 89 of file TrackArtist.h.

Referenced by SetColours().

◆ muteSampleBrush

wxBrush TrackArtist::muteSampleBrush

Definition at line 79 of file TrackArtist.h.

◆ muteSamplePen

wxPen TrackArtist::muteSamplePen

Definition at line 91 of file TrackArtist.h.

Referenced by SetColours().

◆ odProgressDonePen

wxPen TrackArtist::odProgressDonePen

Definition at line 93 of file TrackArtist.h.

Referenced by SetColours().

◆ odProgressNotYetPen

wxPen TrackArtist::odProgressNotYetPen

Definition at line 92 of file TrackArtist.h.

Referenced by SetColours().

◆ onBrushTool

bool TrackArtist::onBrushTool { false }

Definition at line 123 of file TrackArtist.h.

◆ parent

TrackPanel* TrackArtist::parent

Definition at line 66 of file TrackArtist.h.

◆ pPendingTracks

const PendingTracks* TrackArtist::pPendingTracks {}

Definition at line 118 of file TrackArtist.h.

◆ pSelectedRegion

const SelectedRegion* TrackArtist::pSelectedRegion {}

Definition at line 116 of file TrackArtist.h.

◆ pZoomInfo

ZoomInfo* TrackArtist::pZoomInfo {}

Definition at line 117 of file TrackArtist.h.

Referenced by EqualizationPanel::OnPaint().

◆ rmsPen

wxPen TrackArtist::rmsPen

Definition at line 88 of file TrackArtist.h.

Referenced by SetColours().

◆ sampleBrush

wxBrush TrackArtist::sampleBrush

Definition at line 76 of file TrackArtist.h.

Referenced by SetColours().

◆ samplePen

wxPen TrackArtist::samplePen

Definition at line 87 of file TrackArtist.h.

Referenced by SetColours().

◆ selectedBrush

wxBrush TrackArtist::selectedBrush

Definition at line 75 of file TrackArtist.h.

Referenced by SetColours().

◆ selectedPen

wxPen TrackArtist::selectedPen

Definition at line 86 of file TrackArtist.h.

Referenced by SetColours().

◆ selsampleBrush

wxBrush TrackArtist::selsampleBrush

Definition at line 77 of file TrackArtist.h.

Referenced by SetColours().

◆ selsamplePen

wxPen TrackArtist::selsamplePen

Definition at line 90 of file TrackArtist.h.

Referenced by SetColours().

◆ unselectedBrush

wxBrush TrackArtist::unselectedBrush

Definition at line 74 of file TrackArtist.h.

Referenced by SetColours().

◆ unselectedPen

wxPen TrackArtist::unselectedPen

Definition at line 85 of file TrackArtist.h.

Referenced by SetColours().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TrackArtist()

◆ ~TrackArtist()

Member Function Documentation

◆ Get()

◆ SetColours()

◆ UpdatePrefs()

◆ UpdateSelectedPrefs()

Member Data Documentation

◆ barSepearatorPen

◆ beatSepearatorPen

◆ beatStrongBrush

◆ beatStrongSelBrush

◆ beatWeakBrush

◆ beatWeakSelBrush

◆ bigPoints

◆ blankBrush

◆ blankPen

◆ blankSelectedBrush

◆ blankSelectedPen

◆ clipAffordanceBackgroundBrush

◆ clipAffordanceBackgroundSelBrush

◆ clippedPen

◆ dragsampleBrush

◆ drawEnvelope

◆ drawSliders

◆ envelopeBackgroundBrush

◆ hasSolo

◆ mdBrange

◆ mSampleDisplay

◆ mShowClipping

◆ muteClippedPen

◆ muteRmsPen

◆ muteSampleBrush

◆ muteSamplePen

◆ odProgressDonePen

◆ odProgressNotYetPen

◆ onBrushTool

◆ parent

◆ pPendingTracks

◆ pSelectedRegion

◆ pZoomInfo

◆ rmsPen

◆ sampleBrush

◆ samplePen

◆ selectedBrush

◆ selectedPen

◆ selsampleBrush

◆ selsamplePen

◆ unselectedBrush

◆ unselectedPen