summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qt3danimation-module.qdoc
blob: 294edb0e773f42d73eada42d7e35123395c340df (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
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \module Qt3DAnimation
    \title Qt 3D Animation C++ Classes

    \brief The Qt 3D Animation modules provides a set of prebuilt elements to help
    you get started with Qt 3D.

    This module is still in tech preview. This means it is unstable, likely to
    change and provided as a convenience only.

    \ingroup modules
    \ingroup qt3d-modules
    \qtvariable 3danimation

    \code
       #include <Qt3DAnimation>
    \endcode

    To link against the corresponding C++ library, add the following to your qmake project file:

    \badcode
       QT += 3danimation
    \endcode

    Classes, types, and functions are declared under the \l [Qt3DAnimation]{Qt3DAnimation} namespace.

    \section1 Overview

    \section2 Animations

    \list
    \li Qt3DAnimation::QKeyframeAnimation
    \endlist

    \section2 Clip animations

    \list
    \li Qt3DAnimation::QAnimationClip
    \endlist

    \section1 Reference
    \list
    \li \l {Qt 3D Animation C++ Classes}
    \li \l {Qt 3D Examples}
    \endlist
 */

/*!
    \namespace Qt3DAnimation
    \inmodule Qt3DAnimation
    \ingroup qt3d-namespaces

    \brief Contains classes from the Qt3DAnimation module.
*/

/*!
   \qmlmodule Qt3D.Animation 2.0
   \title Qt 3D Qt3DAnimation QML Types
   \ingroup qmlmodules
   \ingroup qt3d-qmlmodules

   \brief Provides Qt 3D QML types for the animation module.

   To import and use the module's QML types, use the following statement:

   \badcode
   import Qt3D.Animation 2.0
   \endcode
*/