NoteTrackVRulerControls Class Reference

#include <NoteTrackVRulerControls.h>

Inheritance diagram for NoteTrackVRulerControls:

Collaboration diagram for NoteTrackVRulerControls:

Public Member Functions
	NoteTrackVRulerControls (const std::shared_ptr< ChannelView > &pChannelView)
	~NoteTrackVRulerControls ()
std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject) override
unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
Public Member Functions inherited from ChannelVRulerControls
	ChannelVRulerControls (const std::shared_ptr< ChannelView > &pChannelView)
virtual	~ChannelVRulerControls ()=0
std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject) override
virtual void	UpdateRuler (const wxRect &rect)=0
std::shared_ptr< const ChannelView >	GetChannelView () const
Public Member Functions inherited from CommonChannelCell
	CommonChannelCell (const std::shared_ptr< Channel > &pChannel)
	Construct from a channel. More...
	~CommonChannelCell ()
std::shared_ptr< Track >	DoFindTrack () override
void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel) override
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
template<typename Subtype = Channel>
auto	FindChannel () -> std::shared_ptr< Subtype >
	May return null. More...
template<typename Subtype = const Channel>
auto	FindChannel () const -> std::enable_if_t< std::is_const_v< Subtype >, std::shared_ptr< Subtype > >
	May return null. More...
Public Member Functions inherited from CommonTrackPanelCell
	CommonTrackPanelCell ()
virtual	~CommonTrackPanelCell ()=0
HitTestPreview	DefaultPreview (const TrackPanelMouseState &, const AudacityProject *) override
std::shared_ptr< Track >	FindTrack ()
std::shared_ptr< const Track >	FindTrack () const
virtual std::vector< MenuItem >	GetMenuItems (const wxRect &rect, const wxPoint *pPosition, AudacityProject *pProject)
	Return a list of items for DoContextMenu() (empties for separators) More...
Public Member Functions inherited from TrackPanelCell
	TrackPanelCell ()=default
	TrackPanelCell (const TrackPanelCell &)=delete
