blob: 9e3d9e4b70d903751482a4934eb34d3054e4f239 (
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
|
/****************************************************************************
**
** Copyright (C) 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$
**
****************************************************************************/
#pragma once
#ifndef ITICKTOCKH
#define ITICKTOCKH
namespace qt3dsdm {
class ISignalConnection;
}
QT_BEGIN_NAMESPACE
class QWidget;
QT_END_NAMESPACE
typedef std::function<void()> TTickTockProc;
namespace Q3DStudio {
/**
* ITickTock is meant for a relatively small number of scheduled
* events that need to happen on the UI thread. Clients can cancel
* any event simply by releasing the returned shared pointer.
* Interface is completely threadsafe and the returned signal connection
* may safely outlive the interface.
*/
class ITickTock
{
protected:
virtual ~ITickTock() {}
static ITickTock *m_Instance;
public:
// The timer is canceled if the shared ptr deletes the signal connection. Save to call from any
// thread.
// The callback, however, (inTickTockProc) will be activated solely from the UI thread.
virtual std::shared_ptr<qt3dsdm::ISignalConnection>
AddTimer(unsigned long inTime, bool inIsPeriodic, TTickTockProc inTickTockProc,
const QString &inName) = 0;
// Called from UI thread to process all of the messages
// that have happened in the timer thread.
// Clients should not generally call this, it will be take care of for them.
// In the current implementation, MainFrm.h processes the tick tock message
// in order to call this function.
virtual void ProcessMessages() = 0;
friend class std::shared_ptr<ITickTock>;
// m_Instance is set to the first tick tock created, and unset when that tick tock
// goes away.
static std::shared_ptr<ITickTock> CreateTickTock(long inMessageID, QWidget* inTarget);
static ITickTock &GetInstance();
};
}
#endif
|
