fx_engine.h

Go to the documentation of this file.

#pragma once
 
#include <stdint.h>
#include <string.h>
 
#include "crgb.h"
#include "fl/map.h"
#include "fl/namespace.h"
#include "fl/ptr.h"
#include "fl/ui.h"
#include "fl/xymap.h"
#include "fx/detail/fx_compositor.h"
#include "fx/detail/fx_layer.h"
#include "fx/fx.h"
#include "fx/time.h"
#include "fx/video.h"
 
// Forward declaration
class TimeFunction;
 
#ifndef FASTLED_FX_ENGINE_MAX_FX
#define FASTLED_FX_ENGINE_MAX_FX 64
#endif
 
namespace fl {

class FxEngine {
  public:
    typedef fl::FixedMap<int, FxPtr, FASTLED_FX_ENGINE_MAX_FX> IntFxMap;
    FxEngine(uint16_t numLeds, bool interpolate = true);

    ~FxEngine();

    int addFx(FxPtr effect);

    int addFx(Fx &effect) { return addFx(fl::Ptr<Fx>::NoTracking(effect)); }

    FxPtr removeFx(int index);

    FxPtr getFx(int index);
 
    int getCurrentFxId() const { return mCurrId; }

    bool draw(uint32_t now, CRGB *outputBuffer);

    bool nextFx(uint16_t transition_ms = 500);

    bool setNextFx(int index, uint16_t duration);
 
    IntFxMap &_getEffects() { return mEffects; }

    void setSpeed(float scale) { mTimeFunction.setSpeed(scale); }
 
  private:
    int mCounter = 0;
    TimeWarp mTimeFunction;   // FxEngine controls the clock, to allow
                              // "time-bending" effects.
    IntFxMap mEffects;        
    FxCompositor mCompositor; 
    int mCurrId;              
    uint16_t mDuration = 0;   
    bool mDurationSet =
        false; 
    bool mInterpolate = true;
};
 
} // namespace fl