TimeTrackVRulerControls Class Reference

#include <TimeTrackVRulerControls.h>

Inheritance diagram for TimeTrackVRulerControls:

Collaboration diagram for TimeTrackVRulerControls:

Public Member Functions
	TimeTrackVRulerControls (const std::shared_ptr< ChannelView > &pChannelView)
	~TimeTrackVRulerControls ()
std::shared_ptr< TimeTrack >	FindTimeTrack ()
std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *) override
Public Member Functions inherited from ChannelVRulerControls
	ChannelVRulerControls (const std::shared_ptr< ChannelView > &pChannelView)
virtual	~ChannelVRulerControls ()=0
std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject) override
virtual void	UpdateRuler (const wxRect &rect)=0
std::shared_ptr< const ChannelView >	GetChannelView () const
Public Member Functions inherited from CommonChannelCell
	CommonChannelCell (const std::shared_ptr< Channel > &pChannel)
	Construct from a channel. More...
	~CommonChannelCell ()
std::shared_ptr< Track >	DoFindTrack () override
void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel) override
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
template<typename Subtype = Channel>
auto	FindChannel () -> std::shared_ptr< Subtype >
	May return null. More...
template<typename Subtype = const Channel>
auto	FindChannel () const -> std::enable_if_t< std::is_const_v< Subtype >, std::shared_ptr< Subtype > >
	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 ChannelAttachment
virtual	~ChannelAttachment ()
virtual void	CopyTo (Track &track, size_t iChannel) const
	Copy state, for undo/redo purposes. More...
virtual void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel)
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
virtual void	WriteXMLAttributes (XMLWriter &writer, size_t iChannel) const
	Serialize persistent attributes. More...
virtual bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView, size_t iChannel)
	Deserialize an attribute, returning true if recognized. More...

Private Member Functions
	TimeTrackVRulerControls (const TimeTrackVRulerControls &)=delete
TimeTrackVRulerControls &	operator= (const TimeTrackVRulerControls &)=delete
void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override
void	UpdateRuler (const wxRect &rect) override

Private Attributes
std::weak_ptr< TimeTrackVZoomHandle >	mVZoomHandle

Additional Inherited Members
Static Public Member Functions inherited from ChannelVRulerControls
static ChannelVRulerControls &	Get (ChannelView &)
static const ChannelVRulerControls &	Get (const ChannelView &)
static void	DrawZooming (TrackPanelDrawingContext &context, const wxRect &rect, int zoomStart, int zoomEnd)
static wxRect	ZoomingArea (const wxRect &rect, const wxRect &panelRect)
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)
Protected Member Functions inherited from ChannelVRulerControls
std::shared_ptr< Track >	DoFindTrack () override
void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override
wxRect	DrawingArea (TrackPanelDrawingContext &, const wxRect &rect, const wxRect &panelRect, unsigned iPass) override
Track *	GetTrack () const
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 ChannelVRulerControls
std::weak_ptr< ChannelView >	mwChannelView

Detailed Description

Definition at line 21 of file TimeTrackVRulerControls.h.

Constructor & Destructor Documentation

TimeTrackVRulerControls() [1/2]

TimeTrackVRulerControls::TimeTrackVRulerControls ( const TimeTrackVRulerControls &  )

privatedelete

TimeTrackVRulerControls() [2/2]

TimeTrackVRulerControls::TimeTrackVRulerControls ( const std::shared_ptr< ChannelView > &  pChannelView )

inlineexplicit

Definition at line 28 of file TimeTrackVRulerControls.h.

      : ChannelVRulerControls{ pChannelView } {}

~TimeTrackVRulerControls()

TimeTrackVRulerControls::~TimeTrackVRulerControls

(

)

Definition at line 33 of file TimeTrackVRulerControls.cpp.

{
}

Member Function Documentation

Draw()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 73 of file TimeTrackVRulerControls.cpp.

