summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qt3d-module.qdoc
blob: 8fdcbcd628928d44e6d69fe3281a59845199180e (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
/****************************************************************************
**
** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or 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.GPL2 and 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \module Qt3DCore
    \title Qt 3D Core C++ Classes
    \brief The Qt 3D module contains functionality to support near-realtime simulation systems.

    \ingroup modules
    \ingroup qt3d-modules
    \qtvariable 3dcore

    The Qt 3D module provides the foundations and core types used for near-realtime
    simulations built on the Qt 3D framework.
*/

/*!
    \page qt3d-cpp.html
    \title Qt 3D C++ Classes
    \brief The Qt 3D module contains functionality to support near-realtime simulation systems.

    The Qt 3D module provides the foundations and core types used for near-realtime
    simulations built on the Qt 3D framework.

    \section1 Namespaces
    \annotatedlist qt3d-namespaces

    \section1 Classes

    \section2 Qt 3D Core Module
    \generatelist {classesbymodule Qt3DCore}

    \section2 Qt 3D Collision Module
    \generatelist {classesbymodule Qt3DCollision}

    \section2 Qt 3D Input Module
    \generatelist {classesbymodule Qt3DInput}

    \section2 Qt 3D Logic Module
    \generatelist {classesbymodule Qt3DLogic}

    \section2 Qt 3D Render Module
    \generatelist {classesbymodule Qt3DRender}
*/

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

    \brief Contains classes that are the foundation for Qt 3D simulation
    framework, as well as classes that provide the ability to render using the
    Qt 3D framework.
*/

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

   \brief Provides core Qt 3D QML types.

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

   \badcode
   import Qt3D.Core 2.0
   \endcode

   For collision detection, renderer, and input-related QML types, use the
   following import statements:

   \badcode
   import Qt3D.Collision 2.0
   import Qt3D.Render 2.0
   import Qt3D.Input 2.0
   import Qt3D.Logic 2.0
   \endcode

   \section1 QML Types

   \section2 Qt 3D Core Module
   \generatelist {qmltypesbymodule Qt3D.Core}

   \section2 Qt 3D Collision Module
   \generatelist {qmltypesbymodule Qt3D.Collision}

   \section2 Qt 3D Input Module
   \generatelist {qmltypesbymodule Qt3D.Input}

   \section2 Qt 3D Logic Module
   \generatelist {qmltypesbymodule Qt3D.Logic}

   \section2 Qt 3D Render Module
   \generatelist {qmltypesbymodule Qt3D.Render}
   \noautolist
*/