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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtQuick 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$
**
****************************************************************************/
#include "qquickanimator_p_p.h"
#include "qquickanimatorjob_p.h"
#include <private/qquickitem_p.h>
QT_BEGIN_NAMESPACE
/*!
\qmltype Animator
\instantiates QQuickAnimator
\inqmlmodule QtQuick
\since 5.2
\ingroup qtquick-transitions-animations
\inherits Animation
\brief Is the base of all QML animators.
Animator types are a special type of animation which operate
directly on Qt Quick's scene graph, rather than the QML objects and their
properties like regular Animation types do. This has the benefit that
Animator based animations can animate on the \l
{Threaded Render Loop ("threaded")}{scene graph's rendering thread} even when the
UI thread is blocked.
The value of the QML property will be updated after the animation has
finished. The property is not updated while the animation is running.
The Animator types can be used just like any other Animation type.
\snippet qml/animators.qml mixed
If all sub-animations of ParallelAnimation and SequentialAnimation
are Animator types, the ParallelAnimation and SequentialAnimation will
also be treated as an Animator and be run on the scene graph's rendering
thread when possible.
The Animator types can be used for animations during transitions, but
they do not support the \l {Transition::reversible}{reversible}
property.
The Animator type cannot be used directly in a QML file. It exists
to provide a set of common properties and methods, available across all the
other animator types that inherit from it. Attempting to use the Animator
type directly will result in an error.
*/
QQuickAnimator::QQuickAnimator(QQuickAnimatorPrivate &dd, QObject *parent)
: QQuickAbstractAnimation(dd, parent)
{
}
QQuickAnimator::QQuickAnimator(QObject *parent)
: QQuickAbstractAnimation(*new QQuickAnimatorPrivate, parent)
{
}
/*!
\qmlproperty QtQuick::Item QtQuick::Animator::target
This property holds the target item of the animator.
\note Animator targets must be Item based types.
*/
void QQuickAnimator::setTargetItem(QQuickItem *target)
{
Q_D(QQuickAnimator);
if (target == d->target)
return;
d->target = target;
Q_EMIT targetItemChanged(d->target);
}
QQuickItem *QQuickAnimator::targetItem() const
{
Q_D(const QQuickAnimator);
return d->target;
}
/*!
\qmlproperty int QtQuick::Animator::duration
This property holds the duration of the animation in milliseconds.
The default value is 250.
*/
void QQuickAnimator::setDuration(int duration)
{
Q_D(QQuickAnimator);
if (duration == d->duration)
return;
d->duration = duration;
Q_EMIT durationChanged(duration);
}
int QQuickAnimator::duration() const
{
Q_D(const QQuickAnimator);
return d->duration;
}
/*!
\qmlpropertygroup QtQuick::Animator::easing
\qmlproperty enumeration QtQuick::Animator::easing.type
\qmlproperty real QtQuick::Animator::easing.amplitude
\qmlproperty real QtQuick::Animator::easing.overshoot
\qmlproperty real QtQuick::Animator::easing.period
\qmlproperty list<real> QtQuick::Animator::easing.bezierCurve
\include qquickanimation.cpp propertyanimation.easing
*/
void QQuickAnimator::setEasing(const QEasingCurve &easing)
{
Q_D(QQuickAnimator);
if (easing == d->easing)
return;
d->easing = easing;
Q_EMIT easingChanged(d->easing);
}
QEasingCurve QQuickAnimator::easing() const
{
Q_D(const QQuickAnimator);
return d->easing;
}
/*!
\qmlproperty real QtQuick::Animator::to
This property holds the end value for the animation.
If the Animator is defined within a \l Transition or \l Behavior,
this value defaults to the value defined in the end state of the
\l Transition, or the value of the property change that triggered the
\l Behavior.
*/
void QQuickAnimator::setTo(qreal to)
{
Q_D(QQuickAnimator);
if (to == d->to)
return;
d->isToDefined = true;
d->to = to;
Q_EMIT toChanged(d->to);
}
qreal QQuickAnimator::to() const
{
Q_D(const QQuickAnimator);
return d->to;
}
/*!
\qmlproperty real QtQuick::Animator::from
This property holds the starting value for the animation.
If the Animator is defined within a \l Transition or \l Behavior,
this value defaults to the value defined in the starting state of the
\l Transition, or the current value of the property at the moment the
\l Behavior is triggered.
\sa {Animation and Transitions in Qt Quick}
*/
void QQuickAnimator::setFrom(qreal from)
{
Q_D(QQuickAnimator);
if (from == d->from)
return;
d->isFromDefined = true;
d->from = from;
Q_EMIT fromChanged(d->from);
}
qreal QQuickAnimator::from() const
{
Q_D(const QQuickAnimator);
return d->from;
}
void QQuickAnimatorPrivate::apply(QQuickAnimatorJob *job,
const QString &propertyName,
QQuickStateActions &actions,
QQmlProperties &modified,
QObject *defaultTarget)
{
if (actions.size()) {
for (int i=0; i<actions.size(); ++i) {
QQuickStateAction &action = actions[i];
if (action.property.name() != propertyName)
continue;
modified << action.property;
job->setTarget(qobject_cast<QQuickItem *>(action.property.object()));
if (isFromDefined)
job->setFrom(from);
else if (action.fromValue.isValid())
job->setFrom(action.fromValue.toReal());
else
job->setFrom(action.property.read().toReal());
if (isToDefined)
job->setTo(to);
else if (action.toValue.isValid())
job->setTo(action.toValue.toReal());
else
job->setTo(action.property.read().toReal());
// This magic line is in sync with what PropertyAnimation does
// and prevents the animation to end up in the "completeList"
// which forces action.toValue to be written directly to
// the item when a transition is cancelled.
action.fromValue = action.toValue;
}
}
if (modified.isEmpty()) {
job->setTarget(target);
job->setFrom(from);
job->setTo(to);
}
if (!job->target()) {
if (defaultProperty.object())
job->setTarget(qobject_cast<QQuickItem *>(defaultProperty.object()));
else
job->setTarget(qobject_cast<QQuickItem *>(defaultTarget));
}
job->setDuration(duration);
job->setLoopCount(loopCount);
job->setEasingCurve(easing);
}
QAbstractAnimationJob *QQuickAnimator::transition(QQuickStateActions &actions,
QQmlProperties &modified,
TransitionDirection direction,
QObject *defaultTarget)
{
Q_D(QQuickAnimator);
if (d->defaultProperty.isValid() && propertyName() != d->defaultProperty.name()) {
qDebug() << Q_FUNC_INFO << "property name conflict...";
return nullptr;
}
// The animation system cannot handle backwards uncontrolled animations.
if (direction == Backward)
return nullptr;
QQuickAnimatorJob *job = createJob();
if (!job)
return nullptr;
d->apply(job, propertyName(), actions, modified, defaultTarget);
if (!job->target()) {
delete job;
return nullptr;
}
return job;
}
/*!
\qmltype XAnimator
\instantiates QQuickXAnimator
\inqmlmodule QtQuick
\since 5.2
\ingroup qtquick-transitions-animations
\inherits Animator
\brief The XAnimator type animates the x position of an Item.
\l{Animator} types are different from normal Animation types. When
using an Animator, the animation can be run in the render thread
and the property value will jump to the end when the animation is
complete.
The value of Item::x is updated after the animation has finished.
The following snippet shows how to use a XAnimator together
with a Rectangle item.
\snippet qml/animators.qml x target
It is also possible to use the \c on keyword to tie the
XAnimator directly to an Item instance.
\snippet qml/animators.qml x on
*/
QQuickXAnimator::QQuickXAnimator(QObject *parent) : QQuickAnimator(parent) {}
QQuickAnimatorJob *QQuickXAnimator::createJob() const { return new QQuickXAnimatorJob(); }
/*!
\qmltype YAnimator
\instantiates QQuickYAnimator
\inqmlmodule QtQuick
\since 5.2
\ingroup qtquick-transitions-animations
\inherits Animator
\brief The YAnimator type animates the y position of an Item.
\l{Animator} types are different from normal Animation types. When
using an Animator, the animation can be run in the render thread
and the property value will jump to the end when the animation is
complete.
The value of Item::y is updated after the animation has finished.
The following snippet shows how to use a YAnimator together
with a Rectangle item.
\snippet qml/animators.qml y target
It is also possible to use the \c on keyword to tie the
YAnimator directly to an Item instance.
\snippet qml/animators.qml y on
*/
QQuickYAnimator::QQuickYAnimator(QObject *parent) : QQuickAnimator(parent) {}
QQuickAnimatorJob *QQuickYAnimator::createJob() const { return new QQuickYAnimatorJob(); }
/*!
\qmltype ScaleAnimator
\instantiates QQuickScaleAnimator
\inqmlmodule QtQuick
\since 5.2
\ingroup qtquick-transitions-animations
\inherits Animator
\brief The ScaleAnimator type animates the scale factor of an Item.
\l{Animator} types are different from normal Animation types. When
using an Animator, the animation can be run in the render thread
and the property value will jump to the end when the animation is
complete.
The value of Item::scale is updated after the animation has finished.
The following snippet shows how to use a ScaleAnimator together
with a Rectangle item.
\snippet qml/animators.qml scale target
It is also possible to use the \c on keyword to tie the
ScaleAnimator directly to an Item instance.
\snippet qml/animators.qml scale on
\sa Item::transformOrigin, RotationAnimator
*/
QQuickScaleAnimator::QQuickScaleAnimator(QObject *parent) : QQuickAnimator(parent) {}
QQuickAnimatorJob *QQuickScaleAnimator::createJob() const { return new QQuickScaleAnimatorJob(); }
/*!
\qmltype OpacityAnimator
\instantiates QQuickOpacityAnimator
\inqmlmodule QtQuick
\since 5.2
\ingroup qtquick-transitions-animations
\inherits Animator
\brief The OpacityAnimator type animates the opacity of an Item.
\l{Animator} types are different from normal Animation types. When
using an Animator, the animation can be run in the render thread
and the property value will jump to the end when the animation is
complete.
The value of Item::opacity is updated after the animation has finished.
The following snippet shows how to use a OpacityAnimator together
with a Rectangle item.
\snippet qml/animators.qml opacity target
It is also possible to use the \c on keyword to tie the
OpacityAnimator directly to an Item instance.
\snippet qml/animators.qml opacity on
*/
QQuickOpacityAnimator::QQuickOpacityAnimator(QObject *parent) : QQuickAnimator(parent) {}
QQuickAnimatorJob *QQuickOpacityAnimator::createJob() const { return new QQuickOpacityAnimatorJob(); }
/*!
\qmltype RotationAnimator
\instantiates QQuickRotationAnimator
\inqmlmodule QtQuick
\since 5.2
\ingroup qtquick-transitions-animations
\inherits Animator
\brief The RotationAnimator type animates the rotation of an Item.
\l{Animator} types are different from normal Animation types. When
using an Animator, the animation can be run in the render thread
and the property value will jump to the end when the animation is
complete.
The value of Item::rotation is updated after the animation has finished.
The following snippet shows how to use a RotationAnimator together
with a Rectangle item.
\snippet qml/animators.qml rotation target
It is also possible to use the \c on keyword to tie the
RotationAnimator directly to the \c rotation property of an Item
instance.
\snippet qml/animators.qml rotation on
\sa Item::transformOrigin, ScaleAnimator
*/
QQuickRotationAnimator::QQuickRotationAnimator(QObject *parent)
: QQuickAnimator(*new QQuickRotationAnimatorPrivate, parent)
{
}
QQuickAnimatorJob *QQuickRotationAnimator::createJob() const {
Q_D(const QQuickRotationAnimator);
QQuickRotationAnimatorJob *job = new QQuickRotationAnimatorJob();
job->setDirection(d->direction);
return job;
}
/*!
\qmlproperty enumeration QtQuick::RotationAnimator::direction
This property holds the direction of the rotation.
Possible values are:
\list
\li RotationAnimator.Numerical (default) - Rotate by linearly interpolating between the two numbers.
A rotation from 10 to 350 will rotate 340 degrees clockwise.
\li RotationAnimator.Clockwise - Rotate clockwise between the two values
\li RotationAnimator.Counterclockwise - Rotate counterclockwise between the two values
\li RotationAnimator.Shortest - Rotate in the direction that produces the shortest animation path.
A rotation from 10 to 350 will rotate 20 degrees counterclockwise.
\endlist
*/
void QQuickRotationAnimator::setDirection(RotationDirection dir)
{
Q_D(QQuickRotationAnimator);
if (d->direction == dir)
return;
d->direction = dir;
Q_EMIT directionChanged(d->direction);
}
QQuickRotationAnimator::RotationDirection QQuickRotationAnimator::direction() const
{
Q_D(const QQuickRotationAnimator);
return d->direction;
}
#if QT_CONFIG(quick_shadereffect) && QT_CONFIG(opengl)
/*!
\qmltype UniformAnimator
\instantiates QQuickUniformAnimator
\inqmlmodule QtQuick
\since 5.2
\ingroup qtquick-transitions-animations
\inherits Animator
\brief The UniformAnimator type animates a uniform of a ShaderEffect.
\l{Animator} types are different from normal Animation types. When
using an Animator, the animation can be run in the render thread
and the property value will jump to the end when the animation is
complete.
The value of the QML property defining the uniform is updated after
the animation has finished.
The following snippet shows how to use a UniformAnimator together
with a ShaderEffect item.
\snippet qml/animators.qml shader target
It is also possible to use the \c on keyword to tie the
UniformAnimator directly to a uniform of a ShaderEffect
instance.
\snippet qml/animators.qml shader on
\sa ShaderEffect, ShaderEffectSource
*/
QQuickUniformAnimator::QQuickUniformAnimator(QObject *parent)
: QQuickAnimator(*new QQuickUniformAnimatorPrivate, parent)
{
}
/*!
\qmlproperty string QtQuick::UniformAnimator::uniform
This property holds the name of the uniform to animate.
The value of the uniform must correspond to both a property
on the target ShaderEffect and must be a uniform of type
\c float in the fragment or vertex shader.
*/
void QQuickUniformAnimator::setUniform(const QString &uniform)
{
Q_D(QQuickUniformAnimator);
if (d->uniform == uniform)
return;
d->uniform = uniform;
Q_EMIT uniformChanged(d->uniform);
}
QString QQuickUniformAnimator::uniform() const
{
Q_D(const QQuickUniformAnimator);
return d->uniform;
}
QString QQuickUniformAnimator::propertyName() const
{
Q_D(const QQuickUniformAnimator);
if (!d->uniform.isEmpty())
return d->uniform;
return d->defaultProperty.name();
}
QQuickAnimatorJob *QQuickUniformAnimator::createJob() const
{
QString u = propertyName();
if (u.isEmpty())
return nullptr;
QQuickUniformAnimatorJob *job = new QQuickUniformAnimatorJob();
job->setUniform(u.toLatin1());
return job;
}
#endif
QT_END_NAMESPACE
#include "moc_qquickanimator_p.cpp"
|