src/corelib/tools/qeasingcurve.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtCore module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QEASINGCURVE_H
  43 #define QEASINGCURVE_H
  44
  45 #include <QtCore/qglobal.h>
  46 #include <QtCore/qobjectdefs.h>
  47 #include <QtCore/qvector.h>
  48 #if QT_DEPRECATED_SINCE(5, 0)
  49 # include <QtCore/qlist.h>
  50 # include <QtCore/qpoint.h>
  51 #endif
  52
  53 QT_BEGIN_HEADER
  54
  55 QT_BEGIN_NAMESPACE
  56
  57
  58 class QEasingCurvePrivate;
  59 class QPointF;
  60 class Q_CORE_EXPORT QEasingCurve
  61 {
  62     Q_GADGET
  63     Q_ENUMS(Type)
  64 public:
  65     enum Type {
  66         Linear,
  67         InQuad, OutQuad, InOutQuad, OutInQuad,
  68         InCubic, OutCubic, InOutCubic, OutInCubic,
  69         InQuart, OutQuart, InOutQuart, OutInQuart,
  70         InQuint, OutQuint, InOutQuint, OutInQuint,
  71         InSine, OutSine, InOutSine, OutInSine,
  72         InExpo, OutExpo, InOutExpo, OutInExpo,
  73         InCirc, OutCirc, InOutCirc, OutInCirc,
  74         InElastic, OutElastic, InOutElastic, OutInElastic,
  75         InBack, OutBack, InOutBack, OutInBack,
  76         InBounce, OutBounce, InOutBounce, OutInBounce,
  77         InCurve, OutCurve, SineCurve, CosineCurve,
  78         BezierSpline, TCBSpline, Custom, NCurveTypes
  79     };
  80
  81     QEasingCurve(Type type = Linear);
  82     QEasingCurve(const QEasingCurve &other);
  83     ~QEasingCurve();
  84
  85     QEasingCurve &operator=(const QEasingCurve &other)
  86     { if ( this != &other ) { QEasingCurve copy(other); swap(copy); } return *this; }
  87 #ifdef Q_COMPILER_RVALUE_REFS
  88     QEasingCurve(QEasingCurve &&other) : d_ptr(other.d_ptr) { other.d_ptr = 0; }
  89     QEasingCurve &operator=(QEasingCurve &&other)
  90     { qSwap(d_ptr, other.d_ptr); return *this; }
  91 #endif
  92
  93     inline void swap(QEasingCurve &other) { qSwap(d_ptr, other.d_ptr); }
  94
  95     bool operator==(const QEasingCurve &other) const;
  96     inline bool operator!=(const QEasingCurve &other) const
  97     { return !(this->operator==(other)); }
  98
  99     qreal amplitude() const;
 100     void setAmplitude(qreal amplitude);
 101
 102     qreal period() const;
 103     void setPeriod(qreal period);
 104
 105     qreal overshoot() const;
 106     void setOvershoot(qreal overshoot);
 107
 108     void addCubicBezierSegment(const QPointF & c1, const QPointF & c2, const QPointF & endPoint);
 109     void addTCBSegment(const QPointF &nextPoint, qreal t, qreal c, qreal b);
 110     QVector<QPointF> toCubicSpline() const;
 111 #if QT_DEPRECATED_SINCE(5, 0)
 112     QT_DEPRECATED QList<QPointF> cubicBezierSpline() const { return toCubicSpline().toList(); }
 113 #endif
 114
 115     Type type() const;
 116     void setType(Type type);
 117     typedef qreal (*EasingFunction)(qreal progress);
 118     void setCustomType(EasingFunction func);
 119     EasingFunction customType() const;
 120
 121     qreal valueForProgress(qreal progress) const;
 122 private:
 123     QEasingCurvePrivate *d_ptr;
 124 #ifndef QT_NO_DEBUG_STREAM
 125     friend Q_CORE_EXPORT QDebug operator<<(QDebug debug, const QEasingCurve &item);
 126 #endif
 127 #ifndef QT_NO_DATASTREAM
 128     friend Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QEasingCurve&);
 129     friend Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QEasingCurve &);
 130 #endif
 131 };
 132 Q_DECLARE_TYPEINFO(QEasingCurve, Q_MOVABLE_TYPE);
 133
 134 #ifndef QT_NO_DEBUG_STREAM
 135 Q_CORE_EXPORT QDebug operator<<(QDebug debug, const QEasingCurve &item);
 136 #endif
 137
 138 #ifndef QT_NO_DATASTREAM
 139 Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QEasingCurve&);
 140 Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QEasingCurve &);
 141 #endif
 142
 143 QT_END_NAMESPACE
 144
 145 QT_END_HEADER
 146
 147 #endif