RulerUpdater::TickSizes Struct Reference

#include <RulerUpdater.h>

Public Member Functions
	TickSizes (double UPP, int orientation, const RulerFormat *format, bool log)
TranslatableString	LabelString (double d, const RulerFormat *format) const

Public Attributes
RulerFormat::TickType	tickType = RulerFormat::t_major
double	mMajor = 0
double	mMinor = 0
double	mMinorMinor = 0
double	mUnits = 0
int	mDigits

Detailed Description

Definition at line 96 of file RulerUpdater.h.

Constructor & Destructor Documentation

TickSizes()

RulerUpdater::TickSizes::TickSizes	(	double	UPP,
		int	orientation,
		const RulerFormat *	format,
		bool	log
	)

Definition at line 35 of file RulerUpdater.cpp.

   {
      //TODO: better dynamic digit computation for the log case
      (void)log;
 
      // Given the dimensions of the ruler, the range of values it
      // has to display, and the format (i.e. Int, Real, Time),
      // figure out how many units are in one Minor tick, and
      // in one Major tick.
      //
      // The goal is to always put tick marks on nice round numbers
      // that are easy for humans to grok.  This is the most tricky
      // with time.
 
      // As a heuristic, we want at least 22 pixels between each 
      // minor tick.  We want to show numbers like "-48"
      // in that space.
      // If vertical, we don't need as much space.
      mUnits = ((orientation == wxHORIZONTAL) ? 22 : 16) * fabs(UPP);
 
      mDigits = 0;
 
      if (format)
         format->SetTickSizes(mUnits, mMajor, mMinor, mMinorMinor, mDigits);
   }

References anonymous_namespace{ExportPCM.cpp}::format, mDigits, mMajor, mMinor, mMinorMinor, and mUnits.

Member Function Documentation

LabelString()

TranslatableString RulerUpdater::TickSizes::LabelString	(	double	d,
		const RulerFormat *	format
	)		const

Definition at line 62 of file RulerUpdater.cpp.

   {
      // Given a value, turn it into a string according
      // to the current ruler format.  The number of digits of
      // accuracy depends on the resolution of the ruler,
      // i.e. how far zoomed in or out you are.
 
      // Should not be called unless TickSizes is instantiated
      wxASSERT(mUnits > 0);
 
      wxString s;
 
      // PRL Todo: are all these cases properly localized?  (Decimal points,
      // hour-minute-second, etc.?)
 
      if (format)
         format->SetLabelString(s, d, mUnits, mMinor, mDigits, tickType);
 
      auto result = Verbatim(s);
 
      return result;
 }

References anonymous_namespace{ExportPCM.cpp}::format, and Verbatim().

Referenced by GeneratedUpdater::Tick().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mDigits

int RulerUpdater::TickSizes::mDigits

Definition at line 105 of file RulerUpdater.h.

Referenced by TickSizes().

mMajor

double RulerUpdater::TickSizes::mMajor = 0

Definition at line 100 of file RulerUpdater.h.

Referenced by TickSizes().

mMinor

double RulerUpdater::TickSizes::mMinor = 0

Definition at line 101 of file RulerUpdater.h.

Referenced by TickSizes().

mMinorMinor

double RulerUpdater::TickSizes::mMinorMinor = 0

Definition at line 102 of file RulerUpdater.h.

Referenced by TickSizes().

mUnits

double RulerUpdater::TickSizes::mUnits = 0

Definition at line 103 of file RulerUpdater.h.

Referenced by TickSizes().

tickType

RulerFormat::TickType RulerUpdater::TickSizes::tickType = RulerFormat::t_major

Definition at line 98 of file RulerUpdater.h.

---

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

• RulerUpdater.h
• RulerUpdater.cpp