AdornedRulerPanel::TrackPanelGuidelineOverlay Class Reference

Inheritance diagram for AdornedRulerPanel::TrackPanelGuidelineOverlay:

Collaboration diagram for AdornedRulerPanel::TrackPanelGuidelineOverlay:

Public Member Functions
	TrackPanelGuidelineOverlay (AudacityProject *project)
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

Private Member Functions
void	Update ()
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	ScrubbingRulerOverlay
friend	AdornedRulerPanel
AudacityProject *	mProject
std::shared_ptr< ScrubbingRulerOverlay >	mPartner { std::make_shared<ScrubbingRulerOverlay>(*this) }
bool	mNewPreviewingScrub {}
int	mOldQPIndicatorPos { -1 }
int	mOldIndicatorSnapped { -1 }
bool	mOldPreviewingScrub {}

Detailed Description

Definition at line 460 of file AdornedRulerPanel.cpp.

Constructor & Destructor Documentation

TrackPanelGuidelineOverlay()

AdornedRulerPanel::TrackPanelGuidelineOverlay::TrackPanelGuidelineOverlay

(

AudacityProject *

project

)

Definition at line 602 of file AdornedRulerPanel.cpp.

   : mProject(project)
{
}

Member Function Documentation

DoGetRectangle()

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

overrideprivatevirtual

Implements Overlay.

Definition at line 628 of file AdornedRulerPanel.cpp.

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

References size.

Draw()

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

overrideprivatevirtual

Implements Overlay.

Definition at line 641 of file AdornedRulerPanel.cpp.

{
   mOldQPIndicatorPos = mPartner->mNewQPIndicatorPos;
   mOldIndicatorSnapped = mPartner->mNewIndicatorSnapped;
   mOldPreviewingScrub = mNewPreviewingScrub;
 
   if (mOldQPIndicatorPos >= 0) {
      if (!mOldPreviewingScrub && mOldIndicatorSnapped < 0) {
         auto &ruler = AdornedRulerPanel::Get(*mProject);
         if (auto pHandle =
             dynamic_cast<PlayRegionAdjustingHandle*>(ruler.Target().get());
             pHandle != nullptr && pHandle->Clicked())
            // Do not draw the quick-play guideline
            return;
      }
   
      mOldPreviewingScrub
         ? AColor::IndicatorColor(&dc, true) // Draw green line for preview.
         : (mOldIndicatorSnapped >= 0)
            ? AColor::SnapGuidePen(&dc) // Yellow snap guideline
            : 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 pChannelView = dynamic_cast<ChannelView*>(&cell);
            if (!pChannelView)
               return;
 
            // Draw the NEW indicator in its NEW location
            AColor::Line(dc,
               mOldQPIndicatorPos,
               rect.GetTop(),
               mOldQPIndicatorPos,
               rect.GetBottom());
      } );
   }
}

References AdornedRulerPanel::CommonRulerHandle::Clicked(), AdornedRulerPanel::Get(), AColor::IndicatorColor(), AColor::Light(), AColor::Line(), AdornedRulerPanel::mProject, anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler(), and AColor::SnapGuidePen().

Here is the call graph for this function:

SequenceNumber()

unsigned AdornedRulerPanel::TrackPanelGuidelineOverlay::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 609 of file AdornedRulerPanel.cpp.

{
   return 30;
}

Update()

void AdornedRulerPanel::TrackPanelGuidelineOverlay::Update ( )

private

Definition at line 614 of file AdornedRulerPanel.cpp.

{
   const auto project = mProject;
   auto &scrubber = Scrubber::Get( *project );
   const auto ruler = &Get( *project );
 
   // Determine the color of the line stroked over
   // the track panel, green for scrub or yellow for snapped or white
   mNewPreviewingScrub =
      ruler->LastCell() == ruler->mScrubbingCell &&
      !scrubber.IsScrubbing();
}

References AdornedRulerPanel::Get(), Scrubber::Get(), AdornedRulerPanel::mProject, project, and anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler().

Here is the call graph for this function:

Member Data Documentation

AdornedRulerPanel

friend AdornedRulerPanel::TrackPanelGuidelineOverlay::AdornedRulerPanel

private

Definition at line 463 of file AdornedRulerPanel.cpp.

mNewPreviewingScrub

bool AdornedRulerPanel::TrackPanelGuidelineOverlay::mNewPreviewingScrub {}

private

Definition at line 480 of file AdornedRulerPanel.cpp.

mOldIndicatorSnapped

int AdornedRulerPanel::TrackPanelGuidelineOverlay::mOldIndicatorSnapped { -1 }

private

Definition at line 483 of file AdornedRulerPanel.cpp.

mOldPreviewingScrub

bool AdornedRulerPanel::TrackPanelGuidelineOverlay::mOldPreviewingScrub {}

private

Definition at line 484 of file AdornedRulerPanel.cpp.

mOldQPIndicatorPos

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

private

Definition at line 482 of file AdornedRulerPanel.cpp.

mPartner

std::shared_ptr<ScrubbingRulerOverlay> AdornedRulerPanel::TrackPanelGuidelineOverlay::mPartner { std::make_shared<ScrubbingRulerOverlay>(*this) }

private

Definition at line 477 of file AdornedRulerPanel.cpp.

mProject

AudacityProject* AdornedRulerPanel::TrackPanelGuidelineOverlay::mProject

private

Definition at line 475 of file AdornedRulerPanel.cpp.

ScrubbingRulerOverlay

friend AdornedRulerPanel::TrackPanelGuidelineOverlay::ScrubbingRulerOverlay

private

Definition at line 462 of file AdornedRulerPanel.cpp.

---

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

• AdornedRulerPanel.cpp