Collaboration diagram for Ruler::Updater:

[legend]

Classes
struct	TickOutputs

struct	UpdateOutputs

Public Member Functions
	Updater (const Ruler &ruler, const ZoomInfo *z)

bool	Tick (wxDC &dc, int pos, double d, const TickSizes &tickSizes, wxFont font, TickOutputs outputs) const

bool	TickCustom (wxDC &dc, int labelIdx, wxFont font, TickOutputs outputs) const

void	Update (wxDC &dc, const Envelope *envelope, UpdateOutputs &allOutputs) const

void	UpdateCustom (wxDC &dc, UpdateOutputs &allOutputs) const

void	UpdateLinear (wxDC &dc, const Envelope *envelope, UpdateOutputs &allOutputs) const

void	UpdateNonlinear (wxDC &dc, UpdateOutputs &allOutputs) const

Static Public Member Functions
static void	ChooseFonts (std::unique_ptr< Fonts > &pFonts, const Fonts *pUserFonts, wxDC &dc, int desiredPixelHeight)

Public Attributes
const Ruler &	mRuler

const ZoomInfo *	zoomInfo

const double	mDbMirrorValue = mRuler.mDbMirrorValue

const int	mLength = mRuler.mLength

const RulerFormat	mFormat = mRuler.mFormat

const TranslatableString	mUnits = mRuler.mUnits

const int	mLeft = mRuler.mLeft

const int	mTop = mRuler.mTop

const int	mBottom = mRuler.mBottom

const int	mRight = mRuler.mRight

const int	mSpacing = mRuler.mSpacing

const int	mOrientation = mRuler.mOrientation

const bool	mFlip = mRuler.mFlip

const bool	mCustom = mRuler.mCustom

const Fonts &	mFonts = *mRuler.mpFonts

const bool	mLog = mRuler.mLog

const double	mHiddenMin = mRuler.mHiddenMin

const double	mHiddenMax = mRuler.mHiddenMax

const bool	mLabelEdges = mRuler.mLabelEdges

const double	mMin = mRuler.mMin

const double	mMax = mRuler.mMax

const int	mLeftOffset = mRuler.mLeftOffset

const NumberScale	mNumberScale = mRuler.mNumberScale

Detailed Description

Definition at line 849 of file Ruler.cpp.

Constructor & Destructor Documentation

◆ Updater()

Ruler::Updater::Updater	(	const Ruler &	ruler,
		const ZoomInfo *	z
	)

inlineexplicit

Definition at line 853 of file Ruler.cpp.

   : mRuler{ ruler }
   , zoomInfo{ z }
   {}

Member Function Documentation

◆ ChooseFonts()

void Ruler::Updater::ChooseFonts	(	std::unique_ptr< Fonts > &	pFonts,
		const Fonts *	pUserFonts,
		wxDC &	dc,
		int	desiredPixelHeight
	)

static

Definition at line 1017 of file Ruler.cpp.

{
   if ( pFonts )
      return;
 
   if ( pUserFonts ) {
      pFonts = std::make_unique<Fonts>( *pUserFonts );
      return;
   }
 
   pFonts = std::make_unique<Fonts>( Fonts{ {}, {}, {}, 0 } );
   auto &fonts = *pFonts;
 
   int fontSize = 4;
 
   desiredPixelHeight =
      std::max(MinPixelHeight, std::min(MaxPixelHeight, -desiredPixelHeight));
 
   // Keep making the font bigger until it's too big, then subtract one.
   wxCoord height;
   FindFontHeights( height, fonts.lead, dc, fontSize, wxFONTWEIGHT_BOLD );
   while (height <= desiredPixelHeight && fontSize < 40) {
      fontSize++;
      FindFontHeights( height, fonts.lead, dc, fontSize, wxFONTWEIGHT_BOLD );
   }
   fontSize--;
   FindFontHeights( height, fonts.lead, dc, fontSize );
 
   fonts.major = wxFont{ fontSize, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_BOLD };
   fonts.minor = wxFont{ fontSize, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL };
   fonts.minorMinor = wxFont{ fontSize - 1, wxFONTFAMILY_SWISS, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL };
}

