#include <NoteTrackControls.h>

Inheritance diagram for NoteTrackControls:

Collaboration diagram for NoteTrackControls:

Public Member Functions
	NoteTrackControls (std::shared_ptr< Track > pTrack)

	~NoteTrackControls ()

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	DefaultNoteTrackHeight ()

static void	GetMidiControlsRect (const wxRect &rect, wxRect &dest)

static void	GetVelocityRect (const wxRect &rect, wxRect &dest)

static LWSlider *	VelocitySlider (const wxRect &sliderRect, const NoteTrack t, bool captured, wxWindow pParent)

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
	NoteTrackControls (const NoteTrackControls &)=delete

NoteTrackControls &	operator= (const NoteTrackControls &)=delete

Static Private Member Functions
static void	ReCreateVelocitySlider (struct ThemeChangeMessage)

Private Attributes
std::weak_ptr< MuteButtonHandle >	mMuteHandle

std::weak_ptr< SoloButtonHandle >	mSoloHandle

std::weak_ptr< NoteTrackButtonHandle >	mClickHandle

std::weak_ptr< VelocitySliderHandle >	mVelocityHandle

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 NoteTrackControls.h.

Constructor & Destructor Documentation

◆ NoteTrackControls() [1/2]

NoteTrackControls::NoteTrackControls ( const NoteTrackControls & )

privatedelete

◆ NoteTrackControls() [2/2]

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

inlineexplicit

Definition at line 40 of file NoteTrackControls.h.

41 : PlayableTrackControls( pTrack ) {}

PlayableTrackControls

Definition: PlayableTrackControls.h:21

◆ ~NoteTrackControls()

NoteTrackControls::~NoteTrackControls ( )

Definition at line 33 of file NoteTrackControls.cpp.

34{

35}

Member Function Documentation

◆ DefaultNoteTrackHeight()

unsigned NoteTrackControls::DefaultNoteTrackHeight ( )

static

Definition at line 336 of file NoteTrackControls.cpp.

{
   return CommonTrackInfo::DefaultTrackHeight( noteTrackTCPLines );
}

References CommonTrackInfo::DefaultTrackHeight(), and noteTrackTCPLines.

Here is the call graph for this function:

◆ GetMenuExtension()

PopupMenuTable * NoteTrackControls::GetMenuExtension ( Track * pTrack )

overridevirtual

Implements CommonTrackControls.

Definition at line 129 of file NoteTrackControls.cpp.

{
#if defined(USE_MIDI)
   return &NoteTrackMenuTable::Instance();
#else
   return NULL;
#endif
}

References NoteTrackMenuTable::Instance().

Here is the call graph for this function:

◆ GetMidiControlsRect()

void NoteTrackControls::GetMidiControlsRect	(	const wxRect &	rect,
		wxRect &	dest
	)

static

Definition at line 326 of file NoteTrackControls.cpp.

{
   const auto rect = wxRect(rect_).Deflate(CommonTrackInfo::Margin);
   GetMidiControlsHorizontalBounds( rect, dest );
   const auto results = TrackInfo::CalcItemY(
      noteTrackTCPLines, TCPLine::kItemMidiControlsRect );
   dest.y = rect.y + results.first;
   dest.height = results.second;
}

References TrackInfo::CalcItemY(), anonymous_namespace{NoteTrackControls.cpp}::GetMidiControlsHorizontalBounds(), TrackInfo::TCPLine::kItemMidiControlsRect, CommonTrackInfo::Margin, and noteTrackTCPLines.

Referenced by NoteTrackButtonHandle::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTCPLines()

const TCPLines & NoteTrackControls::GetTCPLines ( ) const

overridevirtual

Implements TrackControls.

Definition at line 341 of file NoteTrackControls.cpp.

{
   return noteTrackTCPLines;
};

References noteTrackTCPLines.

◆ GetVelocityRect()

void NoteTrackControls::GetVelocityRect	(	const wxRect &	rect,
		wxRect &	dest
	)

static

Definition at line 317 of file NoteTrackControls.cpp.

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

References TrackInfo::CalcItemY(), CommonTrackInfo::GetSliderHorizontalBounds(), TrackInfo::TCPLine::kItemVelocity, CommonTrackInfo::Margin, and noteTrackTCPLines.

Referenced by VelocitySliderHandle::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HitTest()

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

overridevirtual

Implements CommonTrackControls.

Definition at line 37 of file NoteTrackControls.cpp.

