Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQuickAbstractAnimation Class Reference

#include <qquickanimation_p.h>

+ Inheritance diagram for QQuickAbstractAnimation:
+ Collaboration diagram for QQuickAbstractAnimation:

Public Types

enum  ThreadingModel { GuiThread , RenderThread , AnyThread }
 
enum  Loops { Infinite = -2 }
 
enum  TransitionDirection { Forward , Backward }
 

Public Slots

void restart ()
 \qmlmethod QtQuick::Animation::restart()
 
void start ()
 \qmlmethod QtQuick::Animation::start()
 
void pause ()
 \qmlmethod QtQuick::Animation::pause()
 
void resume ()
 \qmlmethod QtQuick::Animation::resume()
 
void stop ()
 \qmlmethod QtQuick::Animation::stop()
 
void complete ()
 \qmlmethod QtQuick::Animation::complete()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void started ()
 
void stopped ()
 
void runningChanged (bool)
 
void pausedChanged (bool)
 
void alwaysRunToEndChanged (bool)
 
void loopCountChanged (int)
 
 Q_REVISION (2, 12) void finished()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QQuickAbstractAnimation (QObject *parent=nullptr)
 \qmltype Animation \nativetype QQuickAbstractAnimation \inqmlmodule QtQuick
 
 ~QQuickAbstractAnimation () override
 
bool isRunning () const
 \qmlproperty bool QtQuick::Animation::running This property holds whether the animation is currently running.
 
void setRunning (bool)
 \qmlsignal QtQuick::Animation::started()
 
bool isPaused () const
 \qmlproperty bool QtQuick::Animation::paused This property holds whether the animation is currently paused.
 
void setPaused (bool)
 
bool alwaysRunToEnd () const
 \qmlproperty bool QtQuick::Animation::alwaysRunToEnd This property holds whether the animation should run to completion when it is stopped.
 
void setAlwaysRunToEnd (bool)
 
int loops () const
 \qmlproperty int QtQuick::Animation::loops This property holds the number of times the animation should play.
 
void setLoops (int)
 
int duration () const
 
int currentTime ()
 
void setCurrentTime (int)
 
QQuickAnimationGroupgroup () const
 
void setGroup (QQuickAnimationGroup *, int index=-1)
 
void setDefaultTarget (const QQmlProperty &)
 
void setDisableUserControl ()
 
void setEnableUserControl ()
 
bool userControlDisabled () const
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
virtual ThreadingModel threadingModel () const
 
virtual QAbstractAnimationJobtransition (QQuickStateActions &actions, QQmlProperties &modified, TransitionDirection direction, QObject *defaultTarget=nullptr)
 
QAbstractAnimationJobqtAnimation ()
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QQmlPropertyValueSource
 QQmlPropertyValueSource ()
 Constructs a QQmlPropertyValueSource.
 
virtual ~QQmlPropertyValueSource ()
 Destroys the value source.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Protected Member Functions

 QQuickAbstractAnimation (QQuickAbstractAnimationPrivate &dd, QObject *parent)
 
QAbstractAnimationJobinitInstance (QAbstractAnimationJob *animation)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Properties

bool running
 
bool paused
 
bool alwaysRunToEnd
 
int loops
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Private Member Functions

void setTarget (const QQmlProperty &) override
 Set the target property for the value source.
 

Friends

class QQuickBehavior
 
class QQuickBehaviorPrivate
 
class QQuickAnimationGroup
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 34 of file qquickanimation_p.h.

Member Enumeration Documentation

◆ Loops

Enumerator
Infinite 

Definition at line 61 of file qquickanimation_p.h.

◆ ThreadingModel

Enumerator
GuiThread 
RenderThread 
AnyThread 

Definition at line 52 of file qquickanimation_p.h.

◆ TransitionDirection

Enumerator
Forward 
Backward 

Definition at line 112 of file qquickanimation_p.h.

Constructor & Destructor Documentation

◆ QQuickAbstractAnimation() [1/2]

