Constructed from one channel, but changes height of all channels in a track. More...

#include <TrackPanelResizeHandle.h>

Inheritance diagram for TrackPanelResizeHandle:

Collaboration diagram for TrackPanelResizeHandle:

Public Member Functions
	TrackPanelResizeHandle (const std::shared_ptr< Channel > &pChannel, int y)

TrackPanelResizeHandle &	operator= (const TrackPanelResizeHandle &)=default

virtual	~TrackPanelResizeHandle ()

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

std::shared_ptr< Channel >	FindChannel ()

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 HitTestPreview	HitPreview (bool bLinked)

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 Types
enum	Mode { IsResizing , IsResizingBetweenLinkedTracks , IsResizingBelowLinkedTracks }

Private Member Functions
	TrackPanelResizeHandle (const TrackPanelResizeHandle &)=delete

Channel *	PrevChannel (Channel &channel)

Channel *	NextChannel (Channel &channel)

Static Private Member Functions
static Track &	GetTrack (Channel &channel)

Private Attributes
Mode	mMode { IsResizing }

std::weak_ptr< Channel >	mwChannel

bool	mInitialMinimized {}

int	mInitialTrackHeight {}

int	mInitialExpandedHeight {}

int	mInitialUpperTrackHeight {}

int	mInitialUpperExpandedHeight {}

int	mMouseClickY {}

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned

using	Cell = TrackPanelCell

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Constructed from one channel, but changes height of all channels in a track.

Definition at line 20 of file TrackPanelResizeHandle.h.

Member Enumeration Documentation

◆ Mode

enum TrackPanelResizeHandle::Mode

private

Enumerator
IsResizing
IsResizingBetweenLinkedTracks
IsResizingBelowLinkedTracks

Definition at line 60 of file TrackPanelResizeHandle.h.

             {
      IsResizing,
      IsResizingBetweenLinkedTracks,
      IsResizingBelowLinkedTracks,
   };

Constructor & Destructor Documentation

◆ TrackPanelResizeHandle() [1/2]

TrackPanelResizeHandle::TrackPanelResizeHandle ( const TrackPanelResizeHandle & )

privatedelete

◆ TrackPanelResizeHandle() [2/2]

TrackPanelResizeHandle::TrackPanelResizeHandle	(	const std::shared_ptr< Channel > &	pChannel,
		int	y
	)

Precondition: pChannel != nullptr

Definition at line 96 of file TrackPanelResizeHandle.cpp.

   : mwChannel{ pChannel }
   , mMouseClickY( y )
{
   // TODO: more-than-two-channels
 
   //STM:  Determine whether we should rescale one or two tracks
   auto channels = GetTrack(*pChannel).Channels();
   auto last = *channels.rbegin();
   auto &lastView = ChannelView::Get(*last);
   mInitialTrackHeight = lastView.GetHeight();
   mInitialExpandedHeight = lastView.GetExpandedHeight();
   mInitialMinimized = lastView.GetMinimized();
 
   if (channels.size() > 1) {
      auto first = *channels.begin();
      auto &firstView = ChannelView::Get(*first);
 
      mInitialUpperTrackHeight = firstView.GetHeight();
      mInitialUpperExpandedHeight = firstView.GetExpandedHeight();
 
      if (pChannel == *channels.rbegin())
         // pChannel is lowest among two or more,
         // so there is a previous channel
         mMode = IsResizingBelowLinkedTracks;
      else
         // pChannel is not the lowest among two or more,
         // so there is a next channel
         mMode = IsResizingBetweenLinkedTracks;
   }
   else
      // Don't assume there is a next or previous channel
      mMode = IsResizing;
}

References ChannelGroup::Channels(), ChannelView::Get(), GetTrack(), IsResizing, IsResizingBelowLinkedTracks, IsResizingBetweenLinkedTracks, mInitialExpandedHeight, mInitialMinimized, mInitialTrackHeight, mInitialUpperExpandedHeight, mInitialUpperTrackHeight, and mMode.