{
   // Hits are mutually exclusive, results single
   std::vector<UIHandlePtr> results;
   const wxMouseState &state = st.state;
   const wxRect &rect = st.rect;
   if (state.ButtonIsDown(wxMOUSE_BTN_ANY)) {
      auto track = std::static_pointer_cast<NoteTrack>(FindTrack());
      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 = VelocitySliderHandle::HitTest(
            mVelocityHandle, state, rect, track)))
            return result;
         if (NULL != (result = NoteTrackButtonHandle::HitTest(
            mClickHandle, 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(), MuteButtonHandle::HitTest(), NoteTrackButtonHandle::HitTest(), SoloButtonHandle::HitTest(), VelocitySliderHandle::HitTest(), mClickHandle, mMuteHandle, mSoloHandle, mVelocityHandle, TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Here is the call graph for this function:

◆ operator=()

NoteTrackControls & NoteTrackControls::operator= ( const NoteTrackControls & )

privatedelete

◆ ReCreateVelocitySlider()

void NoteTrackControls::ReCreateVelocitySlider ( struct ThemeChangeMessage message )

staticprivate

Definition at line 375 of file NoteTrackControls.cpp.

{
   if (message.appearance)
      return;
 
   const auto sliderRect = wxRect(0, 0, kTrackInfoSliderWidth, kTrackInfoSliderHeight);
 
   /* i18n-hint: Title of the Velocity slider, used to adjust the volume of note tracks */
   gVelocity = std::make_unique<LWSlider>(nullptr, XO("Velocity"),
      wxPoint(sliderRect.x, sliderRect.y),
      wxSize(sliderRect.width, sliderRect.height),
      VEL_SLIDER);
   gVelocity->SetDefaultValue(0.0);
   gVelocityCaptured = std::make_unique<LWSlider>(nullptr, XO("Velocity"),
      wxPoint(sliderRect.x, sliderRect.y),
      wxSize(sliderRect.width, sliderRect.height),
      VEL_SLIDER);
   gVelocityCaptured->SetDefaultValue(0.0);
}

References ThemeChangeMessage::appearance, anonymous_namespace{NoteTrackControls.cpp}::gVelocity, anonymous_namespace{NoteTrackControls.cpp}::gVelocityCaptured, kTrackInfoSliderHeight, kTrackInfoSliderWidth, VEL_SLIDER, and XO().

Referenced by VelocitySlider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VelocitySlider()

LWSlider * NoteTrackControls::VelocitySlider	(	const wxRect &	sliderRect,
		const NoteTrack *	t,
		bool	captured,
		wxWindow *	pParent
	)

static

Definition at line 355 of file NoteTrackControls.cpp.

{
   static std::once_flag flag;
   std::call_once( flag, []{ ReCreateVelocitySlider({}); });
   static auto subscription = theTheme.Subscribe(ReCreateVelocitySlider);
 
   wxPoint pos = sliderRect.GetPosition();
   float velocity = t ? t->GetVelocity() : 0.0;
 
   gVelocity->Move(pos);
   gVelocity->Set(velocity);
   gVelocityCaptured->Move(pos);
   gVelocityCaptured->Set(velocity);
 
   auto slider = (captured ? gVelocityCaptured : gVelocity).get();
   slider->SetParent( pParent );
   return slider;
}

References flag, NoteTrack::GetVelocity(), anonymous_namespace{NoteTrackControls.cpp}::gVelocity, anonymous_namespace{NoteTrackControls.cpp}::gVelocityCaptured, ReCreateVelocitySlider(), Observer::Publisher< Message, NotifyAll >::Subscribe(), anonymous_namespace{LinkUrlHandler.cpp}::subscription, and theTheme.

Referenced by VelocitySliderHandle::HitTest(), and anonymous_namespace{NoteTrackControls.cpp}::VelocitySliderDrawFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mClickHandle

std::weak_ptr<NoteTrackButtonHandle> NoteTrackControls::mClickHandle

private

Definition at line 35 of file NoteTrackControls.h.

Referenced by HitTest().

◆ mMuteHandle

std::weak_ptr<MuteButtonHandle> NoteTrackControls::mMuteHandle

private

Definition at line 33 of file NoteTrackControls.h.

Referenced by HitTest().

◆ mSoloHandle

std::weak_ptr<SoloButtonHandle> NoteTrackControls::mSoloHandle

private

Definition at line 34 of file NoteTrackControls.h.

Referenced by HitTest().

◆ mVelocityHandle

std::weak_ptr<VelocitySliderHandle> NoteTrackControls::mVelocityHandle

private

Definition at line 36 of file NoteTrackControls.h.

Referenced by HitTest().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NoteTrackControls() [1/2]

◆ NoteTrackControls() [2/2]

◆ ~NoteTrackControls()

Member Function Documentation

◆ DefaultNoteTrackHeight()

◆ GetMenuExtension()

◆ GetMidiControlsRect()

◆ GetTCPLines()

◆ GetVelocityRect()

◆ HitTest()

◆ operator=()

◆ ReCreateVelocitySlider()

◆ VelocitySlider()

Member Data Documentation

◆ mClickHandle

◆ mMuteHandle

◆ mSoloHandle

◆ mVelocityHandle