summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qt3dextras-module.qdoc
blob: 087018139d5b471d4e51cd502ef5fb5571b6ea2c (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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/****************************************************************************
**
** Copyright (C) 2016 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 Qt3DExtras
    \title Qt 3D Extras C++ Classes

    \brief The Qt 3D Extras 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 3dextras

    \code
       #include <Qt3DExtras>
    \endcode

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

    \badcode
       QT += 3dextras
    \endcode

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

    \section1 Overview

    \section2 Materials

    \list
    \li Qt3DExtras::QDiffuseMapMaterial
    \li Qt3DExtras::QDiffuseSpecularMapMaterial
    \li Qt3DExtras::QGoochMaterial
    \li Qt3DExtras::QNormalDiffuseMapMaterial
    \li Qt3DExtras::QNormalDiffuseMapAlphaMaterial
    \li Qt3DExtras::QNormalDiffuseSpecularMapMaterial
    \li Qt3DExtras::QPerVertexColorMaterial
    \li Qt3DExtras::QPhongMaterial
    \li Qt3DExtras::QPhongAlphaMaterial
    \endlist

    \section2 Meshes and Geometries

    \list
    \li Qt3DExtras::QConeGeometry
    \li Qt3DExtras::QConeMesh
    \li Qt3DExtras::QCuboidGeometry
    \li Qt3DExtras::QCuboidMesh
    \li Qt3DExtras::QCylinderGeometry
    \li Qt3DExtras::QCylinderMesh
    \li Qt3DExtras::QPlaneGeometry
    \li Qt3DExtras::QPlaneMesh
    \li Qt3DExtras::QSphereGeometry
    \li Qt3DExtras::QSphereMesh
    \li Qt3DExtras::QTorusGeometry
    \li Qt3DExtras::QTorusMesh
    \endlist

    \section2 Camera Controllers

    \list
    \li Qt3DExtras::QFirstPersonCameraController
    \li Qt3DExtras::QOrbitCameraController
    \endlist

    \section2 Entities

    \list
    \li Qt3DExtras::QSkyboxEntity
    \endlist

    \section2 FrameGraphs

    \list
    \li Qt3DExtras::QForwardRenderer
    \endlist

    \section2 Window

    \list
    \li Qt3DExtras::Qt3DWindow
    \endlist

    \note The Quick3DExtras module also specifies a Qt3DExtras::Quick::Qt3DQuickWindow.

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

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

    \brief Contains classes from the Qt3DExtras module.
*/

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

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

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

   \badcode
   import Qt3D.Extras 2.0
   \endcode
*/