Abstract base class for policies to manipulate a track type for Time Shift. More...

#include <TimeShiftHandle.h>

Inheritance diagram for TrackShifter:

Collaboration diagram for TrackShifter:

Classes
struct	HitTestParams
	Optional, more complete information for hit testing. More...

Public Types
enum class	HitTestResult { Miss , Selection , Intervals , Track }
	Possibilities for HitTest on the clicked track. More...

using	Intervals = std::vector< std::shared_ptr< ChannelGroupInterval > >

Public Member Functions
	TrackShifter ()

	TrackShifter (const TrackShifter &)=delete

TrackShifter &	operator= (const TrackShifter &)=delete

virtual	~TrackShifter ()=0

virtual Track &	GetTrack () const =0
	There is always an associated track. More...

virtual HitTestResult	HitTest (double time, const ViewInfo &viewInfo, HitTestParams *pParams=nullptr)=0
	Decide how shift behaves, based on the track that is clicked in. More...

const Intervals &	FixedIntervals () const
	Return special intervals of the track that will not move. More...

const Intervals &	MovingIntervals () const
	Return special intervals of the track that may move. More...

void	UnfixIntervals (std::function< bool(const ChannelGroupInterval &)> pred)
	Change intervals satisfying a predicate from fixed to moving. More...

void	UnfixAll ()
	Change all intervals from fixed to moving. More...

virtual void	SelectInterval (const ChannelGroupInterval &interval)
	Notifies the shifter that a region is selected, so it may update its fixed and moving intervals. More...

virtual bool	SyncLocks ()=0
	Whether unfixing of an interval should propagate to all overlapping intervals in the sync lock group. More...

virtual double	HintOffsetLarger (double desiredOffset)
	Given amount to shift by horizontally, maybe adjust it from zero to suggest minimum distance. More...

virtual double	QuantizeOffset (double desiredOffset)
	Given amount to shift by horizontally, do any preferred rounding, before placement constraint checks. More...

virtual double	AdjustOffsetSmaller (double desiredOffset)
	Given amount to shift by horizontally, maybe adjust it toward zero to meet placement constraints. More...

virtual bool	MayMigrateTo (Track &otherTrack)

virtual Intervals	Detach ()
	Remove all moving intervals from the track, if possible. More...

virtual bool	AdjustFit (const Track &otherTrack, const Intervals &intervals, double &desiredOffset, double tolerance)

virtual bool	Attach (Intervals intervals, double offset)
	Put moving intervals into the track, which may have migrated from another. More...

virtual bool	FinishMigration ()
	When dragging is done, do (once) the final steps of migration (which may be expensive) More...

virtual void	DoHorizontalOffset (double offset)

virtual double	AdjustT0 (double t0) const

Protected Member Functions
void	CommonSelectInterval (const ChannelGroupInterval &interval)

bool	CommonMayMigrateTo (Track &otherTrack)

void	InitIntervals ()
	Derived class constructor can initialize all intervals reported by the track as fixed, none moving. More...

bool	AllFixed () const

Protected Attributes
Intervals	mFixed

Intervals	mMoving

Private Attributes
bool	mAllFixed = true

Detailed Description

Abstract base class for policies to manipulate a track type for Time Shift.

Definition at line 33 of file TimeShiftHandle.h.

Member Typedef Documentation

◆ Intervals

using TrackShifter::Intervals = std::vector<std::shared_ptr<ChannelGroupInterval> >

Definition at line 72 of file TimeShiftHandle.h.

Member Enumeration Documentation

◆ HitTestResult

enum class TrackShifter::HitTestResult

strong

Possibilities for HitTest on the clicked track.

Enumerator
Miss	Don't shift anything.
Selection	Shift chosen intervals of this track; may shift other tracks' intervals.
Intervals	Shift intervals only of selected track and sister channels.
Track	Shift selected track and sister channels only, as a whole.

Definition at line 47 of file TimeShiftHandle.h.

                            {
      Miss,      
      Selection, 
      Intervals, 
      Track      
   };

Constructor & Destructor Documentation

◆ TrackShifter() [1/2]

TrackShifter::TrackShifter ( )

default

◆ TrackShifter() [2/2]

TrackShifter::TrackShifter ( const TrackShifter & )

delete

◆ ~TrackShifter()

TrackShifter::~TrackShifter ( )

pure virtualdefault

Member Function Documentation

◆ AdjustFit()

bool TrackShifter::AdjustFit	(	const Track &	otherTrack,
		const Intervals &	intervals,
		double &	desiredOffset,
		double	tolerance
	)

