EditCursorOverlay Class Reference

#include <EditCursorOverlay.h>

Inheritance diagram for EditCursorOverlay:

Collaboration diagram for EditCursorOverlay:

Public Member Functions
	EditCursorOverlay (AudacityProject *project, bool isMaster=true)
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 ()

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
AudacityProject *	mProject
bool	mIsMaster
std::shared_ptr< EditCursorOverlay >	mPartner
int	mLastCursorX
double	mCursorTime
int	mNewCursorX

Detailed Description

Definition at line 20 of file EditCursorOverlay.h.

Constructor & Destructor Documentation

EditCursorOverlay()

EditCursorOverlay::EditCursorOverlay ( AudacityProject *  project, bool  isMaster = true  )

explicit

Definition at line 42 of file EditCursorOverlay.cpp.

   : mProject(project)
   , mIsMaster(isMaster)
   , mLastCursorX(-1)
   , mCursorTime(-1)
   , mNewCursorX(-1)
{
}

Member Function Documentation

DoGetRectangle()

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

overrideprivatevirtual

Implements Overlay.

Definition at line 56 of file EditCursorOverlay.cpp.

{
   const auto &viewInfo = ViewInfo::Get( *mProject );
   const auto &selection = viewInfo.selectedRegion;
   if (!selection.isPoint()) {
      mCursorTime = -1.0;
      mNewCursorX = -1;
   }
   else {
      mCursorTime = selection.t0();
      mNewCursorX = viewInfo.TimeToPosition(
         mCursorTime, viewInfo.GetLeftOffset());
   }
 
   // Excessive height in case of the ruler, but it matters little.
   return std::make_pair(
      mLastCursorX == -1
         ? wxRect()
         : wxRect(mLastCursorX, 0, 1, size.GetHeight()),
      mLastCursorX != mNewCursorX
   );
}

References ViewInfo::Get(), mCursorTime, mLastCursorX, mNewCursorX, mProject, and size.

Here is the call graph for this function:

Draw()

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

overrideprivatevirtual

Implements Overlay.

Definition at line 80 of file EditCursorOverlay.cpp.

{
   if (mIsMaster && !mPartner) {
      auto &ruler = AdornedRulerPanel::Get( *mProject );
      mPartner = std::make_shared<EditCursorOverlay>(mProject, false);
      ruler.AddOverlay( mPartner );
   }
 
   mLastCursorX = mNewCursorX;
   if (mLastCursorX == -1)
      return;
 
   const auto &viewInfo = ViewInfo::Get( *mProject );
 
   const bool
   onScreen = between_incexc(viewInfo.hpos,
                             mCursorTime,
                             viewInfo.GetScreenEndTime());
 
   if (!onScreen)
      return;
 
   auto &trackPanel = TrackPanel::Get( *mProject );
   //NOTE: point selection cursor drawing over tracks moved to TrackPanel.cpp(see also TrackArt::DrawCursor)
   /*if (auto tp = dynamic_cast<TrackPanel*>(&panel)) {
      wxASSERT(mIsMaster);
      AColor::CursorColor(&dc);
 
      // Draw cursor in all selected tracks
      tp->VisitCells( [&]( const wxRect &rect, TrackPanelCell &cell ) {
         const auto pChannelView = dynamic_cast<ChannelView*>(&cell);
         if (!pChannelView)
            return;
         const auto pChannel = pChannelView->FindChannel();
         const auto pTrack =
            dynamic_cast<Track *>(&pChannel->GetChannelGroup());
         if (pChannel && (pTrack->GetSelected() ||
             TrackFocus::Get( *mProject ).IsFocused(pTrack)))
         {
            // AColor::Line includes both endpoints so use GetBottom()
            AColor::Line(dc, mLastCursorX, rect.GetTop(), mLastCursorX, rect.GetBottom());
            // ^^^ The whole point of this routine.
 
         }
      } );
   }
   else if (auto ruler = dynamic_cast<AdornedRulerPanel*>(&panel)) {
      wxASSERT(!mIsMaster);
      dc.SetPen(*wxBLACK_PEN);
      // AColor::Line includes both endpoints so use GetBottom()
      auto rect = ruler->GetInnerRect();
      AColor::Line(dc, mLastCursorX, rect.GetTop(), mLastCursorX, rect.GetBottom());
   }
   else
      wxASSERT(false);*/
   if (auto ruler = dynamic_cast<AdornedRulerPanel*>(&panel)) {
       wxASSERT(!mIsMaster);
       dc.SetPen(*wxBLACK_PEN);
       // AColor::Line includes both endpoints so use GetBottom()
       auto rect = ruler->GetInnerRect();
       AColor::Line(dc, mLastCursorX, rect.GetTop(), mLastCursorX, rect.GetBottom());
   }
}

References anonymous_namespace{EditCursorOverlay.cpp}::between_incexc(), ViewInfo::Get(), AdornedRulerPanel::Get(), TrackPanel::Get(), AColor::Line(), mCursorTime, mIsMaster, mLastCursorX, mNewCursorX, mPartner, mProject, and anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler().

Here is the call graph for this function:

SequenceNumber()

unsigned EditCursorOverlay::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 51 of file EditCursorOverlay.cpp.

{
   return 20;
}

Member Data Documentation

mCursorTime

double EditCursorOverlay::mCursorTime

private

Definition at line 38 of file EditCursorOverlay.h.

Referenced by DoGetRectangle(), and Draw().

mIsMaster

bool EditCursorOverlay::mIsMaster

private

Definition at line 34 of file EditCursorOverlay.h.

Referenced by Draw().

mLastCursorX

int EditCursorOverlay::mLastCursorX

private

Definition at line 37 of file EditCursorOverlay.h.

Referenced by DoGetRectangle(), and Draw().

mNewCursorX

int EditCursorOverlay::mNewCursorX

private

Definition at line 39 of file EditCursorOverlay.h.

Referenced by DoGetRectangle(), and Draw().

mPartner

std::shared_ptr<EditCursorOverlay> EditCursorOverlay::mPartner

private

Definition at line 35 of file EditCursorOverlay.h.

Referenced by Draw().

mProject

AudacityProject* EditCursorOverlay::mProject

private

Definition at line 33 of file EditCursorOverlay.h.

Referenced by DoGetRectangle(), and Draw().

---

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

• EditCursorOverlay.h
• EditCursorOverlay.cpp