WaveTrackControls Class Reference

#include <WaveTrackControls.h>

Inheritance diagram for WaveTrackControls:

Collaboration diagram for WaveTrackControls:

Public Member Functions
	WaveTrackControls (std::shared_ptr< Track > pTrack)
	~WaveTrackControls () override
std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject) override
PopupMenuTable *	GetMenuExtension (Track *pTrack) override
const TCPLines &	GetTCPLines () const override
Public Member Functions inherited from CommonTrackControls
const TCPLines &	GetTCPLines () const override
	TrackControls (std::shared_ptr< Track > pTrack)
Public Member Functions inherited from TrackControls
	TrackControls (std::shared_ptr< Track > pTrack)
virtual	~TrackControls ()=0
virtual const TrackInfo::TCPLines &	GetTCPLines () const =0
Public Member Functions inherited from CommonTrackCell
	CommonTrackCell (const std::shared_ptr< Track > &pTrack)
	Construct from a track. 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...
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 ()

Static Public Member Functions
static unsigned	DefaultWaveTrackHeight ()
static void	GetVolumeRect (const wxRect &rect, wxRect &dest)
static void	GetPanRect (const wxRect &rect, wxRect &dest)
static LWSlider *	VolumeSlider (CellularPanel &panel, const WaveTrack &wt)
static LWSlider *	VolumeSlider (const wxRect &sliderRect, const WaveTrack *t, bool captured, wxWindow *pParent)
static LWSlider *	PanSlider (CellularPanel &panel, const WaveTrack &wt)
static LWSlider *	PanSlider (const wxRect &sliderRect, const WaveTrack *t, bool captured, wxWindow *pParent)
static void	ReCreateSliders ()
Static Public Member Functions inherited from PlayableTrackControls
static const TCPLines &	StaticNoteTCPLines ()
static const TCPLines &	StaticWaveTCPLines ()
static void	GetMuteSoloRect (const wxRect &rect, wxRect &dest, bool solo, const Track *pTrack)
static void	GetEffectsButtonRect (const wxRect &rect, wxRect &dest, const Track *pTrack)
Static Public Member Functions inherited from TrackControls
static TrackControls &	Get (Track &track)
static const TrackControls &	Get (const Track &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)

Private Member Functions
	WaveTrackControls (const WaveTrackControls &)=delete
WaveTrackControls &	operator= (const WaveTrackControls &)=delete

Static Private Member Functions
static void	ReCreatePanSlider (struct ThemeChangeMessage)
static void	ReCreateVolumeSlider (struct ThemeChangeMessage)

Private Attributes
std::weak_ptr< MuteButtonHandle >	mMuteHandle
std::weak_ptr< SoloButtonHandle >	mSoloHandle
std::weak_ptr< EffectsButtonHandle >	mEffectsHandle
std::weak_ptr< VolumeSliderHandle >	mVolumeHandle
std::weak_ptr< PanSliderHandle >	mPanHandle

Additional Inherited Members
Protected Member Functions inherited from CommonTrackControls
virtual std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *) override=0
unsigned	DoContextMenu (const wxRect &rect, wxWindow *pParent, const wxPoint *pPosition, AudacityProject *pProject) override
virtual PopupMenuTable *	GetMenuExtension (Track *pTrack)=0
void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override
wxRect	DrawingArea (TrackPanelDrawingContext &, const wxRect &rect, const wxRect &panelRect, unsigned iPass) override
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 inherited from CommonTrackControls
std::weak_ptr< CloseButtonHandle >	mCloseHandle
std::weak_ptr< MenuButtonHandle >	mMenuHandle
std::weak_ptr< MinimizeButtonHandle >	mMinimizeHandle
std::weak_ptr< TrackSelectHandle >	mSelectHandle

Detailed Description

Definition at line 28 of file WaveTrackControls.h.

Constructor & Destructor Documentation

WaveTrackControls() [1/2]

WaveTrackControls::WaveTrackControls ( const WaveTrackControls &  )

privatedelete

WaveTrackControls() [2/2]

WaveTrackControls::WaveTrackControls ( std::shared_ptr< Track >  pTrack )

inlineexplicit

Definition at line 35 of file WaveTrackControls.h.

      : PlayableTrackControls( pTrack ) {}

~WaveTrackControls()

WaveTrackControls::~WaveTrackControls ( )

overridedefault

Member Function Documentation

DefaultWaveTrackHeight()

unsigned WaveTrackControls::DefaultWaveTrackHeight ( )

static