{
   ChannelVRulerControls::Draw(context, rect_, iPass);
 
   // Draw on a later pass because the bevel overpaints one pixel
   // out of bounds on the bottom
 
   if (iPass == TrackArtist::PassControls) {
      auto t = FindTimeTrack();
      if (!t)
         return;
 
      auto rect = rect_;
      --rect.width;
      --rect.height;
 
      auto dc = &context.dc;
      wxRect bev = rect;
      bev.Inflate(-1, 0);
      bev.width += 1;
      AColor::BevelTrackInfo(*dc, true, bev);
 
      // Right align the ruler
      wxRect rr = rect;
      rr.width--;
      const auto &size =
         ChannelView::Get(*static_cast<TimeTrack*>(t.get())).vrulerSize;
      if (size.first < rect.GetWidth()) {
         int adj = rr.GetWidth() - size.first;
         rr.x += adj;
         rr.width -= adj;
      }
      
      UpdateRuler(rr);
 
      auto vruler = &ruler();
 
      vruler->SetTickColour(theTheme.Colour(clrTrackPanelText));
      vruler->Draw(*dc);
   }
}

References AColor::BevelTrackInfo(), ThemeBase::Colour(), TrackPanelDrawingContext::dc, ChannelVRulerControls::Draw(), FindTimeTrack(), ChannelView::Get(), TrackArtist::PassControls, anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler(), size, theTheme, UpdateRuler(), and ChannelView::vrulerSize.

Here is the call graph for this function:

FindTimeTrack()

std::shared_ptr< TimeTrack > TimeTrackVRulerControls::FindTimeTrack

(

)

Definition at line 37 of file TimeTrackVRulerControls.cpp.

{
   return FindChannel<TimeTrack>();
}

Referenced by Draw(), HitTest(), and UpdateRuler().

Here is the caller graph for this function:

HitTest()

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

overridevirtual

Implements TrackPanelCell.

Definition at line 52 of file TimeTrackVRulerControls.cpp.

{
   std::vector<UIHandlePtr> results;
 
   if ( st.state.GetX() <= st.rect.GetRight() - kGuard ) {
      if (const auto pTrack = FindTimeTrack()) {
         auto result = std::make_shared<TimeTrackVZoomHandle>(
            pTrack, st.rect, st.state.m_y );
         result = AssignUIHandlePtr(mVZoomHandle, result);
         results.push_back(result);
      }
   }
 
   auto more = ChannelVRulerControls::HitTest(st, pProject);
   std::copy(more.begin(), more.end(), std::back_inserter(results));
 
   return results;
}

References AssignUIHandlePtr(), staffpad::vo::copy(), FindTimeTrack(), ChannelVRulerControls::HitTest(), kGuard, mVZoomHandle, TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Here is the call graph for this function:

operator=()

TimeTrackVRulerControls & TimeTrackVRulerControls::operator= ( const TimeTrackVRulerControls &  )

privatedelete

UpdateRuler()

void TimeTrackVRulerControls::UpdateRuler ( const wxRect &  rect )

overrideprivatevirtual

Implements ChannelVRulerControls.

Definition at line 117 of file TimeTrackVRulerControls.cpp.

{
   const auto tt = FindTimeTrack();
   if (!tt)
      return;
   auto vruler = &ruler();
 
   float min, max;
   min = tt->GetRangeLower() * 100.0;
   max = tt->GetRangeUpper() * 100.0;
 
   vruler->SetDbMirrorValue( 0.0 );
   vruler->SetBounds(
      rect.x, rect.y, rect.x + rect.width, rect.y + rect.height - 1);
   vruler->SetOrientation(wxVERTICAL);
   vruler->SetRange(max, min);
   vruler->SetFormat(tt->GetDisplayLog()
      ? &RealFormat::LogInstance()
      : &RealFormat::LinearInstance());
   vruler->SetUnits({});
   vruler->SetLabelEdges(false);
   if (tt->GetDisplayLog())
      vruler->SetUpdater(&LogarithmicUpdater::Instance());
   else
      vruler->SetUpdater(&LinearUpdater::Instance());
 
   auto &size = ChannelView::Get(*tt).vrulerSize;
   vruler->GetMaxSize(&size.first, &size.second);
}

References FindTimeTrack(), ChannelView::Get(), LinearUpdater::Instance(), LogarithmicUpdater::Instance(), RealFormat::LinearInstance(), RealFormat::LogInstance(), min(), anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler(), size, and ChannelView::vrulerSize.

Referenced by Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mVZoomHandle

std::weak_ptr<TimeTrackVZoomHandle> TimeTrackVRulerControls::mVZoomHandle

private

Definition at line 48 of file TimeTrackVRulerControls.h.

Referenced by HitTest().

---

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

• TimeTrackVRulerControls.h
• TimeTrackVRulerControls.cpp