RulerUpdater Class Reference

Used to update a Ruler. More...

#include <RulerUpdater.h>

Inheritance diagram for RulerUpdater:

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

Public Types
using	Labels = std::vector< Label >
using	Bits = std::vector< bool >

Public Member Functions
	RulerUpdater ()
virtual	~RulerUpdater ()=0
virtual void	Update (wxDC &dc, const Envelope *envelope, UpdateOutputs &allOutputs, const RulerStruct &context) const =0

Protected Member Functions
void	BoxAdjust (UpdateOutputs &allOutputs, const RulerStruct &context) const

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

Detailed Description

Used to update a Ruler.

This is a pure virtual class which sets how a ruler will generate its values.

Definition at line 58 of file RulerUpdater.h.

Member Typedef Documentation

Bits

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

Definition at line 76 of file RulerUpdater.h.

Labels

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

Definition at line 74 of file RulerUpdater.h.

Constructor & Destructor Documentation

RulerUpdater()

RulerUpdater::RulerUpdater ( )

inline

Definition at line 84 of file RulerUpdater.h.

{}

~RulerUpdater()

RulerUpdater::~RulerUpdater ( )

pure virtualdefault

Member Function Documentation

BoxAdjust()

void RulerUpdater::BoxAdjust ( UpdateOutputs &  allOutputs, const RulerStruct &  context  ) const

protected

Definition at line 209 of file RulerUpdater.cpp.

{
   const int mLeft = context.mLeft;
   const int mTop = context.mTop;
   const int mBottom = context.mBottom;
   const int mRight = context.mRight;
   const int mOrientation = context.mOrientation;
   const bool mFlip = context.mFlip;
 
   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 RulerUpdater::UpdateOutputs::box, label, RulerUpdater::UpdateOutputs::majorLabels, RulerStruct::mBottom, RulerStruct::mFlip, RulerUpdater::UpdateOutputs::minorLabels, RulerUpdater::UpdateOutputs::minorMinorLabels, RulerStruct::mLeft, RulerStruct::mOrientation, RulerStruct::mRight, and RulerStruct::mTop.

Referenced by CustomUpdater::Update(), LinearUpdater::Update(), and LogarithmicUpdater::Update().

Here is the caller graph for this function:

MakeTick()

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

staticprotected

Definition at line 111 of file RulerUpdater.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 strText = lab.text;
   auto strUnits = lab.units;
   auto str = (strText ? *strText : TranslatableString{}) + strUnits;
   // Do not put the text into results until we are sure it does not overlap
   lab.text = {};
   lab.units = {};
   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 = strText;
   lab.units = strUnits;
   return { { strLeft, strTop, strW, strH }, lab };
}

References anonymous_namespace{LowlitClipButton.cpp}::leftMargin, and str.

Referenced by GeneratedUpdater::Tick(), CustomUpdaterPosition::TickCustom(), and CustomUpdaterValue::TickCustom().

Here is the caller graph for this function:

Update()

virtual void RulerUpdater::Update ( wxDC &  dc, const Envelope *  envelope, UpdateOutputs &  allOutputs, const RulerStruct &  context  ) const

pure virtual

Implemented in CustomUpdater, LinearUpdater, and LogarithmicUpdater.

---

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

• RulerUpdater.h
• RulerUpdater.cpp