#include <WaveformView.h>

Inheritance diagram for WaveformView:

Collaboration diagram for WaveformView:

Public Member Functions
	~WaveformView () override

const Type &	SubViewType () const override

std::shared_ptr< ChannelVRulerControls >	DoGetVRulerControls () override

	WaveChannelSubView (WaveChannelView &waveChannelView)

Public Member Functions inherited from WaveChannelSubView
	WaveChannelSubView (WaveChannelView &waveChannelView)

virtual const Type &	SubViewType () const =0

virtual void	CopyToSubView (WaveChannelSubView *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 CommonChannelView
std::shared_ptr< TrackPanelCell >	ContextMenuDelegate () override

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

void	TimeShiftHitTest ()

virtual int	GetMinimizedHeight () const override

	ChannelView (const std::shared_ptr< Track > &pTrack, size_t iChannel)
	Construct from a track and a channel index. More...

Public Member Functions inherited from ChannelView
	ChannelView (const std::shared_ptr< Track > &pTrack, size_t iChannel)
	Construct from a track and a channel index. More...

virtual	~ChannelView ()=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< ChannelVRulerControls >	GetVRulerControls ()

std::shared_ptr< const ChannelVRulerControls >	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, size_t iChannel)
	Construct from a track and a channel index. More...

	CommonTrackCell (ChannelGroup &group, size_t iChannel)
	Construct from a channel group and a channel index. More...

	~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...

size_t	GetChannelIndex () const

std::shared_ptr< Channel >	FindChannel ()
	May return null. More...

std::shared_ptr< const Channel >	FindChannel () const
	May return null. 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 &)=delete

TrackPanelCell &	operator= (const TrackPanelCell &)=delete

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
void	DoSetMinimized (bool minimized) override

Protected Member Functions inherited from WaveChannelSubView
std::weak_ptr< WaveChannelView >	GetWaveChannelView () 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...

virtual std::vector< UIHandlePtr >	DetailedHitTest (const TrackPanelMouseState &, const AudacityProject *pProject, int currentTool, bool bMultiTool)=0

virtual std::shared_ptr< ChannelVRulerControls >	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

Protected Attributes
std::weak_ptr< SampleHandle >	mSampleHandle

std::weak_ptr< EnvelopeHandle >	mEnvelopeHandle

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

Protected Attributes inherited from ChannelView
std::shared_ptr< ChannelVRulerControls >	mpVRulerControls

Private Member Functions
	WaveformView (const WaveformView &)=delete

WaveformView &	operator= (const WaveformView &)=delete

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

std::vector< UIHandlePtr >	DetailedHitTest (const TrackPanelMouseState &state, const AudacityProject *pProject, int currentTool, bool bMultiTool) override

Static Private Member Functions
static void	DoDraw (TrackPanelDrawingContext &context, size_t channel, const WaveTrack &track, const WaveClip *selectedClip, const wxRect &rect, bool muted)

Additional Inherited Members
Public Types inherited from WaveChannelSubView
using	Display = WaveChannelViewConstants::Display

using	Type = WaveChannelSubViewType

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

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

Static Public Member Functions inherited from CommonChannelView
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 ChannelView
static ChannelView &	Get (Channel &channel)

static const ChannelView &	Get (const Channel &channel)

static ChannelView *	Find (Channel *pChannel)

static const ChannelView *	Find (const Channel *pChannel)

static int	GetChannelGroupHeight (const Track *pTrack)

static int	GetCumulativeHeight (const Channel *pChannel)

static int	GetCumulativeHeight (const Track *pTrack)

static int	GetTotalHeight (const TrackList &list)

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 CommonChannelView
std::weak_ptr< TimeShiftHandle >	mTimeShiftHandle

Public Attributes inherited from ChannelView
std::pair< int, int >	vrulerSize

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

Detailed Description

Definition at line 20 of file WaveformView.h.

Constructor & Destructor Documentation

◆ WaveformView()

WaveformView::WaveformView ( const WaveformView & )

privatedelete

◆ ~WaveformView()

WaveformView::~WaveformView ( )

overridedefault

Member Function Documentation

◆ DetailedHitTest()

std::vector< UIHandlePtr > WaveformView::DetailedHitTest	(	const TrackPanelMouseState &	state,
		const AudacityProject *	pProject,
		int	currentTool,
		bool	bMultiTool
	)

overrideprivatevirtual

Implements CommonChannelView.

Definition at line 52 of file WaveformView.cpp.

