diff options
author | Nico Vertriest <nico.vertriest@qt.io> | 2018-10-24 15:06:58 +0200 |
---|---|---|
committer | Nico Vertriest <nico.vertriest@qt.io> | 2018-11-01 08:35:00 +0000 |
commit | 7b401dcd3345d42108eb162ea354f64152c9d0a4 (patch) | |
tree | e9bc776eb1bfdf9e342c7bd92d77bebe2415f4a2 /src/core/transforms | |
parent | acae8420e94d90a60096cf46c04f461ad134246c (diff) |
Doc: Add doc to undocumented methods
- qcomponent.cpp
- qbackendnode.cpp
- qjoint.cpp
- qskeletonloader.cpp
- qframeaction.cpp
- qscene2d.h
- qrenderaspect.cpp
Change-Id: I25881dee19d2d01f948bfaf4a156a97f6caaea73
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
Diffstat (limited to 'src/core/transforms')
-rw-r--r-- | src/core/transforms/qjoint.cpp | 6 | ||||
-rw-r--r-- | src/core/transforms/qskeletonloader.cpp | 12 |
2 files changed, 17 insertions, 1 deletions
diff --git a/src/core/transforms/qjoint.cpp b/src/core/transforms/qjoint.cpp index c9e672cef..017773ff6 100644 --- a/src/core/transforms/qjoint.cpp +++ b/src/core/transforms/qjoint.cpp @@ -325,6 +325,9 @@ void QJoint::setName(const QString &name) emit nameChanged(name); } +/*! + Sets the transform matrix for this joint to the identity matrix. +*/ void QJoint::setToIdentity() { setScale(QVector3D(1.0f, 1.0f, 1.0f)); @@ -388,6 +391,9 @@ QVector<QJoint *> QJoint::childJoints() const return d->m_childJoints; } +/*! + Returns the name of the joint. +*/ QString QJoint::name() const { Q_D(const QJoint); diff --git a/src/core/transforms/qskeletonloader.cpp b/src/core/transforms/qskeletonloader.cpp index 00026ecf5..a917252d9 100644 --- a/src/core/transforms/qskeletonloader.cpp +++ b/src/core/transforms/qskeletonloader.cpp @@ -120,7 +120,10 @@ void QSkeletonLoaderPrivate::setStatus(QSkeletonLoader::Status status) \value Ready The skeleton was successfully loaded \value Error An error occurred while loading the skeleton */ +/*! + \property Qt3DCore::QSkeletonLoader::createJointsEnabled + \brief A boolean to indicate whether createJoints is enabled or not. /*! Constructs a new QSkeletonLoader with \a parent. */ @@ -171,12 +174,19 @@ QSkeletonLoader::Status QSkeletonLoader::status() const return d->m_status; } +/*! + Returns a boolean indicating whether CreateJoints + is enabled or not. + The default value is \c false. +*/ bool QSkeletonLoader::isCreateJointsEnabled() const { Q_D(const QSkeletonLoader); return d->m_createJoints; } - +/*! + Returns the root joint of the hierarchy of joints forming the skeleton. +*/ Qt3DCore::QJoint *QSkeletonLoader::rootJoint() const { Q_D(const QSkeletonLoader); |