Ruler Class Reference

Used to display a Ruler. More...

#include <Ruler.h>

Inheritance diagram for Ruler:

Collaboration diagram for Ruler:

Classes
struct	Cache
struct	TickLengths

Public Member Functions
	Ruler (const RulerUpdater &updater, const RulerFormat &format)
	~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	SetUpdater (const RulerUpdater *pUpdater)
void	SetTwoTone (bool twoTone)
void	SetFormat (const RulerFormat *pFormat)
void	SetUnits (const TranslatableString &units)
void	SetDbMirrorValue (const double d)
void	SetLabelEdges (bool labelEdges)
void	SetFlip (bool flip)
void	SetMinor (bool value)
void	SetFonts (const wxFont &minorFont, const wxFont &majorFont, const wxFont &minorMinorFont)
RulerStruct::Fonts	GetFonts () const
void	SetNumberScale (const NumberScale &scale)
void	SetTickLengths (const TickLengths &tLengths)
void	OfflimitsPixels (int start, int end)
void	GetMaxSize (wxCoord *width, wxCoord *height)
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 Member Functions inherited from Observer::Publisher< RulerInvalidatedMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Public Attributes
bool	mbTicksOnly
bool	mbTicksAtExtremes

Private Member Functions
void	ChooseFonts (wxDC &dc) const
void	UpdateCache (wxDC &dc, const Envelope *envelope) const
int	FindZero (const RulerUpdater::Labels &labels) const
int	GetZeroPosition () const

Private Attributes
RulerStruct	mRulerStruct
TickLengths	mTickLengths
wxColour	mTickColour
wxPen	mPen
std::unique_ptr< RulerStruct::Fonts >	mpUserFonts
const RulerUpdater *	mpUpdater {}
RulerUpdater::Bits	mUserBits
std::unique_ptr< Cache >	mpCache
bool	mbMinor
bool	mTwoTone

Additional Inherited Members
Public Types inherited from Observer::Publisher< RulerInvalidatedMessage >
using	message_type = RulerInvalidatedMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const RulerInvalidatedMessage &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< RulerInvalidatedMessage >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< RulerInvalidatedMessage >
CallbackReturn	Publish (const RulerInvalidatedMessage &message)
	Send a message to connected callbacks. More...

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 32 of file Ruler.h.

Constructor & Destructor Documentation

Ruler()

Ruler::Ruler	(	const RulerUpdater &	updater,
		const RulerFormat &	format
	)

Definition at line 66 of file Ruler.cpp.

{
   mbTicksOnly = true;
   mbTicksAtExtremes = false;
   mTickColour = wxColour( theTheme.Colour( clrTrackPanelText ));
   mPen.SetColour(mTickColour);
 
   // 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
 
   mbMinor = true;
 
   mTwoTone = false;
 
   SetUpdater(&updater);
   SetFormat(&format);
 
   mTickLengths = { 4, 2, 2 };
}

References ThemeBase::Colour(), anonymous_namespace{ExportPCM.cpp}::format, mbMinor, mbTicksAtExtremes, mbTicksOnly, mPen, mTickColour, mTickLengths, mTwoTone, SetFormat(), SetUpdater(), theTheme, and updater.

Here is the call graph for this function:

~Ruler()

Ruler::~Ruler

(

)

Definition at line 93 of file Ruler.cpp.

{
   // DV: Why?
   // Invalidate();  // frees up our arrays
}

Member Function Documentation

ChooseFonts()

void Ruler::ChooseFonts ( wxDC &  dc ) const

private

Definition at line 354 of file Ruler.cpp.

