timeline.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2018 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "kwin_export.h"
 
#include <QEasingCurve>
#include <QSharedDataPointer>
 
#include <chrono>
 
namespace KWin
{
 
class KWIN_EXPORT TimeLine
{
public:
    enum Direction {
        Forward,
        Backward
    };
 
    explicit TimeLine(std::chrono::milliseconds duration = std::chrono::milliseconds(1000),
                      Direction direction = Forward);
    TimeLine(const TimeLine &other);
    ~TimeLine();
 
    qreal value() const;
 
    void advance(std::chrono::milliseconds timestamp);
 
    std::chrono::milliseconds elapsed() const;
 
    void setElapsed(std::chrono::milliseconds elapsed);
 
    std::chrono::milliseconds duration() const;
 
    void setDuration(std::chrono::milliseconds duration);
 
    Direction direction() const;
 
    void setDirection(Direction direction);
 
    void toggleDirection();
 
    QEasingCurve easingCurve() const;
 
    void setEasingCurve(const QEasingCurve &easingCurve);
 
    void setEasingCurve(QEasingCurve::Type type);
 
    bool running() const;
 
    bool done() const;
 
    void reset();
 
    enum class RedirectMode {
        Strict,
        Relaxed
    };
 
    RedirectMode sourceRedirectMode() const;
 
    void setSourceRedirectMode(RedirectMode mode);
 
    RedirectMode targetRedirectMode() const;
 
    void setTargetRedirectMode(RedirectMode mode);
 
    TimeLine &operator=(const TimeLine &other);
 
    qreal progress() const;
 
private:
    class Data;
    QSharedDataPointer<Data> d;
};
 
} // namespace KWin