Used to display a Ruler. More...

#include <Ruler.h>

Collaboration diagram for Ruler:

Classes
struct	Cache

struct	Fonts

class	Label
	An array of these created by the Ruler is used to determine what and where text annotations to the numbers on the Ruler get drawn. More...

struct	TickSizes

struct	Updater

Public Types
enum	RulerFormat { IntFormat, RealFormat, RealLogFormat, TimeFormat, LinearDBFormat }

Public Member Functions
	Ruler ()

	~Ruler ()

void	SetBounds (int left, int top, int right, int bottom)

void	SetOrientation (int orient)

void	SetRange (double min, double max)

void	SetRange (double min, double max, double hiddenMin, double hiddenMax)

void	SetTwoTone (bool twoTone)

void	SetFormat (RulerFormat format)

void	SetUnits (const TranslatableString &units)

void	SetDbMirrorValue (const double d)

void	SetLog (bool log)

void	SetSpacing (int spacing)

void	SetLabelEdges (bool labelEdges)

void	SetFlip (bool flip)

void	SetMinor (bool value)

void	SetFonts (const wxFont &minorFont, const wxFont &majorFont, const wxFont &minorMinorFont)

Fonts	GetFonts () const

void	SetNumberScale (const NumberScale &scale)

void	OfflimitsPixels (int start, int end)

void	GetMaxSize (wxCoord width, wxCoord height)

void	SetCustomMode (bool value)

void	SetCustomMajorLabels (const TranslatableStrings &labels, int start, int step)

void	SetCustomMinorLabels (const TranslatableStrings &labels, int start, int step)

void	SetUseZoomInfo (int leftOffset, const ZoomInfo *zoomInfo)

void	Draw (wxDC &dc) const

void	Draw (wxDC &dc, const Envelope *envelope) const

void	DrawGrid (wxDC &dc, int length, bool minor=true, bool major=true, int xOffset=0, int yOffset=0) const

void	SetTickColour (const wxColour &colour)

void	Invalidate ()

Public Attributes
bool	mbTicksOnly

bool	mbTicksAtExtremes

Private Types
using	Labels = std::vector< Label >

using	Bits = std::vector< bool >

Private Member Functions
void	ChooseFonts (wxDC &dc) const

void	UpdateCache (wxDC &dc, const Envelope *envelope) const

int	FindZero (const Labels &labels) const

int	GetZeroPosition () const

Static Private Member Functions
static std::pair< wxRect, Label >	MakeTick (Label lab, wxDC &dc, wxFont font, std::vector< bool > &bits, int left, int top, int spacing, int lead, bool flip, int orientation)

Private Attributes
wxColour	mTickColour

wxPen	mPen

int	mLeft

int	mTop

int	mRight

int	mBottom

int	mLength

std::unique_ptr< Fonts >	mpUserFonts

std::unique_ptr< Fonts >	mpFonts

double	mMin

double	mMax

double	mHiddenMin

double	mHiddenMax

Bits	mUserBits

std::unique_ptr< Cache >	mpCache

int	mOrientation

int	mSpacing

double	mDbMirrorValue

bool	mHasSetSpacing

bool	mLabelEdges

RulerFormat	mFormat

bool	mLog

bool	mFlip

bool	mCustom

bool	mbMinor

TranslatableString	mUnits

bool	mTwoTone

const ZoomInfo *	mUseZoomInfo

int	mLeftOffset

NumberScale	mNumberScale

Detailed Description

Used to display a Ruler.

This is a generic class which can be used to display just about any kind of ruler.

At a minimum, the user must specify the dimensions of the ruler, its orientation (horizontal or vertical), and the values displayed at the two ends of the ruler (min and max). By default, this class will display tick marks at reasonable round numbers and fractions, for example, 100, 50, 10, 5, 1, 0.5, 0.1, etc.

The class is designed to display a small handful of labeled Major ticks, and a few Minor ticks between each of these. Minor ticks are labeled if there is enough space. Labels will never run into each other.

In addition to Real numbers, the Ruler currently supports two other formats for its display:

Integer - never shows tick marks for fractions of an integer

Time - Assumes values represent seconds, and labels the tick marks in "HH:MM:SS" format, e.g. 4000 seconds becomes "1:06:40", for example. Will display fractions of a second, and tick marks are all reasonable round numbers for time (i.e. 15 seconds, 30 seconds, etc.)

Definition at line 26 of file Ruler.h.

Member Typedef Documentation

◆ Bits

using Ruler::Bits = std::vector< bool >

private

Definition at line 168 of file Ruler.h.

◆ Labels

using Ruler::Labels = std::vector<Label>

private

Definition at line 166 of file Ruler.h.

Member Enumeration Documentation

◆ RulerFormat

enum Ruler::RulerFormat

Enumerator
IntFormat
RealFormat
RealLogFormat
TimeFormat
LinearDBFormat

Definition at line 29 of file Ruler.h.

                     {
       IntFormat,
       RealFormat,
       RealLogFormat,
       TimeFormat,
       LinearDBFormat,
    };

Constructor & Destructor Documentation

◆ Ruler()

Ruler::Ruler ( )