{
   const RulerStruct::Fonts* pUserFonts = mpUserFonts.get();
   int desiredPixelHeight = mRulerStruct.mOrientation == wxHORIZONTAL
      ? mRulerStruct.mBottom - mRulerStruct.mTop - 5 // height less ticks and 1px gap
      : MaxPixelHeight;
 
   if (mRulerStruct.mpFonts)
      return;
 
   if (pUserFonts) {
      mRulerStruct.mpFonts = std::make_unique<RulerStruct::Fonts>(*pUserFonts);
      return;
   }
 
   mRulerStruct.mpFonts = std::make_unique<RulerStruct::Fonts>(RulerStruct::Fonts{ {}, {}, {}, 0 });
   auto& fonts = *(mRulerStruct.mpFonts);
 
   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, RulerStruct::mBottom, min(), MinPixelHeight, RulerStruct::mOrientation, RulerStruct::mpFonts, mpUserFonts, mRulerStruct, and RulerStruct::mTop.

Referenced by GetFonts().

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 441 of file Ruler.cpp.

{
   Draw( dc, NULL);
}

References Draw().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Draw() [2/2]

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

Definition at line 446 of file Ruler.cpp.

{
   if(mRulerStruct.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 (mRulerStruct.mOrientation == wxHORIZONTAL) {
         if (mRulerStruct.mFlip)
            AColor::Line(dc, mRulerStruct.mLeft, mRulerStruct.mTop, mRulerStruct.mRight, mRulerStruct.mTop);
         else
            AColor::Line(dc, mRulerStruct.mLeft, mRulerStruct.mBottom, mRulerStruct.mRight, mRulerStruct.mBottom);
      }
      else {
         if (mRulerStruct.mFlip)
            AColor::Line(dc, mRulerStruct.mLeft, mRulerStruct.mTop, mRulerStruct.mLeft, mRulerStruct.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 = mRulerStruct.mRight - 1;
            AColor::Line(dc, nLineX, mRulerStruct.mTop, nLineX, mRulerStruct.mBottom);
         }
      }
   }
 
   dc.SetFont( mRulerStruct.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 = (mRulerStruct.mOrientation==wxHORIZONTAL)? mRulerStruct.mRight : mRulerStruct.mBottom-5;
 
   auto drawLabel = [this, iMaxPos, &dc]( const RulerUpdater::Label &label, int length ){
      int pos = label.pos;
 
      if( mbTicksAtExtremes || ((pos!=0)&&(pos!=iMaxPos)))
      {
         if (mRulerStruct.mOrientation == wxHORIZONTAL) {
            if (mRulerStruct.mFlip)
               AColor::Line(dc, mRulerStruct.mLeft + pos, mRulerStruct.mTop,
                             mRulerStruct.mLeft + pos, mRulerStruct.mTop + length);
            else
               AColor::Line(dc, mRulerStruct.mLeft + pos, mRulerStruct.mBottom - length,
                             mRulerStruct.mLeft + pos, mRulerStruct.mBottom);
         }
         else {
            if (mRulerStruct.mFlip)
               AColor::Line(dc, mRulerStruct.mLeft, mRulerStruct.mTop + pos,
                             mRulerStruct.mLeft + length, mRulerStruct.mTop + pos);
            else
               AColor::Line(dc, mRulerStruct.mRight - length, mRulerStruct.mTop + pos,
                             mRulerStruct.mRight, mRulerStruct.mTop + pos);
         }
      }
 
      label.Draw(dc, mTwoTone, mTickColour, mRulerStruct.mpFonts);
   };
 
   for( const auto &label : cache.mMajorLabels )
      drawLabel( label, mTickLengths.majorLength );
 
   if( mbMinor ) {
      dc.SetFont( mRulerStruct.mpFonts->minor );
      for( const auto &label : cache.mMinorLabels )
         drawLabel( label, mTickLengths.minorLength );
   }
 
   dc.SetFont( mRulerStruct.mpFonts->minorMinor );
 
   for( const auto &label : cache.mMinorMinorLabels )
      if ( label.text )
         drawLabel( label, mTickLengths.minorMinorLength );
}

References label, AColor::Line(), Ruler::TickLengths::majorLength, mbMinor, RulerStruct::mBottom, mbTicksAtExtremes, mbTicksOnly, RulerStruct::mFlip, Ruler::TickLengths::minorLength, Ruler::TickLengths::minorMinorLength, RulerStruct::mLeft, RulerStruct::mLength, RulerStruct::mOrientation, mpCache, mPen, RulerStruct::mpFonts, RulerStruct::mRight, mRulerStruct, mTickColour, mTickLengths, RulerStruct::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 534 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(mRulerStruct.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(mRulerStruct.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(mRulerStruct.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, RulerStruct::mOrientation, mpCache, mRulerStruct, 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 RulerUpdater::Labels &  labels ) const

private

Definition at line 592 of file Ruler.cpp.

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

References PackedArray::begin(), PackedArray::end(), and label.

Referenced by GetZeroPosition().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFonts()

auto Ruler::GetFonts

(

)

const

Definition at line 431 of file Ruler.cpp.

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

References ChooseFonts(), RulerStruct::mpFonts, and mRulerStruct.

Here is the call graph for this function:

GetMaxSize()

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

Definition at line 616 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(), MeterPanel::SetActiveStyle(), EffectScienFilter::TransferGraphLimitsFromWindow(), and EqualizationUI::UpdateRuler().

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 605 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 317 of file Ruler.cpp.

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

References RulerStruct::mBottom, RulerStruct::mLeft, RulerStruct::mLength, RulerStruct::mOrientation, mpCache, RulerStruct::mRight, mRulerStruct, RulerStruct::mTop, and Observer::Publisher< RulerInvalidatedMessage >::Publish().

Referenced by anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve(), ProjectTimeRuler::Impl::Impl(), AdornedRulerPanel::InvalidateRuler(), OfflimitsPixels(), SetBounds(), SetDbMirrorValue(), SetFlip(), SetFonts(), SetFormat(), SetLabelEdges(), AdornedRulerPanel::SetLeftOffset(), SetNumberScale(), SetOrientation(), SetRange(), SetTickLengths(), SetUnits(), and SetUpdater().

Here is the call graph for this function:

Here is the caller graph for this function:

OfflimitsPixels()

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

Definition at line 274 of file Ruler.cpp.

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

References PackedArray::end(), Invalidate(), RulerStruct::mBottom, RulerStruct::mLeft, RulerStruct::mLength, RulerStruct::mOrientation, RulerStruct::mRight, mRulerStruct, RulerStruct::mTop, mUserBits, size, 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 304 of file Ruler.cpp.

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

References Invalidate(), RulerStruct::mBottom, RulerStruct::mLeft, RulerStruct::mRight, mRulerStruct, and RulerStruct::mTop.

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

Here is the call graph for this function:

Here is the caller graph for this function:

SetDbMirrorValue()

void Ruler::SetDbMirrorValue

(

const double

d

)

Definition at line 132 of file Ruler.cpp.

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

References Invalidate(), RulerStruct::mDbMirrorValue, and mRulerStruct.

Here is the call graph for this function:

SetFlip()

void Ruler::SetFlip

(

bool

flip

)

Definition at line 192 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 (mRulerStruct.mFlip != flip) {
      mRulerStruct.mFlip = flip;
 
      Invalidate();
   }
}

References Invalidate(), RulerStruct::mFlip, and mRulerStruct.

Referenced by anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve().

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 231 of file Ruler.cpp.

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

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

Here is the call graph for this function:

SetFormat()

void Ruler::SetFormat

(

const RulerFormat *

pFormat

)

Definition at line 104 of file Ruler.cpp.

{
   if (mRulerStruct.mpRulerFormat != pFormat) {
      mRulerStruct.mpRulerFormat = pFormat;
      Invalidate();
   }
}

References Invalidate(), RulerStruct::mpRulerFormat, and mRulerStruct.

Referenced by FrequencyPlotDialog::DrawPlot(), Ruler(), 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 179 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 (mRulerStruct.mLabelEdges != labelEdges) {
      mRulerStruct.mLabelEdges = labelEdges;
 
      Invalidate();
   }
}

References Invalidate(), RulerStruct::mLabelEdges, and mRulerStruct.

Referenced by AdornedRulerPanel::AdornedRulerPanel(), TimeTrackView::Draw(), and anonymous_namespace{Printing.cpp}::AudacityPrintout::OnPrintPage().

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 205 of file Ruler.cpp.

{
   mbMinor = value;
}

References mbMinor.

SetNumberScale()

void Ruler::SetNumberScale

(

const NumberScale &

scale

)

Definition at line 247 of file Ruler.cpp.

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

References Invalidate(), RulerStruct::mNumberScale, and mRulerStruct.

Here is the call graph for this function:

SetOrientation()

void Ruler::SetOrientation

(

int

orient

)

Definition at line 141 of file Ruler.cpp.

{
   // wxHORIZONTAL || wxVERTICAL
 
   if (mRulerStruct.mOrientation != orient) {
      mRulerStruct.mOrientation = orient;
 
      Invalidate();
   }
}

References Invalidate(), RulerStruct::mOrientation, and mRulerStruct.

Referenced by anonymous_namespace{Printing.cpp}::AudacityPrintout::OnPrintPage(), 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 152 of file Ruler.cpp.

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

References min(), and SetRange().

Referenced by AdornedRulerPanel::DoDrawMarks(), anonymous_namespace{TimeTrackView.cpp}::DrawHorzRulerAndCurve(), FrequencyPlotDialog::DrawPlot(), EqualizationUI::OnLinFreq(), anonymous_namespace{Printing.cpp}::AudacityPrintout::OnPrintPage(), MeterPanel::SetActiveStyle(), SetRange(), EffectScienFilter::TransferGraphLimitsFromWindow(), EqualizationUI::UpdateDraw(), EqualizationUI::UpdateGraphic(), and EqualizationUI::UpdateRuler().

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 157 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 (mRulerStruct.mMin != min || mRulerStruct.mMax != max ||
      mRulerStruct.mHiddenMin != hiddenMin || mRulerStruct.mHiddenMax != hiddenMax) {
      mRulerStruct.mMin = min;
      mRulerStruct.mMax = max;
      mRulerStruct.mHiddenMin = hiddenMin;
      mRulerStruct.mHiddenMax = hiddenMax;
 
      Invalidate();
   }
}

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

Here is the call graph for this function:

SetTickColour()

void Ruler::SetTickColour ( const wxColour &  colour )

inline

Definition at line 135 of file Ruler.h.

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

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

Here is the caller graph for this function:

SetTickLengths()

void Ruler::SetTickLengths

(

const TickLengths &

tLengths

)

Definition at line 255 of file Ruler.cpp.

{
   bool inv = false;
   if (mTickLengths.majorLength != tLengths.majorLength) {
      mTickLengths.majorLength = tLengths.majorLength;
      inv = true;
   }
   if (mTickLengths.minorLength != tLengths.minorLength) {
      mTickLengths.minorLength = tLengths.minorLength;
      inv = true;
   }
   if (mTickLengths.minorMinorLength != tLengths.minorMinorLength) {
      mTickLengths.minorMinorLength = tLengths.minorMinorLength;
      inv = true;
   }
 
   if (inv) Invalidate();
}

References Invalidate(), Ruler::TickLengths::majorLength, Ruler::TickLengths::minorLength, Ruler::TickLengths::minorMinorLength, and mTickLengths.

Referenced by AdornedRulerPanel::DoDrawMarks().

Here is the call graph for this function:

Here is the caller graph for this function:

SetTwoTone()

void Ruler::SetTwoTone

(

bool

twoTone

)

Definition at line 99 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 120 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 (mRulerStruct.mUnits != units) {
      mRulerStruct.mUnits = units;
 
      Invalidate();
   }
}