References anonymous_namespace{Ruler.cpp}::FindFontHeights(), MaxPixelHeight, min(), and MinPixelHeight.

Referenced by Ruler::ChooseFonts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Tick()

bool Ruler::Updater::Tick	(	wxDC &	dc,
		int	pos,
		double	d,
		const TickSizes &	tickSizes,
		wxFont	font,
		TickOutputs	outputs
	)		const

Definition at line 926 of file Ruler.cpp.

{
   // Bug 521.  dB view for waveforms needs a 2-sided scale.
   if(( mDbMirrorValue > 1.0 ) && ( -d > mDbMirrorValue ))
      d = -2*mDbMirrorValue - d;
 
   // FIXME: We don't draw a tick if off end of our label arrays
   // But we shouldn't have an array of labels.
   if( outputs.labels.size() >= mLength )
      return false;
 
   Label lab;
   lab.value = d;
   lab.pos = pos;
   lab.text = tickSizes.LabelString( d, mFormat, mUnits );
 
   const auto result = MakeTick(
      lab,
      dc, font,
      outputs.bits,
      mLeft, mTop, mSpacing, mFonts.lead,
      mFlip,
      mOrientation );
 
   auto &rect = result.first;
   outputs.box.Union( rect );
   outputs.labels.emplace_back( result.second );
   return !rect.IsEmpty();
}

References Ruler::Updater::TickOutputs::bits, Ruler::Updater::TickOutputs::box, Ruler::Updater::TickOutputs::labels, Ruler::TickSizes::LabelString(), Ruler::Fonts::lead, Ruler::MakeTick(), mDbMirrorValue, mFlip, mFonts, mFormat, mLeft, mLength, mOrientation, mSpacing, mTop, mUnits, Ruler::Label::pos, Ruler::Label::text, and Ruler::Label::value.

Here is the call graph for this function:

◆ TickCustom()

bool Ruler::Updater::TickCustom	(	wxDC &	dc,
		int	labelIdx,
		wxFont	font,
		TickOutputs	outputs
	)		const

Definition at line 959 of file Ruler.cpp.

{
   // FIXME: We don't draw a tick if of end of our label arrays
   // But we shouldn't have an array of labels.
   if( labelIdx >= outputs.labels.size() )
      return false;
 
   //This should only used in the mCustom case
 
   Label lab;
   lab.value = 0.0;
 
   const auto result = MakeTick(
      lab,
 
      dc, font,
      outputs.bits,
      mLeft, mTop, mSpacing, mFonts.lead,
      mFlip,
      mOrientation );
 
   auto &rect = result.first;
   outputs.box.Union( rect );
   outputs.labels[labelIdx] = ( result.second );
   return !rect.IsEmpty();
}

References Ruler::Updater::TickOutputs::bits, Ruler::Updater::TickOutputs::box, Ruler::Updater::TickOutputs::labels, Ruler::MakeTick(), Ruler::mFlip, Ruler::mLeft, Ruler::mOrientation, Ruler::mSpacing, Ruler::mTop, and Ruler::Label::value.

Here is the call graph for this function:

◆ Update()

void Ruler::Updater::Update	(	wxDC &	dc,
		const Envelope *	envelope,
		UpdateOutputs &	allOutputs
	)		const

Definition at line 1302 of file Ruler.cpp.

{
   TickOutputs majorOutputs{
      allOutputs.majorLabels, allOutputs.bits, allOutputs.box };
 
   if ( mCustom )
      UpdateCustom( dc, allOutputs );
   else if ( !mLog )
      UpdateLinear( dc, envelope, allOutputs );
   else
      UpdateNonlinear( dc, allOutputs );
 
   int displacementx=0, displacementy=0;
   auto &box = allOutputs.box;
   if (!mFlip) {
      if (mOrientation==wxHORIZONTAL) {
         int d = mTop + box.GetHeight() + 5;
         box.Offset(0,d);
         box.Inflate(0,5);
         displacementx=0;
         displacementy=d;
      }
      else {
         int d = mLeft - box.GetLeft() + 5;
         box.Offset(d,0);
         box.Inflate(5,0);
         displacementx=d;
         displacementy=0;
      }
   }
   else {
      if (mOrientation==wxHORIZONTAL) {
         box.Inflate(0,5);
         displacementx=0;
         displacementy=0;
      }
   }
   auto update = [=]( Label &label ){
      label.lx += displacementx;
      label.ly += displacementy;
   };
   for( auto &label : allOutputs.majorLabels )
      update( label );
   for( auto &label : allOutputs.minorLabels )
      update( label );
   for( auto &label : allOutputs.minorMinorLabels )
      update( label );
}