Definition at line 79 of file Ruler.cpp.

 {
    mMin = mHiddenMin = 0.0;
    mMax = mHiddenMax = 100.0;
    mOrientation = wxHORIZONTAL;
    mSpacing = 6;
    mHasSetSpacing = false;
    mFormat = RealFormat;
    mFlip = false;
    mLog = false;
    mLabelEdges = false;
  
    mLeft = -1;
    mTop = -1;
    mRight = -1;
    mBottom = -1;
    mbTicksOnly = true;
    mbTicksAtExtremes = false;
    mTickColour = wxColour( theTheme.Colour( clrTrackPanelText ));
    mPen.SetColour(mTickColour);
    mDbMirrorValue = 0.0;
  
    // Note: the font size is now adjusted automatically whenever
    // Invalidate is called on a horizontal Ruler, unless the user
    // calls SetFonts manually.  So the defaults here are not used
    // often.
  
    int fontSize = 10;
 #ifdef __WXMSW__
    fontSize = 8;
 #endif
  
    mLength = 0;
  
    mCustom = false;
    mbMinor = true;
  
    mTwoTone = false;
  
    mUseZoomInfo = NULL;
 }

References ThemeBase::Colour(), mbMinor, mBottom, mbTicksAtExtremes, mbTicksOnly, mCustom, mDbMirrorValue, mFlip, mFormat, mHasSetSpacing, mHiddenMax, mHiddenMin, mLabelEdges, mLeft, mLength, mLog, mMax, mMin, mOrientation, mPen, mRight, mSpacing, mTickColour, mTop, mTwoTone, mUseZoomInfo, RealFormat, and theTheme.

Here is the call graph for this function:

◆ ~Ruler()

Ruler::~Ruler ( )

Definition at line 121 of file Ruler.cpp.

 {
    Invalidate();  // frees up our arrays
 }

References Invalidate().

Here is the call graph for this function:

Member Function Documentation

◆ ChooseFonts()

void Ruler::ChooseFonts ( wxDC & dc ) const

private

Definition at line 1355 of file Ruler.cpp.

 {
    Updater::ChooseFonts( mpFonts, mpUserFonts.get(), dc,
       mOrientation == wxHORIZONTAL
          ? mBottom - mTop - 5 // height less ticks and 1px gap
          : MaxPixelHeight
    );
 }

References Ruler::Updater::ChooseFonts(), MaxPixelHeight, mBottom, mOrientation, mpFonts, mpUserFonts, and mTop.

Referenced by GetFonts(), and UpdateCache().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Draw() [1/2]

void Ruler::Draw ( wxDC & dc ) const

Definition at line 1428 of file Ruler.cpp.

 {
    Draw( dc, NULL);
 }

Referenced by WaveTrackVRulerControls::DoDraw(), AdornedRulerPanel::DoDrawMarks(), anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve(), EffectCompressorPanel::OnPaint(), MeterPanel::OnPaint(), RulerPanel::OnPaint(), and AudacityPrintout::OnPrintPage().

Here is the caller graph for this function:

◆ Draw() [2/2]

void Ruler::Draw	(	wxDC &	dc,
		const Envelope *	envelope
	)		const

Definition at line 1433 of file Ruler.cpp.

 {
    if( mLength <=0 )
       return;
  
    UpdateCache( dc, envelope );
    auto &cache = *mpCache;
  
    dc.SetTextForeground( mTickColour );
 #ifdef EXPERIMENTAL_THEMING
    dc.SetPen(mPen);
 #else
    dc.SetPen(*wxBLACK_PEN);
 #endif
  
    // Draws a long line the length of the ruler.
    if( !mbTicksOnly )
    {
       if (mOrientation == wxHORIZONTAL) {
          if (mFlip)
             AColor::Line(dc, mLeft, mTop, mRight, mTop);
          else
             AColor::Line(dc, mLeft, mBottom, mRight, mBottom);
       }
       else {
          if (mFlip)
             AColor::Line(dc, mLeft, mTop, mLeft, mBottom);
          else
          {
             // These calculations appear to be wrong, and to never have been used (so not tested) prior to MixerBoard.
             //    AColor::Line(dc, mRect.x-mRect.width, mTop, mRect.x-mRect.width, mBottom);
             const int nLineX = mRight - 1;
             AColor::Line(dc, nLineX, mTop, nLineX, mBottom);
          }
       }
    }
  
    dc.SetFont( mpFonts->major );
  
    // We may want to not show the ticks at the extremes,
    // though still showing the labels.
    // This gives a better look when the ruler is on a bevelled
    // button, since otherwise the tick is drawn on the bevel.
    int iMaxPos = (mOrientation==wxHORIZONTAL)? mRight : mBottom-5;
  
    auto drawLabel = [this, iMaxPos, &dc]( const Label &label, int length ){
       int pos = label.pos;
  
       if( mbTicksAtExtremes || ((pos!=0)&&(pos!=iMaxPos)))
       {
          if (mOrientation == wxHORIZONTAL) {
             if (mFlip)
                AColor::Line(dc, mLeft + pos, mTop,
                              mLeft + pos, mTop + length);
             else
                AColor::Line(dc, mLeft + pos, mBottom - length,
                              mLeft + pos, mBottom);
          }
          else {
             if (mFlip)
                AColor::Line(dc, mLeft, mTop + pos,
                              mLeft + length, mTop + pos);
             else
                AColor::Line(dc, mRight - length, mTop + pos,
                              mRight, mTop + pos);
          }
       }
  
       label.Draw(dc, mTwoTone, mTickColour);
    };
  
    for( const auto &label : cache.mMajorLabels )
       drawLabel( label, 4 );
  
    if( mbMinor ) {
       dc.SetFont( mpFonts->minor );
       for( const auto &label : cache.mMinorLabels )
          drawLabel( label, 2 );
    }
  
    dc.SetFont( mpFonts->minorMinor );
  
    for( const auto &label : cache.mMinorMinorLabels )
       if ( !label.text.empty() )
          drawLabel( label, 2 );
 }

