PlayRegion Class Reference

#include <ViewInfo.h>

Inheritance diagram for PlayRegion:

Collaboration diagram for PlayRegion:

Public Member Functions
	PlayRegion ()=default
	PlayRegion (const PlayRegion &)=delete
PlayRegion &	operator= (const PlayRegion &that)
bool	Active () const
void	SetActive (bool active)
bool	Empty () const
double	GetStart () const
double	GetEnd () const
double	GetLastActiveStart () const
double	GetLastActiveEnd () const
void	SetStart (double start)
void	SetEnd (double end)
void	SetTimes (double start, double end)
void	SetAllTimes (double start, double end)
void	Clear ()
	Set to an invalid state. More...
bool	IsClear () const
	Test whether in invalid state. More...
bool	IsLastActiveRegionClear () const
	Test whether last active region is in invalid state. More...
void	Order ()
Public Member Functions inherited from Observer::Publisher< PlayRegionMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Private Member Functions
void	Notify ()

Private Attributes
double	mStart { invalidValue }
double	mEnd { invalidValue }
double	mLastActiveStart { invalidValue }
double	mLastActiveEnd { invalidValue }
bool	mActive { false }

Static Private Attributes
static constexpr auto	invalidValue = -std::numeric_limits<double>::infinity()

Additional Inherited Members
Public Types inherited from Observer::Publisher< PlayRegionMessage >
using	message_type = PlayRegionMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const PlayRegionMessage &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< PlayRegionMessage >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< PlayRegionMessage >
CallbackReturn	Publish (const PlayRegionMessage &message)
	Send a message to connected callbacks. More...

Detailed Description

Definition at line 106 of file ViewInfo.h.

Constructor & Destructor Documentation

PlayRegion() [1/2]

PlayRegion::PlayRegion ( )

default

PlayRegion() [2/2]

PlayRegion::PlayRegion ( const PlayRegion &  )

delete

Member Function Documentation

Active()

bool PlayRegion::Active ( ) const

inline

Definition at line 124 of file ViewInfo.h.

{ return mActive; }

Referenced by AdornedRulerPanel::DoSelectionChange(), and anonymous_namespace{TransportMenus.cpp}::IsLoopingEnabled().

Here is the caller graph for this function:

Clear()

void PlayRegion::Clear

(

)

Set to an invalid state.

Definition at line 197 of file ViewInfo.cpp.

{
   SetAllTimes(invalidValue, invalidValue);
}

References invalidValue, and SetAllTimes().

Here is the call graph for this function:

Empty()

bool PlayRegion::Empty ( ) const

inline

Definition at line 127 of file ViewInfo.h.

{ return GetStart() == GetEnd(); }

Referenced by ProjectTempoListener::OnProjectTempoChange().

Here is the caller graph for this function:

GetEnd()

double PlayRegion::GetEnd ( ) const

inline

Definition at line 135 of file ViewInfo.h.

   {
      if ( mStart < 0 )
         return mEnd;
      else
         return std::max( mStart, mEnd );
   }

Referenced by IsClear(), ProjectTempoListener::OnProjectTempoChange(), and operator=().

Here is the caller graph for this function:

GetLastActiveEnd()

double PlayRegion::GetLastActiveEnd ( ) const

inline

Definition at line 149 of file ViewInfo.h.

   {
      if ( mLastActiveStart < 0 )
         return mLastActiveEnd;
      else
         return std::max( mLastActiveStart, mLastActiveEnd );
   }

Referenced by IsLastActiveRegionClear(), and operator=().

Here is the caller graph for this function:

GetLastActiveStart()

double PlayRegion::GetLastActiveStart ( ) const

inline

Definition at line 142 of file ViewInfo.h.

   {
      if ( mLastActiveEnd < 0 )
         return mLastActiveStart;
      else
         return std::min( mLastActiveStart, mLastActiveEnd );
   }

References min().