Definition at line 1037 of file WaveTrackControls.cpp.

{
   return CommonTrackInfo::DefaultTrackHeight( waveTrackTCPLines );
}

References CommonTrackInfo::DefaultTrackHeight(), and waveTrackTCPLines.

Referenced by DEFINE_ATTACHED_VIRTUAL_OVERRIDE().

Here is the call graph for this function:

Here is the caller graph for this function:

GetMenuExtension()

PopupMenuTable * WaveTrackControls::GetMenuExtension ( Track *  pTrack )

overridevirtual

Implements CommonTrackControls.

Definition at line 925 of file WaveTrackControls.cpp.

{
   static Registry::OrderingPreferenceInitializer init{
      MenuPathStart,
      {
         {wxT("/SubViews/Extra"), wxT("WaveColor,SpectrogramSettings")},
      }
   };
 
   WaveTrackMenuTable & result = WaveTrackMenuTable::Instance();
   return &result;
}

References WaveTrackMenuTable::Instance(), MenuPathStart, and wxT().

Here is the call graph for this function:

GetPanRect()

void WaveTrackControls::GetPanRect ( const wxRect &  rect, wxRect &  dest  )

static

Definition at line 1028 of file WaveTrackControls.cpp.

{
   const auto rect = wxRect(rect_).Deflate(CommonTrackInfo::Margin);
   CommonTrackInfo::GetSliderHorizontalBounds( rect, dest );
   const auto results = CalcItemY( waveTrackTCPLines, TCPLine::kItemPan );
   dest.y = rect.y + results.first;
   dest.height = results.second;
}

References TrackInfo::CalcItemY(), CommonTrackInfo::GetSliderHorizontalBounds(), TrackInfo::TCPLine::kItemPan, CommonTrackInfo::Margin, and waveTrackTCPLines.

Referenced by PanSliderHandle::HitTest(), and PanSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTCPLines()

const TCPLines & WaveTrackControls::GetTCPLines ( ) const

overridevirtual

Implements TrackControls.

Definition at line 1042 of file WaveTrackControls.cpp.

{
   return waveTrackTCPLines;
}

References waveTrackTCPLines.

GetVolumeRect()

void WaveTrackControls::GetVolumeRect ( const wxRect &  rect, wxRect &  dest  )

static

Definition at line 1019 of file WaveTrackControls.cpp.

{
   const auto rect = wxRect(rect_).Deflate(CommonTrackInfo::Margin);
   CommonTrackInfo::GetSliderHorizontalBounds( rect, dest );
   const auto results = CalcItemY( waveTrackTCPLines, TCPLine::kItemVolume );
   dest.y = rect.y + results.first;
   dest.height = results.second;
}

References TrackInfo::CalcItemY(), CommonTrackInfo::GetSliderHorizontalBounds(), TrackInfo::TCPLine::kItemVolume, CommonTrackInfo::Margin, and waveTrackTCPLines.

Referenced by VolumeSliderHandle::HitTest(), and VolumeSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

HitTest()

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

overridevirtual

Implements CommonTrackControls.

Definition at line 53 of file WaveTrackControls.cpp.

{
   // Hits are mutually exclusive, results single
   const wxMouseState &state = st.state;
   const wxRect &rect = st.rect;
   if (state.ButtonIsDown(wxMOUSE_BTN_LEFT)) {
      auto track = FindTrack();
      std::vector<UIHandlePtr> results;
      auto result = [&]{
         UIHandlePtr result;
         if (NULL != (result = MuteButtonHandle::HitTest(
            mMuteHandle, state, rect, pProject, track)))
            return result;
 
         if (NULL != (result = SoloButtonHandle::HitTest(
            mSoloHandle, state, rect, pProject, track)))
            return result;
 
         if (NULL != (result = EffectsButtonHandle::HitTest(
            mEffectsHandle, state, rect, pProject, track)))
            return result;
 
         if (NULL != (result = VolumeSliderHandle::HitTest(
            mVolumeHandle, state, rect, track)))
            return result;
 
         if (NULL != (result = PanSliderHandle::HitTest(
            mPanHandle, state, rect, track)))
            return result;
 
         return result;
      }();
      if (result) {
         results.push_back(result);
         return results;
      }
   }
 
   return PlayableTrackControls::HitTest(st, pProject);
}

