summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2019-10-07 15:38:49 +0300
committerMats Honkamaa <mats.honkamaa@qt.io>2019-10-08 07:46:36 +0300
commitb367a04314ad0624c9ddb9d56ae50dac10c966b3 (patch)
tree2e2cac4de711f8c65c172dd8bc92ed66b55f9112
parent905444291f3da2dd10769683c75508732d983ac9 (diff)
Add documentation for AbstractClipAnimator QML type properties
Add documentation for the following QML properties: channelMapper, clock, normalizedTime, running. Task-number: QTBUG-78482 Change-Id: I1c24b5f9cbf647eda6f7bb329c58e496dcb22f4a Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
-rw-r--r--src/animation/frontend/qabstractclipanimator.cpp22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/animation/frontend/qabstractclipanimator.cpp b/src/animation/frontend/qabstractclipanimator.cpp
index 238dbea8c..2d4de676c 100644
--- a/src/animation/frontend/qabstractclipanimator.cpp
+++ b/src/animation/frontend/qabstractclipanimator.cpp
@@ -138,6 +138,11 @@ void QAbstractClipAnimator::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &ch
QAbstractClipAnimator::~QAbstractClipAnimator()
{
}
+/*!
+ \qmlproperty bool Qt3DAnimation::AbstractClipAnimator::running
+
+ This property holds a boolean indicating whether the animation is currently running.
+*/
/*!
\property Qt3DAnimation::QAbstractClipAnimator::running
@@ -155,6 +160,13 @@ bool QAbstractClipAnimator::isRunning() const
}
/*!
+ \qmlproperty ChannelMapper Qt3DAnimation::AbstractClipAnimator::channelMapper
+
+ This property holds the ChannelMapper that controls how the channels in
+ the animation clip map onto the properties of the target objects.
+*/
+
+/*!
\property Qt3DAnimation::QAbstractClipAnimator::channelMapper
This property holds the ChannelMapper that controls how the channels in
@@ -212,6 +224,12 @@ int QAbstractClipAnimator::loopCount() const
return d->m_loops;
}
/*!
+ \qmlproperty Clock Qt3DAnimation::AbstractClipAnimator::clock
+
+ The clock controls the speed with which an animation is played.
+*/
+
+/*!
\property Qt3DAnimation::QAbstractClipAnimator::clock
The clock controls the speed with which an animation is played.
@@ -221,7 +239,11 @@ QClock *QAbstractClipAnimator::clock() const
Q_D(const QAbstractClipAnimator);
return d->m_clock;
}
+/*!
+ \qmlproperty real Qt3DAnimation::AbstractClipAnimator::normalizedTime
+ This property holds the clips normalized time.
+*/
/*!
\property Qt3DAnimation::QAbstractClipAnimator::normalizedTime