References Ruler::Updater::UpdateOutputs::bits, Ruler::Updater::UpdateOutputs::box, label, Ruler::Updater::UpdateOutputs::majorLabels, Ruler::mCustom, Ruler::mFlip, Ruler::Updater::UpdateOutputs::minorLabels, Ruler::Updater::UpdateOutputs::minorMinorLabels, Ruler::mLeft, Ruler::mLog, Ruler::mOrientation, and Ruler::mTop.

◆ UpdateCustom()

void Ruler::Updater::UpdateCustom	(	wxDC &	dc,
		UpdateOutputs &	allOutputs
	)		const

Definition at line 1052 of file Ruler.cpp.

{
   TickOutputs majorOutputs{
      allOutputs.majorLabels, allOutputs.bits, allOutputs.box };
 
   // SET PARAMETER IN MCUSTOM CASE
   // Works only with major labels
 
   int numLabel = allOutputs.majorLabels.size();
 
   for( int i = 0; (i<numLabel) && (i<=mLength); ++i )
      TickCustom( dc, i, mFonts.major, majorOutputs );
}

References Ruler::Updater::UpdateOutputs::bits, Ruler::Updater::UpdateOutputs::box, Ruler::Updater::UpdateOutputs::majorLabels, and Ruler::mLength.

◆ UpdateLinear()

void Ruler::Updater::UpdateLinear	(	wxDC &	dc,
		const Envelope *	envelope,
		UpdateOutputs &	allOutputs
	)		const

Definition at line 1066 of file Ruler.cpp.

