summaryrefslogtreecommitdiffstats
path: root/src/Runtime/Source/Runtime/Include/Qt3DSEventCallbacks.h
blob: 5c17477d22678b9d043ff1db9f125ba5c6340219 (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
/****************************************************************************
**
** 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

#include "Qt3DSEvent.h"
#include "Qt3DSMemory.h"

//==============================================================================
//	Namespace
//==============================================================================
namespace Q3DStudio {

//==============================================================================
//	Typedefs
//==============================================================================
typedef void (*TEventCallback)(void *inContextData, SEventCommand &ioEvent);

//==============================================================================
/**
 *	Manages the various events callbacks in the system. It fires the
 *	registered callbacks when an event was triggered.
 */
class CEventCallbacks
{
    //==============================================================================
    //	Structs
    //==============================================================================
protected:
    struct SCallbackEntry
    {
        TEventCallback m_Function; ///< Callback function pointer
        void *m_ContextData; ///< User data
    };
    typedef CArray<SCallbackEntry> TCallbackList; ///< Array of callbacks regisgtered

    struct SEventCallbackEntry
    {
        SEventCallbackEntry()
            : m_EventHash(0)
        {
        }
        ~SEventCallbackEntry() {}

        TEventCommandHash m_EventHash; ///< The event of interest
        TCallbackList m_Callbacks; ///< List of callbacks listening to this event

    private: // Disabled Copy Construction
        SEventCallbackEntry(const SEventCallbackEntry &);
        SEventCallbackEntry &operator=(const SEventCallbackEntry &);
    };
    typedef CArray<SEventCallbackEntry *> TEventCallbacksList; ///< Array of events with callback

    struct SElementCallbackEntry
    {
        SElementCallbackEntry()
            : m_Element(NULL)
        {
        }
        ~SElementCallbackEntry()
        {
            FOR_ARRAY(SEventCallbackEntry *, theEntry, m_EventEntries)
            Q3DStudio_delete(*theEntry, SEventCallbackEntry);
        }

        TElement *m_Element; ///< Element to monitor for event
        TEventCallbacksList m_EventEntries; ///< List of events listened on this element

    private: // Disabled Copy Construction
        SElementCallbackEntry(const SElementCallbackEntry &);
        SElementCallbackEntry &operator=(const SElementCallbackEntry &);
    };
    typedef CArray<SElementCallbackEntry *>
        TElementCallbacksList; ///< Array of elements with callbacks

    //==============================================================================
    //	Fields
    //==============================================================================
protected:
    TElementCallbacksList m_EventCallbacksList; ///< List of event callbacks
    TCallbackList m_CallbackList;

    //==============================================================================
    //	Methods
    //==============================================================================
public: // Construction
    CEventCallbacks();
    ~CEventCallbacks();

public: // Registration
    void RegisterCallback(TElement *inElement, const TEventCommandHash inEventHash,
                          const TEventCallback inCallback, void *inContextData);
    BOOL UnregisterCallback(TElement *inElement, const TEventCommandHash inEventHash,
                            const TEventCallback inCallback, void *inContextData, BOOL &outLast);
    void UnregisterAllCallbacks();

public: // Operation
    void FireCallbacks(SEventCommand &ioEvent);

protected:
    void PerformCallbacks(TCallbackList &inCallbackList, SEventCommand &ioEvent);

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

} // namespace Q3DStudio