SpectrumVZoomHandle Class Reference

#include <SpectrumVZoomHandle.h>

Inheritance diagram for SpectrumVZoomHandle:

Collaboration diagram for SpectrumVZoomHandle:

Public Member Functions
	SpectrumVZoomHandle (const std::shared_ptr< WaveChannel > &pChannel, const wxRect &rect, int y)
SpectrumVZoomHandle &	operator= (const SpectrumVZoomHandle &)=default
	~SpectrumVZoomHandle () override
std::shared_ptr< const Track >	FindTrack () const override
std::shared_ptr< WaveChannel >	FindWaveChannel ()
void	Enter (bool forward, AudacityProject *) override
bool	HandlesRightClick () override
	Whether the handle has any special right-button handling. More...
Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject) override
Result	Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent) override
Result	Cancel (AudacityProject *pProject) override
Public Member Functions inherited from UIHandle
virtual	~UIHandle ()=0
virtual void	Enter (bool forward, AudacityProject *pProject)
virtual bool	HasRotation () const
virtual bool	Rotate (bool forward)
virtual bool	HasEscape (AudacityProject *pProject) const
virtual bool	Escape (AudacityProject *pProject)
virtual bool	HandlesRightClick ()
	Whether the handle has any special right-button handling. More...
virtual Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0
virtual Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0
virtual HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject)=0
virtual Result	Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent)=0
virtual Result	Cancel (AudacityProject *pProject)=0
virtual bool	StopsOnKeystroke ()
virtual void	OnProjectChange (AudacityProject *pProject)
virtual std::shared_ptr< const Track >	FindTrack () const =0
virtual bool	IsDragging () const
Result	GetChangeHighlight () const
void	SetChangeHighlight (Result val)
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)

Static Public Member Functions
static void	DoZoom (AudacityProject *pProject, WaveChannel &wc, WaveChannelViewConstants::ZoomActions ZoomKind, const wxRect &rect, int zoomStart, int zoomEnd, bool fixedMousePoint)
Static Public Member Functions inherited from UIHandle
static UIHandle::Result	NeedChangeHighlight (const UIHandle &, const UIHandle &)
static std::shared_ptr< const Track >	TrackFromChannel (const std::shared_ptr< const Channel > &pChannel)
	A frequent convenience in the definition of UIHandles. More...
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
	SpectrumVZoomHandle (const SpectrumVZoomHandle &)
void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override
wxRect	DrawingArea (TrackPanelDrawingContext &, const wxRect &rect, const wxRect &panelRect, unsigned iPass) override

Private Attributes
std::weak_ptr< WaveChannel >	mpChannel
int	mZoomStart {}
int	mZoomEnd {}
wxRect	mRect {}

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned
using	Cell = TrackPanelCell
Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 20 of file SpectrumVZoomHandle.h.

Constructor & Destructor Documentation

SpectrumVZoomHandle() [1/2]

SpectrumVZoomHandle::SpectrumVZoomHandle ( const SpectrumVZoomHandle &  )

private

SpectrumVZoomHandle() [2/2]

SpectrumVZoomHandle::SpectrumVZoomHandle	(	const std::shared_ptr< WaveChannel > &	pChannel,
		const wxRect &	rect,
		int	y
	)

Definition at line 25 of file SpectrumVZoomHandle.cpp.

   : mpChannel{ pChannel }, mZoomStart(y), mZoomEnd(y), mRect(rect)
{
}

~SpectrumVZoomHandle()

SpectrumVZoomHandle::~SpectrumVZoomHandle ( )

overridedefault

Member Function Documentation

Cancel()

UIHandle::Result SpectrumVZoomHandle::Cancel ( AudacityProject *  pProject )

overridevirtual

Implements UIHandle.

Definition at line 89 of file SpectrumVZoomHandle.cpp.

{
   // Cancel is implemented!  And there is no initial state to restore,
   // so just return a code.
   return RefreshCode::RefreshAll;
}

References RefreshCode::RefreshAll.

