#include <ZoomHandle.h>

Inheritance diagram for ZoomHandle:

Collaboration diagram for ZoomHandle:

Public Member Functions
	ZoomHandle ()

ZoomHandle &	operator= (const ZoomHandle &)=default

virtual	~ZoomHandle ()

std::shared_ptr< const Track >	FindTrack () const 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 UIHandlePtr	HitAnywhere (std::weak_ptr< ZoomHandle > &holder)

static UIHandlePtr	HitTest (std::weak_ptr< ZoomHandle > &holder, const wxMouseState &state)

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
	ZoomHandle (const ZoomHandle &)=delete

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

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

bool	IsDragZooming () const

Static Private Member Functions
static HitTestPreview	HitPreview (const wxMouseState &state, const AudacityProject *pProject)

Private Attributes
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 19 of file ZoomHandle.h.

Constructor & Destructor Documentation

◆ ZoomHandle() [1/2]

ZoomHandle::ZoomHandle ( const ZoomHandle & )

privatedelete

◆ ZoomHandle() [2/2]

ZoomHandle::ZoomHandle ( )

This class takes care of our different zoom possibilities. It is possible for a user to just "zoom in" or "zoom out," but it is also possible for a user to drag and select an area that he or she wants to be zoomed in on. We use mZoomStart and mZoomEnd to track the beginning and end of such a zoom area. Note that the ViewInfo actually keeps track of our zoom constant, so we achieve zooming by altering the zoom constant and forcing a refresh.

Definition at line 39 of file ZoomHandle.cpp.

40{}

◆ ~ZoomHandle()

ZoomHandle::~ZoomHandle ( )

virtual

Definition at line 82 of file ZoomHandle.cpp.

83{

84}

Member Function Documentation

◆ Cancel()

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

overridevirtual

Implements UIHandle.

Definition at line 191 of file ZoomHandle.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 ZoomHandle::Click	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

overridevirtual

Zoom button down, record the position.

Implements UIHandle.

Definition at line 96 of file ZoomHandle.cpp.

{
   const wxMouseEvent &event = evt.event;
   if (event.ButtonDown() || event.LeftDClick()) {
      mZoomStart = event.m_x;
      mZoomEnd = event.m_x;
      mRect = evt.rect;
   }
   return RefreshCode::RefreshNone;
}

References TrackPanelMouseEvent::event, mRect, mZoomEnd, mZoomStart, TrackPanelMouseEvent::rect, and RefreshCode::RefreshNone.

◆ Drag()

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

overridevirtual

Implements UIHandle.

Definition at line 109 of file ZoomHandle.cpp.

{
   const wxMouseEvent &event = evt.event;
   const int left = mRect.GetLeft();
   const int right = mRect.GetRight();
 
   mZoomEnd = event.m_x;
 
   if (event.m_x < left) {
      mZoomEnd = left;
   }
   else if (event.m_x > right) {
      mZoomEnd = right;
   }
 
   // Refresh tracks ALWAYS.  Even if IsDragZooming() becomes false, make the
   // dashed lines disappear. -- PRL
   return RefreshCode::RefreshAll; // (IsDragZooming() ? RefreshAllTracks : RefreshNone),
}

References TrackPanelMouseEvent::event, mRect, mZoomEnd, and RefreshCode::RefreshAll.

◆ Draw()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 198 of file ZoomHandle.cpp.

{
   if ( iPass == TrackArtist::PassZooming &&
       // PRL: Draw dashed lines only if we would zoom in
       // for button up.
       IsDragZooming() ) {
      auto &dc = context.dc;
      dc.SetBrush(*wxTRANSPARENT_BRUSH);
      dc.SetPen(*wxBLACK_DASHED_PEN);
      // Make the top and bottom of the dashed rectangle disappear out of
      // bounds, so that you only see vertical dashed lines.
      dc.DrawRectangle( {
         std::min(mZoomStart, mZoomEnd),
         rect.y - 1,
         1 + abs(mZoomEnd - mZoomStart),
         rect.height + 2
      } );
   }
}

References TrackPanelDrawingContext::dc, IsDragZooming(), min(), mZoomEnd, mZoomStart, and TrackArtist::PassZooming.

Here is the call graph for this function:

◆ DrawingArea()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 220 of file ZoomHandle.cpp.

{
   if ( iPass == TrackArtist::PassZooming )
      return MaximizeHeight( rect, panelRect );
   else
      return rect;
}

References TrackPanelDrawable::MaximizeHeight(), and TrackArtist::PassZooming.

Here is the call graph for this function:

◆ FindTrack()

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

overridevirtual

Returns: pointer to associated track, if any

Implements UIHandle.

Definition at line 86 of file ZoomHandle.cpp.

{
   return nullptr;
}

◆ HandlesRightClick()

bool ZoomHandle::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 91 of file ZoomHandle.cpp.

{
   return true;
}

◆ HitAnywhere()

UIHandlePtr ZoomHandle::HitAnywhere ( std::weak_ptr< ZoomHandle > & holder )

static

Definition at line 64 of file ZoomHandle.cpp.

{
   auto result = std::make_shared<ZoomHandle>();
   result = AssignUIHandlePtr(holder, result);
   return result;
}

References AssignUIHandlePtr().

Referenced by HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HitPreview()

HitTestPreview ZoomHandle::HitPreview	(	const wxMouseState &	state,
		const AudacityProject *	pProject
	)

staticprivate

Definition at line 42 of file ZoomHandle.cpp.

