summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Studio/Palettes/Timeline/Bindings/TimelineTranslationManager.h
blob: 48f7bebe43945ddd03b975388c8f0be40b73af4d (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) 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$
**
****************************************************************************/
//==============================================================================
//	Prefix
//==============================================================================
#ifndef INCLUDED_TIMELINE_TRANSLATIONMANAGER_H
#define INCLUDED_TIMELINE_TRANSLATIONMANAGER_H 1

#pragma once

#include "UICDMHandles.h"
#include "UICDMTimeline.h"

#include "Doc.h"

//==============================================================================
//	Classes
//==============================================================================
class ITimelineItemBinding;
class ITimelineItemProperty;
class CUICDMTimelineItemBinding;
class CBaseStateRow;
class CPropertyRow;
class CKeyframesManager;
class IBreadCrumbProvider;

// Link to data model
class CAsset;
class IUICDMSelectable;
class CClientDataModelBridge;

// UICDM
namespace UICDM {
class CStudioSystem;
class ISignalConnection;
}

class CDoc;

//=============================================================================
/**
 * There is a TranslationManager per presentation (project)
 */
class CTimelineTranslationManager
{
protected: // Typedefs
    // UICDM support
    typedef std::map<UICDM::CUICDMInstanceHandle, CUICDMTimelineItemBinding *>
        TInstanceHandleBindingMap;

    // Store expanded state
    typedef std::map<UICDM::CUICDMInstanceHandle, bool> TInstanceHandleExpandedMap; // UICDM support

protected: // Properties
    // UICDM support
    TInstanceHandleBindingMap m_InstanceHandleBindingMap;

    CKeyframesManager *m_KeyframesManager;
    IBreadCrumbProvider *m_BreadCrumbProvider;
    std::vector<std::shared_ptr<UICDM::ISignalConnection>>
        m_Connections; /// connections to the UICDM

    TInstanceHandleExpandedMap m_InstanceHandleExpandedMap;

public:
    CTimelineTranslationManager();
    ~CTimelineTranslationManager();

public:
    ITimelineItemBinding *GetOrCreate(UICDM::CUICDMInstanceHandle inInstance);
    void CreateNewPropertyRow(ITimelineItemProperty *inTimelineItemPropertyBinding,
                              CBaseStateRow *inParentRow, CPropertyRow *inNextRow);
    void RemovePropertyRow(ITimelineItemProperty *inTimelineItemPropertyBinding);

    void Clear();
    void Unregister(ITimelineItemBinding *inTimelineItem);

    CKeyframesManager *GetKeyframesManager() const;
    IBreadCrumbProvider *GetBreadCrumbProvider() const;
    CBaseStateRow *GetSelectedRow() const;
    long GetCurrentViewTime() const;
    CUICDMTimelineItemBinding *GetBinding(UICDM::CUICDMInstanceHandle inHandle) const;
    CUICDMTimelineItemBinding *GetSelectedBinding() const;

    void ClearKeyframeSelection();
    void OnNewPresentation();
    void OnSelectionChange(Q3DStudio::SSelectedValue inNewSelectable);

    UICDM::CStudioSystem *GetStudioSystem() const;

    // UICDM callback
    void OnAnimationCreated(UICDM::CUICDMInstanceHandle inInstance,
                            UICDM::CUICDMPropertyHandle inProperty);
    void OnAnimationDeleted(UICDM::CUICDMInstanceHandle inInstance,
                            UICDM::CUICDMPropertyHandle inProperty);
    void OnPropertyLinked(UICDM::CUICDMInstanceHandle inInstance,
                          UICDM::CUICDMPropertyHandle inProperty);
    void OnPropertyUnlinked(UICDM::CUICDMInstanceHandle inInstance,
                            UICDM::CUICDMPropertyHandle inProperty);
    void RefreshKeyframe(UICDM::CUICDMAnimationHandle inAnimation,
                         UICDM::CUICDMKeyframeHandle inKeyframe,
                         ETimelineKeyframeTransaction inTransaction);
    void OnKeyframeInserted(UICDM::CUICDMAnimationHandle inAnimation,
                            UICDM::CUICDMKeyframeHandle inKeyframe);
    void OnKeyframeDeleted(UICDM::CUICDMAnimationHandle inAnimation,
                           UICDM::CUICDMKeyframeHandle inKeyframe);
    void OnKeyframeUpdated(UICDM::CUICDMKeyframeHandle inKeyframe);
    void OnPropertyChanged(UICDM::CUICDMInstanceHandle inInstance,
                           UICDM::CUICDMPropertyHandle inProperty);
    void OnDynamicKeyframeChanged(UICDM::CUICDMAnimationHandle inAnimation, bool inDynamic);

    void OnAssetCreated(UICDM::CUICDMInstanceHandle inInstance);
    void OnAssetDeleted(UICDM::CUICDMInstanceHandle inInstance);
    void OnChildAdded(int inParent, int inChild, long inIndex);
    void OnChildRemoved(int inParent, int inChild, long inIndex);
    void OnChildMoved(int inParent, int inChild, long inOldIndex, long inNewIndex);

    void OnActionEvent(UICDM::CUICDMActionHandle inAction, UICDM::CUICDMSlideHandle inSlide,
                       UICDM::CUICDMInstanceHandle inOwner);

    // Helper function to iterate over all bindings
    void ClearBindingsKeyframeSelection();
    CDoc *GetDoc() const;

    // Store expanded state
    bool IsExpanded(UICDM::CUICDMInstanceHandle inInstance) const;
    void SetExpanded(UICDM::CUICDMInstanceHandle inInstance, bool inExpanded);

protected:
    void SetSelected(Q3DStudio::SSelectedValue inSelectable, bool inSelected);
    ITimelineItemBinding *EnsureLoaded(UICDM::CUICDMInstanceHandle inHandle);
};

#endif // INCLUDED_TIMELINE_TRANSLATIONMANAGER_H