WaveformVRulerControls Class Reference

#include <WaveformVRulerControls.h>

Inheritance diagram for WaveformVRulerControls:

Collaboration diagram for WaveformVRulerControls:

Public Member Functions
	WaveformVRulerControls (const std::shared_ptr< ChannelView > &pChannelView)
	~WaveformVRulerControls () override
std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *) override
unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
std::shared_ptr< WaveChannel >	FindWaveChannel ()
Public Member Functions inherited from ChannelVRulerControls
	ChannelVRulerControls (const std::shared_ptr< ChannelView > &pChannelView)
virtual	~ChannelVRulerControls ()=0
std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject) override
virtual void	UpdateRuler (const wxRect &rect)=0
std::shared_ptr< const ChannelView >	GetChannelView () const
Public Member Functions inherited from CommonChannelCell
	CommonChannelCell (const std::shared_ptr< Channel > &pChannel)
	Construct from a channel. More...
	~CommonChannelCell ()
std::shared_ptr< Track >	DoFindTrack () override
void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel) override
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
template<typename Subtype = Channel>
auto	FindChannel () -> std::shared_ptr< Subtype >
	May return null. More...
template<typename Subtype = const Channel>
auto	FindChannel () const -> std::enable_if_t< std::is_const_v< Subtype >, std::shared_ptr< Subtype > >
	May return null. More...
Public Member Functions inherited from CommonTrackPanelCell
	CommonTrackPanelCell ()
virtual	~CommonTrackPanelCell ()=0
HitTestPreview	DefaultPreview (const TrackPanelMouseState &, const AudacityProject *) override
std::shared_ptr< Track >	FindTrack ()
std::shared_ptr< const Track >	FindTrack () const
virtual std::vector< MenuItem >	GetMenuItems (const wxRect &rect, const wxPoint *pPosition, AudacityProject *pProject)
	Return a list of items for DoContextMenu() (empties for separators) More...
Public Member Functions inherited from TrackPanelCell
	TrackPanelCell ()=default
	TrackPanelCell (const TrackPanelCell &)=delete
TrackPanelCell &	operator= (const TrackPanelCell &)=delete
virtual	~TrackPanelCell ()=0
virtual HitTestPreview	DefaultPreview (const TrackPanelMouseState &state, const AudacityProject *pProject)
virtual std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject)=0
virtual unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject)
virtual std::shared_ptr< TrackPanelCell >	ContextMenuDelegate ()
virtual unsigned	DoContextMenu (const wxRect &rect, wxWindow *pParent, const wxPoint *pPosition, AudacityProject *pProject)
virtual unsigned	CaptureKey (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	KeyDown (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	KeyUp (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	Char (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	LoseFocus (AudacityProject *project)
Public Member Functions inherited from TrackPanelNode
	TrackPanelNode ()
virtual	~TrackPanelNode ()=0
Public Member Functions inherited from TrackPanelDrawable
virtual	~TrackPanelDrawable ()=0
virtual void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass)
virtual wxRect	DrawingArea (TrackPanelDrawingContext &context, const wxRect &rect, const wxRect &panelRect, unsigned iPass)
Public Member Functions inherited from ChannelAttachment
virtual	~ChannelAttachment ()
virtual void	CopyTo (Track &track, size_t iChannel) const
	Copy state, for undo/redo purposes. More...
virtual void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel)
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
virtual void	WriteXMLAttributes (XMLWriter &writer, size_t iChannel) const
	Serialize persistent attributes. More...
virtual bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView, size_t iChannel)
	Deserialize an attribute, returning true if recognized. More...

Static Public Member Functions
static unsigned	DoHandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject, WaveChannel &wc)
Static Public Member Functions inherited from ChannelVRulerControls
static ChannelVRulerControls &	Get (ChannelView &)
static const ChannelVRulerControls &	Get (const ChannelView &)
static void	DrawZooming (TrackPanelDrawingContext &context, const wxRect &rect, int zoomStart, int zoomEnd)
static wxRect	ZoomingArea (const wxRect &rect, const wxRect &panelRect)
Static Public Member Functions inherited from TrackPanelDrawable
static wxRect	MaximizeWidth (const wxRect &rect, const wxRect &panelRect)
static wxRect	MaximizeHeight (const wxRect &rect, const wxRect &panelRect)

Private Member Functions
	WaveformVRulerControls (const WaveformVRulerControls &)=delete
WaveformVRulerControls &	operator= (const WaveformVRulerControls &)=delete
void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override
void	UpdateRuler (const wxRect &rect) override