References CommonTrackPanelCell::FindTrack(), CommonTrackControls::HitTest(), EffectsButtonHandle::HitTest(), MuteButtonHandle::HitTest(), PanSliderHandle::HitTest(), SoloButtonHandle::HitTest(), VolumeSliderHandle::HitTest(), mEffectsHandle, mMuteHandle, mPanHandle, mSoloHandle, mVolumeHandle, TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Here is the call graph for this function:

operator=()

WaveTrackControls & WaveTrackControls::operator= ( const WaveTrackControls &  )

privatedelete

PanSlider() [1/2]

LWSlider * WaveTrackControls::PanSlider ( CellularPanel &  panel, const WaveTrack &  wt  )

static

Definition at line 1108 of file WaveTrackControls.cpp.

{
   auto &controls = TrackControls::Get( wt );
   auto rect = panel.FindRect( controls );
   wxRect sliderRect;
   GetPanRect( rect, sliderRect );
   return PanSlider( sliderRect, &wt, false,  &panel );
}

References CellularPanel::FindRect(), TrackControls::Get(), GetPanRect(), and PanSlider().

Referenced by PanSliderHandle::HitTest(), anonymous_namespace{TrackMenus.cpp}::OnTrackPan(), anonymous_namespace{TrackMenus.cpp}::OnTrackPanLeft(), anonymous_namespace{TrackMenus.cpp}::OnTrackPanRight(), PanSlider(), and anonymous_namespace{WaveTrackControls.cpp}::PanSliderDrawFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

PanSlider() [2/2]

LWSlider * WaveTrackControls::PanSlider ( const wxRect &  sliderRect, const WaveTrack *  t, bool  captured, wxWindow *  pParent  )

static

Definition at line 1118 of file WaveTrackControls.cpp.

{
   static std::once_flag flag;
   std::call_once( flag, []{ ReCreatePanSlider({}); });
   static auto subscription = theTheme.Subscribe(ReCreatePanSlider);
 
   wxPoint pos = sliderRect.GetPosition();
   float pan = t ? t->GetPan() : 0.0;
 
   gPan->Move(pos);
   gPan->Set(pan);
   gPanCaptured->Move(pos);
   gPanCaptured->Set(pan);
 
   auto slider = (captured ? gPanCaptured : gPan).get();
   slider->SetParent( pParent );
   return slider;
}

References flag, WaveTrack::GetPan(), anonymous_namespace{WaveTrackControls.cpp}::gPan, anonymous_namespace{WaveTrackControls.cpp}::gPanCaptured, ReCreatePanSlider(), Observer::Publisher< Message, NotifyAll >::Subscribe(), anonymous_namespace{LinkUrlHandler.cpp}::subscription, and theTheme.

Here is the call graph for this function:

ReCreatePanSlider()

void WaveTrackControls::ReCreatePanSlider ( struct ThemeChangeMessage  message )

staticprivate

Definition at line 1138 of file WaveTrackControls.cpp.

{
   if (message.appearance)
      return;
 
   const auto sliderRect = wxRect(0, 0, kTrackInfoSliderWidth, kTrackInfoSliderHeight);
 
   float defPos = 0.0;
   /* i18n-hint: Title of the Pan slider, used to move the sound left or right */
   gPan = std::make_unique<LWSlider>(nullptr, XO("Pan"),
                       wxPoint(sliderRect.x, sliderRect.y),
                       wxSize(sliderRect.width, sliderRect.height),
                       PAN_SLIDER);
   gPan->SetDefaultValue(defPos);
 
   gPanCaptured = std::make_unique<LWSlider>(nullptr, XO("Pan"),
                               wxPoint(sliderRect.x, sliderRect.y),
                               wxSize(sliderRect.width, sliderRect.height),
                               PAN_SLIDER);
   gPanCaptured->SetDefaultValue(defPos);
}

References ThemeChangeMessage::appearance, anonymous_namespace{WaveTrackControls.cpp}::gPan, anonymous_namespace{WaveTrackControls.cpp}::gPanCaptured, kTrackInfoSliderHeight, kTrackInfoSliderWidth, PAN_SLIDER, and XO().

Referenced by PanSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

ReCreateSliders()

static void WaveTrackControls::ReCreateSliders ( )

static

ReCreateVolumeSlider()

void WaveTrackControls::ReCreateVolumeSlider ( struct ThemeChangeMessage  message )

staticprivate

Definition at line 1086 of file WaveTrackControls.cpp.

