NoteTrackRange Class Reference

Persistent data for display of a note track. More...

#include <NoteTrackDisplayData.h>

Inheritance diagram for NoteTrackRange:

Collaboration diagram for NoteTrackRange:

Public Types
enum	{ MinPitch = 0 , MaxPitch = 127 }

Public Member Functions
	~NoteTrackRange () override
std::unique_ptr< NoteTrackAttachment >	Clone () const override
void	WriteXML (XMLWriter &xmlFile) const override
	Default implementation does nothing. More...
bool	HandleAttribute (const Attribute &attribute) override
	Return whether the attribute was used; default returns false. More...
int	GetBottomNote () const
	Gets the current bottom note (a pitch) More...
int	GetTopNote () const
	Gets the current top note (a pitch) More...
void	SetBottomNote (int note)
	Sets the bottom note (a pitch), making sure that it is never greater than the top note. More...
void	SetTopNote (int note)
	Sets the top note (a pitch), making sure that it is never less than the bottom note. More...
void	SetNoteRange (int note1, int note2)
	Sets the top and bottom note (both pitches) automatically, swapping them if needed. More...
void	ShiftNoteRange (int offset)
	Shifts all notes vertically by the given pitch. More...
void	ZoomAllNotes (Alg_seq *pSeq)
	Zooms so that all notes are visible. More...
void	ZoomMaxExtent ()
	Zooms so that the entire track is visible. More...
Public Member Functions inherited from NoteTrackAttachment
	~NoteTrackAttachment () override
virtual void	WriteXML (XMLWriter &xmlFile) const
	Default implementation does nothing. More...
virtual bool	HandleAttribute (const Attribute &attribute)
	Return whether the attribute was used; default returns false. More...

Static Public Member Functions
static NoteTrackRange &	Get (const NoteTrack &track)
	Allow mutative access to attached data of a const track. More...

Private Attributes
int	mBottomNote { MinPitch }
int	mTopNote { MaxPitch }

Detailed Description

Persistent data for display of a note track.

Definition at line 22 of file NoteTrackDisplayData.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MinPitch
MaxPitch

Definition at line 34 of file NoteTrackDisplayData.h.

{ MinPitch = 0, MaxPitch = 127 };

Constructor & Destructor Documentation

~NoteTrackRange()

NoteTrackRange::~NoteTrackRange ( )

overridedefault

Member Function Documentation

Clone()

std::unique_ptr< NoteTrackAttachment > NoteTrackRange::Clone ( ) const

override

Definition at line 29 of file NoteTrackDisplayData.cpp.

{
   return std::make_unique<NoteTrackRange>(*this);
}

Get()

NoteTrackRange & NoteTrackRange::Get ( const NoteTrack &  track )

static

Allow mutative access to attached data of a const track.

Definition at line 20 of file NoteTrackDisplayData.cpp.

{
   auto &mutTrack = const_cast<NoteTrack&>(track);
   return static_cast<NoteTrackRange&>(
      mutTrack.NoteTrackAttachments::Get(key));
}

References key.

Referenced by NoteTrackVRulerControls::HandleWheelRotation(), anonymous_namespace{ImportMIDI.cpp}::ImportMIDI(), NoteTrackDisplayData::NoteTrackDisplayData(), NoteTrackMenuTable::OnChangeOctave(), NoteTrackVRulerMenuTable::OnZoom(), NoteTrackVZoomHandle::Release(), NoteTrackDisplayData::Zoom(), and NoteTrackDisplayData::ZoomTo().

Here is the caller graph for this function:

GetBottomNote()

int NoteTrackRange::GetBottomNote ( ) const

inline

Gets the current bottom note (a pitch)

Definition at line 37 of file NoteTrackDisplayData.h.

{ return mBottomNote; }

GetTopNote()

int NoteTrackRange::GetTopNote ( ) const

inline

Gets the current top note (a pitch)

Definition at line 39 of file NoteTrackDisplayData.h.

{ return mTopNote; }

HandleAttribute()

bool NoteTrackRange::HandleAttribute ( const Attribute &  attribute )

overridevirtual

Return whether the attribute was used; default returns false.

Reimplemented from NoteTrackAttachment.

Definition at line 40 of file NoteTrackDisplayData.cpp.

{
   auto attr = pair.first;
   auto value = pair.second;
   long nValue{};
   if (attr == "bottomnote" && value.TryGet(nValue)) {
      SetBottomNote(nValue);
      return true;
   }
   if (attr == "topnote" && value.TryGet(nValue)) {
      SetTopNote(nValue);
      return true;
   }
   return false;
}

References SetBottomNote(), and SetTopNote().

Here is the call graph for this function:

SetBottomNote()

void NoteTrackRange::SetBottomNote

(

int

note

)

Sets the bottom note (a pitch), making sure that it is never greater than the top note.

Definition at line 56 of file NoteTrackDisplayData.cpp.

{
   if (note < MinPitch)
      note = MinPitch;
   else if (note > 96)
      note = 96;
 
   wxCHECK(note <= mTopNote, );
 
   mBottomNote = note;
}

