#include <WaveTrackView.h>

Inheritance diagram for WaveTrackSubView:

Collaboration diagram for WaveTrackSubView:

Public Types
using	Display = WaveTrackViewConstants::Display

using	Type = WaveTrackSubViewType

Public Types inherited from TrackView
enum	: unsigned { DefaultHeight = 150 }

using	Refinement = std::vector< std::pair< wxCoord, std::shared_ptr< TrackView > > >

Public Member Functions
	WaveTrackSubView (WaveTrackView &waveTrackView)

virtual const Type &	SubViewType () const =0

virtual void	CopyToSubView (WaveTrackSubView *destSubView) const

std::pair< bool, std::vector< UIHandlePtr > >	DoDetailedHitTest (const TrackPanelMouseState &state, const AudacityProject *pProject, int currentTool, bool bMultiTool, const std::shared_ptr< WaveTrack > &wt)

Public Member Functions inherited from CommonTrackView
std::shared_ptr< TrackPanelCell >	ContextMenuDelegate () override

std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &, const AudacityProject *pProject) final override

void	TimeShiftHitTest ()

virtual int	GetMinimizedHeight () const override

	TrackView (const std::shared_ptr< Track > &pTrack)

Public Member Functions inherited from TrackView
	TrackView (const std::shared_ptr< Track > &pTrack)

virtual	~TrackView ()=0

void	CopyTo (Track &track) const override
	Copy state, for undo/redo purposes. More...

bool	GetMinimized () const

void	SetMinimized (bool minimized)

int	GetCumulativeHeightBefore () const

int	GetExpandedHeight () const

virtual int	GetMinimizedHeight () const =0

int	GetHeight () const

void	SetCumulativeHeightBefore (int y)
	Set cached value dependent on position within the track list. More...

void	SetExpandedHeight (int height)

std::shared_ptr< TrackVRulerControls >	GetVRulerControls ()

std::shared_ptr< const TrackVRulerControls >	GetVRulerControls () const

virtual std::shared_ptr< CommonTrackCell >	GetAffordanceControls ()

void	WriteXMLAttributes (XMLWriter &) const override
	Serialize persistent attributes. More...

bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView) override
	Deserialize an attribute, returning true if recognized. More...

virtual Refinement	GetSubViews (const wxRect &rect)

virtual bool	IsSpectral () const

virtual void	DoSetMinimized (bool isMinimized)

Public Member Functions inherited from CommonTrackCell
	CommonTrackCell (const std::shared_ptr< Track > &pTrack)

	~CommonTrackCell ()

std::shared_ptr< Track >	DoFindTrack () override

void	Reparent (const std::shared_ptr< Track > &parent) override
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. 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 &) PROHIBITED

TrackPanelCell &	operator= (const TrackPanelCell &) PROHIBITED

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 TrackAttachment
virtual	~TrackAttachment ()

virtual void	CopyTo (Track &track) const
	Copy state, for undo/redo purposes. More...

virtual void	Reparent (const std::shared_ptr< Track > &parent)
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...

virtual void	WriteXMLAttributes (XMLWriter &) const
	Serialize persistent attributes. More...

virtual bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView)
	Deserialize an attribute, returning true if recognized. More...

Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Protected Member Functions
std::weak_ptr< WaveTrackView >	GetWaveTrackView () const

std::vector< MenuItem >	GetMenuItems (const wxRect &rect, const wxPoint pPosition, AudacityProject pProject) override
	Return a list of items for DoContextMenu() (empties for separators) More...

Protected Member Functions inherited from CommonTrackView
virtual std::vector< UIHandlePtr >	DetailedHitTest (const TrackPanelMouseState &, const AudacityProject *pProject, int currentTool, bool bMultiTool)=0

Protected Member Functions inherited from TrackView
virtual std::shared_ptr< TrackVRulerControls >	DoGetVRulerControls ()=0

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

Static Protected Member Functions
static void	DrawBoldBoundaries (TrackPanelDrawingContext &context, const WaveTrack *track, const wxRect &rect)

Protected Attributes
const size_t	mChannel

Protected Attributes inherited from CommonTrackView
std::weak_ptr< SelectHandle >	mSelectHandle

Protected Attributes inherited from TrackView
std::shared_ptr< TrackVRulerControls >	mpVRulerControls

Private Attributes
std::weak_ptr< SubViewCloseHandle >	mCloseHandle

std::weak_ptr< TrackPanelResizeHandle >	mResizeHandle

std::weak_ptr< SubViewAdjustHandle >	mAdjustHandle

std::weak_ptr< SubViewRearrangeHandle >	mRearrangeHandle