{
   TickOutputs majorOutputs{
      allOutputs.majorLabels, allOutputs.bits, allOutputs.box };
 
   // Use the "hidden" min and max to determine the tick size.
   // That may make a difference with fisheye.
   // Otherwise you may see the tick size for the whole ruler change
   // when the fisheye approaches start or end.
   double UPP = (mHiddenMax-mHiddenMin)/mLength;  // Units per pixel
   TickSizes tickSizes{ UPP, mOrientation, mFormat, false };
 
   auto TickAtValue =
   [this, &tickSizes, &dc, &majorOutputs]
   ( double value ) -> int {
      // Make a tick only if the value is strictly between the bounds
      if ( value <= std::min( mMin, mMax ) )
         return -1;
      if ( value >= std::max( mMin, mMax ) )
         return -1;
 
      int mid;
      if (zoomInfo != NULL) {
         // Tick only at zero
         if ( value )
            return -1;
         mid = (int)(zoomInfo->TimeToPosition(0.0, mLeftOffset));
      }
      else
         mid = (int)(mLength*((mMin - value) / (mMin - mMax)) + 0.5);
 
      const int iMaxPos = (mOrientation == wxHORIZONTAL) ? mRight : mBottom - 5;
      if (mid >= 0 && mid < iMaxPos)
         Tick( dc, mid, value, tickSizes, mFonts.major, majorOutputs );
      else
         return -1;
      
      return mid;
   };
 
   if ( mDbMirrorValue ) {
      // For dB scale, let the zeroes prevail over the extreme values if
      // not the same, and let midline prevail over all
 
      // Do the midline
      TickAtValue( -mDbMirrorValue );
 
      // Do the upper zero
      TickAtValue( 0.0 );
 
      // Do the other zero
      TickAtValue( -2 * mDbMirrorValue );
   }
 
   // Extreme values
   if (mLabelEdges) {
      Tick( dc, 0, mMin, tickSizes, mFonts.major, majorOutputs );
      Tick( dc, mLength, mMax, tickSizes, mFonts.major, majorOutputs );
   }
 
   if ( !mDbMirrorValue ) {
      // Zero (if it's strictly in the middle somewhere)
      TickAtValue( 0.0 );
   }
 
   double sg = UPP > 0.0? 1.0: -1.0;
 
   int nDroppedMinorLabels=0;
   // Major and minor ticks
   for (int jj = 0; jj < 2; ++jj) {
      const double denom = jj == 0 ? tickSizes.mMajor : tickSizes.mMinor;
      auto font = jj == 0 ? mFonts.major : mFonts.minor;
      TickOutputs outputs{
         (jj == 0 ? allOutputs.majorLabels : allOutputs.minorLabels),
         allOutputs.bits, allOutputs.box
      };
      int ii = -1, j = 0;
      double d, warpedD, nextD;
 
      double prevTime = 0.0, time = 0.0;
      if (zoomInfo != NULL) {
         j = zoomInfo->TimeToPosition(mMin);
         prevTime = zoomInfo->PositionToTime(--j);
         time = zoomInfo->PositionToTime(++j);
         d = (prevTime + time) / 2.0;
      }
      else
         d = mMin - UPP / 2;
      if (envelope)
         warpedD = ComputeWarpedLength(*envelope, 0.0, d);
      else
         warpedD = d;
      // using ints doesn't work, as
      // this will overflow and be negative at high zoom.
      double step = floor(sg * warpedD / denom);
      while (ii <= mLength) {
         ii++;
         if (zoomInfo)
         {
            prevTime = time;
            time = zoomInfo->PositionToTime(++j);
            nextD = (prevTime + time) / 2.0;
            // wxASSERT(time >= prevTime);
         }
         else
            nextD = d + UPP;
         if (envelope)
            warpedD += ComputeWarpedLength(*envelope, d, nextD);
         else
            warpedD = nextD;
         d = nextD;
 
         if (floor(sg * warpedD / denom) > step) {
            step = floor(sg * warpedD / denom);
            bool major = jj == 0;
            tickSizes.useMajor = major;
            bool ticked = Tick( dc, ii, sg * step * denom, tickSizes,
               font, outputs );
            if( !major && !ticked ){
               nDroppedMinorLabels++;
            }
         }
      }
   }
 
   tickSizes.useMajor = true;
 
   // If we've dropped minor labels through overcrowding, then don't show
   // any of them.  We're allowed though to drop ones which correspond to the
   // major numbers.
   if( nDroppedMinorLabels >
         (allOutputs.majorLabels.size() + (mLabelEdges ? 2:0)) ){
      // Old code dropped the labels AND their ticks, like so:
      //    mMinorLabels.clear();
      // Nowadays we just drop the labels.
      for( auto &label : allOutputs.minorLabels )
         label.text = {};
   }
 
   // Left and Right Edges
   if (mLabelEdges) {
      Tick( dc, 0, mMin, tickSizes, mFonts.major, majorOutputs );
      Tick( dc, mLength, mMax, tickSizes, mFonts.major, majorOutputs );
   }
}

References Ruler::Updater::UpdateOutputs::bits, Ruler::Updater::UpdateOutputs::box, anonymous_namespace{Ruler.cpp}::ComputeWarpedLength(), label, Ruler::Updater::UpdateOutputs::majorLabels, Ruler::mBottom, Ruler::mDbMirrorValue, Ruler::mFormat, Ruler::mHiddenMax, Ruler::mHiddenMin, min(), Ruler::Updater::UpdateOutputs::minorLabels, Ruler::mLabelEdges, Ruler::mLeftOffset, Ruler::mLength, Ruler::mMax, Ruler::mMin, Ruler::mOrientation, and Ruler::mRight.

Here is the call graph for this function:

◆ UpdateNonlinear()

void Ruler::Updater::UpdateNonlinear	(	wxDC &	dc,
		UpdateOutputs &	allOutputs
	)		const

Definition at line 1213 of file Ruler.cpp.

