summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc12
-rw-r--r--examples/qt3d/wireframe/doc/src/wireframe.qdoc5
-rw-r--r--src/core/aspects/qabstractaspect.cpp21
-rw-r--r--src/core/nodes/qentity.cpp6
-rw-r--r--src/core/nodes/qnode.cpp13
-rw-r--r--src/core/qbackendscenepropertychange.cpp7
-rw-r--r--src/doc/qt3d.qdocconf3
-rw-r--r--src/doc/src/qt3d-index.qdoc5
-rw-r--r--src/doc/src/qt3d-module.qdoc7
-rw-r--r--src/doc/src/qt3dcollision-module.qdoc74
-rw-r--r--src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp3
-rw-r--r--src/render/defaults/qphongalphamaterial.cpp2
12 files changed, 62 insertions, 96 deletions
diff --git a/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc b/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc
index 5d47a4d3e..c2437100d 100644
--- a/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc
+++ b/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc
@@ -58,8 +58,8 @@
import the modules:
\quotefromfile shadow-map-qml/main.qml
- \skipto import Qt3D
- \printuntil Render
+ \skipto import Qt3D.Core
+ \printuntil Render 2.0
The first entities we create are a \l Camera, which represents the camera
used for the final rendering, and a \l Configuration, which allows us to
@@ -90,11 +90,11 @@
\section1 Specifying the Light
- We specify the Light custom entity in \e Light.qml.
+ We specify the Light custom entity in \e ShadowMapLight.qml.
Again, we import the necessary modules:
- \quotefromfile shadow-map-qml/Light.qml
+ \quotefromfile shadow-map-qml/ShadowMapLight.qml
\skipto import Qt3D
\printuntil Qt3D.Render
@@ -118,8 +118,8 @@
Qt Quick module:
\quotefromfile shadow-map-qml/ShadowMapFrameGraph.qml
- \skipto import Qt3D
- \printuntil QtQuick
+ \skipto import QtQuick
+ \printuntil Render 2.0
The code defines a \l FrameGraph entity that has a tree of entities as the
active framegraph:
diff --git a/examples/qt3d/wireframe/doc/src/wireframe.qdoc b/examples/qt3d/wireframe/doc/src/wireframe.qdoc
index 6791f2a3a..a3e9c03ae 100644
--- a/examples/qt3d/wireframe/doc/src/wireframe.qdoc
+++ b/examples/qt3d/wireframe/doc/src/wireframe.qdoc
@@ -81,7 +81,6 @@
named uniform variables:
\skipto Transform
- \printuntil phiRotation
\printuntil }
\section1 Loading Dynamic Per-Vertex Data
@@ -123,8 +122,8 @@
need for animations:
\quotefromfile wireframe/main.qml
- \skipto import Qt3D
- \printuntil QtQuick
+ \skipto import QtQuick
+ \printuntil Render 2.0
We use an \l Entity type as the root type simply to act as a parent for
its children. In this sense, the \l Entity type is much like the \l Item
diff --git a/src/core/aspects/qabstractaspect.cpp b/src/core/aspects/qabstractaspect.cpp
index 72ec7c502..2b7e02e68 100644
--- a/src/core/aspects/qabstractaspect.cpp
+++ b/src/core/aspects/qabstractaspect.cpp
@@ -81,13 +81,30 @@ QAbstractAspect::QAbstractAspect(QObject *parent)
: QObject(*new QAbstractAspectPrivate, parent)
{
}
+/*!
+ \typedef Qt3DCore::QAspectJobPtr
+ \relates Qt3DCore::QAbstractAspect
+
+ A shared pointer for QAspectJob.
+*/
+
+/*!
+ \typedef Qt3DCore::QBackendNodeFunctorPtr
+ \relates Qt3DCore::QAbstractAspect
+
+ A shared pointer for QBackendNodeFunctor.
+*/
-/*! \internal */
+/*!
+ \internal
+*/
QAbstractAspect::QAbstractAspect(QAbstractAspectPrivate &dd, QObject *parent)
: QObject(dd, parent)
{
}
-
+/*!
+ Registers backend.
+*/
void QAbstractAspect::registerBackendType(const QMetaObject &obj, const QBackendNodeFunctorPtr &functor)
{
Q_D(QAbstractAspect);
diff --git a/src/core/nodes/qentity.cpp b/src/core/nodes/qentity.cpp
index 7bca65917..c0396cb21 100644
--- a/src/core/nodes/qentity.cpp
+++ b/src/core/nodes/qentity.cpp
@@ -118,6 +118,12 @@ void QEntity::copy(const QNode *ref)
addComponent(qobject_cast<QComponent *>(ccclone));
}
}
+/*!
+ \typedef Qt3DCore::QComponentList
+ \relates Qt3DCore::QEntity
+
+ List of QComponent pointers.
+*/
/*!
Returns the list of Qt3DCore::QComponent instances the entity is referencing.
diff --git a/src/core/nodes/qnode.cpp b/src/core/nodes/qnode.cpp
index 8378e1f5f..791754c24 100644
--- a/src/core/nodes/qnode.cpp
+++ b/src/core/nodes/qnode.cpp
@@ -538,6 +538,19 @@ void QNode::setParent(QNode *parent)
}
/*!
+ \typedef Qt3DCore::QNodePtr
+ \relates Qt3DCore::QNode
+
+ A shared pointer for QNode.
+*/
+/*!
+ \typedef Qt3DCore::QNodeList
+ \relates Qt3DCore::QNode
+
+ List of QNode pointers.
+*/
+
+/*!
* Returns a list filled with the QNode children of the current
* QNode instance.
*/
diff --git a/src/core/qbackendscenepropertychange.cpp b/src/core/qbackendscenepropertychange.cpp
index a68edda39..c2b73084b 100644
--- a/src/core/qbackendscenepropertychange.cpp
+++ b/src/core/qbackendscenepropertychange.cpp
@@ -83,6 +83,13 @@ QNodeId QBackendScenePropertyChange::targetNode() const
return d->m_targetUuid;
}
+/*!
+ \typedef Qt3DCore::QBackendScenePropertyChangePtr
+ \relates Qt3DCore::QBackendScenePropertyChange
+
+ A shared pointer for QBackendScenePropertyChange.
+*/
+
/*! \internal */
QBackendScenePropertyChange::QBackendScenePropertyChange(QBackendScenePropertyChangePrivate &dd)
: QScenePropertyChange(dd)
diff --git a/src/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf
index d36c1d280..49f612619 100644
--- a/src/doc/qt3d.qdocconf
+++ b/src/doc/qt3d.qdocconf
@@ -79,7 +79,8 @@ Cpp.ignoretokens += QT3DCORE_PRIVATE_EXPORT \
QT3DLOGIC_PRIVATE_EXPORT \
QT3DLOGICSHARED_EXPORT \
QT3DRENDERSHARED_EXPORT \
- QT3DRENDERSHARED_PRIVATE_EXPORT
+ QT3DRENDERSHARED_PRIVATE_EXPORT \
+ QT3DQUICKSHARED_PRIVATE_EXPORT
Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY
diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc
index 4c2ce5a11..9c4255ac8 100644
--- a/src/doc/src/qt3d-index.qdoc
+++ b/src/doc/src/qt3d-index.qdoc
@@ -58,7 +58,7 @@
\l qmake \c .pro file:
\badcode
- QT += 3dcore 3drender 3dinput 3dcollision 3dlogic
+ QT += 3dcore 3drender 3dinput 3dlogic
\endcode
To include the definitions of the modules' classes, use the following
@@ -68,14 +68,13 @@
#include <Qt3DCore>
#include <Qt3DRender>
#include <Qt3DInput>
- #include <Qt3DCollision>
#include <Qt3DLogic>
\endcode
A Qt Quick application requires also additional dependencies:
\badcode
- QT += 3dcore 3drenderer 3dinput 3dcollision qml quick 3dquick
+ QT += 3dcore 3drenderer 3dinput qml quick 3dquick
\endcode
\section1 Overview
diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc
index 90bbd5e86..264c258c3 100644
--- a/src/doc/src/qt3d-module.qdoc
+++ b/src/doc/src/qt3d-module.qdoc
@@ -63,9 +63,6 @@
\section2 Qt 3D Core Module
\generatelist {classesbymodule Qt3DCore}
- \section2 Qt 3D Collision Module
- \generatelist {classesbymodule Qt3DCollision}
-
\section2 Qt 3D Input Module
\generatelist {classesbymodule Qt3DInput}
@@ -104,7 +101,6 @@
following import statements:
\badcode
- import Qt3D.Collision 2.0
import Qt3D.Render 2.0
import Qt3D.Input 2.0
import Qt3D.Logic 2.0
@@ -115,9 +111,6 @@
\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}
diff --git a/src/doc/src/qt3dcollision-module.qdoc b/src/doc/src/qt3dcollision-module.qdoc
deleted file mode 100644
index 84ee787db..000000000
--- a/src/doc/src/qt3dcollision-module.qdoc
+++ /dev/null
@@ -1,74 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2015 The Qt Company Ltd.
-** Contact: http://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 http://www.qt.io/terms-conditions. For further
-** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \module Qt3DCollision
- \title Qt 3D Collision C++ Classes
- \brief The Qt 3D Collision module enables collision detection.
- \ingroup modules
- \ingroup qt3d-modules
- \qtvariable 3dcollision
-
- To use classes from this module, add this directive into the C++ files:
-
- \code
- #include <Qt3DCollision>
- \endcode
-
- To link against the corresponding C++ libraries, add the following to your qmake project file:
-
- \badcode
- QT += 3dcollision
- \endcode
-
-*/
-
-/*!
- \namespace Qt3DCollision
- \inmodule Qt3DCollision
- \ingroup qt3d-namespaces
-
- \brief Contains classes that enable collision detection.
-*/
-
-/*!
- \qmlmodule Qt3D.Collision 2.0
- \title Qt 3D Collision QML Types
- \ingroup qmlmodules
- \ingroup qt3d-qmlmodules
-
- \brief Provides QML types to synchronize frames with the 3D backend.
-
- To import and use the module's QML types, use the following statement:
-
- \badcode
- import Qt3D.Collision 2.0
- \endcode
-
- \section1 QML Types
-*/
-
diff --git a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp
index a4ab82155..5d267fe90 100644
--- a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp
+++ b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp
@@ -77,6 +77,9 @@ public:
QVector<QPointer<QObject> > m_objects;
};
+/*!
+ \internal
+*/
Quick3DNodeInstantiatorPrivate::Quick3DNodeInstantiatorPrivate()
: QNodePrivate()
, m_componentComplete(true)
diff --git a/src/render/defaults/qphongalphamaterial.cpp b/src/render/defaults/qphongalphamaterial.cpp
index a55e13f9b..8968f5f85 100644
--- a/src/render/defaults/qphongalphamaterial.cpp
+++ b/src/render/defaults/qphongalphamaterial.cpp
@@ -206,6 +206,8 @@ void QPhongAlphaMaterialPrivate::handleAlphaChanged(const QVariant &var)
*/
/*!
+ \fn Qt3DRender::QPhongAlphaMaterial::QPhongAlphaMaterial(Qt3DCore::QNode *parent)
+
Constructs a new QPhongAlphaMaterial instance with parent object \a parent.
*/
QPhongAlphaMaterial::QPhongAlphaMaterial(QNode *parent)
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-25 15:04:06 +0000