Here is the call graph for this function:

◆ ~TrackPanelResizeHandle()

TrackPanelResizeHandle::~TrackPanelResizeHandle ( )

virtual

Definition at line 52 of file TrackPanelResizeHandle.cpp.

53{

54}

Member Function Documentation

◆ Cancel()

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

overridevirtual

Implements UIHandle.

Definition at line 293 of file TrackPanelResizeHandle.cpp.

{
   auto &tracks = TrackList::Get( *pProject );
   auto theChannel = FindChannel();
   if (!theChannel)
      return RefreshCode::Cancelled;
 
 
   switch (mMode) {
   case IsResizing:
   {
      auto &view = ChannelView::Get(*theChannel);
      view.SetExpandedHeight(mInitialExpandedHeight);
      view.SetMinimized( mInitialMinimized );
   }
   break;
   case IsResizingBetweenLinkedTracks:
   {
      // Assume next channel is present, see constructor
      const auto next = NextChannel(*theChannel);
      auto &view = ChannelView::Get(*theChannel),
         &nextView = ChannelView::Get(*next);
      view.SetExpandedHeight(mInitialUpperExpandedHeight);
      view.SetMinimized( mInitialMinimized );
      nextView.SetExpandedHeight(mInitialExpandedHeight);
      nextView.SetMinimized( mInitialMinimized );
   }
   break;
   case IsResizingBelowLinkedTracks:
   {
      // Assume previous channel is present, see constructor
      const auto prev = PrevChannel(*theChannel);
      auto &view = ChannelView::Get(*theChannel),
         &prevView = ChannelView::Get(*prev);
      view.SetExpandedHeight(mInitialExpandedHeight);
      view.SetMinimized( mInitialMinimized );
      prevView.SetExpandedHeight(mInitialUpperExpandedHeight);
      prevView.SetMinimized(mInitialMinimized);
   }
   break;
   }
 
   return RefreshCode::RefreshAll;
}

References RefreshCode::Cancelled, FindChannel(), TrackList::Get(), ChannelView::Get(), IsResizing, IsResizingBelowLinkedTracks, IsResizingBetweenLinkedTracks, mInitialExpandedHeight, mInitialMinimized, mInitialUpperExpandedHeight, mMode, NextChannel(), PrevChannel(), RefreshCode::RefreshAll, and tracks.

Here is the call graph for this function:

◆ Click()

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

overridevirtual

Implements UIHandle.

Definition at line 66 of file TrackPanelResizeHandle.cpp.

{
   using namespace RefreshCode;
   if (evt.event.LeftDClick() && mMode == IsResizingBetweenLinkedTracks) {
      auto &tracks = TrackList::Get(*pProject);
      auto theChannel = FindChannel();
      if (!theChannel)
         return RefreshNone;
      auto &view = ChannelView::Get(*theChannel);
      if (!view.GetMinimized()) {
         auto range = GetTrack(*theChannel).Channels();
         auto size = range.size();
         auto height = range.sum( [](auto pChannel){
            return ChannelView::Get(*pChannel).GetHeight(); } );
         int ii = 1;
         int coord = 0;
         for (const auto pChannel : range) {
            int newCoord = ((double)ii++ /size) * height;
            ChannelView::Get(*pChannel).SetExpandedHeight(newCoord - coord);
            coord = newCoord;
         }
         ProjectHistory::Get( *pProject ).ModifyState(false);
         // Do not start a drag
         return Cancelled | RefreshAll;
      }
   }
   return RefreshNone;
}

References Cancelled, ChannelGroup::Channels(), TrackPanelMouseEvent::event, FindChannel(), ProjectHistory::Get(), TrackList::Get(), ChannelView::Get(), ChannelView::GetHeight(), GetTrack(), IsResizingBetweenLinkedTracks, mMode, ProjectHistory::ModifyState(), RefreshCode::RefreshAll, RefreshCode::RefreshNone, ChannelView::SetExpandedHeight(), size, and tracks.