std::weak_ptr< WaveClipTrimHandle >	mClipTrimHandle

std::weak_ptr< CutlineHandle >	mCutlineHandle

std::weak_ptr< WaveTrackView >	mwWaveTrackView

Additional Inherited Members
Static Public Member Functions inherited from CommonTrackView
static void	GetEnvelopeValues (const Envelope &env, double aligned_time, double sampleDur, double *buffer, int bufferLen, int leftOffset, const ZoomInfo &zoomInfo)
	Get many envelope points for pixel columns at once, but don't assume uniform time per pixel. More...

Static Public Member Functions inherited from TrackView
static int	GetTrackHeight (const Track *pTrack)

static int	GetChannelGroupHeight (const Track *pTrack)

static int	GetCumulativeHeight (const Track *pTrack)

static int	GetTotalHeight (const TrackList &list)

static TrackView &	Get (Track &)

static const TrackView &	Get (const Track &)

static TrackView *	Find (Track *)

static const TrackView *	Find (const Track *)

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)

Public Attributes inherited from CommonTrackView
std::weak_ptr< TimeShiftHandle >	mTimeShiftHandle

Detailed Description

Definition at line 39 of file WaveTrackView.h.

Member Typedef Documentation

◆ Display

using WaveTrackSubView::Display = WaveTrackViewConstants::Display

Definition at line 43 of file WaveTrackView.h.

◆ Type

using WaveTrackSubView::Type = WaveTrackSubViewType

Definition at line 44 of file WaveTrackView.h.

Constructor & Destructor Documentation

◆ WaveTrackSubView()

WaveTrackSubView::WaveTrackSubView ( WaveTrackView & waveTrackView )

explicit

Definition at line 929 of file WaveTrackView.cpp.

   : CommonTrackView(waveTrackView.FindTrack())
   , mChannel(waveTrackView.GetChannel())
{
   mwWaveTrackView = std::static_pointer_cast<WaveTrackView>(
      waveTrackView.shared_from_this() );
}

References mwWaveTrackView.

Member Function Documentation

◆ CopyToSubView()

void WaveTrackSubView::CopyToSubView ( WaveTrackSubView * destSubView ) const

virtual

Reimplemented in SpectrumView.

Definition at line 937 of file WaveTrackView.cpp.

                                                                        {
 
}

◆ DoDetailedHitTest()

std::pair< bool, std::vector< UIHandlePtr > > WaveTrackSubView::DoDetailedHitTest	(	const TrackPanelMouseState &	state,
		const AudacityProject *	pProject,
		int	currentTool,
		bool	bMultiTool,
		const std::shared_ptr< WaveTrack > &	wt
	)

Definition at line 744 of file WaveTrackView.cpp.

{
   auto results = WaveTrackView::DoDetailedHitTest(
      state, pProject, currentTool, bMultiTool, wt, *this );
   if ( results.first )
      return results;
 
   auto pWaveTrackView = mwWaveTrackView.lock();
   if ( pWaveTrackView && !state.state.HasModifiers() ) {
      if ( auto pHandle = SubViewCloseHandle::HitTest(
         mCloseHandle,
         *pWaveTrackView, *this, state ) )
         results.second.push_back( pHandle );
 
      auto channels = TrackList::Channels(wt.get());
      if(channels.size() > 1) {
         // Only one cell is tested and we need to know
         // which one and it's relative location to the border.
         auto subviews = pWaveTrackView->GetSubViews();
         auto currentSubview = std::find_if(subviews.begin(), subviews.end(), 
            [self = shared_from_this()](const auto& p){
               return self == p.second;
         });
         if (currentSubview != subviews.end())
         {
            auto currentSubviewIndex = std::distance(subviews.begin(), currentSubview);
            
            const auto py = state.state.GetY();
            const auto topBorderHit = std::abs(py - state.rect.GetTop())
               <= WaveTrackView::kChannelSeparatorThickness / 2;
            const auto bottomBorderHit = std::abs(py - state.rect.GetBottom())
               <= WaveTrackView::kChannelSeparatorThickness / 2;
 
            auto currentChannel = channels.find(wt.get());
            auto currentChannelIndex = std::distance(channels.begin(), currentChannel);
 
            if (//for not-last-view check the bottom border hit
               ((currentChannelIndex != channels.size() - 1)
                  && (currentSubviewIndex == static_cast<int>(subviews.size()) - 1)
                  && bottomBorderHit)
               ||
               //or for not-first-view check the top border hit
               ((currentChannelIndex != 0) && currentSubviewIndex == 0 && topBorderHit))
            {
               //depending on which border hit test succeeded on we
               //need to choose a proper target for resizing
               auto it = bottomBorderHit ? currentChannel : currentChannel.advance(-1);
               auto result = std::make_shared<TrackPanelResizeHandle>((*it)->shared_from_this(), py);
               result = AssignUIHandlePtr(mResizeHandle, result);
               results.second.push_back(result);
            }
         }
      }
 
      if ( auto pHandle = SubViewAdjustHandle::HitTest(
         mAdjustHandle,
         *pWaveTrackView, *this, state ) )
         results.second.push_back( pHandle );
      if ( auto pHandle = SubViewRearrangeHandle::HitTest(
         mRearrangeHandle,
         *pWaveTrackView, *this, state ) )
         results.second.push_back( pHandle );
      if (auto pHandle = WaveClipTrimHandle::HitTest(
          mClipTrimHandle,
          *pWaveTrackView, pProject, state))
          results.second.push_back(pHandle);
   }
   if (auto result = CutlineHandle::HitTest(
      mCutlineHandle, state.state, state.rect,
      pProject, wt ))
      // This overriding test applies in all tools
      results.second.push_back(result);
 
   return results;
}