Click()

UIHandle::Result SpectrumVZoomHandle::Click ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject  )

overridevirtual

Implements UIHandle.

Definition at line 55 of file SpectrumVZoomHandle.cpp.

{
   return RefreshCode::RefreshNone;
}

References RefreshCode::RefreshNone.

DoZoom()

void SpectrumVZoomHandle::DoZoom ( AudacityProject *  pProject, WaveChannel &  wc, WaveChannelViewConstants::ZoomActions  ZoomKind, const wxRect &  rect, int  zoomStart, int  zoomEnd, bool  fixedMousePoint  )

static

Definition at line 117 of file SpectrumVZoomHandle.cpp.

{
   using namespace WaveChannelViewConstants;
   static const float ZOOMLIMIT = 0.001f;
 
   int height = rect.height;
   int ypos = rect.y;
 
   // Ensure start and end are in order (swap if not).
   if (zoomEnd < zoomStart)
      std::swap( zoomStart, zoomEnd );
 
   float min, max, minBand = 0;
   const double rate = wc.GetRate();
   const float halfrate = rate / 2;
   float maxFreq = 8000.0;
   const auto &specSettings = SpectrogramSettings::Get(wc);
   NumberScale scale;
   const bool spectrumLinear =
      (specSettings.scaleType == SpectrogramSettings::stLinear);
   auto &bounds = SpectrogramBounds::Get(wc);
 
   bool bDragZoom = WaveChannelVZoomHandle::IsDragZooming(zoomStart, zoomEnd, true);
   // Add 100 if spectral to separate the kinds of zoom.
   const int kSpectral = 100;
 
   // Possibly override the zoom kind.
   if( bDragZoom )
      ZoomKind = kZoomInByDrag;
 
   float top=2.0;
   float half=0.5;
 
   {
      bounds.GetBounds(wc, min, max);
      scale = (specSettings.GetScale(min, max));
      const auto fftLength = specSettings.GetFFTLength();
      const float binSize = rate / fftLength;
      maxFreq = SpectrumMaxFreq.Read();
      // JKC:  Following discussions of Bug 1208 I'm allowing zooming in
      // down to one bin.
      //      const int minBins =
      //         std::min(10, fftLength / 2); //minimum 10 freq bins, unless there are less
      const int minBins = 1;
      minBand = minBins * binSize;
   }
 
   // Compute min and max.
   switch(ZoomKind)
   {
   default:
      // If we have covered all the cases, this won't happen.
      // In release builds Audacity will ignore the zoom.
      wxFAIL_MSG("Zooming Case not implemented by Audacity");
      break;
 
   // VZooming on spectral we don't implement the other zoom presets.
   // They are also not in the menu.
   case kZoomReset:
      {
         // Zoom out to normal level.
         min = spectrumLinear ? 0.0f : 1.0f;
         max = maxFreq;
      }
      break;
   case kZoom1to1:
   case kZoomHalfWave:
      {
         // Zoom out full
         min = spectrumLinear ? 0.0f : 1.0f;
         max = halfrate;
      }
      break;
   case kZoomInByDrag:
      {
         double xmin = 1 - (zoomEnd - ypos) / (float)height;
         double xmax = 1 - (zoomStart - ypos) / (float)height;
         const float middle = (xmin + xmax) / 2;
         const float middleValue = scale.PositionToValue(middle);
 
         min = std::max(spectrumLinear ? 0.0f : 1.0f,
            std::min(middleValue - minBand / 2,
            scale.PositionToValue(xmin)
            ));
         max = std::min(halfrate,
            std::max(middleValue + minBand / 2,
            scale.PositionToValue(xmax)
            ));
      }
      break;
   case kZoomIn:
      {
         // Center the zoom-in at the click
         const float p1 = (zoomStart - ypos) / (float)height;
         const float middle = 1.0f - p1;
         const float middleValue = scale.PositionToValue(middle);
 
         if (fixedMousePoint) {
            min = std::max(spectrumLinear ? 0.0f : 1.0f,
               std::min(middleValue - minBand * middle,
               scale.PositionToValue(0.5f * middle)
            ));
            max = std::min(halfrate,
               std::max(middleValue + minBand * p1,
               scale.PositionToValue(middle + 0.5f * p1)
            ));
         }
         else {
            min = std::max(spectrumLinear ? 0.0f : 1.0f,
               std::min(middleValue - minBand / 2,
               scale.PositionToValue(middle - 0.25f)
            ));
            max = std::min(halfrate,
               std::max(middleValue + minBand / 2,
               scale.PositionToValue(middle + 0.25f)
            ));
         }
      }
      break;
   case kZoomOut:
      {
         // Zoom out
         const float p1 = (zoomStart - ypos) / (float)height;
         // (Used to zoom out centered at midline, ignoring the click, if linear view.
         //  I think it is better to be consistent.  PRL)
         // Center zoom-out at the midline
         const float middle = // spectrumLinear ? 0.5f :
            1.0f - p1;
 
         if (fixedMousePoint) {
            min = std::max(spectrumLinear ? 0.0f : 1.0f, scale.PositionToValue(-middle));
            max = std::min(halfrate, scale.PositionToValue(1.0f + p1));
         }
         else {
            min = std::max(spectrumLinear ? 0.0f : 1.0f, scale.PositionToValue(middle - 1.0f));
            max = std::min(halfrate, scale.PositionToValue(middle + 1.0f));
         }
      }
      break;
   }
 
   // Now actually apply the zoom.
   bounds.SetBounds(min, max);
 
   zoomEnd = zoomStart = 0;
   if( pProject )
      ProjectHistory::Get( *pProject ).ModifyState(true);
}