Here is the call graph for this function:

◆ Drag()

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

overridevirtual

Implements UIHandle.

Definition at line 148 of file TrackPanelResizeHandle.cpp.

{
   auto &tracks = TrackList::Get( *pProject );
   auto theChannel = FindChannel();
   if (!theChannel)
      return RefreshCode::Cancelled;
 
   auto &view = ChannelView::Get(*theChannel);
 
   if (view.GetMinimized() && mMode == IsResizingBetweenLinkedTracks)
      return RefreshCode::Cancelled;
 
   const wxMouseEvent &event = evt.event;
 
   int delta = (event.m_y - mMouseClickY);
 
   // On first drag, jump out of minimized mode.  Initial height
   // will be height of minimized track.
   //
   // This used to be in HandleResizeClick(), but simply clicking
   // on a resize border would switch the minimized state.
   if (view.GetMinimized()) {
      auto channels = GetTrack(*theChannel).Channels();
      for (auto pChannel : channels) {
         auto &channelView = ChannelView::Get(*pChannel);
         channelView.SetExpandedHeight(channelView.GetHeight());
         channelView.SetMinimized(false);
      }
 
      if (channels.size() > 1) {
         // Initial values must be reset since they weren't based on the
         // minimized heights.
         auto &channelView = ChannelView::Get(**channels.begin());
         mInitialUpperTrackHeight = channelView.GetHeight();
         mInitialTrackHeight = channelView.GetHeight();
      }
   }
 
   // Common pieces of code for MONO_WAVE_PAN and otherwise.
   auto doResizeBelow = [&] (Channel *prev) {
      // TODO: more-than-two-channels
 
      auto &prevView = ChannelView::Get(*prev);
 
      double proportion = static_cast < double >(mInitialTrackHeight)
      / (mInitialTrackHeight + mInitialUpperTrackHeight);
 
      int newTrackHeight = static_cast < int >
      (mInitialTrackHeight + delta * proportion);
 
      int newUpperTrackHeight = static_cast < int >
      (mInitialUpperTrackHeight + delta * (1.0 - proportion));
 
      //make sure neither track is smaller than its minimum height
      if (newTrackHeight < view.GetMinimizedHeight())
         newTrackHeight = view.GetMinimizedHeight();
      if (newUpperTrackHeight < prevView.GetMinimizedHeight())
         newUpperTrackHeight = prevView.GetMinimizedHeight();
 
      view.SetExpandedHeight(newTrackHeight);
      prevView.SetExpandedHeight(newUpperTrackHeight);
   };
 
   auto doResizeBetween = [&] (Channel *next) {
      // TODO: more-than-two-channels
 
      auto &nextView = ChannelView::Get(*next);
      int newUpperTrackHeight = mInitialUpperTrackHeight + delta;
      int newTrackHeight = mInitialTrackHeight - delta;
 
      // make sure neither track is smaller than its minimum height
      if (newTrackHeight < nextView.GetMinimizedHeight()) {
         newTrackHeight = nextView.GetMinimizedHeight();
         newUpperTrackHeight =
         mInitialUpperTrackHeight + mInitialTrackHeight - nextView.GetMinimizedHeight();
      }
      if (newUpperTrackHeight < view.GetMinimizedHeight()) {
         newUpperTrackHeight = view.GetMinimizedHeight();
         newTrackHeight =
         mInitialUpperTrackHeight + mInitialTrackHeight - view.GetMinimizedHeight();
      }
 
      view.SetExpandedHeight(newUpperTrackHeight);
      nextView.SetExpandedHeight(newTrackHeight);
   };
 
   auto doResize = [&] {
      int newTrackHeight = mInitialTrackHeight + delta;
      if (newTrackHeight < view.GetMinimizedHeight())
         newTrackHeight = view.GetMinimizedHeight();
      view.SetExpandedHeight(newTrackHeight);
   };
 
   //STM: We may be dragging one or two (stereo) tracks.
   // If two, resize proportionally if we are dragging the lower track, and
   // adjust compensatively if we are dragging the upper track.
 
   switch( mMode )
   {
      case IsResizingBelowLinkedTracks:
      {
         // Assume previous channel is present, see constructor
         doResizeBelow(PrevChannel(*theChannel));
         break;
      }
      case IsResizingBetweenLinkedTracks:
      {
         // Assume next channel is present, see constructor
         doResizeBetween(NextChannel(*theChannel));
         break;
      }
      case IsResizing:
      {
         doResize();
         break;
      }
      default:
         // don't refresh in this case.
         return RefreshCode::RefreshNone;
   }
 
   return RefreshCode::RefreshAll;
}