Static Private Member Functions
static void	DoUpdateVRuler (const wxRect &rect, const WaveChannel &wc)

Private Attributes
std::weak_ptr< WaveformVZoomHandle >	mVZoomHandle

Additional Inherited Members
Protected Member Functions inherited from ChannelVRulerControls
std::shared_ptr< Track >	DoFindTrack () override
void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override
wxRect	DrawingArea (TrackPanelDrawingContext &, const wxRect &rect, const wxRect &panelRect, unsigned iPass) override
Track *	GetTrack () const
Protected Member Functions inherited from CommonTrackPanelCell
virtual std::shared_ptr< Track >	DoFindTrack ()=0
unsigned	DoContextMenu (const wxRect &rect, wxWindow *pParent, const wxPoint *pPosition, AudacityProject *pProject) override
unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
Protected Attributes inherited from ChannelVRulerControls
std::weak_ptr< ChannelView >	mwChannelView

Detailed Description

Definition at line 19 of file WaveformVRulerControls.h.

Constructor & Destructor Documentation

WaveformVRulerControls() [1/2]

WaveformVRulerControls::WaveformVRulerControls ( const WaveformVRulerControls &  )

privatedelete

WaveformVRulerControls() [2/2]

WaveformVRulerControls::WaveformVRulerControls ( const std::shared_ptr< ChannelView > &  pChannelView )

inlineexplicit

Definition at line 26 of file WaveformVRulerControls.h.

      : ChannelVRulerControls{ pChannelView } {}

~WaveformVRulerControls()

WaveformVRulerControls::~WaveformVRulerControls ( )

overridedefault

Member Function Documentation

DoHandleWheelRotation()

unsigned WaveformVRulerControls::DoHandleWheelRotation ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject, WaveChannel &  wc  )

static

Definition at line 138 of file WaveformVRulerControls.cpp.

{
   using namespace RefreshCode;
   const wxMouseEvent &event = evt.event;
 
   if (!(event.ShiftDown() || event.CmdDown()))
      return RefreshNone;
 
   // Always stop propagation even if the ruler didn't change.  The ruler
   // is a narrow enough target.
   evt.event.Skip(false);
 
   auto steps = evt.steps;
 
   using namespace WaveChannelViewConstants;
   auto &settings = WaveformSettings::Get(wc);
   auto &cache = WaveformScale::Get(wc);
   const bool isDB = !settings.isLinear();
   // Special cases for Waveform (logarithmic) dB only.
   // Set the bottom of the dB scale but only if it's visible
   if (isDB && event.ShiftDown() && event.CmdDown()) {
      float min, max;
      cache.GetDisplayBounds(min, max);
      if (!(min < 0.0 && max > 0.0))
         return RefreshNone;
 
      float olddBRange = settings.dBRange;
      if (steps < 0)
         // Zoom out
         settings.NextLowerDBRange();
      else
         settings.NextHigherDBRange();
 
      float newdBRange = settings.dBRange;
 
      // Is y coordinate within the rectangle half-height centered about
      // the zero level?
      const auto &rect = evt.rect;
      const auto zeroLevel = cache.ZeroLevelYCoordinate(rect);
      const bool fixedMagnification =
      (4 * std::abs(event.GetY() - zeroLevel) < rect.GetHeight());
 
      if (fixedMagnification) {
         // Vary the db limit without changing
         // magnification; that is, peaks and troughs move up and down
         // rigidly, as parts of the wave near zero are exposed or hidden.
         const float extreme = (LINEAR_TO_DB(2) + newdBRange) / newdBRange;
         max = std::min(extreme, max * olddBRange / newdBRange);
         min = std::max(-extreme, min * olddBRange / newdBRange);
         SetLastdBRange(cache, wc);
         cache.SetDisplayBounds(min, max);
      }
   }
   else if (event.CmdDown() && !event.ShiftDown()) {
      const int yy = event.m_y;
      WaveformVZoomHandle::DoZoom(
         pProject, wc,
         (steps < 0)
            ? kZoomOut
            : kZoomIn,
         evt.rect, yy, yy, true);
   }
   else if (!event.CmdDown() && event.ShiftDown()) {
      // Scroll some fixed number of pixels, independent of zoom level or track height:
      static const float movement = 10.0f;
      const int height = evt.rect.GetHeight();
      {
         float topLimit = 2.0;
         if (isDB) {
            const float dBRange = settings.dBRange;
            topLimit = (LINEAR_TO_DB(topLimit) + dBRange) / dBRange;
         }
         const float bottomLimit = -topLimit;
         float top, bottom;
         cache.GetDisplayBounds(bottom, top);
         const float range = top - bottom;
         const float delta = range * steps * movement / height;
         float newTop = std::min(topLimit, top + delta);
         const float newBottom = std::max(bottomLimit, newTop - range);
         newTop = std::min(topLimit, newBottom + range);
         cache.SetDisplayBounds(newBottom, newTop);
      }
   }
   else
      return RefreshNone;
 
   ProjectHistory::Get( *pProject ).ModifyState(true);
 
   return RefreshCell | UpdateVRuler;
}