QT_BEGIN_NAMESPACE QQuickAbstractAnimation::QQuickAbstractAnimation ( QObject * parent = nullptr)

\qmltype Animation \nativetype QQuickAbstractAnimation \inqmlmodule QtQuick

Is the base of all QML animations.

The Animation 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 animation types that inherit from it. Attempting to use the Animation type directly will result in an error.

Definition at line 49 of file qquickanimation.cpp.

◆ ~QQuickAbstractAnimation()

QQuickAbstractAnimation::~QQuickAbstractAnimation ( )
override

Definition at line 54 of file qquickanimation.cpp.

◆ QQuickAbstractAnimation() [2/2]

QQuickAbstractAnimation::QQuickAbstractAnimation ( QQuickAbstractAnimationPrivate & dd,
QObject * parent )
protected

Definition at line 62 of file qquickanimation.cpp.

Member Function Documentation

◆ alwaysRunToEnd()

bool QQuickAbstractAnimation::alwaysRunToEnd ( ) const

\qmlproperty bool QtQuick::Animation::alwaysRunToEnd This property holds whether the animation should run to completion when it is stopped.

If this true the animation will complete its current iteration when it is stopped - either by setting the running property to false, or by calling the stop() method. The complete() method is not effected by this value.

This behavior is most useful when the loops property is set, as the animation will finish playing normally but not restart.

By default, the alwaysRunToEnd property is not set.

Note
alwaysRunToEnd has no effect on animations in a Transition.

Definition at line 388 of file qquickanimation.cpp.

◆ alwaysRunToEndChanged

void QQuickAbstractAnimation::alwaysRunToEndChanged ( bool )
signal

◆ classBegin()

void QQuickAbstractAnimation::classBegin ( )
overridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 350 of file qquickanimation.cpp.

◆ complete

void QQuickAbstractAnimation::complete ( )
slot

\qmlmethod QtQuick::Animation::complete()

Stops the animation, jumping to the final property values

If the animation is not running, calling this method has no effect. The running property will be false following a call to complete().

Unlike stop(), complete() immediately fast-forwards the animation to its end. In the following example,

Rectangle {
NumberAnimation on x { from: 0; to: 100; duration: 500 }
}
GLint GLint GLint GLint GLint x
[0]

calling stop() at time 250ms will result in the x property having a value of 50, while calling complete() will set the x property to 100, exactly as though the animation had played the whole way through.

Definition at line 582 of file qquickanimation.cpp.

◆ componentComplete()

void QQuickAbstractAnimation::componentComplete ( )
overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 356 of file qquickanimation.cpp.

◆ currentTime()

int QQuickAbstractAnimation::currentTime ( )

Definition at line 452 of file qquickanimation.cpp.

◆ duration()

int QQuickAbstractAnimation::duration ( ) const

Definition at line 446 of file qquickanimation.cpp.

◆ group()

QQuickAnimationGroup * QQuickAbstractAnimation::group ( ) const

Definition at line 466 of file qquickanimation.cpp.

◆ initInstance()

QAbstractAnimationJob * QQuickAbstractAnimation::initInstance ( QAbstractAnimationJob * animation)
protected

Definition at line 634 of file qquickanimation.cpp.

◆ isPaused()

bool QQuickAbstractAnimation::isPaused ( ) const

\qmlproperty bool QtQuick::Animation::paused This property holds whether the animation is currently paused.

The paused property can be set to declaratively control whether or not an animation is paused.

Animations can also be paused and resumed imperatively from JavaScript using the pause() and resume() methods.

By default, animations are not paused.

Definition at line 314 of file qquickanimation.cpp.

◆ isRunning()

bool QQuickAbstractAnimation::isRunning ( ) const

\qmlproperty bool QtQuick::Animation::running This property holds whether the animation is currently running.

The running property can be set to declaratively control whether or not an animation is running. The following example will animate a rectangle whenever the \l MouseArea is pressed.

Rectangle {
width: 100; height: 100
NumberAnimation on x {
running: myMouse.pressed
from: 0; to: 100
}
MouseArea { id: myMouse }
}
GLenum GLuint id
[7]
GLint GLsizei width