References RefreshCode::Cancelled, ChannelGroup::Channels(), TrackPanelMouseEvent::event, FindChannel(), TrackList::Get(), ChannelView::Get(), GetTrack(), IsResizing, IsResizingBelowLinkedTracks, IsResizingBetweenLinkedTracks, mInitialTrackHeight, mInitialUpperTrackHeight, mMode, mMouseClickY, NextChannel(), PrevChannel(), RefreshCode::RefreshAll, RefreshCode::RefreshNone, and tracks.

Here is the call graph for this function:

◆ FindChannel()

std::shared_ptr< Channel > TrackPanelResizeHandle::FindChannel ( )

Definition at line 61 of file TrackPanelResizeHandle.cpp.

{
   return mwChannel.lock();
}

References mwChannel.

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

Here is the caller graph for this function:

◆ FindTrack()

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

overridevirtual

Returns: pointer to associated track, if any

Implements UIHandle.

Definition at line 56 of file TrackPanelResizeHandle.cpp.

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

References mwChannel, and UIHandle::TrackFromChannel().

Here is the call graph for this function:

◆ GetTrack()

Track & TrackPanelResizeHandle::GetTrack ( Channel & channel )

staticprivate

Definition at line 338 of file TrackPanelResizeHandle.cpp.

{
   return *static_cast<Track*>(&channel.GetChannelGroup());
}

References Channel::GetChannelGroup().

Referenced by Click(), Drag(), NextChannel(), PrevChannel(), and TrackPanelResizeHandle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HitPreview()

HitTestPreview TrackPanelResizeHandle::HitPreview ( bool bLinked )

static

When in the resize area we can adjust size or relative size.

Definition at line 25 of file TrackPanelResizeHandle.cpp.

{
   // TODO: more-than-two-channels-message
 
   static wxCursor resizeCursor{ wxCURSOR_SIZENS };
 
   // Check to see whether it is the first channel of a stereo track
   if (bLinked) {
      // If we are in the label we got here 'by mistake' and we're
      // not actually in the resize area at all.  (The resize area
      // is shorter when it is between stereo tracks).
 
      return {
         XO(
"Click and drag to adjust relative size of stereo tracks, double-click to make heights equal"),
         &resizeCursor
      };
   }
   else {
      return {
         XO("Click and drag to resize the track."),
         &resizeCursor
      };
   }
}

References XO().

Referenced by Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NextChannel()

Channel * TrackPanelResizeHandle::NextChannel ( Channel & channel )

private

Definition at line 140 of file TrackPanelResizeHandle.cpp.

{
   // Assume channel is first of two
   // TODO: more-than-two-channels
   auto channels = GetTrack(channel).Channels();
   return &**channels.rbegin();
}

References ChannelGroup::Channels(), and GetTrack().

Referenced by Cancel(), and Drag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

TrackPanelResizeHandle & TrackPanelResizeHandle::operator= ( const TrackPanelResizeHandle & )

default

◆ PrevChannel()

Channel * TrackPanelResizeHandle::PrevChannel ( Channel & channel )

private

Definition at line 132 of file TrackPanelResizeHandle.cpp.