References TranslatableString::empty(), label, AColor::Line(), mbMinor, mBottom, mbTicksAtExtremes, mbTicksOnly, mFlip, mLeft, mLength, mOrientation, mpCache, mPen, mpFonts, mRight, mTickColour, mTop, mTwoTone, and UpdateCache().

Here is the call graph for this function:

◆ DrawGrid()

void Ruler::DrawGrid	(	wxDC &	dc,
		int	length,
		bool	minor = `true`,
		bool	major = `true`,
		int	xOffset = `0`,
		int	yOffset = `0`
	)		const

Definition at line 1521 of file Ruler.cpp.

 {
    UpdateCache( dc, nullptr );
    auto &cache = *mpCache;
  
    int gridPos;
    wxPen gridPen;
  
    if(mbMinor && (minorGrid && (gridLineLength != 0 ))) {
       gridPen.SetColour(178, 178, 178); // very light grey
       dc.SetPen(gridPen);
       for( const auto &label : cache.mMinorLabels ) {
          gridPos = label.pos;
          if(mOrientation == wxHORIZONTAL) {
             if((gridPos != 0) && (gridPos != gridLineLength))
                AColor::Line(dc, gridPos+xOffset, yOffset, gridPos+xOffset, gridLineLength-1+yOffset);
          }
          else {
             if((gridPos != 0) && (gridPos != gridLineLength))
                AColor::Line(dc, xOffset, gridPos+yOffset, gridLineLength-1+xOffset, gridPos+yOffset);
          }
       }
    }
  
    if(majorGrid && (gridLineLength != 0 )) {
       gridPen.SetColour(127, 127, 127); // light grey
       dc.SetPen(gridPen);
       for( const auto &label : cache.mMajorLabels ) {
          gridPos = label.pos;
          if(mOrientation == wxHORIZONTAL) {
             if((gridPos != 0) && (gridPos != gridLineLength))
                AColor::Line(dc, gridPos+xOffset, yOffset, gridPos+xOffset, gridLineLength-1+yOffset);
          }
          else {
             if((gridPos != 0) && (gridPos != gridLineLength))
                AColor::Line(dc, xOffset, gridPos+yOffset, gridLineLength-1+xOffset, gridPos+yOffset);
          }
       }
  
       int zeroPosition = GetZeroPosition();
       if(zeroPosition > 0) {
          // Draw 'zero' grid line in black
          dc.SetPen(*wxBLACK_PEN);
          if(mOrientation == wxHORIZONTAL) {
             if(zeroPosition != gridLineLength)
                AColor::Line(dc, zeroPosition+xOffset, yOffset, zeroPosition+xOffset, gridLineLength-1+yOffset);
          }
          else {
             if(zeroPosition != gridLineLength)
                AColor::Line(dc, xOffset, zeroPosition+yOffset, gridLineLength-1+xOffset, zeroPosition+yOffset);
          }
       }
    }
 }

References GetZeroPosition(), label, AColor::Line(), mbMinor, mOrientation, mpCache, and UpdateCache().

Referenced by FrequencyPlotDialog::DrawPlot(), EqualizationPanel::OnPaint(), and EffectScienFilterPanel::OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindZero()

int Ruler::FindZero ( const Labels & labels ) const

private

Definition at line 1579 of file Ruler.cpp.

 {
    auto begin = labels.begin(), end = labels.end(),
       iter = std::find_if( begin, end, []( const Label &label ){
          return label.value == 0.0;
       } );
  
    if ( iter == end )
       return -1;
    else
       return iter->pos;
 }

References label.

Referenced by GetZeroPosition().

Here is the caller graph for this function:

◆ GetFonts()

auto Ruler::GetFonts ( ) const

Definition at line 1418 of file Ruler.cpp.

 {
    if ( !mpFonts ) {
       wxScreenDC dc;
       ChooseFonts( dc );
    }
  
    return *mpFonts;
 }

References ChooseFonts(), and mpFonts.

Here is the call graph for this function:

◆ GetMaxSize()

void Ruler::GetMaxSize	(	wxCoord *	width,
		wxCoord *	height
	)

Definition at line 1603 of file Ruler.cpp.

 {
    if ( !mpCache ) {
       wxScreenDC sdc;
       UpdateCache( sdc, nullptr );
    }
  
    auto &cache = *mpCache;
    if (width)
       *width = cache.mRect.GetWidth();
  
    if (height)
       *height = cache.mRect.GetHeight();
 }

References mpCache, and UpdateCache().

Referenced by FrequencyPlotDialog::DrawPlot(), AdornedRulerPanel::GetMaxSize(), EffectCompressorPanel::OnPaint(), RulerPanel::RulerPanel(), MeterPanel::SetActiveStyle(), EffectEqualization::TransferDataFromWindow(), and EffectScienFilter::TransferGraphLimitsFromWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetZeroPosition()

