summaryrefslogtreecommitdiffstats
path: root/src/Runtime/Source/runtime/Qt3DSComponentManager.h
blob: 865b8aa9f16fb878fbd5250534a8eedc34ae899f (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
/****************************************************************************
**
** Copyright (C) 1993-2009 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$
** 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 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** 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$
**
****************************************************************************/

#pragma once

//==============================================================================
//	Includes
//==============================================================================
#include "Qt3DSIComponentManager.h"
#include "EASTL/hash_map.h"

//==============================================================================
//	Namespace
//==============================================================================
namespace Q3DStudio {
class CTimePolicy;
class CPresentation;
struct SComponentTimePolicyOverride
{
    TElement *m_Element;
    FLOAT m_TimeMultiplier;
    TTimeUnit m_EndTime;
    IComponentTimeOverrideFinishedCallback *m_TimeCallback;
    SComponentTimePolicyOverride(TElement *inElement, FLOAT inMultiplier, TTimeUnit inEndTime,
                                 IComponentTimeOverrideFinishedCallback *inCallback)
        : m_Element(inElement)
        , m_TimeMultiplier(inMultiplier)
        , m_EndTime(inEndTime)
        , m_TimeCallback(inCallback)
    {
    }
    // Returns the local time and a boolean indicating if we have reached the end.
    // Implemented in UICTimePolicy.cpp so that I can compare the CTimePolicy::ComputeTime method
    // with
    // SComponentTimePolicyOverride::ComputLocalTime method
    eastl::pair<BOOL, TTimeUnit> ComputeLocalTime(CTimePolicy &inTimePolicy,
                                                  TTimeUnit inGlobalTime);
    // Implemented in UICTimePolicy.cpp
    void SetTime(CTimePolicy &inTimePolicy, TTimeUnit inLocalTime);
};

typedef eastl::hash_map<TElement *, SComponentGotoSlideData> TComponentGotoSlideDataMap;
typedef eastl::hash_map<TElement *, Q3DStudio::INT32> TComponentIntMap;

//==============================================================================
/**
 *	The Component Manager is a factory and container of all components
 *	within the presentation.
 */
class CComponentManager : public IComponentManager
{
    CPresentation &m_Presentation;
    //==============================================================================
    //	Methods
    //==============================================================================
public: // Construction
    CComponentManager(IPresentation &inPresentation);

public: // Slide
    void GotoSlideIndex(TElement *inComponent, const SComponentGotoSlideData &inGotoData,
                        BOOL inSlideExit = true) override;
    void GotoSlideName(TElement *inComponent, const TStringHash inSlideHashName) override;
    void GoToBackSlide(TElement *inComponent) override;
    void GoToNextSlide(TElement *inComponent, const INT32 inDecrement = 1) override;
    void GoToPreviousSlide(TElement *inComponent, const INT32 inDecrement = 1) override;
    void PlaythroughToSlide(TElement *inComponent);

    UINT8 GetSlideCount(TElement *inComponent) override;
    UINT8 GetCurrentSlide(TElement *inComponent) override;
    const CHAR *GetCurrentSlideName(TElement *inComponent) override;

    void OnElementDeactivated(TElement *inElement) override;

    void SetComponentTimeOverride(TElement *inElement, TTimeUnit inEndTime, FLOAT inInterpolation,
                                  IComponentTimeOverrideFinishedCallback *inCallback) override;

    // Allows multiple gotoslide command operating on the same element to work correctly.
    // This API is meant to fix a scenario where gotoslide is called multiple times in a frame
    // on the same component.  This isn't avoidable in some cases without very complex scene logic.

    // later calls override earlier calls
    void SetupComponentGotoSlideCommand(TElement *inElement,
                                        const SComponentGotoSlideData &inSlide) override;
    bool HasComponentGotoSlideCommand(TElement *inElement) override;
    SComponentGotoSlideData GetComponentGotoSlideCommand(TElement *inElement) override;
    void ReleaseComponentGotoSlideCommand(TElement *inElement) override;

public: // Time
    void GoToTime(TElement *inComponent, const TTimeUnit inTime) override;
    void SetPause(TElement *inComponent, const BOOL inPause) override;
    void SetTimePolicy(TElement *inComponent, const TTimeUnit inLoopDuration,
                       const UINT32 inRepetitions, const BOOL inPingPong, const BOOL inPlayThrough) override;

    TTimeUnit ComputeComponentLocalTime(TElement *inComponent, const TTimeUnit inGlobalTime);
    BOOL GetPause(TElement *inComponent) override;
    BOOL GetPlayBackDirection(TElement *inComponent) override;

protected: // Promotion
    TComponent *GetComponent(TElement *inElement) override;

private:
    // Disabled Copy Construction
    CComponentManager(const CComponentManager &);
    CComponentManager &operator=(const CComponentManager &);

    TComponentGotoSlideDataMap m_ComponentInitialSlideMap;
    TComponentGotoSlideDataMap m_ComponentGotoSlideMap;
    TComponentIntMap m_PlaythroughOverrideMap;

    //==============================================================================
    //	Friends
    //==============================================================================
    friend class CSlideBuilder;
};

} // namespace Q3DStudio