lottie_view.hpp

Go to the documentation of this file.

#pragma once

 
#include <memory>
#include <string>
 
#include <pulp/view/view.hpp>
 
namespace pulp::canvas { class LottieAnimation; }
 
namespace pulp::view {
 
class LottieView : public View {
public:
    LottieView();
    ~LottieView() override;

    static bool supported();
 
    bool set_source_file(const std::string& path);
    bool set_source_json(const std::string& json);
    bool valid() const;
 
    void set_playing(bool playing);
    bool playing() const { return playing_; }
    void set_looping(bool looping) { looping_ = looping; }
    bool looping() const { return looping_; }
    void set_speed(float speed) { speed_ = speed < 0.0f ? 0.0f : speed; }
    float speed() const { return speed_; }
 
    void seek(double seconds);
    double time() const { return time_; }
    double duration() const;

    void advance(float dt);
 
    void paint(canvas::Canvas& canvas) override;
    void on_attached() override;
    void on_detached() override;
    void on_frame_clock_changed() override;
 
private:
    void subscribe_clock();
    void unsubscribe_clock();
    // Paint a bordered "Lottie unavailable" placeholder when Lottie is compiled
    // out of this build, so a disabled build reads as intentionally-unavailable
    // rather than a silently blank box (mirrors the ImageView missing-image
    // placeholder). Logs the reason once per view instance.
    void paint_unsupported_placeholder(canvas::Canvas& canvas);
 
    std::unique_ptr<canvas::LottieAnimation> animation_;
    double time_ = 0.0;
    float speed_ = 1.0f;
    bool playing_ = true;
    bool looping_ = true;
    int clock_subscription_ = -1;
    // frame_clock() becomes null after detachment; retain the actual clock so
    // a descendant subscription can always be removed from its old host.
    FrameClock* subscription_clock_ = nullptr;
    bool unsupported_logged_ = false;
};
 
}  // namespace pulp::view