summaryrefslogtreecommitdiffstats
path: root/src/animation/frontend/qkeyframe.h
blob: c7c0b59978b86668c484bb1d6758e2cbbf2cb946 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/****************************************************************************
**
** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:COMM$
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/

#ifndef QT3DANIMATION_QKEYFRAME_H
#define QT3DANIMATION_QKEYFRAME_H

#include <QtGui/qvector2d.h>
#include <Qt3DAnimation/qt3danimation_global.h>

QT_BEGIN_NAMESPACE

namespace Qt3DAnimation {

class Q_3DANIMATIONSHARED_EXPORT QKeyFrame
{
public:
    enum InterpolationType : quint8 {
        ConstantInterpolation,
        LinearInterpolation,
        BezierInterpolation
    };

    Q_DECL_CONSTEXPR QKeyFrame() Q_DECL_NOTHROW
        : m_coordinates()
        , m_leftControlPoint()
        , m_rightControlPoint()
        , m_interpolationType(BezierInterpolation)
    {
    }

    Q_DECL_CONSTEXPR explicit QKeyFrame(QVector2D coords) Q_DECL_NOTHROW
        : m_coordinates(coords)
        , m_leftControlPoint()
        , m_rightControlPoint()
        , m_interpolationType(LinearInterpolation)
    {
    }

    Q_DECL_CONSTEXPR explicit QKeyFrame(QVector2D coords,
                                        QVector2D lh,
                                        QVector2D rh) Q_DECL_NOTHROW
        : m_coordinates(coords)
        , m_leftControlPoint(lh)
        , m_rightControlPoint(rh)
        , m_interpolationType(BezierInterpolation)
    {
    }

    void setCoordinates(QVector2D coords) Q_DECL_NOTHROW
    {
        m_coordinates = coords;
    }

    Q_DECL_CONSTEXPR QVector2D coordinates() const Q_DECL_NOTHROW
    {
        return m_coordinates;
    }

    void setLeftControlPoint(QVector2D lh) Q_DECL_NOTHROW
    {
        m_leftControlPoint = lh;
    }

    Q_DECL_CONSTEXPR QVector2D leftControlPoint() const Q_DECL_NOTHROW
    {
        return m_leftControlPoint;
    }

    void setRightControlPoint(QVector2D rh) Q_DECL_NOTHROW
    {
        m_rightControlPoint = rh;
    }

    Q_DECL_CONSTEXPR QVector2D rightControlPoint() const Q_DECL_NOTHROW
    {
        return m_rightControlPoint;
    }

    void setInterpolationType(InterpolationType interp) Q_DECL_NOTHROW
    {
        m_interpolationType = interp;
    }

    Q_DECL_CONSTEXPR InterpolationType interpolationType() const Q_DECL_NOTHROW
    {
        return m_interpolationType;
    }

    friend inline bool operator==(const QKeyFrame &, const QKeyFrame &) Q_DECL_NOTHROW;
    friend inline bool operator!=(const QKeyFrame &, const QKeyFrame &) Q_DECL_NOTHROW;

private:
    QVector2D m_coordinates;
    QVector2D m_leftControlPoint;
    QVector2D m_rightControlPoint;
    InterpolationType m_interpolationType;
};

QT3D_DECLARE_TYPEINFO(Qt3DAnimation, QKeyFrame, Q_PRIMITIVE_TYPE)

inline bool operator==(const QKeyFrame &lhs, const QKeyFrame &rhs) Q_DECL_NOTHROW
{
    if (lhs.m_interpolationType != rhs.m_interpolationType)
        return false;

    if (lhs.m_interpolationType == QKeyFrame::BezierInterpolation) {
        return lhs.m_coordinates == rhs.m_coordinates &&
               lhs.m_leftControlPoint == rhs.m_leftControlPoint &&
               lhs.m_rightControlPoint == rhs.m_rightControlPoint;
    }

    return lhs.m_coordinates == rhs.m_coordinates;
}

inline bool operator!=(const QKeyFrame &lhs, const QKeyFrame &rhs) Q_DECL_NOTHROW
{
    return !(lhs == rhs);
}

} // namespace Qt3DAnimation

QT_END_NAMESPACE

#endif // QT3DANIMATION_QKEYFRAME_H