int Ruler::GetZeroPosition ( ) const

private

Definition at line 1592 of file Ruler.cpp.

 {
    wxASSERT( mpCache );
    auto &cache = *mpCache;
    int zero;
    if( (zero = FindZero( cache.mMajorLabels ) ) < 0)
       zero = FindZero( cache.mMinorLabels );
    // PRL: don't consult minor minor??
    return zero;
 }

References FindZero(), and mpCache.

Referenced by DrawGrid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Invalidate()

void Ruler::Invalidate ( )

Definition at line 345 of file Ruler.cpp.

 {
    if (mOrientation == wxHORIZONTAL)
       mLength = mRight-mLeft;
    else
       mLength = mBottom-mTop;
  
    mpCache.reset();
    // Bug 2316 we must preserve off-limit pixels.
    // mUserBits.clear();
 }

References mBottom, mLeft, mLength, mOrientation, mpCache, mRight, and mTop.

Referenced by anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve(), AdornedRulerPanel::InvalidateRuler(), OfflimitsPixels(), SetBounds(), SetCustomMode(), SetDbMirrorValue(), SetFlip(), SetFonts(), SetFormat(), SetLabelEdges(), SetLog(), SetNumberScale(), SetOrientation(), SetRange(), SetSpacing(), SetUnits(), SetUseZoomInfo(), and ~Ruler().

Here is the caller graph for this function:

◆ MakeTick()

auto Ruler::MakeTick	(	Label	lab,
		wxDC &	dc,
		wxFont	font,
		std::vector< bool > &	bits,
		int	left,
		int	top,
		int	spacing,
		int	lead,
		bool	flip,
		int	orientation
	)

staticprivate

Definition at line 758 of file Ruler.cpp.

 {
    lab.lx = left - 1000; // don't display
    lab.ly = top - 1000;  // don't display
  
    auto length = bits.size() - 1;
    auto pos = lab.pos;
  
    dc.SetFont( font );
  
    wxCoord strW, strH, strD, strL;
    auto str = lab.text;
    // Do not put the text into results until we are sure it does not overlap
    lab.text = {};
    dc.GetTextExtent(str.Translation(), &strW, &strH, &strD, &strL);
  
    int strPos, strLen, strLeft, strTop;
    if ( orientation == wxHORIZONTAL ) {
       strLen = strW;
       strPos = pos - strW/2;
       if (strPos < 0)
          strPos = 0;
       if (strPos + strW >= length)
          strPos = length - strW;
       strLeft = left + strPos;
       if ( flip )
          strTop = top + 4;
       else
          strTop = -strH - lead;
 //         strTop = top - lead + 4;// More space was needed...
    }
    else {
       strLen = strH;
       strPos = pos - strH/2;
       if (strPos < 0)
          strPos = 0;
       if (strPos + strH >= length)
          strPos = length - strH;
       strTop = top + strPos;
       if ( flip )
          strLeft = left + 5;
       else
          strLeft = -strW - 6;
    }
  
    // FIXME: we shouldn't even get here if strPos < 0.
    // Ruler code currently does  not handle very small or
    // negative sized windows (i.e. don't draw) properly.
    if( strPos < 0 )
       return { {}, lab };
  
    // See if any of the pixels we need to draw this
    // label is already covered
  
    int i;
    for(i=0; i<strLen; i++)
       if ( bits[strPos+i] )
          return { {}, lab };
  
    // If not, position the label
  
    lab.lx = strLeft;
    lab.ly = strTop;
  
    // And mark these pixels, plus some surrounding
    // ones (the spacing between labels), as covered
    int leftMargin = spacing;
    if (strPos < leftMargin)
       leftMargin = strPos;
    strPos -= leftMargin;
    strLen += leftMargin;
  
    int rightMargin = spacing;
    if (strPos + strLen > length - spacing)
       rightMargin = length - strPos - strLen;
    strLen += rightMargin;
  
    for(i=0; i<strLen; i++)
       bits[strPos+i] = true;
  
    // Good to display the text
    lab.text = str;
    return { { strLeft, strTop, strW, strH }, lab };
 }

Referenced by Ruler::Updater::Tick(), and Ruler::Updater::TickCustom().

Here is the caller graph for this function:

◆ OfflimitsPixels()

void Ruler::OfflimitsPixels	(	int	start,
		int	end
	)

Definition at line 302 of file Ruler.cpp.

 {
    int length = mLength;
    if (mOrientation == wxHORIZONTAL)
       length = mRight - mLeft;
    else
       length = mBottom - mTop;
    if( length < 0 )
       return;
  
    auto size = static_cast<size_t>( length + 1 );
    if ( mUserBits.size() < size ) {
       mLength = length;
       mUserBits.resize( size, false );
    }
  
    if (end < start)
       std::swap( start, end );
  
    if (start < 0)
       start = 0;
    if (end > mLength)
       end = mLength;
  
    for(int i = start; i <= end; i++)
       mUserBits[i] = true;
  
    Invalidate();
 }

References Invalidate(), mBottom, mLeft, mLength, mOrientation, mRight, mTop, mUserBits, and anonymous_namespace{NoteTrack.cpp}::swap().

Referenced by MeterPanel::HandleLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBounds()

