AdornedRulerPanel::QuickPlayIndicatorOverlay Class Reference

Inheritance diagram for AdornedRulerPanel::QuickPlayIndicatorOverlay:

Collaboration diagram for AdornedRulerPanel::QuickPlayIndicatorOverlay:

Public Member Functions
	QuickPlayIndicatorOverlay (AudacityProject *project)
Public Member Functions inherited from Overlay
	Overlay ()=default
	Overlay (const Overlay &) PROHIBITED
Overlay &	operator= (const Overlay &) PROHIBITED
virtual	~Overlay ()=0
std::pair< wxRect, bool >	GetRectangle (wxSize size)
virtual void	Erase (wxDC &dc, wxDC &src)

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

Private Attributes
friend	QuickPlayRulerOverlay
friend	AdornedRulerPanel
AudacityProject *	mProject
std::shared_ptr< QuickPlayRulerOverlay >	mPartner { std::make_shared<QuickPlayRulerOverlay>(*this) }
int	mOldQPIndicatorPos { -1 }
bool	mOldQPIndicatorSnapped {}
bool	mOldPreviewingScrub {}

Detailed Description

Definition at line 167 of file AdornedRulerPanel.cpp.

Constructor & Destructor Documentation

QuickPlayIndicatorOverlay()

AdornedRulerPanel::QuickPlayIndicatorOverlay::QuickPlayIndicatorOverlay

(

AudacityProject *

project

)

Definition at line 303 of file AdornedRulerPanel.cpp.

   : mProject(project)
{
}

Member Function Documentation

DoGetRectangle()

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

overrideprivatevirtual

Implements Overlay.

Definition at line 316 of file AdornedRulerPanel.cpp.

{
   mPartner->Update();
 
   wxRect rect(mOldQPIndicatorPos, 0, 1, size.GetHeight());
   return std::make_pair(
      rect,
      (mOldQPIndicatorPos != mPartner->mNewQPIndicatorPos ||
       mOldQPIndicatorSnapped != mPartner->mNewQPIndicatorSnapped ||
       mOldPreviewingScrub != mPartner->mNewPreviewingScrub)
   );
}

References size.

Draw()

void AdornedRulerPanel::QuickPlayIndicatorOverlay::Draw ( OverlayPanel &  panel, wxDC &  dc  )

overrideprivatevirtual

Implements Overlay.

Definition at line 329 of file AdornedRulerPanel.cpp.

{
   mOldQPIndicatorPos = mPartner->mNewQPIndicatorPos;
   mOldQPIndicatorSnapped = mPartner->mNewQPIndicatorSnapped;
   mOldPreviewingScrub = mPartner->mNewPreviewingScrub;
 
   if (mOldQPIndicatorPos >= 0) {
      mOldPreviewingScrub
      ? AColor::IndicatorColor(&dc, true) // Draw green line for preview.
      : mOldQPIndicatorSnapped
        ? AColor::SnapGuidePen(&dc)
        : AColor::Light(&dc, false)
      ;
 
      // Draw indicator in all visible tracks
      auto pCellularPanel = dynamic_cast<CellularPanel*>( &panel );
      if ( !pCellularPanel ) {
         wxASSERT( false );
         return;
      }
      pCellularPanel
         ->VisitCells( [&]( const wxRect &rect, TrackPanelCell &cell ) {
            const auto pTrackView = dynamic_cast<TrackView*>(&cell);
            if (!pTrackView)
               return;
 
            // Draw the NEW indicator in its NEW location
            AColor::Line(dc,
               mOldQPIndicatorPos,
               rect.GetTop(),
               mOldQPIndicatorPos,
               rect.GetBottom());
      } );
   }
}

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

Here is the call graph for this function:

SequenceNumber()

unsigned AdornedRulerPanel::QuickPlayIndicatorOverlay::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 310 of file AdornedRulerPanel.cpp.

{
   return 30;
}

Member Data Documentation

AdornedRulerPanel

friend AdornedRulerPanel::QuickPlayIndicatorOverlay::AdornedRulerPanel

private

Definition at line 170 of file AdornedRulerPanel.cpp.

mOldPreviewingScrub

bool AdornedRulerPanel::QuickPlayIndicatorOverlay::mOldPreviewingScrub {}

private

Definition at line 187 of file AdornedRulerPanel.cpp.

mOldQPIndicatorPos

int AdornedRulerPanel::QuickPlayIndicatorOverlay::mOldQPIndicatorPos { -1 }

private

Definition at line 185 of file AdornedRulerPanel.cpp.

mOldQPIndicatorSnapped

bool AdornedRulerPanel::QuickPlayIndicatorOverlay::mOldQPIndicatorSnapped {}

private

Definition at line 186 of file AdornedRulerPanel.cpp.

mPartner

std::shared_ptr<QuickPlayRulerOverlay> AdornedRulerPanel::QuickPlayIndicatorOverlay::mPartner { std::make_shared<QuickPlayRulerOverlay>(*this) }

private

Definition at line 182 of file AdornedRulerPanel.cpp.

mProject

AudacityProject* AdornedRulerPanel::QuickPlayIndicatorOverlay::mProject

private

Definition at line 180 of file AdornedRulerPanel.cpp.

QuickPlayRulerOverlay

friend AdornedRulerPanel::QuickPlayIndicatorOverlay::QuickPlayRulerOverlay

private

Definition at line 169 of file AdornedRulerPanel.cpp.

---

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

• AdornedRulerPanel.cpp