{
   auto &view = *this;
   const auto pTrack =
      std::static_pointer_cast< WaveTrack >( view.FindTrack() );
 
   auto pair = WaveChannelSubView::DoDetailedHitTest(
      st, pProject, currentTool, bMultiTool, pTrack);
   auto &results = pair.second;
 
   if (!pair.first) {
      UIHandlePtr result;
 
      if (bMultiTool) {
         // Conditional hit tests
         // If Tools toolbar were eliminated, we would keep these
         // The priority of these, in case more than one might apply at one
         // point, seems arbitrary
         if (NULL != (result = EnvelopeHandle::WaveTrackHitTest(
            view.mEnvelopeHandle, st.state, st.rect,
            pProject, pTrack )))
            results.push_back(result);
         if (NULL != (result = TimeShiftHandle::HitTest(
            view.mTimeShiftHandle, st.state, st.rect, pTrack )))
            // This is the hit test on the "grips" drawn left and
            // right in Multi only
            results.push_back(result);
         if (NULL != (result = SampleHandle::HitTest(
            view.mSampleHandle, st.state, st.rect,
            pProject, pTrack )))
            results.push_back(result);
      }
      else {
         switch ( currentTool ) {
               // Unconditional hits appropriate to the tool
               // If tools toolbar were eliminated, we would eliminate these
            case ToolCodes::envelopeTool: {
               auto &viewInfo = ViewInfo::Get(*pProject);
               auto time =
                  viewInfo.PositionToTime(st.state.m_x, st.rect.GetX());
               auto envelope = pTrack->GetEnvelopeAtTime(time);
               result = EnvelopeHandle::HitAnywhere(
                  view.mEnvelopeHandle, envelope,
                  std::dynamic_pointer_cast<const Channel>(pTrack),
                  false);
               break;
            }
            case ToolCodes::drawTool:
               result = SampleHandle::HitAnywhere(
                  view.mSampleHandle, st.state, pTrack );
               break;
            default:
               result = {};
               break;
         }
         if (result)
            results.push_back(result);
      }
   }
 
   return std::move( results );
}

References WaveChannelSubView::DoDetailedHitTest(), ToolCodes::drawTool, ToolCodes::envelopeTool, ViewInfo::Get(), EnvelopeHandle::HitAnywhere(), SampleHandle::HitAnywhere(), SampleHandle::HitTest(), TimeShiftHandle::HitTest(), TrackPanelMouseState::rect, TrackPanelMouseState::state, and EnvelopeHandle::WaveTrackHitTest().

Here is the call graph for this function:

◆ DoDraw()

void WaveformView::DoDraw	(	TrackPanelDrawingContext &	context,
		size_t	channel,
		const WaveTrack &	track,
		const WaveClip *	selectedClip,
		const wxRect &	rect,
		bool	muted
	)

staticprivate

Definition at line 946 of file WaveformView.cpp.

{
   auto &dc = context.dc;
   const auto artist = TrackArtist::Get( context );
 
   bool highlight = false;
   bool gripHit = false;
#ifdef EXPERIMENTAL_TRACK_PANEL_HIGHLIGHTING
   auto target = dynamic_cast<TimeShiftHandle*>(context.target.get());
   gripHit = target && target->IsGripHit();
   highlight = target && target->GetTrack().get() == &track;
#endif
 
   const bool dB = !WaveformSettings::Get(track).isLinear();
 
   const auto &blankSelectedBrush = artist->blankSelectedBrush;
   const auto &blankBrush = artist->blankBrush;
   TrackArt::DrawBackgroundWithSelection(
      context, rect, &track, blankSelectedBrush, blankBrush );
 
   // Really useful channel numbers are not yet passed in
   // TODO wide wave tracks -- really use channel
   assert(channel == 0);
   channel = (track.IsLeader() ? 0 : 1);
 
   // TODO wide wave tracks -- remove this workaround
   auto pLeader = *track.GetHolder()->Find(&track);
   assert(pLeader->IsLeader());
 
   for (const auto pInterval :
      static_cast<const WaveTrack*>(pLeader)->GetChannel(channel)->Intervals()
   ) {
      DrawClipWaveform(context, track, *pInterval, rect,
         dB, muted, (&pInterval->GetClip() == selectedClip));
   }
   DrawBoldBoundaries(context, track, rect);
 
   const auto drawSliders = artist->drawSliders;
   if (drawSliders) {
      DrawTimeSlider( context, rect, true, highlight && gripHit );  // directed right
      DrawTimeSlider( context, rect, false, highlight && gripHit ); // directed left
   }
}

References TrackPanelDrawingContext::dc, TrackArt::DrawBackgroundWithSelection(), WaveChannelSubView::DrawBoldBoundaries(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), anonymous_namespace{WaveformView.cpp}::DrawTimeSlider(), TrackList::Find(), WaveformSettings::Get(), TrackArtist::Get(), Track::GetHolder(), TimeShiftHandle::IsGripHit(), WaveTrack::IsLeader(), WaveformSettings::isLinear(), and TrackPanelDrawingContext::target.