{
   // Assume channel is last of two
   // TODO: more-than-two-channels
   auto channels = GetTrack(channel).Channels();
   return &**channels.begin();
}

References ChannelGroup::Channels(), and GetTrack().

Referenced by Cancel(), and Drag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Preview()

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

overridevirtual

Implements UIHandle.

Definition at line 273 of file TrackPanelResizeHandle.cpp.

{
   return HitPreview(mMode == IsResizingBetweenLinkedTracks);
}

References HitPreview(), IsResizingBetweenLinkedTracks, and mMode.

Here is the call graph for this function:

◆ Release()

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

overridevirtual

This happens when the button is released from a drag. Since we actually took care of resizing the track when we got drag events, all we have to do here is clean up. We also modify the undo state (the action doesn't become undo-able, but it gets merged with the previous undo-able event).

Implements UIHandle.

Definition at line 279 of file TrackPanelResizeHandle.cpp.

{
   ProjectHistory::Get( *pProject ).ModifyState(false);
   return RefreshCode::FixScrollbars;
}

References RefreshCode::FixScrollbars, ProjectHistory::Get(), and ProjectHistory::ModifyState().

Here is the call graph for this function:

Member Data Documentation

◆ mInitialExpandedHeight

int TrackPanelResizeHandle::mInitialExpandedHeight {}

private

Definition at line 71 of file TrackPanelResizeHandle.h.

Referenced by Cancel(), and TrackPanelResizeHandle().

◆ mInitialMinimized

bool TrackPanelResizeHandle::mInitialMinimized {}

private

Definition at line 69 of file TrackPanelResizeHandle.h.

Referenced by Cancel(), and TrackPanelResizeHandle().

◆ mInitialTrackHeight

int TrackPanelResizeHandle::mInitialTrackHeight {}

private

Definition at line 70 of file TrackPanelResizeHandle.h.

Referenced by Drag(), and TrackPanelResizeHandle().

◆ mInitialUpperExpandedHeight

int TrackPanelResizeHandle::mInitialUpperExpandedHeight {}

private

Definition at line 73 of file TrackPanelResizeHandle.h.

Referenced by Cancel(), and TrackPanelResizeHandle().

◆ mInitialUpperTrackHeight

int TrackPanelResizeHandle::mInitialUpperTrackHeight {}

private

Definition at line 72 of file TrackPanelResizeHandle.h.

Referenced by Drag(), and TrackPanelResizeHandle().

◆ mMode

Mode TrackPanelResizeHandle::mMode { IsResizing }

private

Definition at line 65 of file TrackPanelResizeHandle.h.

Referenced by Cancel(), Click(), Drag(), Preview(), and TrackPanelResizeHandle().

◆ mMouseClickY

int TrackPanelResizeHandle::mMouseClickY {}

private

Definition at line 75 of file TrackPanelResizeHandle.h.

Referenced by Drag().

◆ mwChannel

std::weak_ptr<Channel> TrackPanelResizeHandle::mwChannel

private

Definition at line 67 of file TrackPanelResizeHandle.h.

Referenced by FindChannel(), and FindTrack().

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

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Mode

Constructor & Destructor Documentation

◆ TrackPanelResizeHandle() [1/2]

◆ TrackPanelResizeHandle() [2/2]

◆ ~TrackPanelResizeHandle()

Member Function Documentation

◆ Cancel()

◆ Click()

◆ Drag()

◆ FindChannel()

◆ FindTrack()

◆ GetTrack()

◆ HitPreview()

◆ NextChannel()

◆ operator=()

◆ PrevChannel()

◆ Preview()

◆ Release()

Member Data Documentation

◆ mInitialExpandedHeight

◆ mInitialMinimized

◆ mInitialTrackHeight

◆ mInitialUpperExpandedHeight

◆ mInitialUpperTrackHeight

◆ mMode

◆ mMouseClickY

◆ mwChannel