summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Studio/Palettes/Timeline/TimelineControl.h
blob: 470a10a5e5762ca5a0ea426e9bd7f5d1ee7208c5 (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
/****************************************************************************
**
** Copyright (C) 1999-2002 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_CONTROL_H
#define INCLUDED_TIMELINE_CONTROL_H 1

#pragma once

//==============================================================================
//	Includes
//==============================================================================
#include "Control.h"
#include "DispatchListeners.h"
#include "TimelineRow.h"
#include "ITimelineControl.h"

#include "UICDMHandles.h"
#include "UICDMSignals.h"
#include "SelectedValueImpl.h"

//==============================================================================
//	Forwards
//==============================================================================
class CDoc;
class CDropTarget;
class CTimelineSplitter;
class CTimelineTreeLayout;
class CTimelineTimelineLayout;
class CScroller;
class CInsertionLine;
class CInsertionOverlay;
class CRenderer;
class CHotKeys;
class CBreadCrumbControl;
class CTimelineTranslationManager;
class CClientDataModelBridge;

//==============================================================================
//	Classes
//==============================================================================

class CTimelineControl : public CControl,
                         public CPresentationChangeListener,
                         public CClientPlayChangeListener,
                         public ITimelineControl
{
public:
    CTimelineControl();
    ~CTimelineControl();

    DEFINE_OBJECT_COUNTER(CTimelineControl)

    // CControl
    void OnDraw(CRenderer *inRenderer, CRct &inDirtyRect, bool inIgnoreValidation = false) override;
    void Draw(CRenderer *inRenderer) override;
    void OnGainFocus() override;
    CDropTarget *FindDropCandidate(CPt &inMousePoint, Qt::KeyboardModifiers inFlags) override;
    void OnMouseOut(CPt inPoint, Qt::KeyboardModifiers inFlags) override;
    void OnMouseUp(CPt inPoint, Qt::KeyboardModifiers inFlags) override;

    // Presentation Change Listener
    void OnNewPresentation() override;
    void OnClosingPresentation() override;
    void OnSavingPresentation(const CUICFile *inNewPresentationFile) override;

    // ClientPlayChangeListener
    void OnPlayStart() override;
    void OnPlayStop() override;
    void OnTimeChanged(long inNewTime) override;

    // CSelectionChangeListener,
    virtual void OnSelectionChange(Q3DStudio::SSelectedValue inNewSelectable);

    // ITimelineControl
    void OnLayoutChanged() override;
    CRct GetBounds() const override;
    void HideTimelineMoveableTooltip() override;
    ISnappingListProvider *GetSnappingListProvider() const override;

    void ClearView();
    void ViewSlide(UICDM::CUICDMSlideHandle inSlide);
    UICDM::CUICDMSlideHandle GetActiveSlide();

    CTimelineTimelineLayout *GetTimelineLayout();
    CTimelineTreeLayout *GetTreeLayout();

    void SetSize(CPt inSize) override;
    long GetTime();
    void SetScrollPositionY(CScroller *inSource, long inPositionY);

    CInsertionLine *GetInsertionLine();
    CInsertionOverlay *GetInsertionOverlay();
    CRct GetVisibleTreeLayoutArea();

    void RegisterGlobalKeyboardShortcuts(CHotKeys *inShortcutHandler);

    CTimelineTranslationManager *GetTranslationManager() const { return m_TranslationManager; }

protected:
    void SuspendLayoutChanges(bool inSuspend);
    void SetTime(long inNewTime);

    void HideInsertionMarkers();

    // UICDM callbacks
    void OnActiveSlide(UICDM::CUICDMSlideHandle inSlide);
    void OnDeleteSlide(UICDM::CUICDMSlideHandle inSlide);

    // Helper functions
    inline CDoc *GetDoc();
    inline CClientDataModelBridge *GetBridge();

    CTimelineSplitter *m_Splitter;
    CTimelineTreeLayout *m_TreeLayout;
    CTimelineTimelineLayout *m_TimelineLayout;
    UICDM::CUICDMSlideHandle m_ActiveSlide;
    CInsertionLine
        *m_InsertionLine; ///< Drag-and-drop insertion line for dropping between timeline items
    CInsertionOverlay
        *m_InsertionOverlay; ///< Drag-and-drop insertion marker for dropping on a timeline item
    CBreadCrumbControl *m_BreadCrumbToolbar;
    bool m_SuspendRecalcLayout;

    CTimelineTranslationManager *m_TranslationManager;

    std::vector<std::shared_ptr<UICDM::ISignalConnection>>
        m_Connections; /// connections to the UICDM
};
#endif // INCLUDED_TIMELINE_CONTROL_H