References AssignUIHandlePtr(), TrackList::Channels(), WaveTrackView::DoDetailedHitTest(), CutlineHandle::HitTest(), SubViewAdjustHandle::HitTest(), SubViewCloseHandle::HitTest(), SubViewRearrangeHandle::HitTest(), WaveClipTrimHandle::HitTest(), WaveTrackView::kChannelSeparatorThickness, mAdjustHandle, mClipTrimHandle, mCloseHandle, mCutlineHandle, mRearrangeHandle, mResizeHandle, mwWaveTrackView, TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Referenced by SpectrumView::DetailedHitTest(), and WaveformView::DetailedHitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawBoldBoundaries()

void WaveTrackSubView::DrawBoldBoundaries	(	TrackPanelDrawingContext &	context,
		const WaveTrack *	track,
		const wxRect &	rect
	)

staticprotected

Definition at line 824 of file WaveTrackView.cpp.

{
   auto &dc = context.dc;
   const auto artist = TrackArtist::Get( context );
 
   const auto &zoomInfo = *artist->pZoomInfo;
 
#ifdef EXPERIMENTAL_TRACK_PANEL_HIGHLIGHTING
   auto target2 = dynamic_cast<CutlineHandle*>(context.target.get());
#endif
   for (const auto loc : WaveTrackLocations::Get(*track).Get()) {
      bool highlightLoc = false;
#ifdef EXPERIMENTAL_TRACK_PANEL_HIGHLIGHTING
      highlightLoc =
         target2 && target2->GetTrack().get() == track &&
         target2->GetLocation() == loc;
#endif
      const int xx = zoomInfo.TimeToPosition(loc.pos);
      if (xx >= 0 && xx < rect.width) {
         dc.SetPen( highlightLoc ? AColor::uglyPen : *wxGREY_PEN );
         AColor::Line(dc, (int) (rect.x + xx - 1), rect.y, (int) (rect.x + xx - 1), rect.y + rect.height);
         if (loc.typ == WaveTrackLocation::locationCutLine) {
            dc.SetPen( highlightLoc ? AColor::uglyPen : *wxRED_PEN );
         }
         else {
#ifdef EXPERIMENTAL_DA
            // JKC Black does not show up enough.
            dc.SetPen(highlightLoc ? AColor::uglyPen : *wxWHITE_PEN);
#else
            dc.SetPen(highlightLoc ? AColor::uglyPen : *wxBLACK_PEN);
#endif
         }
         AColor::Line(dc, (int) (rect.x + xx), rect.y, (int) (rect.x + xx), rect.y + rect.height);
         dc.SetPen( highlightLoc ? AColor::uglyPen : *wxGREY_PEN );
         AColor::Line(dc, (int) (rect.x + xx + 1), rect.y, (int) (rect.x + xx + 1), rect.y + rect.height);
      }
   }
}

References TrackPanelDrawingContext::dc, WaveTrackLocations::Get(), TrackArtist::Get(), CutlineHandle::GetTrack(), AColor::Line(), WaveTrackLocation::locationCutLine, TrackPanelDrawingContext::target, and AColor::uglyPen.

Referenced by SpectrumView::DoDraw(), and WaveformView::DoDraw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMenuItems()

auto WaveTrackSubView::GetMenuItems	(	const wxRect &	rect,
		const wxPoint *	pPosition,
		AudacityProject *	pProject
	)

overrideprotectedvirtual

Return a list of items for DoContextMenu() (empties for separators)

If the vector is empty (as in the default), there is no context menu.

