/* This file is part of the KDE project
 * SPDX-FileCopyrightText: 2010 Thorsten Zachmann <zachmann@kde.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (  at your option ) any later version.
 *
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef KPRANIMATIONBASE_H
#define KPRANIMATIONBASE_H

#include "KPrAnimationData.h"
#include <QAbstractAnimation>

class KoXmlElement;
class KoShapeLoadingContext;
class KoPASavingContext;
class KoShape;
class KPrAnimationCache;
class KPrShapeAnimation;

class KPrAnimationBase : public QAbstractAnimation, KPrAnimationData
{
public:
    enum FillType {
        FillRemove,
        FillFreeze,
        FillHold,
        FillTransition,
        FillAuto,
        FillDefault
    };
    explicit KPrAnimationBase(KPrShapeAnimation *shapeAnimation);
    ~KPrAnimationBase() override;
    virtual bool loadOdf(const KoXmlElement &element, KoShapeLoadingContext &context);
    virtual bool saveOdf(KoPASavingContext &paContext) const = 0;

    /// Total duration including time delay
    int duration() const override;
    virtual int begin() const;
    virtual void setBegin(int value);

    /// Set duration (without time delay)
    virtual void setDuration(int value);
    using KPrAnimationData::init;
    int animationDuration() const;
    virtual bool saveAttribute(KoPASavingContext &paContext) const;

protected:
    void updateCurrentTime(int currentTime) override;
    virtual void next(int currentTime) = 0;
    void updateCache(const QString &id, const QVariant &value);

    KPrShapeAnimation *m_shapeAnimation; // we could also use the group() but that would mean we need to cast all the time
    KPrAnimationCache *m_animationCache;
    int m_begin; // in milliseconds
    int m_duration; // in milliseconds
    FillType m_fill;
};

#endif /* KPRANIMATIONBASE_H */