Referenced by IsLastActiveRegionClear(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

GetStart()

double PlayRegion::GetStart ( ) const

inline

Definition at line 128 of file ViewInfo.h.

   {
      if ( mEnd < 0 )
         return mStart;
      else
         return std::min( mStart, mEnd );
   }

References min().

Referenced by IsClear(), TimeToolBar::OnIdle(), ProjectTempoListener::OnProjectTempoChange(), operator=(), and TransportUtilities::PlayCurrentRegionAndWait().

Here is the call graph for this function:

Here is the caller graph for this function:

IsClear()

bool PlayRegion::IsClear

(

)

const

Test whether in invalid state.

Definition at line 202 of file ViewInfo.cpp.

{
   return GetStart() == invalidValue && GetEnd() == invalidValue;
}

References GetEnd(), GetStart(), and invalidValue.

Here is the call graph for this function:

IsLastActiveRegionClear()

bool PlayRegion::IsLastActiveRegionClear

(

)

const

Test whether last active region is in invalid state.

Definition at line 207 of file ViewInfo.cpp.

{
   return GetLastActiveStart() == invalidValue && GetLastActiveEnd() == invalidValue;
}

References GetLastActiveEnd(), GetLastActiveStart(), and invalidValue.

Here is the call graph for this function:

Notify()

void PlayRegion::Notify ( )

private

Definition at line 222 of file ViewInfo.cpp.

{
   Publish({});
}

References Observer::Publisher< PlayRegionMessage >::Publish().

Referenced by Order(), SetActive(), SetEnd(), SetStart(), and SetTimes().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

PlayRegion & PlayRegion::operator= ( const PlayRegion &  that )

inline

Definition at line 113 of file ViewInfo.h.

   {
      mActive = that.mActive;
      // Guarantee the equivalent un-swapped order of endpoints
      mStart = that.GetStart();
      mEnd = that.GetEnd();
      mLastActiveStart = that.GetLastActiveStart();
      mLastActiveEnd = that.GetLastActiveEnd();
      return *this;
   }

References GetEnd(), GetLastActiveEnd(), GetLastActiveStart(), GetStart(), and mActive.

Here is the call graph for this function:

Order()

void PlayRegion::Order

(

)

Definition at line 212 of file ViewInfo.cpp.

{
   if ( mStart >= 0 && mEnd >= 0 && mStart > mEnd) {
      std::swap( mStart, mEnd );
      if (mActive)
         mLastActiveStart = mStart, mLastActiveEnd = mEnd;
      Notify();
   }
}

References mActive, mEnd, mLastActiveEnd, mLastActiveStart, mStart, Notify(), and anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

SetActive()

void PlayRegion::SetActive

(

bool

active

)

Definition at line 146 of file ViewInfo.cpp.

{
   if (mActive != active) {
      mActive = active;
      if (mActive) {
         // Restore values
         if (mStart != mLastActiveStart || mEnd != mLastActiveEnd) {
            mStart = mLastActiveStart;
            mEnd = mLastActiveEnd;
         }
      }
      Notify();
   }
}

References mActive, mEnd, mLastActiveEnd, mLastActiveStart, mStart, and Notify().

Here is the call graph for this function:

SetAllTimes()

void PlayRegion::SetAllTimes	(	double	start,
		double	end
	)

Definition at line 191 of file ViewInfo.cpp.

{
   SetTimes(start, end);
   mLastActiveStart = start, mLastActiveEnd = end;
}

References details::end(), mLastActiveEnd, mLastActiveStart, and SetTimes().

Referenced by Clear().

Here is the call graph for this function:

Here is the caller graph for this function:

SetEnd()

void PlayRegion::SetEnd

(

double

end

)

Definition at line 171 of file ViewInfo.cpp.

{
   if (mEnd != end) {
      if (mActive)
         mLastActiveEnd = end;
      mEnd = end;
      Notify();
   }
}

References details::end(), mActive, mEnd, mLastActiveEnd, and Notify().

Referenced by AdornedRulerPanel::NewPlayRegionHandle::DoAdjust().

Here is the call graph for this function:

Here is the caller graph for this function:

SetStart()

void PlayRegion::SetStart

(

double

start

)

Definition at line 161 of file ViewInfo.cpp.

{
   if (mStart != start) {
      if (mActive)
         mLastActiveStart = start;
      mStart = start;
      Notify();
   }
}

References mActive, mLastActiveStart, mStart, and Notify().

Referenced by AdornedRulerPanel::ResizePlayRegionHandle::DoAdjust().

Here is the call graph for this function:

Here is the caller graph for this function:

SetTimes()

void PlayRegion::SetTimes	(	double	start,
		double	end
	)

Definition at line 181 of file ViewInfo.cpp.

{
   if (mStart != start || mEnd != end) {
      if (mActive)
         mLastActiveStart = start, mLastActiveEnd = end;
      mStart = start, mEnd = end;
      Notify();
   }
}

References details::end(), mActive, mEnd, mLastActiveEnd, mLastActiveStart, mStart, and Notify().

Referenced by AdornedRulerPanel::MovePlayRegionHandle::DoAdjust(), AdornedRulerPanel::NewPlayRegionHandle::DoStartAdjust(), ProjectTempoListener::OnProjectTempoChange(), and SetAllTimes().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

invalidValue

constexpr auto PlayRegion::invalidValue = -std::numeric_limits<double>::infinity()

staticconstexprprivate

Definition at line 176 of file ViewInfo.h.

Referenced by Clear(), IsClear(), and IsLastActiveRegionClear().

mActive

bool PlayRegion::mActive { false }

private

Definition at line 183 of file ViewInfo.h.

Referenced by operator=(), Order(), SetActive(), SetEnd(), SetStart(), and SetTimes().

mEnd

double PlayRegion::mEnd { invalidValue }

private

Definition at line 179 of file ViewInfo.h.

Referenced by Order(), SetActive(), SetEnd(), and SetTimes().

mLastActiveEnd

double PlayRegion::mLastActiveEnd { invalidValue }

private

Definition at line 181 of file ViewInfo.h.

Referenced by Order(), SetActive(), SetAllTimes(), SetEnd(), and SetTimes().

mLastActiveStart

double PlayRegion::mLastActiveStart { invalidValue }

private

Definition at line 180 of file ViewInfo.h.

Referenced by Order(), SetActive(), SetAllTimes(), SetStart(), and SetTimes().

mStart

double PlayRegion::mStart { invalidValue }

private

Definition at line 178 of file ViewInfo.h.

Referenced by Order(), SetActive(), SetStart(), and SetTimes().

---

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

• ViewInfo.h
• ViewInfo.cpp