void Ruler::SetBounds	(	int	left,
		int	top,
		int	right,
		int	bottom
	)

Definition at line 332 of file Ruler.cpp.

 {
    if (mLeft != left || mTop != top ||
        mRight != right || mBottom != bottom) {
       mLeft = left;
       mTop = top;
       mRight = right;
       mBottom = bottom;
  
       Invalidate();
    }
 }

References Invalidate(), mBottom, mLeft, mRight, and mTop.

Referenced by RulerPanel::DoSetSize(), anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve(), MeterPanel::HandleLayout(), EffectCompressorPanel::OnPaint(), AudacityPrintout::OnPrintPage(), RulerPanel::RulerPanel(), MeterPanel::SetActiveStyle(), AdornedRulerPanel::UpdateRects(), and NoteTrackVRulerControls::UpdateRuler().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetCustomMajorLabels()

void Ruler::SetCustomMajorLabels	(	const TranslatableStrings &	labels,
		int	start,
		int	step
	)

◆ SetCustomMinorLabels()

void Ruler::SetCustomMinorLabels	(	const TranslatableStrings &	labels,
		int	start,
		int	step
	)

◆ SetCustomMode()

void Ruler::SetCustomMode ( bool value )

Definition at line 1619 of file Ruler.cpp.

 {
    if ( mCustom != value ) {
       mCustom = value;
       Invalidate();
    }
 }

References Invalidate(), and mCustom.

Here is the call graph for this function:

◆ SetDbMirrorValue()

void Ruler::SetDbMirrorValue ( const double d )

Definition at line 165 of file Ruler.cpp.

 {
    if (mDbMirrorValue != d) {
       mDbMirrorValue = d;
  
       Invalidate();
    }
 }

References Invalidate(), and mDbMirrorValue.

Here is the call graph for this function:

◆ SetFlip()

void Ruler::SetFlip ( bool flip )

Definition at line 239 of file Ruler.cpp.

 {
    // If this is true, the orientation of the tick marks
    // is reversed from the default; eg. above the line
    // instead of below
  
    if (mFlip != flip) {
       mFlip = flip;
  
       Invalidate();
    }
 }

References Invalidate(), and mFlip.

Referenced by anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve(), EffectCompressorPanel::OnPaint(), and RulerPanel::RulerPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFonts()

void Ruler::SetFonts	(	const wxFont &	minorFont,
		const wxFont &	majorFont,
		const wxFont &	minorMinorFont
	)

Definition at line 278 of file Ruler.cpp.

 {
    // Won't override these fonts
  
    mpUserFonts = std::make_unique<Fonts>(
       Fonts{ majorFont, minorFont, minorMinorFont, 0 } );
  
    wxScreenDC dc;
    wxCoord height;
    FindFontHeights( height, mpUserFonts->lead, dc, majorFont );
  
    mpFonts.reset();
    mpFonts.reset();
    Invalidate();
 }

References anonymous_namespace{Ruler.cpp}::FindFontHeights(), Invalidate(), mpFonts, and mpUserFonts.

Here is the call graph for this function:

◆ SetFormat()

void Ruler::SetFormat ( RulerFormat format )

Definition at line 131 of file Ruler.cpp.

 {
    // IntFormat, RealFormat, RealLogFormat, TimeFormat, or LinearDBFormat
  
    if (mFormat != format) {
       mFormat = format;
  
       Invalidate();
    }
 }

References format, Invalidate(), and mFormat.

Referenced by AdornedRulerPanel::AdornedRulerPanel(), FrequencyPlotDialog::DrawPlot(), EffectCompressorPanel::OnPaint(), AudacityPrintout::OnPrintPage(), RulerPanel::RulerPanel(), and MeterPanel::SetActiveStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLabelEdges()

void Ruler::SetLabelEdges ( bool labelEdges )

Definition at line 226 of file Ruler.cpp.

 {
    // If this is true, the edges of the ruler will always
    // receive a label.  If not, the nearest round number is
    // labeled (which may or may not be the edge).
  
    if (mLabelEdges != labelEdges) {
       mLabelEdges = labelEdges;
  
       Invalidate();
    }
 }

References Invalidate(), and mLabelEdges.

Referenced by AdornedRulerPanel::AdornedRulerPanel(), AudacityPrintout::OnPrintPage(), and RulerPanel::RulerPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLog()

void Ruler::SetLog ( bool log )

Definition at line 142 of file Ruler.cpp.

 {
    // Logarithmic
  
    if (mLog != log) {
       mLog = log;
  
       Invalidate();
    }
 }

References Invalidate(), and mLog.

Referenced by FrequencyPlotDialog::DrawPlot(), EffectEqualization::OnLinFreq(), RulerPanel::RulerPanel(), EffectEqualization::UpdateDraw(), and EffectEqualization::UpdateGraphic().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMinor()

void Ruler::SetMinor ( bool value )

Definition at line 252 of file Ruler.cpp.

 {
    mbMinor = value;
 }

References mbMinor.

◆ SetNumberScale()

void Ruler::SetNumberScale ( const NumberScale & scale )

Definition at line 294 of file Ruler.cpp.

 {
    if ( mNumberScale != scale ) {
       mNumberScale = scale;
       Invalidate();
    }
 }

References Invalidate(), and mNumberScale.

Here is the call graph for this function:

◆ SetOrientation()

