PlayIndicatorOverlayBase Class Reference

#include <PlayIndicatorOverlay.h>

Inheritance diagram for PlayIndicatorOverlayBase:

Collaboration diagram for PlayIndicatorOverlayBase:

Public Member Functions
	PlayIndicatorOverlayBase (AudacityProject *project, bool isMaster)
virtual	~PlayIndicatorOverlayBase ()
void	Update (int newIndicatorX)
Public Member Functions inherited from Overlay
	Overlay ()=default
	Overlay (const Overlay &)=delete
Overlay &	operator= (const Overlay &)=delete
virtual	~Overlay ()=0
virtual unsigned	SequenceNumber () const =0
	This number determines an ordering of overlays, so that those with higher numbers overpaint those with lower numbers that intersect. More...
std::pair< wxRect, bool >	GetRectangle (wxSize size)
virtual std::pair< wxRect, bool >	DoGetRectangle (wxSize size)=0
virtual void	Erase (wxDC &dc, wxDC &src)
virtual void	Draw (OverlayPanel &panel, wxDC &dc)=0
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Protected Attributes
AudacityProject *const	mProject
const bool	mIsMaster
int	mLastIndicatorX { -1 }
int	mNewIndicatorX { -1 }
bool	mNewIsCapturing { false }
bool	mLastIsCapturing { false }

Private Member Functions
unsigned	SequenceNumber () const override
	This number determines an ordering of overlays, so that those with higher numbers overpaint those with lower numbers that intersect. More...
std::pair< wxRect, bool >	DoGetRectangle (wxSize size) override
void	Draw (OverlayPanel &panel, wxDC &dc) override

Detailed Description

Definition at line 23 of file PlayIndicatorOverlay.h.

Constructor & Destructor Documentation

PlayIndicatorOverlayBase()

PlayIndicatorOverlayBase::PlayIndicatorOverlayBase	(	AudacityProject *	project,
		bool	isMaster
	)

Definition at line 44 of file PlayIndicatorOverlay.cpp.

: mProject(project)
, mIsMaster(isMaster)
{
}

~PlayIndicatorOverlayBase()

PlayIndicatorOverlayBase::~PlayIndicatorOverlayBase ( )

virtual

Definition at line 50 of file PlayIndicatorOverlay.cpp.

{
}

Member Function Documentation

DoGetRectangle()

std::pair< wxRect, bool > PlayIndicatorOverlayBase::DoGetRectangle ( wxSize  size )

overrideprivatevirtual

Implements Overlay.

Definition at line 77 of file PlayIndicatorOverlay.cpp.

{
   wxCoord width = 1, xx = mLastIndicatorX;
 
   if ( !mIsMaster ) {
      auto gAudioIO = AudioIO::Get();
      bool rec = gAudioIO->IsCapturing();
      auto pair = GetIndicatorBitmap( *mProject, xx, !rec );
      xx = pair.first.x;
      width = pair.second.GetWidth();
   }
 
   // May be excessive height, but little matter
   wxRect rect( xx, 0, width, size.GetHeight());
   return {
      rect,
      (mLastIndicatorX != mNewIndicatorX
       || mLastIsCapturing != mNewIsCapturing)
   };
}

References AudioIO::Get(), anonymous_namespace{PlayIndicatorOverlay.cpp}::GetIndicatorBitmap(), mIsMaster, mLastIndicatorX, mLastIsCapturing, mNewIndicatorX, mNewIsCapturing, mProject, and size.

Here is the call graph for this function:

Draw()

void PlayIndicatorOverlayBase::Draw ( OverlayPanel &  panel, wxDC &  dc  )

overrideprivatevirtual

Implements Overlay.

Definition at line 99 of file PlayIndicatorOverlay.cpp.