virtual

Test whether intervals can fit into another track, maybe adjusting the offset slightly

Default implementation does nothing and returns false

Parameters

	intervals	Assume these came from Detach() and only after MayMigrateTo returned true for otherTrack
[in,out]	desiredOffset
	tolerance	Nonnegative ceiling for allowed changes in fabs(desiredOffset)

Reimplemented in LabelTrackShifter, and WaveTrackShifter.

Definition at line 213 of file TimeShiftHandle.cpp.

{
   return false;
}

◆ AdjustOffsetSmaller()

double TrackShifter::AdjustOffsetSmaller ( double desiredOffset )

virtual

Given amount to shift by horizontally, maybe adjust it toward zero to meet placement constraints.

Default implementation returns the argument

Postcondition: fabs(r) <= fabs(desiredOffset); r * desiredOffset >= 0 (i.e. signs are not opposite); (where r is return value)

Reimplemented in WaveTrackShifter.

Definition at line 179 of file TimeShiftHandle.cpp.

{
   return desiredOffset;
}

◆ AdjustT0()

double TrackShifter::AdjustT0 ( double t0 ) const

virtual

Reimplemented in NoteTrackShifter, and WaveTrackShifter.

Definition at line 235 of file TimeShiftHandle.cpp.

{
   return t0;
}

◆ AllFixed()

bool TrackShifter::AllFixed ( ) const

inlineprotected

Definition at line 188 of file TimeShiftHandle.h.

                         {
      return mAllFixed && mMoving.empty();
   }

Referenced by DoHorizontalOffset().

Here is the caller graph for this function:

◆ Attach()

bool TrackShifter::Attach	(	Intervals	intervals,
		double	offset
	)

virtual

Put moving intervals into the track, which may have migrated from another.

The ChannelGroupInterval objects pointed to by intervals will not be used again. The shifter should repopupate mMoving with new ChannelGroupInterval objects to reflect the new state of the track. In case of failure, track states are unspecified

Returns: success Default implementation does nothing and returns true

Reimplemented in LabelTrackShifter, and WaveTrackShifter.

Definition at line 219 of file TimeShiftHandle.cpp.

{
   return true;
}

◆ CommonMayMigrateTo()

bool TrackShifter::CommonMayMigrateTo ( Track & otherTrack )

protected

May be useful to override MayMigrateTo(), if certain other needed overrides are given. Returns true, iff: tracks have same type, and their channel groups have same width

Precondition: otherTrack.IsLeader()

Definition at line 189 of file TimeShiftHandle.cpp.

{
   assert(otherTrack.IsLeader());
   auto &track = GetTrack();
   // Both tracks need to be owned to decide this
   auto pMyList = track.GetOwner().get();
   auto pOtherList = otherTrack.GetOwner().get();
   if (pMyList && pOtherList) {
      // Can migrate to another track of the same kind...
      if (otherTrack.SameKindAs(track)) {
         // ... with the same number of channels
         auto myChannels = track.Channels();
         auto otherChannels = otherTrack.Channels();
         return (myChannels.size() == otherChannels.size());
      }
   }
   return false;
}

References ChannelGroup::Channels(), Track::GetOwner(), GetTrack(), Track::IsLeader(), and Track::SameKindAs().

Referenced by WaveTrackShifter::MayMigrateTo(), and LabelTrackShifter::MayMigrateTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CommonSelectInterval()

void TrackShifter::CommonSelectInterval ( const ChannelGroupInterval & interval )

protected

Unfix any of the intervals that intersect the given one; may be useful to override SelectInterval()

Definition at line 161 of file TimeShiftHandle.cpp.

{
   UnfixIntervals( [&](auto &myInterval){
      return !(interval.End() < myInterval.Start() ||
               myInterval.End() < interval.Start());
   });
}

References ChannelGroupInterval::End(), ChannelGroupInterval::Start(), and UnfixIntervals().

Referenced by LabelTrackShifter::SelectInterval(), and NoteTrackShifter::SelectInterval().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Detach()

auto TrackShifter::Detach ( )

virtual

Remove all moving intervals from the track, if possible.

Default implementation does nothing

Reimplemented in LabelTrackShifter, and WaveTrackShifter.

Definition at line 208 of file TimeShiftHandle.cpp.

{
   return {};
}

◆ DoHorizontalOffset()

void TrackShifter::DoHorizontalOffset ( double offset )

virtual

Shift all moving intervals horizontally Default moves the whole track, provided !AllFixed(); else does nothing