void Ruler::SetOrientation ( int orient )

Definition at line 174 of file Ruler.cpp.

 {
    // wxHORIZONTAL || wxVERTICAL
  
    if (mOrientation != orient) {
       mOrientation = orient;
  
       if (mOrientation == wxVERTICAL && !mHasSetSpacing)
          mSpacing = 2;
  
       Invalidate();
    }
 }

References Invalidate(), mHasSetSpacing, mOrientation, and mSpacing.

Referenced by EffectCompressorPanel::OnPaint(), AudacityPrintout::OnPrintPage(), RulerPanel::RulerPanel(), and MeterPanel::SetActiveStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRange() [1/2]

void Ruler::SetRange	(	double	min,
		double	max
	)

Definition at line 188 of file Ruler.cpp.

 {
    SetRange(min, max, min, max);
 }

References min().

Referenced by AdornedRulerPanel::DoDrawMarks(), anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve(), FrequencyPlotDialog::DrawPlot(), EffectEqualization::OnLinFreq(), EffectCompressorPanel::OnPaint(), AudacityPrintout::OnPrintPage(), RulerPanel::RulerPanel(), MeterPanel::SetActiveStyle(), EffectEqualization::TransferDataFromWindow(), EffectScienFilter::TransferGraphLimitsFromWindow(), EffectEqualization::UpdateDraw(), and EffectEqualization::UpdateGraphic().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRange() [2/2]

void Ruler::SetRange	(	double	min,
		double	max,
		double	hiddenMin,
		double	hiddenMax
	)

Definition at line 193 of file Ruler.cpp.

 {
    // For a horizontal ruler,
    // min is the value in the center of pixel "left",
    // max is the value in the center of pixel "right".
  
    // In the special case of a time ruler,
    // hiddenMin and hiddenMax are values that would be shown with the fisheye
    // turned off.  In other cases they equal min and max respectively.
  
    if (mMin != min || mMax != max ||
       mHiddenMin != hiddenMin || mHiddenMax != hiddenMax) {
       mMin = min;
       mMax = max;
       mHiddenMin = hiddenMin;
       mHiddenMax = hiddenMax;
  
       Invalidate();
    }
 }

References Invalidate(), mHiddenMax, mHiddenMin, min(), mMax, and mMin.

Here is the call graph for this function:

◆ SetSpacing()

void Ruler::SetSpacing ( int spacing )

Definition at line 215 of file Ruler.cpp.

 {
    mHasSetSpacing = true;
  
    if (mSpacing != spacing) {
       mSpacing = spacing;
  
       Invalidate();
    }
 }

References Invalidate(), mHasSetSpacing, and mSpacing.

Here is the call graph for this function:

◆ SetTickColour()

void Ruler::SetTickColour ( const wxColour & colour )

inline

Definition at line 148 of file Ruler.h.

149 { mTickColour = colour; mPen.SetColour( colour );}

Referenced by WaveTrackVRulerControls::DoDraw(), AdornedRulerPanel::DoDrawMarks(), anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve(), EffectCompressorPanel::OnPaint(), MeterPanel::OnPaint(), RulerPanel::RulerPanel(), and RulerPanel::SetTickColour().

Here is the caller graph for this function:

◆ SetTwoTone()

void Ruler::SetTwoTone ( bool twoTone )

Definition at line 126 of file Ruler.cpp.

 {
    mTwoTone = twoTone;
 }

References mTwoTone.

Referenced by AdornedRulerPanel::UpdatePrefs().

Here is the caller graph for this function:

◆ SetUnits()

void Ruler::SetUnits ( const TranslatableString & units )

Definition at line 153 of file Ruler.cpp.

 {
    // Specify the name of the units (like "dB") if you
    // want numbers like "1.6" formatted as "1.6 dB".
  
    if (mUnits != units) {
       mUnits = units;
  
       Invalidate();
    }
 }

References Invalidate(), and mUnits.

Referenced by FrequencyPlotDialog::DrawPlot(), EffectCompressorPanel::OnPaint(), and RulerPanel::RulerPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetUseZoomInfo()

void Ruler::SetUseZoomInfo	(	int	leftOffset,
		const ZoomInfo *	zoomInfo
	)

Definition at line 1680 of file Ruler.cpp.

 {
    
    if ( mLeftOffset != leftOffset ||
       // Hm, is this invalidation sufficient?  What if *zoomInfo changes under us?
       mUseZoomInfo != zoomInfo
    ) {
       mLeftOffset = leftOffset;
       mUseZoomInfo = zoomInfo;
       Invalidate();
    }
 }

References Invalidate(), mLeftOffset, and mUseZoomInfo.

Referenced by AdornedRulerPanel::AdornedRulerPanel(), and AdornedRulerPanel::SetLeftOffset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateCache()

void Ruler::UpdateCache	(	wxDC &	dc,
		const Envelope *	envelope
	)		const

private

