#include <CustomUpdaterValue.h>

Inheritance diagram for CustomUpdaterValue:

Collaboration diagram for CustomUpdaterValue:

Public Member Functions
	CustomUpdaterValue ()=default

	~CustomUpdaterValue () override

Public Member Functions inherited from CustomUpdater
	~CustomUpdater () override

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

void	SetData (RulerUpdater::Labels majorLabels, RulerUpdater::Labels minorLabels, RulerUpdater::Labels minorMinorLabels)

	RulerUpdater ()

Public Member Functions inherited from RulerUpdater
	RulerUpdater ()

virtual	~RulerUpdater ()=0

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

Static Public Member Functions
static const CustomUpdaterValue &	Instance ()

Protected Member Functions
bool	TickCustom (wxDC &dc, int labelIdx, wxFont font, TickOutputs outputs, const RulerStruct &context) const override

virtual bool	TickCustom (wxDC &dc, int labelIdx, wxFont font, TickOutputs outputs, const RulerStruct &context) const =0

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

Additional Inherited Members
Public Types inherited from RulerUpdater
using	Labels = std::vector< Label >

using	Bits = std::vector< bool >

Static Protected Member Functions inherited from RulerUpdater
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)

Protected Attributes inherited from CustomUpdater
RulerUpdater::Labels	mMajorLabels

RulerUpdater::Labels	mMinorLabels

RulerUpdater::Labels	mMinorMinorLabels

Detailed Description

Definition at line 17 of file CustomUpdaterValue.h.

Constructor & Destructor Documentation

◆ CustomUpdaterValue()

CustomUpdaterValue::CustomUpdaterValue ( )

default

◆ ~CustomUpdaterValue()

CustomUpdaterValue::~CustomUpdaterValue ( )

overridedefault

Member Function Documentation

◆ Instance()

const CustomUpdaterValue & CustomUpdaterValue::Instance ( )

static

Definition at line 15 of file CustomUpdaterValue.cpp.

{
   static CustomUpdaterValue instance;
   return instance;
}

◆ TickCustom()

bool CustomUpdaterValue::TickCustom	(	wxDC &	dc,
		int	labelIdx,
		wxFont	font,
		TickOutputs	outputs,
		const RulerStruct &	context
	)		const

overrideprotectedvirtual

Implements CustomUpdater.

Definition at line 21 of file CustomUpdaterValue.cpp.

{
   const double mMin = context.mMin;
   const double mMax = context.mMax;
 
   const int mLeft = context.mLeft;
   const int mTop = context.mTop;
   const int mRight = context.mRight;
   const int mBottom = context.mBottom;
   const int mLength = context.mLength;
   const int mOrientation = context.mOrientation;
 
   const RulerStruct::Fonts& mFonts = *context.mpFonts;
   constexpr int spacing = 2;
   const bool mFlip = context.mFlip;
   const TranslatableString mUnits = context.mUnits;
   const bool mLabelEdges = context.mLabelEdges;
 
   auto TickAtValue =
      [this, &dc, &mFonts, mOrientation, mLabelEdges,
      mMin, mMax, mLength, mRight, mBottom, &context]
   (double value, double *pos) -> bool {
      // Make a tick only if the value is strictly between the bounds
      double min = std::min(mMin, mMax);
      double max = std::max(mMin, mMax);
      if ((value <= min && !mLabelEdges) || value < min)
         return false;
      if ((value >= max && !mLabelEdges) || value > max)
         return false;
 
      int mid = (int)(mLength * ((mMin - value) / (mMin - mMax)) + 0.5);
 
      const int iMaxPos = (mOrientation == wxHORIZONTAL) ? mRight : mBottom - 5;
      if (mid >= 0 && mid < iMaxPos) {
         *pos = mid;
         return true;
      }
      return false;
   };
 
   // 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;
 
   // Get the correct position based on value.
   // Don't draw if the value is out of bounds.
   double pos;
   if (!TickAtValue(outputs.labels[labelIdx].value, &pos))
      return false;
 
   Label lab;
   lab.value = 0.0;
   lab.pos = pos;
   // Custom is flexible with text format
   // We can assume they use the right format, but still append the right units.
   lab.text = outputs.labels[labelIdx].text;
   lab.units = mUnits;
 
   auto result = MakeTick(
      lab,
      dc, font,
      outputs.bits,
      mLeft, mTop, spacing, mFonts.lead,
      mFlip,
      mOrientation);
 
   if (!result.second.text)
      // Always a non-empty optional
      result.second.text = { TranslatableString{} };
 
   auto& rect = result.first;
   outputs.box.Union(rect);
   outputs.labels[labelIdx] = (result.second);
   return !rect.IsEmpty();
}

References RulerUpdater::TickOutputs::bits, RulerUpdater::TickOutputs::box, RulerUpdater::TickOutputs::labels, RulerStruct::Fonts::lead, RulerUpdater::MakeTick(), RulerStruct::mBottom, RulerStruct::mFlip, min(), RulerStruct::mLabelEdges, RulerStruct::mLeft, RulerStruct::mLength, RulerStruct::mMax, RulerStruct::mMin, RulerStruct::mOrientation, RulerStruct::mpFonts, RulerStruct::mRight, RulerStruct::mTop, RulerStruct::mUnits, RulerUpdater::Label::pos, RulerUpdater::Label::text, RulerUpdater::Label::units, and RulerUpdater::Label::value.

Here is the call graph for this function:

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

Public Member Functions

Static Public Member Functions

Protected Member Functions