Commands are invoked with temporary selection fields of CommandContext set to a point selected region at the mouse pick, and the cell's track.

A function may be given, but if it is null, then the command can be found by name in the CommandManager.

An item in the list with no command name marks a menu separator.

The menu item is enabled only if it contains a true flag, but if looked up in the command manager, it must also satisfy the command manager's conditions.

Reimplemented from CommonTrackPanelCell.

Definition at line 870 of file WaveTrackView.cpp.

{
   const WaveClip *pClip = nullptr;
   auto pTrack = static_cast<WaveTrack*>( FindTrack().get() );
   double time = 0.0;
   if ( pTrack && pPosition ) {
      auto &viewInfo = ViewInfo::Get(*pProject);
      time = viewInfo.PositionToTime( pPosition->x, rect.x );
      pClip = pTrack->GetClipAtTime( time );
   }
 
   if (pClip)
      return {
         { L"Cut", XO("Cut") },
         { L"Copy", XO("Copy") },
         { L"Paste", XO("Paste")  },
         {},
         { L"Split", XO("Split Clip") },
         { L"TrackMute", XO("Mute/Unmute Track") },
         {},
         { L"RenameClip", XO("Rename Clip...") },
      };
   else
      return {
         { L"Paste", XO("Paste")  },
         {},
         { L"TrackMute", XO("Mute/Unmute Track") },
      };
}

References anonymous_namespace{TrackPanel.cpp}::FindTrack(), ViewInfo::Get(), and XO().

Here is the call graph for this function:

◆ GetWaveTrackView()

std::weak_ptr< WaveTrackView > WaveTrackSubView::GetWaveTrackView ( ) const

protected

Definition at line 865 of file WaveTrackView.cpp.

{
   return mwWaveTrackView;
}

References mwWaveTrackView.

Referenced by SpectrumView::Draw(), and WaveformView::Draw().

Here is the caller graph for this function:

◆ SubViewType()

virtual const Type & WaveTrackSubView::SubViewType ( ) const

pure virtual

Implemented in SpectrumView, and WaveformView.

Referenced by WaveTrackView::DoSetDisplay(), WaveTrackView::GetDisplays(), and WaveTrackView::ToggleSubView().

Here is the caller graph for this function:

Member Data Documentation

◆ mAdjustHandle

std::weak_ptr<SubViewAdjustHandle> WaveTrackSubView::mAdjustHandle

private

Definition at line 80 of file WaveTrackView.h.

Referenced by DoDetailedHitTest().

◆ mChannel

const size_t WaveTrackSubView::mChannel

protected

Definition at line 75 of file WaveTrackView.h.

Referenced by WaveformView::Draw().

◆ mClipTrimHandle

std::weak_ptr<WaveClipTrimHandle> WaveTrackSubView::mClipTrimHandle

private

Definition at line 82 of file WaveTrackView.h.

Referenced by DoDetailedHitTest().

◆ mCloseHandle

std::weak_ptr<SubViewCloseHandle> WaveTrackSubView::mCloseHandle

private

Definition at line 78 of file WaveTrackView.h.

Referenced by DoDetailedHitTest().

◆ mCutlineHandle

std::weak_ptr<CutlineHandle> WaveTrackSubView::mCutlineHandle

private

Definition at line 83 of file WaveTrackView.h.

Referenced by DoDetailedHitTest().

◆ mRearrangeHandle

std::weak_ptr<SubViewRearrangeHandle> WaveTrackSubView::mRearrangeHandle

private

Definition at line 81 of file WaveTrackView.h.

Referenced by DoDetailedHitTest().

◆ mResizeHandle

std::weak_ptr<TrackPanelResizeHandle> WaveTrackSubView::mResizeHandle

private

Definition at line 79 of file WaveTrackView.h.

Referenced by DoDetailedHitTest().

◆ mwWaveTrackView

std::weak_ptr<WaveTrackView> WaveTrackSubView::mwWaveTrackView

private

Definition at line 84 of file WaveTrackView.h.

Referenced by DoDetailedHitTest(), GetWaveTrackView(), and WaveTrackSubView().

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

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Display

◆ Type

Constructor & Destructor Documentation

◆ WaveTrackSubView()

Member Function Documentation

◆ CopyToSubView()

◆ DoDetailedHitTest()

◆ DrawBoldBoundaries()

◆ GetMenuItems()

◆ GetWaveTrackView()

◆ SubViewType()

Member Data Documentation

◆ mAdjustHandle

◆ mChannel

◆ mClipTrimHandle

◆ mCloseHandle

◆ mCutlineHandle

◆ mRearrangeHandle

◆ mResizeHandle

◆ mwWaveTrackView