ChannelView.h

Go to the documentation of this file.

/**********************************************************************
 
Audacity: A Digital Audio Editor
 
ChannelView.h
 
Paul Licameli split from class Track
 
**********************************************************************/
 
#ifndef __AUDACITY_TRACK_VIEW__
#define __AUDACITY_TRACK_VIEW__
 
#include <memory>
#include "CommonTrackPanelCell.h" // to inherit
#include "XMLAttributeValueView.h"
 
class Channel;
class ChannelGroup;
class TrackList;
class ChannelVRulerControls;
 
class AUDACITY_DLL_API ChannelView /* not final */ : public CommonChannelCell
   , public std::enable_shared_from_this<ChannelView>
{
   ChannelView(const ChannelView&) = delete;
   ChannelView &operator=(const ChannelView&) = delete;
 
public:
   enum : unsigned { DefaultHeight = 150 };
 
   static ChannelView &Get(Channel &channel);
   static const ChannelView &Get(const Channel &channel);
   static ChannelView *Find(Channel *pChannel);
   static const ChannelView *Find(const Channel *pChannel);
 
   explicit ChannelView(const std::shared_ptr<Channel> &pChannel);
   virtual ~ChannelView() = 0;
 
   void Reparent(const std::shared_ptr<Track> &parent, size_t iChannel)
   override;
 
   // some static conveniences, useful for summation over track iterator
   // ranges
   static int GetChannelGroupHeight(const Track *pTrack);
   // Total height of the given channel and all previous ones (constant time!)
   static int GetCumulativeHeight(const Channel *pChannel);
   // Total height of all Channels of the the given track and all previous ones
   // (constant time!)
   static int GetCumulativeHeight(const Track *pTrack);
   static int GetTotalHeight(const TrackList &list);
 
   // Copy view state, for undo/redo purposes
   void CopyTo(Track &track, size_t iChannel) const override;
 
   bool GetMinimized() const { return mMinimized; }
   void SetMinimized( bool minimized );
 
   int GetCumulativeHeightBefore() const { return mY; }
 
 
   int GetExpandedHeight() const { return mHeight; }
 
 
   virtual int GetMinimizedHeight() const = 0;
 
 
   int GetHeight() const;
 
   void SetCumulativeHeightBefore(int y) { DoSetY( y ); }
 
   void SetExpandedHeight(int height);
 
   // Return another, associated TrackPanelCell object that implements the
   // mouse actions for the vertical ruler
   std::shared_ptr<ChannelVRulerControls> GetVRulerControls();
   std::shared_ptr<const ChannelVRulerControls> GetVRulerControls() const;
 
   // Returns cell that would be used at affordance area, by default returns nullptr,
   // meaning that track has no such area.
   virtual std::shared_ptr<CommonTrackCell> GetAffordanceControls();
 
   void WriteXMLAttributes(XMLWriter &writer, size_t iChannel) const override;
   bool HandleXMLAttribute(
      const std::string_view& attr, const XMLAttributeValueView& valueView,
      size_t iChannel) override;
 
   // New virtual function.  The default just returns a one-element array
   // containing this.  Overrides might refine the Y axis.
   using Refinement = std::vector<
      std::pair<wxCoord, std::shared_ptr<ChannelView>>
   >;
   virtual Refinement GetSubViews( const wxRect &rect );
 
   // default is false
   virtual bool IsSpectral() const;
 
   virtual void DoSetMinimized( bool isMinimized );
 
   mutable std::pair<int, int> vrulerSize;
 
private:
   void AdjustPositions();
 
   // No need yet to make this virtual
   void DoSetY(int y);
 
   void DoSetHeight(int h);
 
protected:
   // Private factory to make appropriate object; class ChannelView handles
   // memory management thereafter
   virtual std::shared_ptr<ChannelVRulerControls> DoGetVRulerControls() = 0;
 
   std::shared_ptr<ChannelVRulerControls> mpVRulerControls;
 
private:
   static ChannelView &GetFromChannelGroup(
      ChannelGroup &group, size_t iChannel);
   static ChannelView *FindFromChannelGroup(
      ChannelGroup *pGroup, size_t iChannel = 0);
 
   bool           mMinimized{ false };
   int            mY{ 0 };
   int            mHeight{ DefaultHeight };
};
 
#include "AttachedVirtualFunction.h"
 
struct DoGetViewTag;
 
 
using DoGetView =
AttachedVirtualFunction<
   DoGetViewTag,
   std::shared_ptr<ChannelView>,
   Track,
   size_t// channel index
>;
DECLARE_EXPORTED_ATTACHED_VIRTUAL(AUDACITY_DLL_API, DoGetView);
 
struct GetDefaultTrackHeightTag;
 
using GetDefaultTrackHeight =
AttachedVirtualFunction<
   GetDefaultTrackHeightTag,
   int,
   Channel
>;
DECLARE_EXPORTED_ATTACHED_VIRTUAL(AUDACITY_DLL_API, GetDefaultTrackHeight);
 
#endif