Definition at line 1364 of file Ruler.cpp.

 {
    if ( mpCache )
       return;
  
    const ZoomInfo *zoomInfo = NULL;
    if (!mLog && mOrientation == wxHORIZONTAL)
       zoomInfo = mUseZoomInfo;
  
    // This gets called when something has been changed
    // (i.e. we've been invalidated).  Recompute all
    // tick positions and font size.
  
    ChooseFonts( dc );
    mpCache = std::make_unique< Cache >();
    auto &cache = *mpCache;
  
    // If ruler is being resized, we could end up with it being too small.
    // Values of mLength of zero or below cause bad array allocations and
    // division by zero.  So...
    // IF too small THEN bail out and don't draw.
    if( mLength <= 0 )
       return;
  
    if (mOrientation == wxHORIZONTAL)
       cache.mRect = { 0, 0, mLength, 0 };
    else
       cache.mRect = { 0, 0, 0, mLength };
  
    // FIXME: Surely we do not need to allocate storage for the labels?
    // We can just recompute them as we need them?  Yes, but only if
    // mCustom is false!!!!
  
    if(!mCustom) {
       cache.mMajorLabels.clear();
       cache.mMinorLabels.clear();
       cache.mMinorMinorLabels.clear();
    }
  
    cache.mBits = mUserBits;
    cache.mBits.resize( static_cast<size_t>(mLength + 1), false );
  
    // Keep Updater const!  We want no hidden state changes affecting its
    // computations.
    const Updater updater{ *this, zoomInfo };
    Updater::UpdateOutputs allOutputs{
       cache.mMajorLabels, cache.mMinorLabels, cache.mMinorMinorLabels,
       cache.mBits, cache.mRect
    };
    updater.Update(dc, envelope, allOutputs);
 }

References ChooseFonts(), mCustom, mLength, mLog, mOrientation, mpCache, mUserBits, and mUseZoomInfo.

Referenced by Draw(), DrawGrid(), and GetMaxSize().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mbMinor

bool Ruler::mbMinor

private

Definition at line 219 of file Ruler.h.

Referenced by Draw(), DrawGrid(), Ruler(), and SetMinor().

◆ mBottom

int Ruler::mBottom

private

Definition at line 184 of file Ruler.h.

Referenced by ChooseFonts(), Draw(), Invalidate(), OfflimitsPixels(), Ruler(), SetBounds(), and Ruler::Updater::UpdateLinear().

◆ mbTicksAtExtremes

bool Ruler::mbTicksAtExtremes

Definition at line 178 of file Ruler.h.

Referenced by Draw(), Ruler(), and RulerPanel::RulerPanel().

◆ mbTicksOnly

bool Ruler::mbTicksOnly

Definition at line 177 of file Ruler.h.

Referenced by Draw(), and Ruler().

◆ mCustom

bool Ruler::mCustom

private

Definition at line 218 of file Ruler.h.

Referenced by Ruler(), SetCustomMode(), Ruler::Updater::Update(), and UpdateCache().

◆ mDbMirrorValue

double Ruler::mDbMirrorValue

private

Definition at line 212 of file Ruler.h.

Referenced by Ruler(), SetDbMirrorValue(), and Ruler::Updater::UpdateLinear().

◆ mFlip

bool Ruler::mFlip

private

Definition at line 217 of file Ruler.h.

Referenced by Draw(), Ruler(), SetFlip(), Ruler::Updater::TickCustom(), and Ruler::Updater::Update().

◆ mFormat

RulerFormat Ruler::mFormat

private

Definition at line 215 of file Ruler.h.

Referenced by Ruler(), SetFormat(), Ruler::Updater::UpdateLinear(), and Ruler::Updater::UpdateNonlinear().

◆ mHasSetSpacing

bool Ruler::mHasSetSpacing

private

Definition at line 213 of file Ruler.h.

Referenced by Ruler(), SetOrientation(), and SetSpacing().

◆ mHiddenMax

double Ruler::mHiddenMax

private

Definition at line 191 of file Ruler.h.

Referenced by Ruler(), SetRange(), Ruler::Updater::UpdateLinear(), and Ruler::Updater::UpdateNonlinear().

◆ mHiddenMin

double Ruler::mHiddenMin

private

Definition at line 191 of file Ruler.h.

Referenced by Ruler(), SetRange(), Ruler::Updater::UpdateLinear(), and Ruler::Updater::UpdateNonlinear().

◆ mLabelEdges

bool Ruler::mLabelEdges

private

Definition at line 214 of file Ruler.h.

Referenced by Ruler(), SetLabelEdges(), and Ruler::Updater::UpdateLinear().

◆ mLeft

int Ruler::mLeft

private

Definition at line 184 of file Ruler.h.

Referenced by Draw(), Invalidate(), OfflimitsPixels(), Ruler(), SetBounds(), Ruler::Updater::TickCustom(), and Ruler::Updater::Update().

◆ mLeftOffset

int Ruler::mLeftOffset

private

Definition at line 223 of file Ruler.h.

Referenced by SetUseZoomInfo(), and Ruler::Updater::UpdateLinear().

◆ mLength

int Ruler::mLength

private

Definition at line 185 of file Ruler.h.

Referenced by Draw(), Invalidate(), OfflimitsPixels(), Ruler(), UpdateCache(), Ruler::Updater::UpdateCustom(), Ruler::Updater::UpdateLinear(), and Ruler::Updater::UpdateNonlinear().

◆ mLog

bool Ruler::mLog

private

Definition at line 216 of file Ruler.h.

Referenced by Ruler(), SetLog(), Ruler::Updater::Update(), and UpdateCache().

◆ mMax

double Ruler::mMax

private

Definition at line 190 of file Ruler.h.