{
   if (message.appearance)
      return;
 
   const auto sliderRect = wxRect(0, 0, kTrackInfoSliderWidth, kTrackInfoSliderHeight);
 
   float defPos = 1.0;
   /* i18n-hint: Title of the Volume slider, used to adjust the volume */
   gVolume = std::make_unique<LWSlider>(nullptr, XO("Volume"),
                        wxPoint(sliderRect.x, sliderRect.y),
                        wxSize(sliderRect.width, sliderRect.height),
                        DB_SLIDER);
   gVolume->SetDefaultValue(defPos);
 
   gVolumeCaptured = std::make_unique<LWSlider>(nullptr, XO("Volume"),
                                wxPoint(sliderRect.x, sliderRect.y),
                                wxSize(sliderRect.width, sliderRect.height),
                                DB_SLIDER);
   gVolumeCaptured->SetDefaultValue(defPos);
}

References ThemeChangeMessage::appearance, DB_SLIDER, anonymous_namespace{WaveTrackControls.cpp}::gVolume, anonymous_namespace{WaveTrackControls.cpp}::gVolumeCaptured, kTrackInfoSliderHeight, kTrackInfoSliderWidth, and XO().

Referenced by VolumeSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

VolumeSlider() [1/2]

LWSlider * WaveTrackControls::VolumeSlider ( CellularPanel &  panel, const WaveTrack &  wt  )

static

Definition at line 1056 of file WaveTrackControls.cpp.

{
   auto &controls = TrackControls::Get( wt );
   const auto rect = panel.FindRect( controls ).Deflate(CommonTrackInfo::Margin);
   wxRect sliderRect;
   GetVolumeRect( rect, sliderRect );
   return VolumeSlider( sliderRect, &wt, false, &panel );
}

References CellularPanel::FindRect(), TrackControls::Get(), GetVolumeRect(), CommonTrackInfo::Margin, and VolumeSlider().

Referenced by VolumeSliderHandle::HitTest(), anonymous_namespace{TrackMenus.cpp}::OnTrackGain(), anonymous_namespace{TrackMenus.cpp}::OnTrackGainDec(), anonymous_namespace{TrackMenus.cpp}::OnTrackGainInc(), VolumeSlider(), and anonymous_namespace{WaveTrackControls.cpp}::VolumeSliderDrawFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

VolumeSlider() [2/2]

LWSlider * WaveTrackControls::VolumeSlider ( const wxRect &  sliderRect, const WaveTrack *  t, bool  captured, wxWindow *  pParent  )

static

Definition at line 1066 of file WaveTrackControls.cpp.

{
   static std::once_flag flag;
   std::call_once( flag, []{ ReCreateVolumeSlider({}); });
   static auto subscription = theTheme.Subscribe(ReCreateVolumeSlider);
 
   wxPoint pos = sliderRect.GetPosition();
   float volume = t ? t->GetVolume() : 1.0;
 
   gVolume->Move(pos);
   gVolume->Set(volume);
   gVolumeCaptured->Move(pos);
   gVolumeCaptured->Set(volume);
 
   auto slider = (captured ? gVolumeCaptured : gVolume).get();
   slider->SetParent( pParent );
   return slider;
}

References flag, WaveTrack::GetVolume(), anonymous_namespace{WaveTrackControls.cpp}::gVolume, anonymous_namespace{WaveTrackControls.cpp}::gVolumeCaptured, ReCreateVolumeSlider(), Observer::Publisher< Message, NotifyAll >::Subscribe(), anonymous_namespace{LinkUrlHandler.cpp}::subscription, and theTheme.

Here is the call graph for this function:

Member Data Documentation

mEffectsHandle

std::weak_ptr<EffectsButtonHandle> WaveTrackControls::mEffectsHandle

private

Definition at line 69 of file WaveTrackControls.h.

Referenced by HitTest().

mMuteHandle

std::weak_ptr<MuteButtonHandle> WaveTrackControls::mMuteHandle

private

Definition at line 67 of file WaveTrackControls.h.

Referenced by HitTest().

mPanHandle

std::weak_ptr<PanSliderHandle> WaveTrackControls::mPanHandle

private

Definition at line 71 of file WaveTrackControls.h.

Referenced by HitTest().

mSoloHandle

std::weak_ptr<SoloButtonHandle> WaveTrackControls::mSoloHandle

private

Definition at line 68 of file WaveTrackControls.h.

Referenced by HitTest().

mVolumeHandle

std::weak_ptr<VolumeSliderHandle> WaveTrackControls::mVolumeHandle

private

Definition at line 70 of file WaveTrackControls.h.

Referenced by HitTest().

---

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

• WaveTrackControls.h
• WaveTrackControls.cpp