References mBottomNote, MinPitch, and mTopNote.

Referenced by HandleAttribute().

Here is the caller graph for this function:

SetNoteRange()

void NoteTrackRange::SetNoteRange	(	int	note1,
		int	note2
	)

Sets the top and bottom note (both pitches) automatically, swapping them if needed.

Definition at line 78 of file NoteTrackDisplayData.cpp.

{
   // Bounds check
   if (note1 > MaxPitch)
      note1 = MaxPitch;
   else if (note1 < MinPitch)
      note1 = MinPitch;
   if (note2 > MaxPitch)
      note2 = MaxPitch;
   else if (note2 < MinPitch)
      note2 = MinPitch;
   // Swap to ensure ordering
   if (note2 < note1) { std::swap(note1, note2); }
 
   mBottomNote = note1;
   mTopNote = note2;
}

References MaxPitch, mBottomNote, MinPitch, mTopNote, and anonymous_namespace{NoteTrack.cpp}::swap().

Referenced by ZoomAllNotes(), and NoteTrackDisplayData::ZoomTo().

Here is the call graph for this function:

Here is the caller graph for this function:

SetTopNote()

void NoteTrackRange::SetTopNote

(

int

note

)

Sets the top note (a pitch), making sure that it is never less than the bottom note.

Definition at line 68 of file NoteTrackDisplayData.cpp.

{
   if (note > MaxPitch)
      note = MaxPitch;
 
   wxCHECK(note >= mBottomNote, );
 
   mTopNote = note;
}

References MaxPitch, mBottomNote, and mTopNote.

Referenced by HandleAttribute().

Here is the caller graph for this function:

ShiftNoteRange()

void NoteTrackRange::ShiftNoteRange

(

int

offset

)

Shifts all notes vertically by the given pitch.

Definition at line 96 of file NoteTrackDisplayData.cpp.

{
   // Ensure everything stays in bounds
   if (mBottomNote + offset < MinPitch || mTopNote + offset > MaxPitch)
       return;
 
   mBottomNote += offset;
   mTopNote += offset;
}

References MaxPitch, mBottomNote, and mTopNote.

Referenced by NoteTrackVRulerControls::HandleWheelRotation(), and NoteTrackMenuTable::OnChangeOctave().

Here is the caller graph for this function:

WriteXML()

void NoteTrackRange::WriteXML ( XMLWriter &  xmlFile ) const

overridevirtual

Default implementation does nothing.

Reimplemented from NoteTrackAttachment.

Definition at line 34 of file NoteTrackDisplayData.cpp.

{
   xmlFile.WriteAttr(wxT("bottomnote"), mBottomNote);
   xmlFile.WriteAttr(wxT("topnote"), mTopNote);
}

References mBottomNote, mTopNote, XMLWriter::WriteAttr(), and wxT().

Here is the call graph for this function:

ZoomAllNotes()

void NoteTrackRange::ZoomAllNotes

(

Alg_seq *

pSeq

)

Zooms so that all notes are visible.

Definition at line 120 of file NoteTrackDisplayData.cpp.

{
   Alg_iterator iterator(pSeq, false);
   iterator.begin();
   Alg_event_ptr evt;
 
   // Go through all of the notes, finding the minimum and maximum value pitches.
   bool hasNotes = false;
   int minPitch = MaxPitch;
   int maxPitch = MinPitch;
 
   while (nullptr != (evt = iterator.next())) {
      if (evt->is_note()) {
         int pitch = (int) evt->get_pitch();
         hasNotes = true;
         if (pitch < minPitch)
            minPitch = pitch;
         if (pitch > maxPitch)
            maxPitch = pitch;
      }
   }
 
   if (!hasNotes) {
      // Semi-arbitrary default values:
      minPitch = 48;
      maxPitch = 72;
   }
 
   SetNoteRange(minPitch, maxPitch);
}

References MaxPitch, MinPitch, and SetNoteRange().

Referenced by anonymous_namespace{ImportMIDI.cpp}::ImportMIDI().

Here is the call graph for this function:

Here is the caller graph for this function:

ZoomMaxExtent()

void NoteTrackRange::ZoomMaxExtent ( )

inline

Zooms so that the entire track is visible.

Definition at line 54 of file NoteTrackDisplayData.h.

{ SetNoteRange(MinPitch, MaxPitch); }

Member Data Documentation

mBottomNote

int NoteTrackRange::mBottomNote { MinPitch }

private

Definition at line 68 of file NoteTrackDisplayData.h.

Referenced by SetBottomNote(), SetNoteRange(), SetTopNote(), ShiftNoteRange(), and WriteXML().

mTopNote

int NoteTrackRange::mTopNote { MaxPitch }

private

Definition at line 69 of file NoteTrackDisplayData.h.

Referenced by SetBottomNote(), SetNoteRange(), SetTopNote(), ShiftNoteRange(), and WriteXML().

---

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

• NoteTrackDisplayData.h
• NoteTrackDisplayData.cpp