TrackPanelCell &	operator= (const TrackPanelCell &)=delete
virtual	~TrackPanelCell ()=0
virtual HitTestPreview	DefaultPreview (const TrackPanelMouseState &state, const AudacityProject *pProject)
virtual std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject)=0
virtual unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject)
virtual std::shared_ptr< TrackPanelCell >	ContextMenuDelegate ()
virtual unsigned	DoContextMenu (const wxRect &rect, wxWindow *pParent, const wxPoint *pPosition, AudacityProject *pProject)
virtual unsigned	CaptureKey (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	KeyDown (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	KeyUp (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	Char (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	LoseFocus (AudacityProject *project)
Public Member Functions inherited from TrackPanelNode
	TrackPanelNode ()
virtual	~TrackPanelNode ()=0
Public Member Functions inherited from TrackPanelDrawable
virtual	~TrackPanelDrawable ()=0
virtual void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass)
virtual wxRect	DrawingArea (TrackPanelDrawingContext &context, const wxRect &rect, const wxRect &panelRect, unsigned iPass)
Public Member Functions inherited from ChannelAttachment
virtual	~ChannelAttachment ()
virtual void	CopyTo (Track &track, size_t iChannel) const
	Copy state, for undo/redo purposes. More...
virtual void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel)
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
virtual void	WriteXMLAttributes (XMLWriter &writer, size_t iChannel) const
	Serialize persistent attributes. More...
virtual bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView, size_t iChannel)
	Deserialize an attribute, returning true if recognized. More...

Private Member Functions
	NoteTrackVRulerControls (const NoteTrackVRulerControls &)=delete
NoteTrackVRulerControls &	operator= (const NoteTrackVRulerControls &)=delete
std::shared_ptr< NoteTrack >	FindNoteTrack ()
void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override
void	UpdateRuler (const wxRect &rect) override

Private Attributes
std::weak_ptr< NoteTrackVZoomHandle >	mVZoomHandle

Additional Inherited Members
Static Public Member Functions inherited from ChannelVRulerControls
static ChannelVRulerControls &	Get (ChannelView &)
static const ChannelVRulerControls &	Get (const ChannelView &)
static void	DrawZooming (TrackPanelDrawingContext &context, const wxRect &rect, int zoomStart, int zoomEnd)
static wxRect	ZoomingArea (const wxRect &rect, const wxRect &panelRect)
Static Public Member Functions inherited from TrackPanelDrawable
static wxRect	MaximizeWidth (const wxRect &rect, const wxRect &panelRect)
static wxRect	MaximizeHeight (const wxRect &rect, const wxRect &panelRect)
Protected Member Functions inherited from ChannelVRulerControls
std::shared_ptr< Track >	DoFindTrack () override
void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override
wxRect	DrawingArea (TrackPanelDrawingContext &, const wxRect &rect, const wxRect &panelRect, unsigned iPass) override
Track *	GetTrack () const
Protected Member Functions inherited from CommonTrackPanelCell
virtual std::shared_ptr< Track >	DoFindTrack ()=0
unsigned	DoContextMenu (const wxRect &rect, wxWindow *pParent, const wxPoint *pPosition, AudacityProject *pProject) override
unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
Protected Attributes inherited from ChannelVRulerControls
std::weak_ptr< ChannelView >	mwChannelView

Detailed Description

Definition at line 19 of file NoteTrackVRulerControls.h.

Constructor & Destructor Documentation

NoteTrackVRulerControls() [1/2]

NoteTrackVRulerControls::NoteTrackVRulerControls ( const NoteTrackVRulerControls &  )

privatedelete

NoteTrackVRulerControls() [2/2]

NoteTrackVRulerControls::NoteTrackVRulerControls ( const std::shared_ptr< ChannelView > &  pChannelView )

inlineexplicit

Definition at line 26 of file NoteTrackVRulerControls.h.

      : ChannelVRulerControls{ pChannelView } {}

~NoteTrackVRulerControls()

NoteTrackVRulerControls::~NoteTrackVRulerControls

(

)

Definition at line 37 of file NoteTrackVRulerControls.cpp.

{
}

Member Function Documentation

Draw()

void NoteTrackVRulerControls::Draw ( TrackPanelDrawingContext &  context, const wxRect &  rect, unsigned  iPass  )

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 105 of file NoteTrackVRulerControls.cpp.

{
   ChannelVRulerControls::Draw(context, rect_, iPass);
 
   // Draw on a later pass like other vertical rulers,
   // although the bevel is done a little differently
 
   if ( iPass == TrackArtist::PassControls ) {
      // The note track draws a vertical keyboard to label pitches
      auto track = FindNoteTrack();
      if (!track)
         return;
 
      auto rect = rect_;
      --rect.width;
      --rect.height;
 
      bool highlight = false;
#ifdef EXPERIMENTAL_TRACK_PANEL_HIGHLIGHTING
      highlight = rect.Contains(context.lastState.GetPosition());
#endif
 
      const auto artist = TrackArtist::Get( context );
      UpdateRuler(rect);
 
      auto dc = &context.dc;
 
      dc->SetPen(highlight ? AColor::uglyPen : *wxTRANSPARENT_PEN);
      dc->SetBrush(*wxWHITE_BRUSH);
      wxRect bev = rect;
      bev.x++;
      bev.width--;
      dc->DrawRectangle(bev);
 
      rect.y += 1;
      rect.height -= 1;
 
      NoteTrackDisplayData data{ *track, rect };
 
      wxPen hilitePen;
      hilitePen.SetColour(120, 120, 120);
      wxBrush blackKeyBrush;
      blackKeyBrush.SetColour(70, 70, 70);
 
      dc->SetBrush(blackKeyBrush);
 
      int fontSize = 10;
#ifdef __WXMSW__
      fontSize = 8;
#endif
 
      wxFont labelFont(fontSize, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
      dc->SetFont(labelFont);
 
      int octave = 0;
      int obottom = data.GetOctaveBottom(octave);
      int marg = data.GetNoteMargin();
 
      while (obottom >= rect.y) {
         dc->SetPen(*wxBLACK_PEN);
         for (int white = 0; white < 7; white++) {
            int pos = data.GetWhitePos(white);
            if (obottom - pos > rect.y + marg + 1 &&
                // don't draw too close to margin line -- it's annoying
                obottom - pos < rect.y + rect.height - marg - 3)
               AColor::Line(*dc, rect.x, obottom - pos,
                            rect.x + rect.width, obottom - pos);
         }
         wxRect br = rect;
         br.height = data.GetPitchHeight(1);
         br.x++;
         br.width = 17;
         for (int black = 0; black < 5; black++) {
            br.y = obottom - data.GetBlackPos(black);
            if (br.y > rect.y + marg - 2 && br.y + br.height < rect.y + rect.height - marg) {
               dc->SetPen(hilitePen);
               dc->DrawRectangle(br);
               dc->SetPen(*wxBLACK_PEN);
               AColor::Line(*dc,
                            br.x + 1, br.y + br.height - 1,
                            br.x + br.width - 1, br.y + br.height - 1);
               AColor::Line(*dc,
                            br.x + br.width - 1, br.y + 1,
                            br.x + br.width - 1, br.y + br.height - 1);
            }
         }
 
         if (octave >= 1 && octave <= 10) {
            wxString s;
            // ISO standard: A440 is in the 4th octave, denoted
            // A4 <- the "4" should be a subscript.
            s.Printf(wxT("C%d"), octave - 1);
            wxCoord width, height;
            dc->GetTextExtent(s, &width, &height);
            if (obottom - height + 4 > rect.y &&
                obottom + 4 < rect.y + rect.height) {
               dc->SetTextForeground(wxColour(60, 60, 255));
               dc->DrawText(s, rect.x + rect.width - width,
                            obottom - height + 2);
            }
         }
         obottom = data.GetOctaveBottom(++octave);
      }
      // draw lines delineating the out-of-bounds margins
      dc->SetPen(*wxBLACK_PEN);
      // you would think the -1 offset here should be -2 to match the
      // adjustment to rect.y (see above), but -1 produces correct output
      AColor::Line(*dc, rect.x, rect.y + marg - 1, rect.x + rect.width, rect.y + marg - 1);
      // since the margin gives us the bottom of the line,
      // the extra -1 gets us to the top
      AColor::Line(*dc, rect.x, rect.y + rect.height - marg - 1,
                        rect.x + rect.width, rect.y + rect.height - marg - 1);
 
   }
}

References TrackPanelDrawingContext::dc, ChannelVRulerControls::Draw(), FindNoteTrack(), TrackArtist::Get(), TrackPanelDrawingContext::lastState, AColor::Line(), TrackArtist::PassControls, AColor::uglyPen, UpdateRuler(), and wxT().

Here is the call graph for this function:

FindNoteTrack()

std::shared_ptr< NoteTrack > NoteTrackVRulerControls::FindNoteTrack ( )

private

Definition at line 62 of file NoteTrackVRulerControls.cpp.

{
   return FindChannel<NoteTrack>();
}

Referenced by Draw(), HandleWheelRotation(), HitTest(), and UpdateRuler().

Here is the caller graph for this function:

HandleWheelRotation()

unsigned NoteTrackVRulerControls::HandleWheelRotation ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject  )

overridevirtual

Reimplemented from TrackPanelCell.

Definition at line 67 of file NoteTrackVRulerControls.cpp.

{
   using namespace RefreshCode;
   const wxMouseEvent &event = evt.event;
 
   if (!(event.ShiftDown() || event.CmdDown()))
      return RefreshNone;
 
   // Always stop propagation even if the ruler didn't change.  The ruler
   // is a narrow enough target.
   evt.event.Skip(false);
 
   const auto nt = FindNoteTrack();
   if (!nt)
      return RefreshNone;
 
   auto steps = evt.steps;
 
   if (event.CmdDown() && !event.ShiftDown()) {
      NoteTrackDisplayData data{ *nt, evt.rect };
      if (steps > 0)
         data.ZoomIn(evt.event.m_y);
      else
         data.ZoomOut(evt.event.m_y);
   } else if (!event.CmdDown() && event.ShiftDown()) {
      // Scroll some fixed number of notes, independent of zoom level or track height:
      static const int movement = 6; // 6 semitones is half an octave
      NoteTrackRange::Get(*nt).ShiftNoteRange((int) (steps * movement));
   } else {
      return RefreshNone;
   }
 
   ProjectHistory::Get( *pProject ).ModifyState(false);
 
   return RefreshCell | UpdateVRuler;
}

References TrackPanelMouseEvent::event, FindNoteTrack(), ProjectHistory::Get(), NoteTrackRange::Get(), ProjectHistory::ModifyState(), TrackPanelMouseEvent::rect, RefreshCode::RefreshCell, RefreshCode::RefreshNone, NoteTrackRange::ShiftNoteRange(), TrackPanelMouseEvent::steps, and RefreshCode::UpdateVRuler.

Here is the call graph for this function:

HitTest()

std::vector< UIHandlePtr > NoteTrackVRulerControls::HitTest ( const TrackPanelMouseState &  state, const AudacityProject *  pProject  )

overridevirtual

Implements TrackPanelCell.

Definition at line 41 of file NoteTrackVRulerControls.cpp.

{
   std::vector<UIHandlePtr> results;
   UIHandlePtr result;
 
   if ( st.state.GetX() <= st.rect.GetRight() - kGuard ) {
      const auto track = FindNoteTrack();
      result = NoteTrackVZoomHandle::HitTest(
         mVZoomHandle, st.state, track, st.rect);
      if (result)
         results.push_back(result);
   }
 
   auto more = ChannelVRulerControls::HitTest(st, pProject);
   std::copy(more.begin(), more.end(), std::back_inserter(results));
 
   return results;
}

References staffpad::vo::copy(), FindNoteTrack(), ChannelVRulerControls::HitTest(), NoteTrackVZoomHandle::HitTest(), kGuard, mVZoomHandle, TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Here is the call graph for this function:

operator=()

NoteTrackVRulerControls & NoteTrackVRulerControls::operator= ( const NoteTrackVRulerControls &  )

privatedelete

UpdateRuler()

void NoteTrackVRulerControls::UpdateRuler ( const wxRect &  rect )

overrideprivatevirtual

Implements ChannelVRulerControls.

Definition at line 224 of file NoteTrackVRulerControls.cpp.

{
   // The note track isn't drawing a ruler at all!
   // But it needs to!
 
   const auto nt = FindNoteTrack();
   if (!nt)
      return;
 
   static Ruler ruler{
      LinearUpdater::Instance(), RealFormat::LinearInstance() };
   const auto vruler = &ruler;
 
   vruler->SetBounds(rect.x, rect.y, rect.x + 1, rect.y + rect.height - 1);
   vruler->SetOrientation(wxVERTICAL);
 
   auto &size = ChannelView::Get(*nt).vrulerSize;
   vruler->GetMaxSize(&size.first, &size.second);
}

References FindNoteTrack(), ChannelView::Get(), LinearUpdater::Instance(), RealFormat::LinearInstance(), anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler(), Ruler::SetBounds(), size, and ChannelView::vrulerSize.

Referenced by Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mVZoomHandle

std::weak_ptr<NoteTrackVZoomHandle> NoteTrackVRulerControls::mVZoomHandle

private

Definition at line 49 of file NoteTrackVRulerControls.h.

Referenced by HitTest().

---

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

• NoteTrackVRulerControls.h
• NoteTrackVRulerControls.cpp