SubViewAdjustHandle Class Reference

Inheritance diagram for SubViewAdjustHandle:

Collaboration diagram for SubViewAdjustHandle:

Public Types
enum	{ MinHeight = SubViewAdjuster::HotZoneSize }
Public Types inherited from UIHandle
using	Result = unsigned
using	Cell = TrackPanelCell

Public Member Functions
	SubViewAdjustHandle (SubViewAdjuster &&adjuster, size_t subViewIndex, wxCoord viewHeight, bool top)
std::shared_ptr< const Track >	FindTrack () const override
Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *) override
HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *) override
Result	Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent) override
Result	Cancel (AudacityProject *) 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	HitTest (std::weak_ptr< SubViewAdjustHandle > &holder, WaveChannelView &view, WaveChannelSubView &subView, const TrackPanelMouseState &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 Attributes
SubViewAdjuster	mAdjuster
std::vector< wxCoord >	mOrigHeights
size_t	mMySubView {}
wxCoord	mYMin {}
wxCoord	mYMax {}
wxCoord	mViewHeight {}
wxCoord	mTotalHeight {}
wxCoord	mOrigHeight {}
wxCoord	mOrigY {}
bool	mTop {}

Additional Inherited Members
Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 267 of file WaveChannelView.cpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MinHeight

Definition at line 270 of file WaveChannelView.cpp.

{ MinHeight = SubViewAdjuster::HotZoneSize };

Constructor & Destructor Documentation

SubViewAdjustHandle()

SubViewAdjustHandle::SubViewAdjustHandle ( SubViewAdjuster &&  adjuster, size_t  subViewIndex, wxCoord  viewHeight, bool  top  )

inline

Definition at line 296 of file WaveChannelView.cpp.

      : mAdjuster{ std::move( adjuster ) }
      , mMySubView{ subViewIndex }
      , mViewHeight{ viewHeight }
      , mTop{ top }
   {
      if ( mAdjuster.ModifyPermutation( top ) )
         --mMySubView;
   }

References mAdjuster, mMySubView, and SubViewAdjuster::ModifyPermutation().

Here is the call graph for this function:

Member Function Documentation

Cancel()

Result SubViewAdjustHandle::Cancel ( AudacityProject *  )

inlineoverridevirtual

Implements UIHandle.

Definition at line 462 of file WaveChannelView.cpp.

   {
      mAdjuster.UpdateViews( true );
      return RefreshCode::RefreshAll;
   }

References mAdjuster, RefreshCode::RefreshAll, and SubViewAdjuster::UpdateViews().

Here is the call graph for this function:

Click()

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

inlineoverridevirtual

Implements UIHandle.

Definition at line 316 of file WaveChannelView.cpp.

   {
      using namespace RefreshCode;
      const auto &permutation = mAdjuster.mPermutation;
      const auto size = permutation.size();
      if ( mMySubView >= size )
         return Cancelled;
 
      if (event.event.LeftDClick()) {
         for ( auto &placement : mAdjuster.mNewPlacements ) {
            if ( placement.index >= 0 )
               placement.fraction = 1.0f;
            else
               placement.fraction = 0.0f;
         }
         mAdjuster.UpdateViews( false );
         ProjectHistory::Get( *pProject ).ModifyState( false );
 
         // Do not start a drag
         return Cancelled | RefreshAll;
      }
 
      const auto &rect = event.rect;
      const auto height = rect.GetHeight();
      mOrigHeight = height;
 
      mOrigHeights = mAdjuster.ComputeHeights( mViewHeight );
 
      // Find the total height of the sub-views that may resize
      mTotalHeight = 0;
      auto index = ( mTop ? mAdjuster.mFirstSubView : mMySubView );
      const auto end = ( mTop ?  mMySubView + 1 : permutation.size() );
      for (; index != end; ++index)
         mTotalHeight += mOrigHeights[ index ];
 
      wxASSERT( height == mOrigHeights[ mMySubView ] );
 
      // Compute the maximum and minimum Y coordinates for drag effect
      if ( mTop ) {
         mOrigY = rect.GetTop();
         mYMax = rect.GetBottom();
         mYMin = mYMax - mTotalHeight + 1;
      }
      else {
         mOrigY = rect.GetBottom();
         mYMin = rect.GetTop();
         mYMax = mYMin + mTotalHeight - 1;
      }
 
      return RefreshNone;
   }

References Cancelled, SubViewAdjuster::ComputeHeights(), details::end(), TrackPanelMouseEvent::event, ProjectHistory::Get(), mAdjuster, SubViewAdjuster::mFirstSubView, mMySubView, SubViewAdjuster::mNewPlacements, ProjectHistory::ModifyState(), mOrigHeight, mOrigHeights, mOrigY, SubViewAdjuster::mPermutation, mTop, mTotalHeight, mViewHeight, mYMax, mYMin, RefreshCode::RefreshAll, RefreshCode::RefreshNone, size, and SubViewAdjuster::UpdateViews().

Here is the call graph for this function:

Drag()

Result SubViewAdjustHandle::Drag ( const TrackPanelMouseEvent &  event, AudacityProject *    )

inlineoverridevirtual

Implements UIHandle.

Definition at line 369 of file WaveChannelView.cpp.

   {
      using namespace RefreshCode;
      auto pView = mAdjuster.mwView.lock();
      if ( !pView )
         return Cancelled;
 
      // Find new height for the dragged sub-view
      auto newY = std::max( mYMin, std::min( mYMax, event.event.GetY() ) );
      const auto delta = newY - mOrigY;
      wxCoord newHeight = mTop
         ? mOrigHeight - delta
         : mOrigHeight + delta
      ;
      wxASSERT( newHeight >= 0 && newHeight <= mTotalHeight );
      if ( newHeight < MinHeight )
         // Snap the dragged sub-view to nothing
         newHeight = 0;
 
      // Reassign height for the dragged sub-view
      auto &myPlacement =
         mAdjuster.mNewPlacements[ mAdjuster.mPermutation[ mMySubView ] ];
      myPlacement.fraction = newHeight;
 
      // Grow or shrink other sub-views
      auto excess = newHeight - mOrigHeight; // maybe negative
      const auto adjustHeight = [&](size_t ii) {
         if (excess == 0)
            return true;
 
         const auto oldFraction = mOrigHeights[ ii ];
 
         auto index = mAdjuster.mPermutation[ ii ];
         auto &placement = mAdjuster.mNewPlacements[ index ];
         auto &fraction = placement.fraction;
 
         if (excess > oldFraction) {
            excess -= oldFraction, fraction = 0;
            return false;
         }
         else {
            auto newFraction = oldFraction - excess;
            if ( newFraction < MinHeight ) {
               // This snaps very short sub-views to nothing
               myPlacement.fraction += newFraction;
               fraction = 0;
            }
            else
               fraction = newFraction;
            return true;
         }
      };
      if ( mTop ) {
         for ( size_t ii = mMySubView; ii > 0; ) {
            --ii;
            if ( adjustHeight( ii ) )
               break;
         }
      }
      else {
         for ( size_t ii = mMySubView + 1, size = mAdjuster.mPermutation.size();
            ii < size; ++ii
         ) {
            if ( adjustHeight( ii ) )
               break;
         }
      }
 
      // Save adjustment to the track and request a redraw
      mAdjuster.UpdateViews( false );
      return RefreshAll;
   }

References Cancelled, TrackPanelMouseEvent::event, mAdjuster, min(), MinHeight, mMySubView, SubViewAdjuster::mNewPlacements, mOrigHeight, mOrigHeights, mOrigY, SubViewAdjuster::mPermutation, mTop, mTotalHeight, SubViewAdjuster::mwView, mYMax, mYMin, RefreshCode::RefreshAll, size, and SubViewAdjuster::UpdateViews().

Here is the call graph for this function:

FindTrack()

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

inlineoverridevirtual

Returns

pointer to associated track, if any

Implements UIHandle.

Definition at line 308 of file WaveChannelView.cpp.

   {
      auto pView = mAdjuster.mwView.lock();
      if (pView)
         return TrackFromChannel(pView->FindChannel());
      return nullptr;
   }

References mAdjuster, SubViewAdjuster::mwView, and UIHandle::TrackFromChannel().

Here is the call graph for this function:

HitTest()

static UIHandlePtr SubViewAdjustHandle::HitTest ( std::weak_ptr< SubViewAdjustHandle > &  holder, WaveChannelView &  view, WaveChannelSubView &  subView, const TrackPanelMouseState &  state  )

inlinestatic

Definition at line 272 of file WaveChannelView.cpp.

   {
      if ( !view.GetMultiView() )
         return {};
 
      SubViewAdjuster adjuster{ view };
      auto hit = adjuster.HitTest( subView,
         state.state.GetY(), state.rect.GetTop(), state.rect.GetHeight() );
      auto index = hit.first;
 
      if ( index < adjuster.mPermutation.size() ) {
         auto result = std::make_shared< SubViewAdjustHandle >(
            std::move( adjuster ), index, view.GetLastHeight(), hit.second
         );
         result = AssignUIHandlePtr( holder, result );
         return result;
      }
      else
         return {};
   }

References AssignUIHandlePtr(), WaveChannelView::GetLastHeight(), WaveChannelView::GetMultiView(), WaveChannelView::HitTest(), TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Referenced by WaveChannelSubView::DoDetailedHitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

Preview()

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

inlineoverridevirtual

Implements UIHandle.

Definition at line 442 of file WaveChannelView.cpp.

   {
      static auto resizeCursor =
         ::MakeCursor(wxCURSOR_ARROW, SubViewsCursorXpm, 16, 16);
      return {
         XO(
"Click and drag to adjust sizes of sub-views, double-click to split evenly"),
         &*resizeCursor
      };
   }

References MakeCursor(), and XO().

Here is the call graph for this function:

Release()

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

inlineoverridevirtual

Implements UIHandle.

Definition at line 454 of file WaveChannelView.cpp.

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

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

Here is the call graph for this function:

Member Data Documentation

mAdjuster

SubViewAdjuster SubViewAdjustHandle::mAdjuster

private

Definition at line 470 of file WaveChannelView.cpp.

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

mMySubView

size_t SubViewAdjustHandle::mMySubView {}

private

Definition at line 474 of file WaveChannelView.cpp.

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

mOrigHeight

wxCoord SubViewAdjustHandle::mOrigHeight {}

private

Definition at line 479 of file WaveChannelView.cpp.

Referenced by Click(), and Drag().

mOrigHeights

std::vector<wxCoord> SubViewAdjustHandle::mOrigHeights

private

Definition at line 471 of file WaveChannelView.cpp.

Referenced by Click(), and Drag().

mOrigY

wxCoord SubViewAdjustHandle::mOrigY {}

private

Definition at line 480 of file WaveChannelView.cpp.

Referenced by Click(), and Drag().

mTop

bool SubViewAdjustHandle::mTop {}

private

Definition at line 483 of file WaveChannelView.cpp.

Referenced by Click(), and Drag().

mTotalHeight

wxCoord SubViewAdjustHandle::mTotalHeight {}

private

Definition at line 478 of file WaveChannelView.cpp.

Referenced by Click(), and Drag().

mViewHeight

wxCoord SubViewAdjustHandle::mViewHeight {}

private

Definition at line 477 of file WaveChannelView.cpp.

Referenced by Click().

mYMax

wxCoord SubViewAdjustHandle::mYMax {}

private

Definition at line 476 of file WaveChannelView.cpp.

Referenced by Click(), and Drag().

mYMin

wxCoord SubViewAdjustHandle::mYMin {}

private

Definition at line 476 of file WaveChannelView.cpp.

Referenced by Click(), and Drag().

---

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

• WaveChannelView.cpp