Likewise, the running property can be read to determine if the animation is running. In the following example the Text item will indicate whether or not the animation is running.

NumberAnimation { id: myAnimation }
Text { text: myAnimation.running ? "Animation is running" : "Animation is not running" }
Definition text.h:12
QString text
[12]

Animations can also be started and stopped imperatively from JavaScript using the start() and stop() methods.

By default, animations are not running. Though, when the animations are assigned to properties, as property value sources using the on syntax, they are set to running by default.

Definition at line 107 of file qquickanimation.cpp.

◆ loopCountChanged

void QQuickAbstractAnimation::loopCountChanged ( int )
signal

◆ loops()

int QQuickAbstractAnimation::loops ( ) const

\qmlproperty int QtQuick::Animation::loops This property holds the number of times the animation should play.

By default, loops is 1: the animation will play through once and then stop.

If set to Animation.Infinite, the animation will continuously repeat until it is explicitly stopped - either by setting the running property to false, or by calling the stop() method.

In the following example, the rectangle will spin indefinitely.

Rectangle {
width: 100; height: 100; color: "green"
RotationAnimation on rotation {
loops: Animation.Infinite
from: 0
to: 360
}
}
GLuint color
[2]

Definition at line 427 of file qquickanimation.cpp.

◆ pause

void QQuickAbstractAnimation::pause ( )
slot

\qmlmethod QtQuick::Animation::pause()

Pauses the animation

If the animation is already paused or not running, calling this method has no effect. The paused property will be true following a call to pause().

Definition at line 509 of file qquickanimation.cpp.

◆ pausedChanged

void QQuickAbstractAnimation::pausedChanged ( bool )
signal

◆ Q_REVISION

QQuickAbstractAnimation::Q_REVISION ( 2 ,
12  )
signal

◆ qtAnimation()

QAbstractAnimationJob * QQuickAbstractAnimation::qtAnimation ( )

Definition at line 67 of file qquickanimation.cpp.

◆ restart

void QQuickAbstractAnimation::restart ( )
slot

\qmlmethod QtQuick::Animation::restart()

Restarts the animation

This is a convenience method, and is equivalent to calling stop() and then start().

Definition at line 558 of file qquickanimation.cpp.

◆ resume

void QQuickAbstractAnimation::resume ( )
slot

\qmlmethod QtQuick::Animation::resume()

Resumes a paused animation

If the animation is not paused or not running, calling this method has no effect. The paused property will be false following a call to resume().

Definition at line 521 of file qquickanimation.cpp.

◆ runningChanged

void QQuickAbstractAnimation::runningChanged ( bool )
signal

◆ setAlwaysRunToEnd()

void QQuickAbstractAnimation::setAlwaysRunToEnd ( bool f)

Definition at line 394 of file qquickanimation.cpp.

◆ setCurrentTime()

void QQuickAbstractAnimation::setCurrentTime ( int time)

Definition at line 458 of file qquickanimation.cpp.

◆ setDefaultTarget()

void QQuickAbstractAnimation::setDefaultTarget ( const QQmlProperty & p)

Definition at line 604 of file qquickanimation.cpp.

◆ setDisableUserControl()

void QQuickAbstractAnimation::setDisableUserControl ( )

Definition at line 615 of file qquickanimation.cpp.

◆ setEnableUserControl()

void QQuickAbstractAnimation::setEnableUserControl ( )

Definition at line 621 of file qquickanimation.cpp.

◆ setGroup()

void QQuickAbstractAnimation::setGroup ( QQuickAnimationGroup * g,
int index = -1 )

Definition at line 472 of file qquickanimation.cpp.

◆ setLoops()

void QQuickAbstractAnimation::setLoops ( int loops)

Definition at line 433 of file qquickanimation.cpp.

◆ setPaused()

void QQuickAbstractAnimation::setPaused ( bool p)

Definition at line 321 of file qquickanimation.cpp.

◆ setRunning()

void QQuickAbstractAnimation::setRunning ( bool r)