References Invalidate(), mRulerStruct, and RulerStruct::mUnits.

Referenced by FrequencyPlotDialog::DrawPlot().

Here is the call graph for this function:

Here is the caller graph for this function:

SetUpdater()

void Ruler::SetUpdater

(

const RulerUpdater *

pUpdater

)

Definition at line 112 of file Ruler.cpp.

{
   if (mpUpdater != pUpdater) {
      mpUpdater = pUpdater;
      Invalidate();
   }
}

References Invalidate(), mpUpdater, and anonymous_namespace{LogWindow.cpp}::pUpdater.

Referenced by FrequencyPlotDialog::DrawPlot(), EqualizationUI::OnLinFreq(), Ruler(), EqualizationUI::UpdateDraw(), and EqualizationUI::UpdateGraphic().

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 393 of file Ruler.cpp.

{
   if ( mpCache )
      return;
 
   // 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( mRulerStruct.mLength <= 0 )
      return;
 
   if (mRulerStruct.mOrientation == wxHORIZONTAL)
      cache.mRect = { 0, 0, mRulerStruct.mLength, 0 };
   else
      cache.mRect = { 0, 0, 0, mRulerStruct.mLength };
 
   cache.mBits = mUserBits;
   cache.mBits.resize( static_cast<size_t>(mRulerStruct.mLength + 1), false );
   
   RulerUpdater::UpdateOutputs allOutputs{
      cache.mMajorLabels, cache.mMinorLabels, cache.mMinorMinorLabels,
      cache.mBits, cache.mRect
   };
   if (mpUpdater)
      mpUpdater->Update(dc, envelope, allOutputs, mRulerStruct);
}

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

