time.h

Go to the documentation of this file.

#pragma once
 
#include "fl/stl/stdint.h"
 
#include "fl/stl/compiler_control.h"
#include "fl/stl/shared_ptr.h"         // For FASTLED_SHARED_PTR macros
#include "fl/stl/noexcept.h"
 
namespace fl {
 
FASTLED_SHARED_PTR(TimeFunction);
FASTLED_SHARED_PTR(TimeWarp);
 
// Interface for time generation and time manipulation.
class TimeFunction {
  public:
    virtual ~TimeFunction() FL_NO_EXCEPT {}
    virtual fl::u32
    update(fl::u32 timeNow) FL_NO_EXCEPT = 0; // Inputs the real clock time and outputs the
                                  // virtual time.
    virtual fl::u32 time() const FL_NO_EXCEPT = 0;
    virtual void reset(fl::u32 realTimeNow) FL_NO_EXCEPT = 0;
};
 
// Time clock. Use this to gracefully handle time manipulation. You can input a
// float value representing the current time scale and this will adjust a the
// clock smoothly. Updating requires inputing the real clock from the millis()
// function. HANDLES NEGATIVE TIME SCALES!!! Use this to control viusualizers
// back and forth motion which draw according to a clock value. Clock will never
// go below 0.
class TimeWarp : public TimeFunction {
  public:
    TimeWarp(fl::u32 realTimeNow = 0, float initialTimeScale = 1.0f) FL_NO_EXCEPT;
    ~TimeWarp() FL_NO_EXCEPT;
    void setSpeed(float speedScale) FL_NO_EXCEPT;
    void setScale(float speed)
        FL_NO_EXCEPT FASTLED_DEPRECATED("Use setSpeed(...) instead."); // Deprecated
    float scale() const FL_NO_EXCEPT;
    fl::u32 update(fl::u32 timeNow) FL_NO_EXCEPT override;
    fl::u32 time() const FL_NO_EXCEPT override;
    void reset(fl::u32 realTimeNow) FL_NO_EXCEPT override;
    void pause(fl::u32 now) FL_NO_EXCEPT;
    void resume(fl::u32 now) FL_NO_EXCEPT;
 
  private:
    void applyExact(fl::u32 timeNow) FL_NO_EXCEPT;
    fl::u32 mLastRealTime = 0;
    fl::u32 mStartTime = 0;
    fl::u32 mRelativeTime = 0;
    float mTimeScale = 1.0f;
    fl::u32 mPauseTime = 0;
};
 
} // namespace fl