Referenced by Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGetVRulerControls()

std::shared_ptr< ChannelVRulerControls > WaveformView::DoGetVRulerControls ( )

overridevirtual

Implements ChannelView.

Definition at line 144 of file WaveformView.cpp.

{
   return std::make_shared<WaveformVRulerControls>(shared_from_this());
}

◆ DoSetMinimized()

void WaveformView::DoSetMinimized ( bool minimized )

overrideprotectedvirtual

Reimplemented from ChannelView.

Definition at line 117 of file WaveformView.cpp.

{
   auto wt = static_cast<WaveTrack*>( FindTrack().get() );
 
#ifdef EXPERIMENTAL_HALF_WAVE
   bool bHalfWave;
   gPrefs->Read(wxT("/GUI/CollapseToHalfWave"), &bHalfWave, false);
   if( bHalfWave )
   {
      auto &cache = WaveformScale::Get(*wt);
      if (minimized)
         // Zoom to show fractionally more than the top half of the wave.
         cache.SetDisplayBounds( -0.01f, 1.0f );
      else
         // Zoom out full
         cache.SetDisplayBounds( -1.0f, 1.0f );
   }
#endif
 
   ChannelView::DoSetMinimized(minimized);
}

References ChannelView::DoSetMinimized(), CommonTrackPanelCell::FindTrack(), WaveformScale::Get(), gPrefs, audacity::BasicSettings::Read(), and wxT().

Here is the call graph for this function:

◆ Draw()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 994 of file WaveformView.cpp.

{
   if ( iPass == TrackArtist::PassTracks ) {
      auto &dc = context.dc;
 
      const auto wt = std::static_pointer_cast<const WaveTrack>(
         FindTrack()->SubstitutePendingChangedTrack());
 
      const auto artist = TrackArtist::Get( context );
      const auto hasSolo = artist->hasSolo;
      bool muted = (hasSolo || wt->GetMute()) &&
      !wt->GetSolo();
 
#if defined(__WXMAC__)
      wxAntialiasMode aamode = dc.GetGraphicsContext()->GetAntialiasMode();
      dc.GetGraphicsContext()->SetAntialiasMode(wxANTIALIAS_NONE);
#endif
 
      auto waveChannelView = GetWaveChannelView().lock();
      wxASSERT(waveChannelView.use_count());
 
      auto selectedClip = waveChannelView->GetSelectedClip().lock();
      DoDraw(context, GetChannelIndex(), *wt, selectedClip.get(), rect, muted);
 
#if defined(__WXMAC__)
      dc.GetGraphicsContext()->SetAntialiasMode(aamode);
#endif
   }
   WaveChannelSubView::Draw(context, rect, iPass);
}

References TrackPanelDrawingContext::dc, DoDraw(), TrackPanelDrawable::Draw(), CommonTrackPanelCell::FindTrack(), TrackArtist::Get(), CommonTrackCell::GetChannelIndex(), WaveChannelSubView::GetWaveChannelView(), and TrackArtist::PassTracks.

Here is the call graph for this function:

◆ operator=()

WaveformView & WaveformView::operator= ( const WaveformView & )

privatedelete

◆ SubViewType()

auto WaveformView::SubViewType ( ) const

overridevirtual

Implements WaveChannelSubView.

Definition at line 139 of file WaveformView.cpp.

{
   return sType;
}

References sType.

◆ WaveChannelSubView()

WaveChannelSubView::WaveChannelSubView ( WaveChannelView & waveChannelView )

explicit

Definition at line 49 of file WaveChannelView.cpp.

   : CommonChannelView{
      waveChannelView.FindTrack(), waveChannelView.GetChannelIndex() }
{
   mwWaveChannelView = std::static_pointer_cast<WaveChannelView>(
      waveChannelView.shared_from_this() );
}

Member Data Documentation

◆ mEnvelopeHandle

std::weak_ptr<EnvelopeHandle> WaveformView::mEnvelopeHandle

protected

Definition at line 54 of file WaveformView.h.

◆ mSampleHandle

std::weak_ptr<SampleHandle> WaveformView::mSampleHandle

protected

Definition at line 53 of file WaveformView.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WaveformView()

◆ ~WaveformView()

Member Function Documentation

◆ DetailedHitTest()

◆ DoDraw()

◆ DoGetVRulerControls()

◆ DoSetMinimized()

◆ Draw()

◆ operator=()

◆ SubViewType()

◆ WaveChannelSubView()

Member Data Documentation

◆ mEnvelopeHandle

◆ mSampleHandle