AnimationParameters.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2024, EPFL/Blue Brain Project
 *
 * The Blue Brain BioExplorer is a tool for scientists to extract and analyse
 * scientific data from visualization
 *
 * This file is part of Blue Brain BioExplorer <https://github.com/BlueBrain/BioExplorer>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include "AbstractParameters.h"
#include <list>
 
SERIALIZATION_ACCESS(AnimationParameters)
 
namespace core
{
class AnimationParameters : public AbstractParameters
{
public:
    AnimationParameters();
 
    void print() final;
 
    void reset();
 
    void setFrame(uint32_t value) { _updateValue(_current, _adjustedCurrent(value)); }
    uint32_t getFrame() const { return _current; }
    void setDelta(const int32_t delta);
    int32_t getDelta() const { return _delta; }
    void setNumFrames(const uint32_t numFrames, const bool triggerCallback = true)
    {
        _updateValue(_numFrames, numFrames, triggerCallback);
        _updateValue(_current, std::min(_current, _numFrames), triggerCallback);
    }
    uint32_t getNumFrames() const { return _numFrames; }
    void setDt(const double dt, const bool triggerCallback = true) { _updateValue(_dt, dt, triggerCallback); }
    double getDt() const { return _dt; }
    void setUnit(const std::string& unit, const bool triggerCallback = true)
    {
        _updateValue(_unit, unit, triggerCallback);
    }
    using IsReadyCallback = std::function<bool()>;
 
    void setIsReadyCallback(const IsReadyCallback& callback) { _isReadyCallback = callback; }
 
    void removeIsReadyCallback()
    {
        if (_isReadyCallback)
        {
            reset();
            _isReadyCallback = nullptr;
        }
    }
 
    bool hasIsReadyCallback() const { return !!_isReadyCallback; }
    void update();
 
    void jumpFrames(int frames);
 
    void togglePlayback() { _playing = !_playing; }
    bool isPlaying() const { return _playing; }
 
private:
    uint32_t _adjustedCurrent(const uint32_t newCurrent) const { return _numFrames == 0 ? 0 : newCurrent % _numFrames; }
 
    bool _canUpdateFrame() const;
 
    uint32_t _numFrames{0};
    uint32_t _current{0};
    int32_t _delta{1};
    bool _playing{false};
    double _dt{0};
    std::string _unit;
 
    IsReadyCallback _isReadyCallback;
 
    SERIALIZATION_FRIEND(AnimationParameters)
};
} // namespace core