{
   TickOutputs majorOutputs{
      allOutputs.majorLabels, allOutputs.bits, allOutputs.box };
 
   auto numberScale = ( mNumberScale == NumberScale{} )
      ? NumberScale( nstLogarithmic, mMin, mMax )
      : mNumberScale;
 
   double UPP = (mHiddenMax-mHiddenMin)/mLength;  // Units per pixel
   TickSizes tickSizes{ UPP, mOrientation, mFormat, true };
 
   tickSizes.mDigits = 2; //TODO: implement dynamic digit computation
 
   double loLog = log10(mMin);
   double hiLog = log10(mMax);
   int loDecade = (int) floor(loLog);
 
   double val;
   double startDecade = pow(10., (double)loDecade);
 
   // Major ticks are the decades
   double decade = startDecade;
   double delta=hiLog-loLog, steps=fabs(delta);
   double step = delta>=0 ? 10 : 0.1;
   double rMin=std::min(mMin, mMax), rMax=std::max(mMin, mMax);
   for(int i=0; i<=steps; i++)
   {  // if(i!=0)
      {  val = decade;
         if(val >= rMin && val < rMax) {
            const int pos(0.5 + mLength * numberScale.ValueToPosition(val));
            Tick( dc, pos, val, tickSizes, mFonts.major, majorOutputs );
         }
      }
      decade *= step;
   }
 
   // Minor ticks are multiples of decades
   decade = startDecade;
   float start, end, mstep;
   if (delta > 0)
   {  start=2; end=10; mstep=1;
   }else
   {  start=9; end=1; mstep=-1;
   }
   steps++;
   tickSizes.useMajor = false;
   TickOutputs minorOutputs{
      allOutputs.minorLabels, allOutputs.bits, allOutputs.box };
   for(int i=0; i<=steps; i++) {
      for(int j=start; j!=end; j+=mstep) {
         val = decade * j;
         if(val >= rMin && val < rMax) {
            const int pos(0.5 + mLength * numberScale.ValueToPosition(val));
            Tick( dc, pos, val, tickSizes, mFonts.minor, minorOutputs );
         }
      }
      decade *= step;
   }
 
   // MinorMinor ticks are multiples of decades
   decade = startDecade;
   if (delta > 0)
   {  start= 10; end=100; mstep= 1;
   }else
   {  start=100; end= 10; mstep=-1;
   }
   steps++;
   TickOutputs minorMinorOutputs{
      allOutputs.minorMinorLabels, allOutputs.bits, allOutputs.box };
   for (int i = 0; i <= steps; i++) {
      // PRL:  Bug1038.  Don't label 1.6, rounded, as a duplicate tick for "2"
      if (!(mFormat == IntFormat && decade < 10.0)) {
         for (int f = start; f != (int)(end); f += mstep) {
            if ((int)(f / 10) != f / 10.0f) {
               val = decade * f / 10;
               if (val >= rMin && val < rMax) {
                  const int pos(0.5 + mLength * numberScale.ValueToPosition(val));
                  Tick( dc, pos, val, tickSizes,
                     mFonts.minorMinor, minorMinorOutputs );
               }
            }
         }
      }
      decade *= step;
   }
}

References Ruler::Updater::UpdateOutputs::bits, Ruler::Updater::UpdateOutputs::box, PackedArray::end(), Ruler::IntFormat, Ruler::Updater::UpdateOutputs::majorLabels, Ruler::mFormat, Ruler::mHiddenMax, Ruler::mHiddenMin, min(), Ruler::Updater::UpdateOutputs::minorLabels, Ruler::Updater::UpdateOutputs::minorMinorLabels, Ruler::mLength, Ruler::mMax, Ruler::mMin, Ruler::mNumberScale, Ruler::mOrientation, and nstLogarithmic.

Here is the call graph for this function:

Member Data Documentation

◆ mBottom

const int Ruler::Updater::mBottom = mRuler.mBottom

Definition at line 865 of file Ruler.cpp.

◆ mCustom

const bool Ruler::Updater::mCustom = mRuler.mCustom

Definition at line 872 of file Ruler.cpp.