References WaveformVZoomHandle::DoZoom(), TrackPanelMouseEvent::event, ProjectHistory::Get(), WaveformSettings::Get(), WaveformScale::Get(), WaveChannelViewConstants::kZoomIn, WaveChannelViewConstants::kZoomOut, LINEAR_TO_DB, min(), ProjectHistory::ModifyState(), TrackPanelMouseEvent::rect, RefreshCode::RefreshCell, RefreshCode::RefreshNone, anonymous_namespace{WaveformVRulerControls.cpp}::SetLastdBRange(), settings(), TrackPanelMouseEvent::steps, and RefreshCode::UpdateVRuler.

Referenced by HandleWheelRotation().

Here is the call graph for this function:

Here is the caller graph for this function:

DoUpdateVRuler()

void WaveformVRulerControls::DoUpdateVRuler ( const wxRect &  rect, const WaveChannel &  wc  )

staticprivate

Definition at line 248 of file WaveformVRulerControls.cpp.

{
   auto vruler = &WaveChannelVRulerControls::ScratchRuler();
 
   // All waves have a ruler in the info panel
   // The ruler needs a bevelled surround.
   auto &settings = WaveformSettings::Get(wc);
   const float dBRange = settings.dBRange;
 
   float min, max;
   auto &cache = WaveformScale::Get(wc);
   cache.GetDisplayBounds(min, max);
   const float lastdBRange = cache.GetLastDBRange();
   if (dBRange != lastdBRange)
      SetLastdBRange(cache, wc);
 
   auto scaleType = settings.scaleType;
   
   if (settings.isLinear()) {
      // Waveform
      
      if (cache.GetLastScaleType() != WaveformSettings::stLinearAmp &&
          cache.GetLastScaleType() != WaveformSettings::stLinearDb &&
          cache.GetLastScaleType() != -1)
      {
         // do a translation into the linear space
         SetLastScaleType(cache, wc);
         SetLastdBRange(cache, wc);
         float sign = (min >= 0 ? 1 : -1);
         if (min != 0.) {
            min = DB_TO_LINEAR(fabs(min) * dBRange - dBRange);
            if (min < 0.0)
               min = 0.0;
            min *= sign;
         }
         sign = (max >= 0 ? 1 : -1);
         
         if (max != 0.) {
            max = DB_TO_LINEAR(fabs(max) * dBRange - dBRange);
            if (max < 0.0)
               max = 0.0;
            max *= sign;
         }
         cache.SetDisplayBounds(min, max);
      }
      
      vruler->SetDbMirrorValue(0.0);
      vruler->SetBounds(
         rect.x, rect.y, rect.x + rect.width, rect.y + rect.height - 1);
      vruler->SetOrientation(wxVERTICAL);
      vruler->SetRange(max, min);
      vruler->SetFormat(&RealFormat::LinearInstance());
      if (scaleType == WaveformSettings::stLinearAmp) {
         vruler->SetLabelEdges(false);
         vruler->SetUnits({});
         vruler->SetUpdater(&LinearUpdater::Instance());
      }
      else {
         RegenerateLinearDBValues(dBRange, min, max, rect.GetHeight());
         vruler->SetLabelEdges(true);
         vruler->SetUnits(XO("dB"));
         vruler->SetUpdater(&updater);
         RulerUpdater::Labels major, minor, minorMinor;
         std::vector<LinearDBValues> values =
            { majorValues, minorValues, minorMinorValues };
         for (int ii = 0; ii < 3; ii++) {
            RulerUpdater::Labels labs;
            int size = (ii == 0) ? majorValues.size() :
               (ii == 1) ? minorValues.size() : minorMinorValues.size();
            for (int i = 0; i < size; i++) {
               double value = (ii == 0) ? majorValues[i] :
                  (ii == 1) ? minorValues[i] : minorMinorValues[i];
               RulerUpdater::Label lab;
 
               if (value == -dBRange)
                  lab.value = 0;
               else {
                  float sign = (value > -dBRange ? 1 : -1);
                  if (value < -dBRange)
                     value = -2 * dBRange - value;
                  lab.value = DB_TO_LINEAR(value) * sign;
               }
 
               wxString s = (value == -dBRange) ?
                  wxString(L"-\u221e") : wxString::FromDouble(value);
               // \u221e represents the infinity symbol
               // Should this just be -dBRange so it is consistent?
               //wxString s = wxString::FromDouble(value);
               lab.text = Verbatim(s);
 
               labs.push_back(lab);
            }
            if (ii == 0)
               major = labs;
            else if (ii == 1)
               minor = labs;
            else
               minorMinor = labs;
         }
         updater.SetData(major, minor, minorMinor);
      }
   }
   else {
      vruler->SetUnits(XO("dB"));
      if (cache.GetLastScaleType() != WaveformSettings::stLogarithmicDb &&
         // When Logarithmic Amp happens, put that here
          cache.GetLastScaleType() != -1)
      {
         // do a translation into the dB space
         SetLastScaleType(cache, wc);
         SetLastdBRange(cache, wc);
         float sign = (min >= 0 ? 1 : -1);
         if (min != 0.) {
            min = (LINEAR_TO_DB(fabs(min)) + dBRange) / dBRange;
            if (min < 0.0)
               min = 0.0;
            min *= sign;
         }
         sign = (max >= 0 ? 1 : -1);
         
         if (max != 0.) {
            max = (LINEAR_TO_DB(fabs(max)) + dBRange) / dBRange;
            if (max < 0.0)
               max = 0.0;
            max *= sign;
         }
         cache.SetDisplayBounds(min, max);
      }
      else if (dBRange != lastdBRange) {
         SetLastdBRange(cache, wc);
         // Remap the max of the scale
         float newMax = max;
         
         // This commented out code is problematic.
         // min and max may be correct, and this code cause them to change.
#ifdef ONLY_LABEL_POSITIVE
         const float sign = (max >= 0 ? 1 : -1);
         if (max != 0.) {
            
            // Ugh, duplicating from TrackPanel.cpp
#define ZOOMLIMIT 0.001f
            
            const float extreme = LINEAR_TO_DB(2);
            // recover dB value of max
            const float dB = std::min(
               extreme, (float(fabs(max)) * lastdBRange - lastdBRange));
            // find NEW scale position, but old max may get trimmed if the db limit rises
            // Don't trim it to zero though, but leave max and limit distinct
            newMax = sign * std::max(ZOOMLIMIT, (dBRange + dB) / dBRange);
            // Adjust the min of the scale if we can,
            // so the db Limit remains where it was on screen, but don't violate extremes
            if (min != 0.)
               min = std::max(-extreme, newMax * min / max);
         }
#endif
         cache.SetDisplayBounds(min, newMax);
      }
      
      // Old code was if ONLY_LABEL_POSITIVE were defined.
      // it uses the +1 to 0 range only.
      // the enabled code uses +1 to -1, and relies on set ticks labelling knowing about
      // the dB scale.
#ifdef ONLY_LABEL_POSITIVE
      if (max > 0) {
#endif
         int top = 0;
         float topval = 0;
         int bot = rect.height;
         float botval = -dBRange;
         
#ifdef ONLY_LABEL_POSITIVE
         if (min < 0) {
            bot = top + (int)((max / (max - min))*(bot - top));
            min = 0;
         }
         
         if (max > 1) {
            top += (int)((max - 1) / (max - min) * (bot - top));
            max = 1;
         }
         
         if (max < 1 && max > 0)
            topval = -((1 - max) * dBRange);
         
         if (min > 0) {
            botval = -((1 - min) * dBRange);
         }
#else
         topval = -((1 - max) * dBRange);
         botval = -((1 - min) * dBRange);
         vruler->SetDbMirrorValue( dBRange );
#endif
         vruler->SetBounds(rect.x, rect.y + top, rect.x + rect.width, rect.y + bot - 1);
         vruler->SetOrientation(wxVERTICAL);
         vruler->SetRange(topval, botval);
#ifdef ONLY_LABEL_POSITIVE
      }
      else
         vruler->SetBounds(0.0, 0.0, 0.0, 0.0); // A.C.H I couldn't find a way to just disable it?
#endif
      vruler->SetFormat(&RealFormat::LogInstance());
      vruler->SetLabelEdges(true);
      vruler->SetUpdater(&LinearUpdater::Instance());
   }
   auto &size = ChannelView::Get(wc).vrulerSize;
   vruler->GetMaxSize(&size.first, &size.second);
}

