summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Studio/Palettes/Timeline/Bindings/KeyframesManager.h
blob: 61ac2740fa7b7398134dfea530610a22da916d5d (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
/****************************************************************************
**
** Copyright (C) 2008 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef INCLUDED_KEYFRAMES_MANAGER_H
#define INCLUDED_KEYFRAMES_MANAGER_H 1

#pragma once

#include "ITimelineKeyframesManager.h"
#include "OffsetKeyframesCommandHelper.h"

class CTimelineTranslationManager;
class CUICDMTimelineKeyframe;
class CUICDMTimelineItemBinding;
class CPasteKeyframeCommandHelper;

//=============================================================================
/**
 * Abstraction layer to the class that manages both selected keyframes.
 */
//=============================================================================
class CKeyframesManager : public ITimelineKeyframesManager
{
public:
    CKeyframesManager(CTimelineTranslationManager *inTransMgr);
    virtual ~CKeyframesManager();

    // IKeyframesManager
    bool HasSelectedKeyframes(bool inOnlyDynamic = false) override;
    bool HasDynamicKeyframes() override;
    bool CanPerformKeyframeCopy() override;
    bool CanPerformKeyframePaste() override;
    void CopyKeyframes() override;
    bool RemoveKeyframes(bool inPerformCopy) override;
    void PasteKeyframes() override;
    void SetKeyframeInterpolation() override;
    void DeselectAllKeyframes() override;
    void SelectAllKeyframes() override;
    void SetChangedKeyframes() override;
    // ITimelineKeyframesManager
    void SetKeyframeTime(long inTime) override;
    void SetKeyframesDynamic(bool inDynamic) override;
    bool CanMakeSelectedKeyframesDynamic() override;
    long OffsetSelectedKeyframes(long inOffset) override;
    void CommitChangedKeyframes() override;
    void RollbackChangedKeyframes() override;

    void SetKeyframeSelected(CUICDMTimelineKeyframe *inKeyframe, bool inSelected,
                             CUICDMTimelineItemBinding *inOwningInstance = nullptr);

protected:
    void SetKeyframeDynamic(CUICDMTimelineKeyframe *inKeyframe, bool inDynamic);
    void CopySelectedKeyframes();

public:
    struct SKeyframeInstancePair
    {
        CUICDMTimelineKeyframe *m_Keyframe;
        CUICDMTimelineItemBinding *m_Instance;

        SKeyframeInstancePair(CUICDMTimelineKeyframe *inKeyframe,
                              CUICDMTimelineItemBinding *inInstance)
        {
            m_Keyframe = inKeyframe;
            m_Instance = inInstance;
        }
    };

protected:
    typedef std::vector<SKeyframeInstancePair> TSelectedKeyframeList; ///< handle multiple keyframes
                                                                      ///manipulation, e.g.
                                                                      ///offsetting by dragging

    CTimelineTranslationManager *m_TransMgr;
    TSelectedKeyframeList m_SelectedKeyframes;
    COffsetKeyframesCommandHelper m_OffsetKeyframeCommandHelper; // so that we can commit on mouseup
    CPasteKeyframeCommandHelper *m_PasteKeyframeCommandHelper;
    std::set<CUICDMTimelineItemBinding *> m_InstanceSet;
    std::vector<UICDM::CUICDMInstanceHandle> m_InstanceList;
};

#endif // INCLUDED_IKEYFRAMES_MANAGER_H