Reimplemented in LabelTrackShifter, and WaveTrackShifter.

Definition at line 229 of file TimeShiftHandle.cpp.

{
   if (!AllFixed())
      GetTrack().ShiftBy(offset);
}

References AllFixed(), GetTrack(), and ChannelGroup::ShiftBy().

Here is the call graph for this function:

◆ FinishMigration()

bool TrackShifter::FinishMigration ( )

virtual

When dragging is done, do (once) the final steps of migration (which may be expensive)

Returns: success

In case of failure, track states are unspecified

Default implementation does nothing and returns true

Reimplemented in WaveTrackShifter.

Definition at line 224 of file TimeShiftHandle.cpp.

{
   return true;
}

◆ FixedIntervals()

const Intervals & TrackShifter::FixedIntervals ( ) const

inline

Return special intervals of the track that will not move.

Definition at line 75 of file TimeShiftHandle.h.

75{ return mFixed; }

TrackShifter::mFixed

Intervals mFixed

Definition: TimeShiftHandle.h:192

◆ GetTrack()

virtual Track & TrackShifter::GetTrack ( ) const

pure virtual

There is always an associated track.

Postcondition: result: result.IsLeader()

Implemented in LabelTrackShifter, NoteTrackShifter, WaveTrackShifter, and CoarseTrackShifter.

Referenced by CommonMayMigrateTo(), DoHorizontalOffset(), and InitIntervals().

Here is the caller graph for this function:

◆ HintOffsetLarger()

double TrackShifter::HintOffsetLarger ( double desiredOffset )

virtual

Given amount to shift by horizontally, maybe adjust it from zero to suggest minimum distance.

Any interval placement constraints, not necessarily met at the suggested offset Default implementation returns the argument

Postcondition: fabs(r) >= fabs(desiredOffset); r * desiredOffset >= 0 (i.e. signs are not opposite); (where r is return value)

Reimplemented in WaveTrackShifter.

Definition at line 169 of file TimeShiftHandle.cpp.

{
   return desiredOffset;
}

◆ HitTest()

virtual HitTestResult TrackShifter::HitTest	(	double	time,
		const ViewInfo &	viewInfo,
		HitTestParams *	pParams = `nullptr`
	)

pure virtual

Decide how shift behaves, based on the track that is clicked in.

If the return value is Intervals or Selection, then some intervals may be marked moving as a side effect

Precondition: !pParams || (time == pParams->viewInfo.PositionToTime(pParams->xx, pParams->rect.x))

Parameters

time	A time value to test
pParams	Optional extra information

Implemented in NoteTrackShifter, WaveTrackShifter, LabelTrackShifter, and CoarseTrackShifter.

◆ InitIntervals()

void TrackShifter::InitIntervals ( )

protected

Derived class constructor can initialize all intervals reported by the track as fixed, none moving.

This can't be called by the base class constructor, when GetTrack() isn't yet callable

Definition at line 240 of file TimeShiftHandle.cpp.

{
   auto &track = GetTrack();
   assert(track.IsLeader()); // postcondition
   mMoving.clear();
   auto range = track.Intervals();
   std::copy(range.begin(), range.end(), back_inserter(mFixed));
}

References staffpad::vo::copy(), GetTrack(), mFixed, and mMoving.

Referenced by CoarseTrackShifter::CoarseTrackShifter(), LabelTrackShifter::LabelTrackShifter(), NoteTrackShifter::NoteTrackShifter(), and WaveTrackShifter::WaveTrackShifter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MayMigrateTo()

bool TrackShifter::MayMigrateTo ( Track & otherTrack )

virtual

Whether intervals may migrate to the other track, not yet checking all placement constraints

Precondition: otherTrack.IsLeader() Default implementation returns false

Reimplemented in WaveTrackShifter, and LabelTrackShifter.

Definition at line 184 of file TimeShiftHandle.cpp.

{
   return false;
}

◆ MovingIntervals()

const Intervals & TrackShifter::MovingIntervals ( ) const

inline

Return special intervals of the track that may move.

Definition at line 78 of file TimeShiftHandle.h.

78{ return mMoving; }

Referenced by WaveTrackShifter::AdjustOffsetSmaller(), WaveTrackShifter::AdjustT0(), LabelTrackShifter::DoHorizontalOffset(), and WaveTrackShifter::DoHorizontalOffset().

Here is the caller graph for this function:

◆ operator=()

TrackShifter & TrackShifter::operator= ( const TrackShifter & )

delete

◆ QuantizeOffset()

double TrackShifter::QuantizeOffset ( double desiredOffset )

