Overlay Class Reference

#include <Overlay.h>

Inheritance diagram for Overlay:

Public Member Functions
	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

Detailed Description

Definition at line 93 of file Overlay.h.

Constructor & Destructor Documentation

Overlay() [1/2]

Overlay::Overlay ( )

default

Overlay() [2/2]

Overlay::Overlay ( const Overlay &  )

delete

~Overlay()

Overlay::~Overlay ( )

pure virtual

Definition at line 13 of file Overlay.cpp.

{
}

Member Function Documentation

DoGetRectangle()

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

pure virtual

Implemented in AdornedRulerPanel::ScrubbingRulerOverlay, AdornedRulerPanel::TrackPanelGuidelineOverlay, EditCursorOverlay, PlayIndicatorOverlayBase, and ScrubbingOverlay.

Referenced by GetRectangle().

Here is the caller graph for this function:

Draw()

virtual void Overlay::Draw ( OverlayPanel &  panel, wxDC &  dc  )

pure virtual

Implemented in AdornedRulerPanel::ScrubbingRulerOverlay, AdornedRulerPanel::TrackPanelGuidelineOverlay, EditCursorOverlay, PlayIndicatorOverlayBase, and ScrubbingOverlay.

Erase()

void Overlay::Erase ( wxDC &  dc, wxDC &  src  )

virtual

Definition at line 29 of file Overlay.cpp.

{
   wxRect rect(dc.GetSize());
   rect.Intersect(src.GetSize());
   auto smallRect(GetRectangle(src.GetSize()).first);
   rect.Intersect(smallRect);
   if (!rect.IsEmpty())
      dc.Blit(rect.x, rect.y, rect.width, rect.height,
              &src, rect.x, rect.y);
}

References GetRectangle().

Here is the call graph for this function:

GetRectangle()

std::pair< wxRect, bool > Overlay::GetRectangle

(

wxSize

size

)

Definition at line 17 of file Overlay.cpp.

{
   auto result = DoGetRectangle(size);
#ifdef __WXMAC__
   // On OSX, if a HiDPI resolution is being used, a vertical line will actually take up
   // more than 1 pixel (even though it is drawn as 1), so we restore the surrounding
   // pixels as well.  (This is because the wxClientDC doesn't know about the scaling.
   result.first.Inflate(1, 0);
#endif
   return result;
}

References DoGetRectangle(), and size.

Referenced by Erase().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

Overlay & Overlay::operator= ( const Overlay &  )

delete

SequenceNumber()

virtual unsigned Overlay::SequenceNumber ( ) const

pure virtual

This number determines an ordering of overlays, so that those with higher numbers overpaint those with lower numbers that intersect.

Implemented in AdornedRulerPanel::ScrubbingRulerOverlay, AdornedRulerPanel::TrackPanelGuidelineOverlay, EditCursorOverlay, PlayIndicatorOverlayBase, and ScrubbingOverlay.

---

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

• Overlay.h
• Overlay.cpp