summaryrefslogtreecommitdiffstats
path: root/src/animation/backend/animationutils_p.h
blob: b662ec445fcb134fb075ff2c3a2c0aceb34794ff (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
/****************************************************************************
**
** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QT3DANIMATION_ANIMATION_ANIMATIONUTILS_P_H
#define QT3DANIMATION_ANIMATION_ANIMATIONUTILS_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of other Qt classes.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <Qt3DAnimation/private/qt3danimation_global_p.h>
#include <Qt3DCore/qnodeid.h>
#include <Qt3DCore/qscenechange.h>

QT_BEGIN_NAMESPACE

namespace Qt3DAnimation {
namespace Animation {

struct ChannelGroup;
class Handler;
class AnimationClip;
class ChannelMapper;

class Q_AUTOTEST_EXPORT AnimationUtils
{
public:
    struct MappingData
    {
        Qt3DCore::QNodeId targetId;
        const char *propertyName;
        int type;
        int channelBaseIndex;
        QVector<int> channelIndices;
    };

    struct BlendingMappingData : public MappingData
    {
        QVector<int> channelIndicesClip1;
        QVector<int> channelIndicesClip2;

        enum BlendAction {
            NoBlending, // Use the channel from Clip1 only
            ClipBlending, // Blending 2 clips sharing the same channel
        };
        BlendAction blendAction;
    };

    struct AnimatorEvaluationData
    {
        double globalTime;
        double startTime;
        int loopCount;
        double playbackRate;
    };

    struct ClipPreEvaluationData
    {
        int currentLoop;
        double localTime;
        bool isFinalFrame;
    };

    template<typename Animator>
    static AnimatorEvaluationData animatorEvaluationDataForAnimator(Animator animator, qint64 globalTime)
    {
        AnimationUtils::AnimatorEvaluationData data;
        data.loopCount = animator->loops();
        data.playbackRate = 1.0; // should be a property on the animator
        // Convert global time from nsec to sec
        data.startTime = double(animator->startTime()) / 1.0e9;
        data.globalTime = double(globalTime) / 1.0e9;
        return data;
    }

    static ClipPreEvaluationData evaluationDataForClip(AnimationClip *clip, const AnimatorEvaluationData &animatorData);

    static QVector<int> channelsToIndices(const ChannelGroup &channelGroup,
                                          int dataType,
                                          int offset = 0);
    static QVector<int> channelsToIndicesHelper(const ChannelGroup &channelGroup,
                                                int dataType,
                                                int offset,
                                                const QStringList &suffixes);
    static QVector<float> evaluateClipAtLocalTime(AnimationClip *clip,
                                              float localTime);
    static QVector<Qt3DCore::QSceneChangePtr> preparePropertyChanges(Qt3DCore::QNodeId peerId,
                                                                     const QVector<MappingData> &mappingData,
                                                                     const QVector<float> &channelResults,
                                                                     bool finalFrame);
    static QVector<MappingData> buildPropertyMappings(Handler *handler,
                                                      const AnimationClip *clip,
                                                      const ChannelMapper *mapper);

private:
    static double localTimeFromGlobalTime(double t_global, double t_start_global,
                                          double playbackRate, double duration,
                                          int loopCount, int &currentLoop);
};

} // Animation
} // Qt3DAnimation

QT_END_NAMESPACE


#endif // QT3DANIMATION_ANIMATION_ANIMATIONUTILS_P_H