NAP
Public Member Functions | Protected Attributes | List of all members
SequencePlayerClock Class Referenceabstract

#include <sequenceplayerclock.h>

Public Member Functions

 SequencePlayerClock ()=default
 
 ~SequencePlayerClock ()=default
 
 SequencePlayerClock (const SequencePlayerClock &)=delete
 
SequencePlayerClockoperator= (const SequencePlayerClock &)=delete
 
virtual void start (Slot< double > &updateSlot)=0
 
virtual void stop ()=0
 
- Public Member Functions inherited from Resource
 Resource ()
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
virtual bool init (utility::ErrorState &errorState)
 
virtual void onDestroy ()
 
 Object (Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&)=delete
 
Objectoperator= (Object &&)=delete
 

Protected Attributes

Slot< double > mSlot
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static bool isIDProperty (rtti::Instance &object, const rtti::Property &property)
 
- Public Attributes inherited from Object
std::string mID
 Property: 'mID' unique name of the object. Used as an identifier by the system. More...
 

Description

The SequencePlayerClock is used by the sequence player to get its update calls The idea behind this is that we can synchronize the SequencePlayer to any threads, external sources or clocks

Inheritance diagram for SequencePlayerClock:
[legend]
Collaboration diagram for SequencePlayerClock:
[legend]

Constructor & Destructor Documentation

◆ SequencePlayerClock() [1/2]

SequencePlayerClock ( )
default

◆ ~SequencePlayerClock()

~SequencePlayerClock ( )
default

◆ SequencePlayerClock() [2/2]

Member Function Documentation

◆ operator=()

SequencePlayerClock& operator= ( const SequencePlayerClock )
delete

◆ start()

virtual void start ( Slot< double > &  updateSlot)
pure virtual

Start needs to be overloaded. The update slot is the slot that needs to be called on update with a delta time DeltaTime needs to be in seconds

Parameters
updateSlotthe update slot from the SequencePlayer that needs to be called

Implemented in SequencePlayerIndependentClock, SequencePlayerStandardClock, and SequencePlayerAudioClock.

◆ stop()

virtual void stop ( )
pure virtual

Called by the SequencePlayer when player is deconstructed

Implemented in SequencePlayerIndependentClock, SequencePlayerStandardClock, and SequencePlayerAudioClock.

Member Data Documentation

◆ mSlot

Slot<double> mSlot
protected