virtual

Given amount to shift by horizontally, do any preferred rounding, before placement constraint checks.

Default implementation returns argument

Reimplemented in WaveTrackShifter.

Definition at line 174 of file TimeShiftHandle.cpp.

{
   return desiredOffset;
}

◆ SelectInterval()

void TrackShifter::SelectInterval ( const ChannelGroupInterval & interval )

virtual

Notifies the shifter that a region is selected, so it may update its fixed and moving intervals.

Default behavior: if any part of the track is selected, unfix all parts of it.

Reimplemented in LabelTrackShifter, NoteTrackShifter, and WaveTrackShifter.

Definition at line 156 of file TimeShiftHandle.cpp.

{
   UnfixAll();
}

References UnfixAll().

Here is the call graph for this function:

◆ SyncLocks()

virtual bool TrackShifter::SyncLocks ( )

pure virtual

Whether unfixing of an interval should propagate to all overlapping intervals in the sync lock group.

Implemented in LabelTrackShifter, NoteTrackShifter, WaveTrackShifter, and CoarseTrackShifter.

◆ UnfixAll()

void TrackShifter::UnfixAll ( )

Change all intervals from fixed to moving.

Definition at line 149 of file TimeShiftHandle.cpp.

{
   std::move(mFixed.begin(), mFixed.end(), std::back_inserter(mMoving));
   mFixed = Intervals{};
   mAllFixed = false;
}

References mAllFixed, mFixed, and mMoving.

Referenced by NoteTrackShifter::HitTest(), and SelectInterval().

Here is the caller graph for this function:

◆ UnfixIntervals()

void TrackShifter::UnfixIntervals ( std::function< bool(const ChannelGroupInterval &)> pred )

Change intervals satisfying a predicate from fixed to moving.

Definition at line 135 of file TimeShiftHandle.cpp.

{
   for (auto iter = mFixed.begin(); iter != mFixed.end();) {
      if (pred(**iter)) {
         mMoving.push_back(std::move(*iter));
         iter = mFixed.erase(iter);
         mAllFixed = false;
      }
      else
         ++iter;
   }
}

References mAllFixed, mFixed, and mMoving.

Referenced by CommonSelectInterval(), WaveTrackShifter::HitTest(), LabelTrackShifter::HitTest(), and WaveTrackShifter::SelectInterval().

Here is the caller graph for this function:

Member Data Documentation

◆ mAllFixed

bool TrackShifter::mAllFixed = true

private

Becomes false after UnfixAll(), even if there are no intervals, or if any one interval was unfixed

Definition at line 196 of file TimeShiftHandle.h.

Referenced by UnfixAll(), and UnfixIntervals().

◆ mFixed

Intervals TrackShifter::mFixed

protected

Definition at line 192 of file TimeShiftHandle.h.

Referenced by InitIntervals(), LabelTrackShifter::OnLabelAdded(), LabelTrackShifter::OnLabelDeleted(), LabelTrackShifter::OnLabelPermuted(), UnfixAll(), and UnfixIntervals().

◆ mMoving

Intervals TrackShifter::mMoving

protected

Definition at line 193 of file TimeShiftHandle.h.

Referenced by WaveTrackShifter::Attach(), LabelTrackShifter::Detach(), WaveTrackShifter::Detach(), LabelTrackShifter::HitTest(), InitIntervals(), LabelTrackShifter::OnLabelAdded(), LabelTrackShifter::OnLabelDeleted(), LabelTrackShifter::OnLabelPermuted(), UnfixAll(), and UnfixIntervals().

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Intervals

Member Enumeration Documentation

◆ HitTestResult

Constructor & Destructor Documentation

◆ TrackShifter() [1/2]

◆ TrackShifter() [2/2]

◆ ~TrackShifter()

Member Function Documentation

◆ AdjustFit()

◆ AdjustOffsetSmaller()

◆ AdjustT0()

◆ AllFixed()

◆ Attach()

◆ CommonMayMigrateTo()

◆ CommonSelectInterval()

◆ Detach()

◆ DoHorizontalOffset()

◆ FinishMigration()

◆ FixedIntervals()

◆ GetTrack()

◆ HintOffsetLarger()

◆ HitTest()

◆ InitIntervals()

◆ MayMigrateTo()

◆ MovingIntervals()

◆ operator=()

◆ QuantizeOffset()

◆ SelectInterval()

◆ SyncLocks()

◆ UnfixAll()

◆ UnfixIntervals()

Member Data Documentation

◆ mAllFixed

◆ mFixed

◆ mMoving