AdornedRulerPanel::ScrubbingRulerOverlay Class Reference

Inheritance diagram for AdornedRulerPanel::ScrubbingRulerOverlay:

Collaboration diagram for AdornedRulerPanel::ScrubbingRulerOverlay:

Public Member Functions
	ScrubbingRulerOverlay (TrackPanelGuidelineOverlay &partner)
void	Update ()
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 Attributes
int	mNewQPIndicatorPos { -1 }
int	mNewIndicatorSnapped { -1 }
bool	mNewScrub {}
bool	mNewSeek {}

Private Member Functions
AdornedRulerPanel *	GetRuler () const
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
TrackPanelGuidelineOverlay &	mPartner
int	mOldQPIndicatorPos { -1 }
bool	mOldScrub {}
bool	mOldSeek {}

Detailed Description

Definition at line 422 of file AdornedRulerPanel.cpp.

Constructor & Destructor Documentation

ScrubbingRulerOverlay()

AdornedRulerPanel::ScrubbingRulerOverlay::ScrubbingRulerOverlay

(

TrackPanelGuidelineOverlay &

partner

)

Definition at line 493 of file AdornedRulerPanel.cpp.

: mPartner(partner)
{
}

Member Function Documentation

DoGetRectangle()

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

overrideprivatevirtual

Implements Overlay.

Definition at line 554 of file AdornedRulerPanel.cpp.

{
   Update();
 
   const auto x = mOldQPIndicatorPos;
   if (x >= 0) {
      // These dimensions are always sufficient, even if a little
      // excessive for the small triangle:
      const int width = IndicatorBigWidth() * 3 / 2;
      //const auto height = IndicatorHeightForWidth(width);
 
      const int indsize = width / 2;
 
      auto xx = x - indsize;
      auto yy = 0;
      return {
         { xx, yy,
            indsize * 2 + 1,
            GetRuler()->GetSize().GetHeight() },
         (x != mNewQPIndicatorPos
          || (mOldScrub != mNewScrub)
          || (mOldSeek != mNewSeek) )
      };
   }
   else
      return { {}, mNewQPIndicatorPos >= 0 };
}

References IndicatorBigWidth().

Here is the call graph for this function:

Draw()

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

overrideprivatevirtual

Implements Overlay.

Definition at line 582 of file AdornedRulerPanel.cpp.

{
   mOldQPIndicatorPos = mNewQPIndicatorPos;
   mOldScrub = mNewScrub;
   mOldSeek = mNewSeek;
   if (mOldQPIndicatorPos >= 0) {
      auto ruler = GetRuler();
      auto width = mOldScrub ? IndicatorBigWidth() : IndicatorSmallWidth;
      ruler->DoDrawScrubIndicator(
         &dc, mOldQPIndicatorPos, width, mOldScrub, mOldSeek);
   }
}

References IndicatorBigWidth(), IndicatorSmallWidth, and anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler().

Here is the call graph for this function:

GetRuler()

AdornedRulerPanel * AdornedRulerPanel::ScrubbingRulerOverlay::GetRuler ( ) const

private

Definition at line 499 of file AdornedRulerPanel.cpp.

{
   return &Get( *mPartner.mProject );
}

References AdornedRulerPanel::Get().

Here is the call graph for this function:

SequenceNumber()

unsigned AdornedRulerPanel::ScrubbingRulerOverlay::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 548 of file AdornedRulerPanel.cpp.

{
   return 30;
}

Update()

void AdornedRulerPanel::ScrubbingRulerOverlay::Update

(

)

Definition at line 504 of file AdornedRulerPanel.cpp.

{
   const auto project = mPartner.mProject;
   auto &scrubber = Scrubber::Get( *project );
   auto ruler = GetRuler();
 
   bool scrubbing = (scrubber.IsScrubbing()
      && !scrubber.IsSpeedPlaying()
      && !scrubber.IsKeyboardScrubbing());
 
   // Hide during transport, or if mouse is not in the ruler, unless scrubbing
   if ((!ruler->LastCell() || ProjectAudioIO::Get( *project ).IsAudioActive())
       && !scrubbing)
      mNewQPIndicatorPos = -1;
   else {
      const auto &selectedRegion = ViewInfo::Get( *project ).selectedRegion;
      double latestEnd =
         std::max(ruler->mTracks->GetEndTime(), selectedRegion.t1());
      // This will determine the x coordinate of the line and of the
      // ruler indicator
 
      // Test all snap points
      mNewIndicatorSnapped = -1;
      for (size_t ii = 0;
           mNewIndicatorSnapped == -1 && ii < ruler->mNumGuides; ++ii) {
         if (ruler->mIsSnapped[ii]) {
            mNewIndicatorSnapped = ii;
         }
      }
      mNewQPIndicatorPos = ruler->Time2Pos(
         ruler->mQuickPlayPos[std::max(0, mNewIndicatorSnapped)]);
 
      // These determine which shape is drawn on the ruler, and whether
      // in the scrub or the qp zone
      mNewScrub =
         !ruler->IsMouseCaptured() && // not doing some other drag in the ruler
         (ruler->LastCell() == ruler->mScrubbingCell ||
          (scrubber.HasMark()));
      mNewSeek = mNewScrub &&
         (scrubber.Seeks() || scrubber.TemporarilySeeks());
   }
}

References ProjectAudioIO::Get(), ViewInfo::Get(), Scrubber::Get(), ProjectAudioIO::IsAudioActive(), project, anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler(), and ViewInfo::selectedRegion.

Here is the call graph for this function:

Member Data Documentation

mNewIndicatorSnapped

int AdornedRulerPanel::ScrubbingRulerOverlay::mNewIndicatorSnapped { -1 }

Definition at line 428 of file AdornedRulerPanel.cpp.

mNewQPIndicatorPos

int AdornedRulerPanel::ScrubbingRulerOverlay::mNewQPIndicatorPos { -1 }

Definition at line 427 of file AdornedRulerPanel.cpp.

mNewScrub

bool AdornedRulerPanel::ScrubbingRulerOverlay::mNewScrub {}

Definition at line 430 of file AdornedRulerPanel.cpp.

mNewSeek

bool AdornedRulerPanel::ScrubbingRulerOverlay::mNewSeek {}

Definition at line 431 of file AdornedRulerPanel.cpp.

mOldQPIndicatorPos

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

private

Definition at line 446 of file AdornedRulerPanel.cpp.

mOldScrub

bool AdornedRulerPanel::ScrubbingRulerOverlay::mOldScrub {}

private

Definition at line 447 of file AdornedRulerPanel.cpp.

mOldSeek

bool AdornedRulerPanel::ScrubbingRulerOverlay::mOldSeek {}

private

Definition at line 448 of file AdornedRulerPanel.cpp.

mPartner

TrackPanelGuidelineOverlay& AdornedRulerPanel::ScrubbingRulerOverlay::mPartner

private

Definition at line 443 of file AdornedRulerPanel.cpp.

---

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

• AdornedRulerPanel.cpp