SpectrumVRulerControls Class Reference

#include <SpectrumVRulerControls.h>

Inheritance diagram for SpectrumVRulerControls:

Collaboration diagram for SpectrumVRulerControls:

Public Member Functions
	SpectrumVRulerControls (const std::shared_ptr< ChannelView > &pChannelView)
	~SpectrumVRulerControls () 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 &evt, 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
	SpectrumVRulerControls (const SpectrumVRulerControls &)=delete
SpectrumVRulerControls &	operator= (const SpectrumVRulerControls &)=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< SpectrumVZoomHandle >	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 SpectrumVRulerControls.h.

Constructor & Destructor Documentation

SpectrumVRulerControls() [1/2]

SpectrumVRulerControls::SpectrumVRulerControls ( const SpectrumVRulerControls &  )

privatedelete

SpectrumVRulerControls() [2/2]

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

inlineexplicit

Definition at line 26 of file SpectrumVRulerControls.h.

      : ChannelVRulerControls{ pChannelView } {}

~SpectrumVRulerControls()

SpectrumVRulerControls::~SpectrumVRulerControls ( )

overridedefault

Member Function Documentation

DoHandleWheelRotation()

unsigned SpectrumVRulerControls::DoHandleWheelRotation ( const TrackPanelMouseEvent &  evt, AudacityProject *  pProject, WaveChannel &  wc  )

static

Definition at line 67 of file SpectrumVRulerControls.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;
   if (event.CmdDown() && !event.ShiftDown()) {
      const int yy = event.m_y;
      SpectrumVZoomHandle::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();
      {
         const float delta = steps * movement / height;
         SpectrogramSettings &settings = SpectrogramSettings::Own(wc);
         const bool isLinear = settings.scaleType == SpectrogramSettings::stLinear;
         float bottom, top;
         SpectrogramBounds::Get(wc).GetBounds(wc, bottom, top);
         const double rate = wc.GetRate();
         const float bound = rate / 2;
         const NumberScale numberScale(settings.GetScale(bottom, top));
         float newTop =
         std::min(bound, numberScale.PositionToValue(1.0f + delta));
         const float newBottom =
         std::max((isLinear ? 0.0f : 1.0f),
                  numberScale.PositionToValue(numberScale.ValueToPosition(newTop) - 1.0f));
         newTop =
         std::min(bound,
                  numberScale.PositionToValue(numberScale.ValueToPosition(newBottom) + 1.0f));
         
         SpectrogramBounds::Get(wc).SetBounds(newBottom, newTop);
      }
   }
   else
      return RefreshNone;
   
   ProjectHistory::Get( *pProject ).ModifyState(true);
   
   return RefreshCell | UpdateVRuler;
}

References SpectrumVZoomHandle::DoZoom(), TrackPanelMouseEvent::event, ProjectHistory::Get(), SpectrogramBounds::Get(), SpectrogramBounds::GetBounds(), WaveChannel::GetRate(), WaveChannelViewConstants::kZoomIn, WaveChannelViewConstants::kZoomOut, min(), ProjectHistory::ModifyState(), SpectrogramSettings::Own(), NumberScale::PositionToValue(), TrackPanelMouseEvent::rect, RefreshCode::RefreshCell, RefreshCode::RefreshNone, SpectrogramBounds::SetBounds(), settings(), TrackPanelMouseEvent::steps, SpectrogramSettings::stLinear, RefreshCode::UpdateVRuler, and NumberScale::ValueToPosition().

Referenced by HandleWheelRotation().

Here is the call graph for this function:

Here is the caller graph for this function:

DoUpdateVRuler()

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

staticprivate

Definition at line 141 of file SpectrumVRulerControls.cpp.