{
   static auto zoomInCursor =
      ::MakeCursor(wxCURSOR_MAGNIFIER, ZoomInCursorXpm, 19, 15);
   static auto zoomOutCursor =
      ::MakeCursor(wxCURSOR_MAGNIFIER, ZoomOutCursorXpm, 19, 15);
   TranslatableString message;
   // TODO:  Why not mention middle click to zoom normal on Windows too?
#if defined( __WXMAC__ )
   message = XO("Click to Zoom In, Shift-Click to Zoom Out");
#elif defined( __WXMSW__ )
   message = XO("Drag to Zoom Into Region, Right-Click to Zoom Out");
#elif defined( __WXGTK__ )
   message = XO("Left=Zoom In, Right=Zoom Out, Middle=Normal");
#endif
   return {
      message,
      (state.ShiftDown() ? &*zoomOutCursor : &*zoomInCursor)
   };
}

References MakeCursor(), and XO().

Referenced by Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HitTest()

UIHandlePtr ZoomHandle::HitTest	(	std::weak_ptr< ZoomHandle > &	holder,
		const wxMouseState &	state
	)

static

Definition at line 72 of file ZoomHandle.cpp.

{
   if (state.ButtonIsDown(wxMOUSE_BTN_RIGHT))
      return HitAnywhere(holder);
   else
      return {};
}

References HitAnywhere().

Referenced by CommonChannelView::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsDragZooming()

bool ZoomHandle::IsDragZooming ( ) const

private

Definition at line 230 of file ZoomHandle.cpp.

{
   const int DragThreshold = 3;// Anything over 3 pixels is a drag, else a click.
   return (abs(mZoomEnd - mZoomStart) > DragThreshold);
}

References DragThreshold, mZoomEnd, and mZoomStart.

Referenced by Draw(), and Release().

Here is the caller graph for this function:

◆ operator=()

ZoomHandle & ZoomHandle::operator= ( const ZoomHandle & )

default

◆ Preview()

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

overridevirtual

Implements UIHandle.

Definition at line 130 of file ZoomHandle.cpp.

{
   return HitPreview(st.state, pProject);
}

References HitPreview(), and TrackPanelMouseState::state.

Here is the call graph for this function:

◆ Release()

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

overridevirtual

This actually sets the Zoom value when you're done doing a drag zoom.

This handles normal Zoom In/Out, if you just clicked; IOW, if you were NOT dragging to zoom an area.

Todo:: MAGIC NUMBER: We've got several in this method.

Implements UIHandle.

Definition at line 136 of file ZoomHandle.cpp.

{
   const wxMouseEvent &event = evt.event;
   auto &viewInfo = ViewInfo::Get( *pProject );
   if (mZoomEnd < mZoomStart)
      std::swap(mZoomStart, mZoomEnd);
 
   const int trackLeftEdge = mRect.x;
   if (IsDragZooming())
   {
      double left = viewInfo.PositionToTime(mZoomStart, trackLeftEdge);
      double right = viewInfo.PositionToTime(mZoomEnd, trackLeftEdge);
 
      double multiplier =
         (viewInfo.PositionToTime(mRect.width) - viewInfo.PositionToTime(0)) /
         (right - left);
      if (event.ShiftDown())
         multiplier = 1.0 / multiplier;
 
      viewInfo.ZoomBy(multiplier);
 
      viewInfo.hpos = left;
   }
   else
   {
      const double center_h =
         viewInfo.PositionToTime(event.m_x, trackLeftEdge);
 
      const double multiplier =
         (event.RightUp() || event.RightDClick() || event.ShiftDown())
         ? 0.5 : 2.0;
      viewInfo.ZoomBy(multiplier);
 
      if (event.MiddleUp() || event.MiddleDClick())
         viewInfo.SetZoom(ZoomInfo::GetDefaultZoom()); // AS: Reset zoom.
 
      const double new_center_h =
         viewInfo.PositionToTime(event.m_x, trackLeftEdge);
 
      viewInfo.hpos += (center_h - new_center_h);
   }
 
   mZoomEnd = mZoomStart = 0;
 
   using namespace RefreshCode;
   return RefreshAll | FixScrollbars;
}

References TrackPanelMouseEvent::event, RefreshCode::FixScrollbars, ViewInfo::Get(), ZoomInfo::GetDefaultZoom(), IsDragZooming(), mRect, mZoomEnd, mZoomStart, RefreshCode::RefreshAll, and anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

Member Data Documentation

◆ mRect

wxRect ZoomHandle::mRect {}

private

Definition at line 71 of file ZoomHandle.h.

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

◆ mZoomEnd

int ZoomHandle::mZoomEnd {}

private

Definition at line 70 of file ZoomHandle.h.

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

◆ mZoomStart

int ZoomHandle::mZoomStart {}

private

Definition at line 70 of file ZoomHandle.h.

Referenced by Click(), Draw(), IsDragZooming(), and Release().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ZoomHandle() [1/2]

◆ ZoomHandle() [2/2]

◆ ~ZoomHandle()

Member Function Documentation

◆ Cancel()

◆ Click()

◆ Drag()

◆ Draw()

◆ DrawingArea()

◆ FindTrack()

◆ HandlesRightClick()

◆ HitAnywhere()

◆ HitPreview()

◆ HitTest()

◆ IsDragZooming()

◆ operator=()

◆ Preview()

◆ Release()

Member Data Documentation

◆ mRect

◆ mZoomEnd

◆ mZoomStart