References DB_TO_LINEAR, ChannelView::Get(), WaveformSettings::Get(), WaveformScale::Get(), LinearUpdater::Instance(), LINEAR_TO_DB, RealFormat::LinearInstance(), RealFormat::LogInstance(), majorValues, min(), minorMinorValues, minorValues, RegenerateLinearDBValues(), WaveChannelVRulerControls::ScratchRuler(), CustomUpdater::SetData(), anonymous_namespace{WaveformVRulerControls.cpp}::SetLastdBRange(), anonymous_namespace{WaveformVRulerControls.cpp}::SetLastScaleType(), settings(), size, WaveformSettings::stLinearAmp, WaveformSettings::stLinearDb, WaveformSettings::stLogarithmicDb, RulerUpdater::Label::text, updater, RulerUpdater::Label::value, values, Verbatim(), ChannelView::vrulerSize, and XO().

Referenced by UpdateRuler().

Here is the call graph for this function:

Here is the caller graph for this function:

Draw()

void WaveformVRulerControls::Draw ( TrackPanelDrawingContext &  context, const wxRect &  rect, unsigned  iPass  )

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 230 of file WaveformVRulerControls.cpp.

{
   ChannelVRulerControls::Draw(context, rect_, iPass);
   WaveChannelVRulerControls::DoDraw(*this, context, rect_, iPass);
}

