NoteTrackDisplayData Class Reference

Data used to display a note track. More...

#include <NoteTrack.h>

Public Member Functions
	NoteTrackDisplayData (const NoteTrack *track, const wxRect &r)
int	GetPitchHeight (int factor) const
int	GetNoteMargin () const
int	GetOctaveHeight () const
int	IPitchToY (int p) const
int	GetOctaveBottom (int oct) const
int	PitchToY (double p) const
int	YToIPitch (int y) const
int	GetNotePos (int p) const
int	GetBlackPos (int i) const
int	GetWhitePos (int i) const

Private Types
enum	{ MinPitchHeight = 1 , MaxPitchHeight = 25 }

Private Attributes
float	mPitchHeight
int	mBottom
int	mMargin

Detailed Description

Data used to display a note track.

Definition at line 250 of file NoteTrack.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
MinPitchHeight
MaxPitchHeight

Definition at line 259 of file NoteTrack.h.

{ MinPitchHeight = 1, MaxPitchHeight = 25 };

Constructor & Destructor Documentation

NoteTrackDisplayData()

NoteTrackDisplayData::NoteTrackDisplayData	(	const NoteTrack *	track,
		const wxRect &	r
	)

Definition at line 1118 of file NoteTrack.cpp.

{
   auto span = track->GetTopNote() - track->GetBottomNote() + 1; // + 1 to make sure it includes both
 
   mMargin = std::min((int) (r.height / (float)(span)) / 2, r.height / 4);
 
   // Count the number of dividers between B/C and E/F
   int numC = 0, numF = 0;
   auto botOctave = track->GetBottomNote() / 12, botNote = track->GetBottomNote() % 12;
   auto topOctave = track->GetTopNote() / 12, topNote = track->GetTopNote() % 12;
   if (topOctave == botOctave)
   {
      if (botNote == 0) numC = 1;
      if (topNote <= 5) numF = 1;
   }
   else
   {
      numC = topOctave - botOctave;
      numF = topOctave - botOctave - 1;
      if (botNote == 0) numC++;
      if (botNote <= 5) numF++;
      if (topOctave <= 5) numF++;
   }
   // Effective space, excluding the margins and the lines between some notes
   auto effectiveHeight = r.height - (2 * (mMargin + 1)) - numC - numF;
   // Guaranteed that both the bottom and top notes will be visible
   // (assuming that the clamping below does not happen)
   mPitchHeight = effectiveHeight / ((float) span);
 
   if (mPitchHeight < MinPitchHeight)
      mPitchHeight = MinPitchHeight;
   if (mPitchHeight > MaxPitchHeight)
      mPitchHeight = MaxPitchHeight;
 
   mBottom = r.y + r.height - GetNoteMargin() - 1 - GetPitchHeight(1) +
            botOctave * GetOctaveHeight() + GetNotePos(botNote);
}

References NoteTrack::GetBottomNote(), GetNoteMargin(), GetNotePos(), GetOctaveHeight(), GetPitchHeight(), NoteTrack::GetTopNote(), MaxPitchHeight, mBottom, min(), MinPitchHeight, mMargin, and mPitchHeight.

Here is the call graph for this function:

Member Function Documentation

GetBlackPos()

int NoteTrackDisplayData::GetBlackPos ( int  i ) const

inline

Definition at line 286 of file NoteTrack.h.

{ return GetNotePos(i * 2 + 1 + (i > 1)); }

References GetNotePos().

Here is the call graph for this function:

GetNoteMargin()

int NoteTrackDisplayData::GetNoteMargin ( ) const

inline

Definition at line 265 of file NoteTrack.h.

{ return mMargin; };

References mMargin.

Referenced by NoteTrackDisplayData().

Here is the caller graph for this function:

GetNotePos()

int NoteTrackDisplayData::GetNotePos ( int  p ) const

inline

Definition at line 283 of file NoteTrack.h.

   { return 1 + GetPitchHeight(p + 1) + (p > 4); }

References GetPitchHeight().

Referenced by GetBlackPos(), IPitchToY(), and NoteTrackDisplayData().

Here is the call graph for this function:

Here is the caller graph for this function:

GetOctaveBottom()

int NoteTrackDisplayData::GetOctaveBottom ( int  oct ) const

inline

Definition at line 271 of file NoteTrack.h.

                                      {
      return IPitchToY(oct * 12) + GetPitchHeight(1) + 1;
   }

References GetPitchHeight(), and IPitchToY().

Here is the call graph for this function:

GetOctaveHeight()

int NoteTrackDisplayData::GetOctaveHeight ( ) const

inline

Definition at line 266 of file NoteTrack.h.

{ return GetPitchHeight(12) + 2; }

References GetPitchHeight().

Referenced by GetWhitePos(), IPitchToY(), NoteTrackDisplayData(), and YToIPitch().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPitchHeight()

int NoteTrackDisplayData::GetPitchHeight ( int  factor ) const

inline

Definition at line 263 of file NoteTrack.h.

   { return std::max(1, (int)(factor * mPitchHeight)); }

References mPitchHeight.

Referenced by GetNotePos(), GetOctaveBottom(), GetOctaveHeight(), and NoteTrackDisplayData().

Here is the caller graph for this function:

GetWhitePos()

int NoteTrackDisplayData::GetWhitePos ( int  i ) const

inline

Definition at line 290 of file NoteTrack.h.

{ return 1 + (i * GetOctaveHeight()) / 7; }

References GetOctaveHeight().

Here is the call graph for this function:

IPitchToY()

int NoteTrackDisplayData::IPitchToY

(

int

p

)

const

Definition at line 1156 of file NoteTrack.cpp.

{ return mBottom - (p / 12) * GetOctaveHeight() - GetNotePos(p % 12); }

References GetNotePos(), GetOctaveHeight(), and mBottom.

Referenced by GetOctaveBottom(), and PitchToY().

Here is the call graph for this function:

Here is the caller graph for this function:

PitchToY()

int NoteTrackDisplayData::PitchToY ( double  p ) const

inline

Definition at line 275 of file NoteTrack.h.

                                {
      return IPitchToY((int) (p + 0.5));
   }

References IPitchToY().

Here is the call graph for this function:

YToIPitch()

int NoteTrackDisplayData::YToIPitch

(

int

y

)

const

Definition at line 1159 of file NoteTrack.cpp.

{
   y = mBottom - y; // pixels above pitch 0
   int octave = (y / GetOctaveHeight());
   y -= octave * GetOctaveHeight();
   // result is approximate because C and G are one pixel taller than
   // mPitchHeight.
   // Poke 1-13-18: However in practice this seems not to be an issue,
   // as long as we use mPitchHeight and not the rounded version
   return (y / mPitchHeight) + octave * 12;
}

References GetOctaveHeight(), mBottom, and mPitchHeight.

Referenced by NoteTrack::Zoom(), and NoteTrack::ZoomTo().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mBottom

int NoteTrackDisplayData::mBottom

private

Definition at line 256 of file NoteTrack.h.

Referenced by IPitchToY(), NoteTrackDisplayData(), and YToIPitch().

mMargin

int NoteTrackDisplayData::mMargin

private

Definition at line 257 of file NoteTrack.h.

Referenced by GetNoteMargin(), and NoteTrackDisplayData().

mPitchHeight

float NoteTrackDisplayData::mPitchHeight

private

Definition at line 252 of file NoteTrack.h.

Referenced by GetPitchHeight(), NoteTrackDisplayData(), and YToIPitch().

---

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

• NoteTrack.h
• NoteTrack.cpp