Referenced by Ruler(), SetRange(), Ruler::Updater::UpdateLinear(), and Ruler::Updater::UpdateNonlinear().

◆ mMin

double Ruler::mMin

private

Definition at line 190 of file Ruler.h.

Referenced by Ruler(), SetRange(), Ruler::Updater::UpdateLinear(), and Ruler::Updater::UpdateNonlinear().

◆ mNumberScale

NumberScale Ruler::mNumberScale

private

Definition at line 225 of file Ruler.h.

Referenced by SetNumberScale(), and Ruler::Updater::UpdateNonlinear().

◆ mOrientation

int Ruler::mOrientation

private

Definition at line 210 of file Ruler.h.

Referenced by ChooseFonts(), Draw(), DrawGrid(), Invalidate(), OfflimitsPixels(), Ruler(), SetOrientation(), Ruler::Updater::TickCustom(), Ruler::Updater::Update(), UpdateCache(), Ruler::Updater::UpdateLinear(), and Ruler::Updater::UpdateNonlinear().

◆ mpCache

std::unique_ptr<Cache> Ruler::mpCache

mutableprivate

Definition at line 203 of file Ruler.h.

Referenced by Draw(), DrawGrid(), GetMaxSize(), GetZeroPosition(), Invalidate(), and UpdateCache().

◆ mPen

wxPen Ruler::mPen

private

Definition at line 182 of file Ruler.h.

Referenced by Draw(), and Ruler().

◆ mpFonts

std::unique_ptr<Fonts> Ruler::mpFonts

mutableprivate

Definition at line 188 of file Ruler.h.

Referenced by ChooseFonts(), Draw(), GetFonts(), and SetFonts().

◆ mpUserFonts

std::unique_ptr<Fonts> Ruler::mpUserFonts

private

Definition at line 187 of file Ruler.h.

Referenced by ChooseFonts(), and SetFonts().

◆ mRight

int Ruler::mRight

private

Definition at line 184 of file Ruler.h.

Referenced by Draw(), Invalidate(), OfflimitsPixels(), Ruler(), SetBounds(), and Ruler::Updater::UpdateLinear().

◆ mSpacing

int Ruler::mSpacing

private

Definition at line 211 of file Ruler.h.

Referenced by Ruler(), SetOrientation(), SetSpacing(), and Ruler::Updater::TickCustom().

◆ mTickColour

wxColour Ruler::mTickColour

private

Definition at line 181 of file Ruler.h.

Referenced by Draw(), and Ruler().

◆ mTop

int Ruler::mTop

private

Definition at line 184 of file Ruler.h.

Referenced by ChooseFonts(), Draw(), Invalidate(), OfflimitsPixels(), Ruler(), SetBounds(), Ruler::Updater::TickCustom(), and Ruler::Updater::Update().

◆ mTwoTone

bool Ruler::mTwoTone

private

Definition at line 221 of file Ruler.h.

Referenced by Draw(), Ruler(), and SetTwoTone().

◆ mUnits

TranslatableString Ruler::mUnits

private

Definition at line 220 of file Ruler.h.

Referenced by SetUnits().

◆ mUserBits

Bits Ruler::mUserBits

private

Definition at line 193 of file Ruler.h.

Referenced by OfflimitsPixels(), and UpdateCache().

◆ mUseZoomInfo

const ZoomInfo* Ruler::mUseZoomInfo

private

Definition at line 222 of file Ruler.h.

Referenced by Ruler(), SetUseZoomInfo(), and UpdateCache().

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

Classes

Public Types

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Bits

◆ Labels

Member Enumeration Documentation

◆ RulerFormat

Constructor & Destructor Documentation

◆ Ruler()

◆ ~Ruler()

Member Function Documentation

◆ ChooseFonts()

◆ Draw() [1/2]

◆ Draw() [2/2]

◆ DrawGrid()

◆ FindZero()

◆ GetFonts()

◆ GetMaxSize()

◆ GetZeroPosition()

◆ Invalidate()

◆ MakeTick()

◆ OfflimitsPixels()

◆ SetBounds()

◆ SetCustomMajorLabels()

◆ SetCustomMinorLabels()

◆ SetCustomMode()

◆ SetDbMirrorValue()

◆ SetFlip()

◆ SetFonts()

◆ SetFormat()

◆ SetLabelEdges()

◆ SetLog()

◆ SetMinor()

◆ SetNumberScale()

◆ SetOrientation()

◆ SetRange() [1/2]

◆ SetRange() [2/2]

◆ SetSpacing()

◆ SetTickColour()

◆ SetTwoTone()

◆ SetUnits()

◆ SetUseZoomInfo()

◆ UpdateCache()

Member Data Documentation

◆ mbMinor

◆ mBottom

◆ mbTicksAtExtremes

◆ mbTicksOnly

◆ mCustom

◆ mDbMirrorValue

◆ mFlip

◆ mFormat

◆ mHasSetSpacing

◆ mHiddenMax

◆ mHiddenMin

◆ mLabelEdges

◆ mLeft

◆ mLeftOffset

◆ mLength

◆ mLog

◆ mMax

◆ mMin

◆ mNumberScale

◆ mOrientation

◆ mpCache

◆ mPen

◆ mpFonts

◆ mpUserFonts

◆ mRight

◆ mSpacing

◆ mTickColour

◆ mTop

◆ mTwoTone