References WaveChannelVRulerControls::DoDraw(), and ChannelVRulerControls::Draw().

Here is the call graph for this function:

FindWaveChannel()

std::shared_ptr< WaveChannel > WaveformVRulerControls::FindWaveChannel

(

)

Definition at line 109 of file WaveformVRulerControls.cpp.

{
   return FindChannel<WaveChannel>();
}

Referenced by HandleWheelRotation(), HitTest(), and UpdateRuler().

Here is the caller graph for this function:

HandleWheelRotation()

unsigned WaveformVRulerControls::HandleWheelRotation ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject  )

overridevirtual

Reimplemented from TrackPanelCell.

Definition at line 114 of file WaveformVRulerControls.cpp.

{
   using namespace RefreshCode;
   const auto pChannel = FindWaveChannel();
   if (!pChannel)
      return RefreshNone;
   return DoHandleWheelRotation(evt, pProject, *pChannel);
}

References DoHandleWheelRotation(), FindWaveChannel(), and RefreshCode::RefreshNone.

Here is the call graph for this function:

HitTest()

std::vector< UIHandlePtr > WaveformVRulerControls::HitTest ( const TrackPanelMouseState &  state, const AudacityProject *  pProject  )

overridevirtual

Implements TrackPanelCell.

Definition at line 88 of file WaveformVRulerControls.cpp.

{
   std::vector<UIHandlePtr> results;
 
   if ( st.state.GetX() <= st.rect.GetRight() - kGuard ) {
      if (const auto pChannel = FindWaveChannel()) {
         auto result = std::make_shared<WaveformVZoomHandle>(
            pChannel, st.rect, st.state.m_y );
         result = AssignUIHandlePtr(mVZoomHandle, result);
         results.push_back(result);
      }
   }
 
   auto more = ChannelVRulerControls::HitTest(st, pProject);
   std::copy(more.begin(), more.end(), std::back_inserter(results));
 
   return results;
}

References AssignUIHandlePtr(), staffpad::vo::copy(), FindWaveChannel(), ChannelVRulerControls::HitTest(), kGuard, mVZoomHandle, TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Here is the call graph for this function:

operator=()

WaveformVRulerControls & WaveformVRulerControls::operator= ( const WaveformVRulerControls &  )

privatedelete

UpdateRuler()

void WaveformVRulerControls::UpdateRuler ( const wxRect &  rect )

overrideprivatevirtual

Implements ChannelVRulerControls.

Definition at line 238 of file WaveformVRulerControls.cpp.

{
   const auto pChannel = FindWaveChannel();
   if (!pChannel)
      return;
   DoUpdateVRuler(rect, *pChannel);
}

References DoUpdateVRuler(), and FindWaveChannel().

Here is the call graph for this function:

Member Data Documentation

mVZoomHandle

std::weak_ptr<WaveformVZoomHandle> WaveformVRulerControls::mVZoomHandle

private

Definition at line 54 of file WaveformVRulerControls.h.

Referenced by HitTest().

---

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

• WaveformVRulerControls.h
• WaveformVRulerControls.cpp