{
   // Set play/record color
   auto gAudioIO = AudioIO::Get();
   bool rec = gAudioIO->IsCapturing();
   AColor::IndicatorColor(&dc, !rec);
 
   if (mIsMaster
       && mLastIsCapturing != mNewIsCapturing) {
      // Detect transition to recording during punch and roll; make ruler
      // change its button color too
      auto &ruler = AdornedRulerPanel::Get( *mProject );
      ruler.UpdateButtonStates();
      ruler.Refresh();
   }
   mLastIsCapturing = mNewIsCapturing;
 
   mLastIndicatorX = mNewIndicatorX;
   if (!between_incexc(0, mLastIndicatorX, dc.GetSize().GetWidth()))
      return;
 
   if(auto tp = dynamic_cast<TrackPanel*>(&panel)) {
      wxASSERT(mIsMaster);
 
      AColor::Line(dc, mLastIndicatorX, 0, mLastIndicatorX, tp->GetSize().GetHeight());
   }
   else if(auto ruler = dynamic_cast<AdornedRulerPanel*>(&panel)) {
      wxASSERT(!mIsMaster);
 
      auto pair = GetIndicatorBitmap( *mProject, mLastIndicatorX, !rec );
      dc.DrawBitmap( pair.second, pair.first.x, pair.first.y );
   }
   else
      wxASSERT(false);
}

References anonymous_namespace{PlayIndicatorOverlay.cpp}::between_incexc(), AudioIO::Get(), AdornedRulerPanel::Get(), anonymous_namespace{PlayIndicatorOverlay.cpp}::GetIndicatorBitmap(), AColor::IndicatorColor(), AColor::Line(), mIsMaster, mLastIndicatorX, mLastIsCapturing, mNewIndicatorX, mNewIsCapturing, mProject, and anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler().

Here is the call graph for this function:

SequenceNumber()

unsigned PlayIndicatorOverlayBase::SequenceNumber ( ) const

overrideprivatevirtual

This number determines an ordering of overlays, so that those with higher numbers overpaint those with lower numbers that intersect.

Implements Overlay.

Definition at line 54 of file PlayIndicatorOverlay.cpp.

{
   return 10;
}

Update()

void PlayIndicatorOverlayBase::Update ( int  newIndicatorX )

inline

Definition at line 31 of file PlayIndicatorOverlay.h.

{ mNewIndicatorX = newIndicatorX; }

References mNewIndicatorX.

Member Data Documentation

mIsMaster

const bool PlayIndicatorOverlayBase::mIsMaster

protected

Definition at line 41 of file PlayIndicatorOverlay.h.

Referenced by DoGetRectangle(), and Draw().

mLastIndicatorX

int PlayIndicatorOverlayBase::mLastIndicatorX { -1 }

protected

Definition at line 42 of file PlayIndicatorOverlay.h.

Referenced by DoGetRectangle(), and Draw().

mLastIsCapturing

bool PlayIndicatorOverlayBase::mLastIsCapturing { false }

protected

Definition at line 45 of file PlayIndicatorOverlay.h.

Referenced by DoGetRectangle(), and Draw().

mNewIndicatorX

int PlayIndicatorOverlayBase::mNewIndicatorX { -1 }

protected

Definition at line 43 of file PlayIndicatorOverlay.h.

Referenced by DoGetRectangle(), Draw(), PlayIndicatorOverlay::OnTimer(), and Update().

mNewIsCapturing

bool PlayIndicatorOverlayBase::mNewIsCapturing { false }

protected

Definition at line 44 of file PlayIndicatorOverlay.h.

Referenced by DoGetRectangle(), Draw(), and PlayIndicatorOverlay::OnTimer().

mProject

AudacityProject* const PlayIndicatorOverlayBase::mProject

protected

Definition at line 40 of file PlayIndicatorOverlay.h.

Referenced by DoGetRectangle(), Draw(), PlayIndicatorOverlay::OnTimer(), and PlayIndicatorOverlay::PlayIndicatorOverlay().

---

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

• PlayIndicatorOverlay.h
• PlayIndicatorOverlay.cpp