{
   auto vruler = &WaveChannelVRulerControls::ScratchRuler();
   const auto &settings = SpectrogramSettings::Get(wc);
   float minFreq, maxFreq;
   SpectrogramBounds::Get(wc).GetBounds(wc, minFreq, maxFreq);
   vruler->SetDbMirrorValue(0.0);
   
   switch (settings.scaleType) {
      default:
         wxASSERT(false);
      case SpectrogramSettings::stLinear:
      {
         // Spectrum
         
         /*
          draw the ruler
          we will use Hz if maxFreq is < 2000, otherwise we represent kHz,
          and append to the numbers a "k"
          */
         vruler->SetBounds(
            rect.x, rect.y, rect.x + rect.width, rect.y + rect.height - 1);
         vruler->SetOrientation(wxVERTICAL);
         vruler->SetFormat(&RealFormat::LinearInstance());
         vruler->SetLabelEdges(true);
         // use kHz in scale, if appropriate
         if (maxFreq >= 2000) {
            vruler->SetRange((maxFreq / 1000.), (minFreq / 1000.));
            /* i18n-hint k abbreviating kilo meaning thousands */
            vruler->SetUnits(XO("k"));
         }
         else {
            // use Hz
            vruler->SetRange((int)(maxFreq), (int)(minFreq));
            vruler->SetUnits({});
         }
         vruler->SetUpdater(&LinearUpdater::Instance());
      }
         break;
      case SpectrogramSettings::stLogarithmic:
      case SpectrogramSettings::stMel:
      case SpectrogramSettings::stBark:
      case SpectrogramSettings::stErb:
      case SpectrogramSettings::stPeriod:
      {
         // SpectrumLog
         
         /*
          draw the ruler
          we will use Hz if maxFreq is < 2000, otherwise we represent kHz,
          and append to the numbers a "k"
          */
         vruler->SetBounds(
            rect.x, rect.y, rect.x + rect.width, rect.y + rect.height - 1);
         vruler->SetOrientation(wxVERTICAL);
         vruler->SetFormat(&IntFormat::Instance());
         vruler->SetLabelEdges(true);
         vruler->SetRange(maxFreq, minFreq);
         vruler->SetUnits({});
         vruler->SetUpdater(&LogarithmicUpdater::Instance());
         NumberScale scale(settings.GetScale(minFreq, maxFreq).Reversal());
         vruler->SetNumberScale(scale);
      }
         break;
   }
   auto &size = ChannelView::Get(wc).vrulerSize;
   vruler->GetMaxSize(&size.first, &size.second);
}

References ChannelView::Get(), SpectrogramSettings::Get(), SpectrogramBounds::Get(), SpectrogramBounds::GetBounds(), IntFormat::Instance(), LinearUpdater::Instance(), LogarithmicUpdater::Instance(), RealFormat::LinearInstance(), WaveChannelVRulerControls::ScratchRuler(), settings(), size, SpectrogramSettings::stBark, SpectrogramSettings::stErb, SpectrogramSettings::stLinear, SpectrogramSettings::stLogarithmic, SpectrogramSettings::stMel, SpectrogramSettings::stPeriod, 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 SpectrumVRulerControls::Draw ( TrackPanelDrawingContext &  context, const wxRect &  rect, unsigned  iPass  )

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 125 of file SpectrumVRulerControls.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 > SpectrumVRulerControls::FindWaveChannel

(

)

Definition at line 62 of file SpectrumVRulerControls.cpp.

{
   return FindChannel<WaveChannel>();
}

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

Here is the caller graph for this function:

HandleWheelRotation()

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

overridevirtual

Reimplemented from TrackPanelCell.

Definition at line 52 of file SpectrumVRulerControls.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 > SpectrumVRulerControls::HitTest ( const TrackPanelMouseState &  state, const AudacityProject *  pProject  )

overridevirtual

Implements TrackPanelCell.

Definition at line 31 of file SpectrumVRulerControls.cpp.

{
   std::vector<UIHandlePtr> results;
 
   if ( st.state.GetX() <= st.rect.GetRight() - kGuard ) {
      if (const auto pChannel = FindWaveChannel()) {
         auto result = std::make_shared<SpectrumVZoomHandle>(
            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=()

SpectrumVRulerControls & SpectrumVRulerControls::operator= ( const SpectrumVRulerControls &  )

privatedelete

UpdateRuler()

void SpectrumVRulerControls::UpdateRuler ( const wxRect &  rect )

overrideprivatevirtual

Implements ChannelVRulerControls.

Definition at line 133 of file SpectrumVRulerControls.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<SpectrumVZoomHandle> SpectrumVRulerControls::mVZoomHandle

private

Definition at line 54 of file SpectrumVRulerControls.h.

Referenced by HitTest().

---

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

• SpectrumVRulerControls.h
• SpectrumVRulerControls.cpp