◆ mDbMirrorValue

const double Ruler::Updater::mDbMirrorValue = mRuler.mDbMirrorValue

Definition at line 858 of file Ruler.cpp.

Referenced by Tick().

◆ mFlip

const bool Ruler::Updater::mFlip = mRuler.mFlip

Definition at line 870 of file Ruler.cpp.

Referenced by Tick().

◆ mFonts

const Fonts& Ruler::Updater::mFonts = *mRuler.mpFonts

Definition at line 873 of file Ruler.cpp.

Referenced by Tick().

◆ mFormat

const RulerFormat Ruler::Updater::mFormat = mRuler.mFormat

Definition at line 860 of file Ruler.cpp.

Referenced by Tick().

◆ mHiddenMax

const double Ruler::Updater::mHiddenMax = mRuler.mHiddenMax

Definition at line 876 of file Ruler.cpp.

◆ mHiddenMin

const double Ruler::Updater::mHiddenMin = mRuler.mHiddenMin

Definition at line 875 of file Ruler.cpp.

◆ mLabelEdges

const bool Ruler::Updater::mLabelEdges = mRuler.mLabelEdges

Definition at line 877 of file Ruler.cpp.

◆ mLeft

const int Ruler::Updater::mLeft = mRuler.mLeft

Definition at line 863 of file Ruler.cpp.

Referenced by Tick().

◆ mLeftOffset

const int Ruler::Updater::mLeftOffset = mRuler.mLeftOffset

Definition at line 880 of file Ruler.cpp.

◆ mLength

const int Ruler::Updater::mLength = mRuler.mLength

Definition at line 859 of file Ruler.cpp.

Referenced by Tick().

◆ mLog

const bool Ruler::Updater::mLog = mRuler.mLog

Definition at line 874 of file Ruler.cpp.

◆ mMax

const double Ruler::Updater::mMax = mRuler.mMax

Definition at line 879 of file Ruler.cpp.

◆ mMin

const double Ruler::Updater::mMin = mRuler.mMin

Definition at line 878 of file Ruler.cpp.

◆ mNumberScale

const NumberScale Ruler::Updater::mNumberScale = mRuler.mNumberScale

Definition at line 881 of file Ruler.cpp.

◆ mOrientation

const int Ruler::Updater::mOrientation = mRuler.mOrientation

Definition at line 869 of file Ruler.cpp.

Referenced by Tick().

◆ mRight

const int Ruler::Updater::mRight = mRuler.mRight

Definition at line 866 of file Ruler.cpp.

◆ mRuler

const Ruler& Ruler::Updater::mRuler

Definition at line 850 of file Ruler.cpp.

◆ mSpacing

const int Ruler::Updater::mSpacing = mRuler.mSpacing

Definition at line 868 of file Ruler.cpp.

Referenced by Tick().

◆ mTop

const int Ruler::Updater::mTop = mRuler.mTop

Definition at line 864 of file Ruler.cpp.

Referenced by Tick().

◆ mUnits

const TranslatableString Ruler::Updater::mUnits = mRuler.mUnits

Definition at line 861 of file Ruler.cpp.

Referenced by Tick().

◆ zoomInfo

const ZoomInfo* Ruler::Updater::zoomInfo

Definition at line 851 of file Ruler.cpp.

The documentation for this struct was generated from the following file:

Ruler.cpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Updater()

Member Function Documentation

◆ ChooseFonts()

◆ Tick()

◆ TickCustom()

◆ Update()

◆ UpdateCustom()

◆ UpdateLinear()

◆ UpdateNonlinear()

Member Data Documentation

◆ mBottom

◆ mCustom

◆ mDbMirrorValue

◆ mFlip

◆ mFonts

◆ mFormat

◆ mHiddenMax

◆ mHiddenMin

◆ mLabelEdges

◆ mLeft

◆ mLeftOffset

◆ mLength

◆ mLog

◆ mMax

◆ mMin

◆ mNumberScale

◆ mOrientation

◆ mRight

◆ mRuler

◆ mSpacing

◆ mTop

◆ mUnits

◆ zoomInfo