References ProjectHistory::Get(), SpectrogramSettings::Get(), SpectrogramBounds::Get(), WaveChannel::GetRate(), WaveChannelVZoomHandle::IsDragZooming(), WaveChannelViewConstants::kZoom1to1, WaveChannelViewConstants::kZoomHalfWave, WaveChannelViewConstants::kZoomIn, WaveChannelViewConstants::kZoomInByDrag, WaveChannelViewConstants::kZoomOut, WaveChannelViewConstants::kZoomReset, min(), ProjectHistory::ModifyState(), NumberScale::PositionToValue(), Setting< T >::Read(), SpectrumMaxFreq, SpectrogramSettings::stLinear, and anonymous_namespace{NoteTrack.cpp}::swap().

Referenced by SpectrumVRulerControls::DoHandleWheelRotation(), and Release().

Here is the call graph for this function:

Here is the caller graph for this function:

Drag()

UIHandle::Result SpectrumVZoomHandle::Drag ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject  )

overridevirtual

Implements UIHandle.

Definition at line 61 of file SpectrumVZoomHandle.cpp.

{
   using namespace RefreshCode;
   if (!FindTrack())
      return Cancelled;
   return WaveChannelVZoomHandle::DoDrag(evt, pProject, mZoomStart, mZoomEnd, true);
}

References Cancelled, WaveChannelVZoomHandle::DoDrag(), FindTrack(), mZoomEnd, and mZoomStart.

Here is the call graph for this function:

Draw()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 96 of file SpectrumVZoomHandle.cpp.

{
   const auto pChannel = FindTrack();
   if (!pChannel)
      return;
   return WaveChannelVZoomHandle::DoDraw(
      context, rect, iPass, mZoomStart, mZoomEnd, true );
}

References WaveChannelVZoomHandle::DoDraw(), FindTrack(), mZoomEnd, and mZoomStart.

Here is the call graph for this function:

DrawingArea()

wxRect SpectrumVZoomHandle::DrawingArea ( TrackPanelDrawingContext &  , const wxRect &  rect, const wxRect &  panelRect, unsigned  iPass  )

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 107 of file SpectrumVZoomHandle.cpp.

{
   return WaveChannelVZoomHandle::DoDrawingArea(rect, panelRect, iPass);
}

