NoteTrackDisplayData Class Reference

Temporary data used to display a note track. More...

#include <NoteTrackDisplayData.h>

Collaboration diagram for NoteTrackDisplayData:

Public Member Functions
	NoteTrackDisplayData (const NoteTrack &track, const wxRect &r)
void	Zoom (int y, float multiplier, bool center)
void	ZoomTo (int start, int end)
void	ZoomOut (int y)
	Zooms out a constant factor (subject to zoom limits) More...
void	ZoomIn (int y)
	Zooms in a constant factor (subject to zoom limits) More...
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

Static Public Attributes
static const float	ZoomStep = powf( 2.0f, 0.25f )

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

Private Attributes
const NoteTrack &	mTrack
wxRect	mRect
float	mPitchHeight
int	mBottom
int	mMargin

Detailed Description

Temporary data used to display a note track.

Definition at line 77 of file NoteTrackDisplayData.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
MinPitchHeight
MaxPitchHeight

Definition at line 89 of file NoteTrackDisplayData.h.

{ MinPitchHeight = 1, MaxPitchHeight = 25 };

Constructor & Destructor Documentation

NoteTrackDisplayData()

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

Definition at line 151 of file NoteTrackDisplayData.cpp.

   : mTrack{ track }
   , mRect{ rect }
{
   auto &data = NoteTrackRange::Get(mTrack);
   auto span = data.GetTopNote() - data.GetBottomNote() + 1; // + 1 to make sure it includes both
 
   mMargin = std::min((int) (rect.height / (float)(span)) / 2, rect.height / 4);
 
   // Count the number of dividers between B/C and E/F
   int numC = 0, numF = 0;
   auto botOctave = data.GetBottomNote() / 12, botNote = data.GetBottomNote() % 12;
   auto topOctave = data.GetTopNote() / 12, topNote = data.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 = rect.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 = rect.y + rect.height - GetNoteMargin() - 1 - GetPitchHeight(1) +
            botOctave * GetOctaveHeight() + GetNotePos(botNote);
}

References NoteTrackRange::Get(), GetNoteMargin(), GetNotePos(), GetOctaveHeight(), GetPitchHeight(), MaxPitchHeight, mBottom, min(), MinPitchHeight, mMargin, mPitchHeight, and mTrack.

Here is the call graph for this function:

Member Function Documentation

GetBlackPos()

int NoteTrackDisplayData::GetBlackPos ( int  i ) const

inline

Definition at line 124 of file NoteTrackDisplayData.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 103 of file NoteTrackDisplayData.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 121 of file NoteTrackDisplayData.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 109 of file NoteTrackDisplayData.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 104 of file NoteTrackDisplayData.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

Definition at line 241 of file NoteTrackDisplayData.cpp.

{
   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 128 of file NoteTrackDisplayData.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 193 of file NoteTrackDisplayData.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 113 of file NoteTrackDisplayData.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 196 of file NoteTrackDisplayData.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 Zoom(), and ZoomTo().

Here is the call graph for this function:

Here is the caller graph for this function:

Zoom()

void NoteTrackDisplayData::Zoom	(	int	y,
		float	multiplier,
		bool	center
	)

Zoom the note track around y. If center is true, the result will be centered at y.

Definition at line 208 of file NoteTrackDisplayData.cpp.

{
   auto &data = NoteTrackRange::Get(mTrack);
   int clickedPitch = YToIPitch(y);
   int extent = data.GetTopNote() - data.GetBottomNote() + 1;
   int newExtent = (int) (extent / multiplier);
   float position;
   if (center) {
      // center the pitch that the user clicked on
      position = .5;
   } else {
      // align to keep the pitch that the user clicked on in the same place
      position = extent / (clickedPitch - data.GetBottomNote());
   }
   int newBottomNote = clickedPitch - (newExtent * position);
   int newTopNote = clickedPitch + (newExtent * (1 - position));
   data.SetNoteRange(newBottomNote, newTopNote);
}

References NoteTrackRange::Get(), mTrack, and YToIPitch().

Referenced by ZoomIn(), ZoomOut(), and ZoomTo().

Here is the call graph for this function:

Here is the caller graph for this function:

ZoomIn()

void NoteTrackDisplayData::ZoomIn ( int  y )

inline

Zooms in a constant factor (subject to zoom limits)

Definition at line 100 of file NoteTrackDisplayData.h.

{ Zoom(y, ZoomStep, true); }

References Zoom(), and ZoomStep.

Here is the call graph for this function:

ZoomOut()

void NoteTrackDisplayData::ZoomOut ( int  y )

inline

Zooms out a constant factor (subject to zoom limits)

Definition at line 98 of file NoteTrackDisplayData.h.

{ Zoom(y, 1.0f / ZoomStep, true); }

References Zoom(), and ZoomStep.

Here is the call graph for this function:

ZoomTo()

void NoteTrackDisplayData::ZoomTo	(	int	start,
		int	end
	)

Definition at line 227 of file NoteTrackDisplayData.cpp.

{
   wxRect trackRect(0, mRect.GetY(), 1, mRect.GetHeight());
   int pitch1 = YToIPitch(start);
   int pitch2 = YToIPitch(end);
   if (pitch1 == pitch2) {
      // Just zoom in instead of zooming to show only one note
      Zoom(start, 1, true);
      return;
   }
   // It's fine for this to be in either order
   NoteTrackRange::Get(mTrack).SetNoteRange(pitch1, pitch2);
}

References details::end(), NoteTrackRange::Get(), mRect, mTrack, NoteTrackRange::SetNoteRange(), YToIPitch(), and Zoom().

Referenced by NoteTrackVZoomHandle::Release().

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 86 of file NoteTrackDisplayData.h.

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

mMargin

int NoteTrackDisplayData::mMargin

private

Definition at line 87 of file NoteTrackDisplayData.h.

Referenced by GetNoteMargin(), and NoteTrackDisplayData().

mPitchHeight

float NoteTrackDisplayData::mPitchHeight

private

Definition at line 82 of file NoteTrackDisplayData.h.

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

mRect

wxRect NoteTrackDisplayData::mRect

private

Definition at line 80 of file NoteTrackDisplayData.h.

Referenced by ZoomTo().

mTrack

const NoteTrack& NoteTrackDisplayData::mTrack

private

Definition at line 79 of file NoteTrackDisplayData.h.

Referenced by NoteTrackDisplayData(), Zoom(), and ZoomTo().

ZoomStep

const float NoteTrackDisplayData::ZoomStep = powf( 2.0f, 0.25f )

static

Definition at line 130 of file NoteTrackDisplayData.h.

Referenced by ZoomIn(), and ZoomOut().

---

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

• NoteTrackDisplayData.h
• NoteTrackDisplayData.cpp