blob: ddb05ef970488762420a14207e6c96569d4dd45d (
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
|
// Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qframeaction.h"
#include "qframeaction_p.h"
QT_BEGIN_NAMESPACE
namespace Qt3DLogic {
QFrameActionPrivate::QFrameActionPrivate()
: QComponentPrivate()
{
}
/*!
\namespace Qt3DLogic::Logic
\inmodule Qt3DLogic
\brief Used to import and use the module's QML types.
*/
/*!
\class Qt3DLogic::QFrameAction
\inmodule Qt3DLogic
\since 5.5
\brief Provides a way to have a synchronous function executed each frame.
The QFrameAction provides a way to perform tasks each frame in a
synchronized way with the Qt3D backend. This is useful to implement some
aspects of application logic and to prototype functionality that can later
be folded into an additional Qt3D aspect.
For example, the QFrameAction can be used to animate a property in sync
with the Qt3D engine where a Qt Quick animation element is not perfectly
synchronized and may lead to stutters in some cases.
To execute your own code each frame connect to the QFrameAction::triggered signal.
*/
/*!
\qmltype FrameAction
\inqmlmodule Qt3D.Logic
\instantiates Qt3DLogic::QFrameAction
\inherits Component3D
\since 5.5
\brief Provides a way to have a synchronous function executed each frame.
The FrameAction provides a way to perform tasks each frame in a
synchronized way with the Qt3D backend. This is useful to implement some
aspects of application logic and to prototype functionality that can later
be folded into an additional Qt3D aspect.
For example, the FrameAction can be used to animate a property in sync
with the Qt3D engine where a Qt Quick animation element is not perfectly
synchronized and may lead to stutters in some cases.
To execute your own code each frame connect to the FrameAction::triggered signal.
*/
/*!
Constructs a new QFrameAction instance with parent \a parent.
*/
QFrameAction::QFrameAction(QNode *parent)
: QComponent(*new QFrameActionPrivate, parent)
{
}
/*! \internal */
QFrameAction::~QFrameAction()
{
}
/*! \internal */
QFrameAction::QFrameAction(QFrameActionPrivate &dd, QNode *parent)
: QComponent(dd, parent)
{
}
/*!
\internal
This function will be called in a synchronous manner once each frame by
the Logic aspect.
*/
void QFrameAction::onTriggered(float dt)
{
// Emit signal so that QML instances get the onTriggered() signal
// handler called
emit triggered(dt);
}
/*!
\qmlsignal Qt3D.Logic::FrameAction::triggered(real dt)
This signal is emitted each frame with \a dt being the time (in seconds) since the last triggering.
*/
/*!
\fn Qt3DLogic::QFrameAction::triggered(float dt)
This signal is emitted each frame with \a dt being the time (in seconds) since the last triggering.
*/
} // namespace Qt3DLogic
QT_END_NAMESPACE
|