References WaveChannelVZoomHandle::DoDrawingArea().

Here is the call graph for this function:

Enter()

void SpectrumVZoomHandle::Enter ( bool  forward, AudacityProject *    )

overridevirtual

Reimplemented from UIHandle.

Definition at line 43 of file SpectrumVZoomHandle.cpp.

{
#ifdef EXPERIMENTAL_TRACK_PANEL_HIGHLIGHTING
   mChangeHighlight = RefreshCode::RefreshCell;
#endif
}

References UIHandle::mChangeHighlight, and RefreshCode::RefreshCell.

FindTrack()

std::shared_ptr< const Track > SpectrumVZoomHandle::FindTrack ( ) const

overridevirtual

Returns

pointer to associated track, if any

Implements UIHandle.

Definition at line 33 of file SpectrumVZoomHandle.cpp.

{
   return TrackFromChannel(mpChannel.lock());
}

References mpChannel, and UIHandle::TrackFromChannel().

Referenced by Drag(), and Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

FindWaveChannel()

std::shared_ptr< WaveChannel > SpectrumVZoomHandle::FindWaveChannel

(

)

Definition at line 38 of file SpectrumVZoomHandle.cpp.

{
   return mpChannel.lock();
}

References mpChannel.

Referenced by Release().

Here is the caller graph for this function:

HandlesRightClick()

bool SpectrumVZoomHandle::HandlesRightClick ( )

overridevirtual

Whether the handle has any special right-button handling.

If not, then Click() will not be called for right click. Default is always false

Reimplemented from UIHandle.

Definition at line 50 of file SpectrumVZoomHandle.cpp.

{
   return true;
}

operator=()

SpectrumVZoomHandle & SpectrumVZoomHandle::operator= ( const SpectrumVZoomHandle &  )

default

Preview()

HitTestPreview SpectrumVZoomHandle::Preview ( const TrackPanelMouseState &  state, AudacityProject *  pProject  )

overridevirtual

Implements UIHandle.

Definition at line 70 of file SpectrumVZoomHandle.cpp.

{
   return WaveChannelVZoomHandle::HitPreview(true);
}

References WaveChannelVZoomHandle::HitPreview().

Here is the call graph for this function:

Release()

UIHandle::Result SpectrumVZoomHandle::Release ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject, wxWindow *  pParent  )

overridevirtual

Implements UIHandle.

Definition at line 76 of file SpectrumVZoomHandle.cpp.

{
   const auto pChannel = FindWaveChannel();
   if (!pChannel)
      return RefreshCode::Cancelled;
   return WaveChannelVZoomHandle::DoRelease(
      evt, pProject, pParent, *pChannel, mRect,
      DoZoom, SpectrumVRulerMenuTable::Instance(),
      mZoomStart, mZoomEnd);
}

References RefreshCode::Cancelled, WaveChannelVZoomHandle::DoRelease(), DoZoom(), FindWaveChannel(), SpectrumVRulerMenuTable::Instance(), mRect, mZoomEnd, and mZoomStart.

Here is the call graph for this function:

Member Data Documentation

mpChannel

std::weak_ptr<WaveChannel> SpectrumVZoomHandle::mpChannel

private

Definition at line 72 of file SpectrumVZoomHandle.h.

Referenced by FindTrack(), and FindWaveChannel().

mRect

wxRect SpectrumVZoomHandle::mRect {}

private

Definition at line 75 of file SpectrumVZoomHandle.h.

Referenced by Release().

mZoomEnd

int SpectrumVZoomHandle::mZoomEnd {}

private

Definition at line 74 of file SpectrumVZoomHandle.h.

Referenced by Drag(), Draw(), and Release().

mZoomStart

int SpectrumVZoomHandle::mZoomStart {}

private

Definition at line 74 of file SpectrumVZoomHandle.h.

Referenced by Drag(), Draw(), and Release().

---

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

• SpectrumVZoomHandle.h
• SpectrumVZoomHandle.cpp