OverlayPanel Class Reference

#include <OverlayPanel.h>

Inheritance diagram for OverlayPanel:

Collaboration diagram for OverlayPanel:

Public Member Functions
	OverlayPanel (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, long style=wxTAB_TRAVERSAL|wxNO_BORDER)
void	AddOverlay (const std::weak_ptr< Overlay > &pOverlay)
void	ClearOverlays ()
void	DrawOverlays (bool repaint_all, wxDC *pDC=nullptr)
Public Member Functions inherited from BackedPanel
	BackedPanel (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, long style)
	~BackedPanel ()
wxDC &	GetBackingDC ()
wxDC &	GetBackingDCForRepaint ()
void	ResizeBacking ()
void	RepairBitmap (wxDC &dc, wxCoord x, wxCoord y, wxCoord width, wxCoord height)
void	DisplayBitmap (wxDC &dc)
void	OnSize (wxSizeEvent &event)
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Types
using	OverlayPtr = std::weak_ptr< Overlay >

Private Member Functions
void	Compress ()

Private Attributes
std::vector< OverlayPtr >	mOverlays

Friends
class	GetInfoCommand

Detailed Description

Definition at line 18 of file OverlayPanel.h.

Member Typedef Documentation

OverlayPtr

using OverlayPanel::OverlayPtr = std::weak_ptr<Overlay>

private

Definition at line 43 of file OverlayPanel.h.

Constructor & Destructor Documentation

OverlayPanel()

OverlayPanel::OverlayPanel	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos,
		const wxSize &	size,
		long	style = wxTAB_TRAVERSAL | wxNO_BORDER
	)

Definition at line 17 of file OverlayPanel.cpp.

: BackedPanel(parent, id, pos, size, style)
{}

Member Function Documentation

AddOverlay()

void OverlayPanel::AddOverlay

(

const std::weak_ptr< Overlay > &

pOverlay

)

Definition at line 24 of file OverlayPanel.cpp.

{
   if (pOverlay.expired())
      return;
   Compress();
   auto iter = std::lower_bound( mOverlays.begin(), mOverlays.end(),
      pOverlay.lock()->SequenceNumber(),
      []( const OverlayPtr &p, unsigned value ) {
         return p.expired() || p.lock()->SequenceNumber() < value;
      }
   );
   mOverlays.insert(iter, pOverlay);
}

References Compress(), and mOverlays.

Referenced by AdornedRulerPanel::CreateOverlays().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearOverlays()

void OverlayPanel::ClearOverlays

(

)

Definition at line 38 of file OverlayPanel.cpp.

{
   mOverlays.clear();
}

References mOverlays.

Compress()

void OverlayPanel::Compress ( )

private

Definition at line 126 of file OverlayPanel.cpp.

{
   // remove any expired pointers
   auto begin = mOverlays.begin();
   auto end = mOverlays.end();
   auto newEnd = std::remove_if( begin, end,
      []( const std::weak_ptr<Overlay> &pOverlay ){
         return pOverlay.expired(); } );
   if ( end != newEnd )
      mOverlays.resize( newEnd - begin );
}

References details::begin(), details::end(), and mOverlays.

Referenced by AddOverlay(), and DrawOverlays().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawOverlays()

void OverlayPanel::DrawOverlays	(	bool	repaint_all,
		wxDC *	pDC = nullptr
	)

Definition at line 43 of file OverlayPanel.cpp.

{
   if ( !IsShownOnScreen() )
      return;
 
   size_t n_pairs = mOverlays.size();
 
   using Pair = std::pair<wxRect, bool /*out of date?*/>;
   std::vector< Pair > pairs;
   pairs.reserve(n_pairs);
 
   // First...
   Compress();
   // ... then assume pointers are not expired
 
   // Find out the rectangles and outdatedness for each overlay
   wxSize size(GetBackingDC().GetSize());
   for (const auto& pOverlay : mOverlays)
      pairs.push_back( pOverlay.lock()->GetRectangle(size) );
 
   // See what requires redrawing.  If repainting, all.
   // If not, then whatever is outdated, and whatever will be damaged by
   // undrawing.
   // By redrawing only what needs it, we avoid flashing things like
   // the cursor that are drawn with invert, and also avoid
   // unnecessary work.
 
   // But first, a quick exit test.
   bool some_overlays_need_repainting =
      repaint_all ||
      std::any_of( pairs.begin(), pairs.end(),
         []( const Pair &pair ){ return pair.second; } );
 
   if (!some_overlays_need_repainting) {
     // This function (OverlayPanel::DrawOverlays()) is called at
     // fairly high frequency through a timer in TrackPanel. In case
     // there is nothing to do, we exit early because creating the
     // wxClientDC below is expensive, at least on Linux.
     return;
   }
 
   if (!repaint_all) {
      // For each overlay that needs update, any other overlay whose
      // rectangle intersects it will also need update.
      bool done;
      do {
         done = true;
         for (size_t ii = 0; ii < n_pairs - 1; ++ii) {
            for (size_t jj = ii + 1; jj < n_pairs; ++jj) {
               if (pairs[ii].second != pairs[jj].second &&
                   pairs[ii].first.Intersects(pairs[jj].first)) {
                  done = false;
                  pairs[ii].second = pairs[jj].second = true;
               }
            }
         }
      } while (!done);
   }
 
   std::optional<wxClientDC> myDC;
   auto &dc = pDC ? *pDC : (myDC.emplace(this), *myDC);
 
   // Erase
   auto it2 = pairs.begin();
   for (auto pOverlay : mOverlays) {
      if (repaint_all || it2->second)
         pOverlay.lock()->Erase(dc, GetBackingDC());
      ++it2;
   }
 
   // Draw
   it2 = pairs.begin();
   for (auto pOverlay : mOverlays) {
      if (repaint_all || it2->second) {
         // Guarantee a clean state of the dc each pass:
         ADCChanger changer{ &dc };
 
         pOverlay.lock()->Draw(*this, dc);
      }
      ++it2;
   }
}

References Compress(), BackedPanel::GetBackingDC(), mOverlays, and size.

Referenced by AdornedRulerPanel::DrawBothOverlays(), TrackPanel::OnPaint(), AdornedRulerPanel::OnPaint(), TrackPanel::OnTimer(), and TrackPanel::ProcessUIHandleResult().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

GetInfoCommand

friend class GetInfoCommand

friend

Definition at line 50 of file OverlayPanel.h.

Member Data Documentation

mOverlays

std::vector< OverlayPtr > OverlayPanel::mOverlays

private

Definition at line 46 of file OverlayPanel.h.

Referenced by AddOverlay(), ClearOverlays(), Compress(), and DrawOverlays().

---

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

• OverlayPanel.h
• OverlayPanel.cpp