Here is the caller graph for this function:

Member Data Documentation

mbMinor

bool Ruler::mbMinor

private

Definition at line 174 of file Ruler.h.

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

mbTicksAtExtremes

bool Ruler::mbTicksAtExtremes

Definition at line 149 of file Ruler.h.

Referenced by Draw(), and Ruler().

mbTicksOnly

bool Ruler::mbTicksOnly

Definition at line 148 of file Ruler.h.

Referenced by Draw(), and Ruler().

mpCache

std::unique_ptr<Cache> Ruler::mpCache

mutableprivate

Definition at line 167 of file Ruler.h.

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

mPen

wxPen Ruler::mPen

private

Definition at line 158 of file Ruler.h.

Referenced by Draw(), and Ruler().

mpUpdater

const RulerUpdater* Ruler::mpUpdater {}

private

Definition at line 162 of file Ruler.h.

Referenced by SetUpdater().

mpUserFonts

std::unique_ptr<RulerStruct::Fonts> Ruler::mpUserFonts

private

Definition at line 160 of file Ruler.h.

Referenced by ChooseFonts(), and SetFonts().

mRulerStruct

RulerStruct Ruler::mRulerStruct

private

Definition at line 153 of file Ruler.h.

Referenced by ChooseFonts(), Draw(), DrawGrid(), GetFonts(), Invalidate(), OfflimitsPixels(), SetBounds(), SetDbMirrorValue(), SetFlip(), SetFonts(), SetFormat(), SetLabelEdges(), SetNumberScale(), SetOrientation(), SetRange(), and SetUnits().

mTickColour

wxColour Ruler::mTickColour

private

Definition at line 156 of file Ruler.h.

Referenced by Draw(), and Ruler().

mTickLengths

TickLengths Ruler::mTickLengths

private

Definition at line 154 of file Ruler.h.

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

mTwoTone

bool Ruler::mTwoTone

private

Definition at line 175 of file Ruler.h.

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

mUserBits

RulerUpdater::Bits Ruler::mUserBits

private

Definition at line 164 of file Ruler.h.

Referenced by OfflimitsPixels().

---

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

• Ruler.h
• Ruler.cpp