\qmlsignal QtQuick::Animation::started()

This signal is emitted when the animation begins.

It is only triggered for top-level, standalone animations. It will not be triggered for animations in a Behavior or Transition, or animations that are part of an animation group.

\qmlsignal QtQuick::Animation::stopped()

This signal is emitted when the animation ends.

The animation may have been stopped manually, or may have run to completion.

It is only triggered for top-level, standalone animations. It will not be triggered for animations in a Behavior or Transition, or animations that are part of an animation group.

If \l alwaysRunToEnd is true, this signal will not be emitted until the animation has completed its current iteration.

\qmlsignal QtQuick::Animation::finished()

Since
5.12

This signal is emitted when the animation has finished naturally.

It is not emitted when \l running is set to false, nor for animations whose \l loops property is set to Animation.Infinite.

In addition, it is only emitted for top-level, standalone animations. It will not be emitted for animations in a Behavior or Transition, or animations that are part of an animation group.

If \l alwaysRunToEnd is true, this signal will not be emitted until the animation has completed its current iteration.

See also
stopped(), started(), running

Definition at line 234 of file qquickanimation.cpp.

◆ setTarget()

void QQuickAbstractAnimation::setTarget ( const QQmlProperty & property)
overrideprivatevirtual

Set the target property for the value source.

This method will be called by the QML engine when assigning a value source.

Implements QQmlPropertyValueSource.

Definition at line 590 of file qquickanimation.cpp.

◆ start

void QQuickAbstractAnimation::start ( )
slot

\qmlmethod QtQuick::Animation::start()

Starts the animation

If the animation is already running, calling this method has no effect. The running property will be true following a call to start().

Definition at line 497 of file qquickanimation.cpp.

◆ started

void QQuickAbstractAnimation::started ( )
signal

◆ stop

void QQuickAbstractAnimation::stop ( )
slot

\qmlmethod QtQuick::Animation::stop()

Stops the animation

If the animation is not running, calling this method has no effect. Both the running and paused properties will be false following a call to stop().

Normally stop() stops the animation immediately, and the animation has no further influence on property values. In this example animation

Rectangle {
NumberAnimation on x { from: 0; to: 100; duration: 500 }
}

was stopped at time 250ms, the x property will have a value of 50.

However, if the alwaysRunToEnd property is set, the animation will continue running until it completes and then stop. The running property will still become false immediately.

Definition at line 546 of file qquickanimation.cpp.

◆ stopped

void QQuickAbstractAnimation::stopped ( )
signal

◆ threadingModel()

QQuickAbstractAnimation::ThreadingModel QQuickAbstractAnimation::threadingModel ( ) const
virtual

Reimplemented in QQuickAnimator, QQuickParallelAnimation, and QQuickSequentialAnimation.

Definition at line 666 of file qquickanimation.cpp.

◆ transition()

◆ userControlDisabled()

bool QQuickAbstractAnimation::userControlDisabled ( ) const

Definition at line 628 of file qquickanimation.cpp.

Friends And Related Symbol Documentation

◆ QQuickAnimationGroup

friend class QQuickAnimationGroup
friend

Definition at line 124 of file qquickanimation_p.h.

◆ QQuickBehavior

friend class QQuickBehavior
friend

Definition at line 122 of file qquickanimation_p.h.

◆ QQuickBehaviorPrivate

friend class QQuickBehaviorPrivate
friend

Definition at line 123 of file qquickanimation_p.h.

Property Documentation

◆ alwaysRunToEnd

bool QQuickAbstractAnimation::alwaysRunToEnd
readwrite

Definition at line 43 of file qquickanimation_p.h.

◆ loops

int QQuickAbstractAnimation::loops
readwrite

Definition at line 44 of file qquickanimation_p.h.

◆ paused

bool QQuickAbstractAnimation::paused
readwrite

Definition at line 42 of file qquickanimation_p.h.

◆ running

bool QQuickAbstractAnimation::running
readwrite

Definition at line 41 of file qquickanimation_p.h.


The documentation for this class was generated from the following files: