#include <qquickanimator_p.h>

Inheritance diagram for QQuickAnimator:

Collaboration diagram for QQuickAnimator:

Signals
void	targetItemChanged (QQuickItem *)

void	durationChanged (int duration)

void	easingChanged (const QEasingCurve &curve)

void	toChanged (qreal to)

void	fromChanged (qreal from)

Signals inherited from QQuickAbstractAnimation
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
QQuickItem *	targetItem () const

void	setTargetItem (QQuickItem *target)
	\qmlproperty QtQuick::Item QtQuick::Animator::target

int	duration () const

void	setDuration (int duration)
	\qmlproperty int QtQuick::Animator::duration This property holds the duration of the animation in milliseconds.

QEasingCurve	easing () const

void	setEasing (const QEasingCurve &easing)
	\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

qreal	to () const

void	setTo (qreal to)
	\qmlproperty real QtQuick::Animator::to This property holds the end value for the animation.

qreal	from () const

void	setFrom (qreal from)
	\qmlproperty real QtQuick::Animator::from This property holds the starting value for the animation.

Public Member Functions inherited from QQuickAbstractAnimation
	QQuickAbstractAnimation (QObject *parent=nullptr)
	\qmltype Animation \instantiates 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)

QQuickAnimationGroup *	group () 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.

QAbstractAnimationJob *	qtAnimation ()

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< QString >	bindableObjectName ()

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).

QThread *	thread () 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 >
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 >
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 QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () 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
ThreadingModel	threadingModel () const override

virtual QQuickAnimatorJob *	createJob () const =0

virtual QString	propertyName () const =0

QAbstractAnimationJob *	transition (QQuickStateActions &actions, QQmlProperties &modified, TransitionDirection, QObject *) override

	QQuickAnimator (QQuickAnimatorPrivate &dd, QObject *parent=nullptr)
	\qmltype Animator \instantiates QQuickAnimator \inqmlmodule QtQuick

	QQuickAnimator (QObject *parent=nullptr)

Protected Member Functions inherited from QQuickAbstractAnimation
	QQuickAbstractAnimation (QQuickAbstractAnimationPrivate &dd, QObject *parent)

QAbstractAnimationJob *	initInstance (QAbstractAnimationJob *animation)

Protected Member Functions inherited from QObject
QObject *	sender () 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
QQuickItem *	target

QEasingCurve	easing

int	duration

qreal	to

qreal	from

Properties inherited from QQuickAbstractAnimation
bool	running

bool	paused

bool	alwaysRunToEnd

int	loops

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Types inherited from QQuickAbstractAnimation
enum	ThreadingModel { GuiThread , RenderThread , AnyThread }

enum	Loops { Infinite = -2 }

enum	TransitionDirection { Forward , Backward }

Public Slots inherited from QQuickAbstractAnimation
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

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< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 26 of file qquickanimator_p.h.

Constructor & Destructor Documentation

◆ QQuickAnimator() [1/2]

QT_BEGIN_NAMESPACE QQuickAnimator::QQuickAnimator	(	QQuickAnimatorPrivate &	dd,
		QObject *	parent = nullptr )

protected

\qmltype Animator \instantiates QQuickAnimator \inqmlmodule QtQuick

Since: 5.2

\inherits Animation

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.

Rectangle {
    id: mixBox
    width: 50
    height: 50
    ParallelAnimation {
        ColorAnimation {
            target: mixBox
            property: "color"
            from: "forestgreen"
            to: "lightsteelblue";
            duration: 1000
        }
        ScaleAnimator {
            target: mixBox
            from: 2
            to: 1
            duration: 1000
        }
        running: true
    }
}

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.

Definition at line 49 of file qquickanimator.cpp.

◆ QQuickAnimator() [2/2]

QQuickAnimator::QQuickAnimator ( QObject * parent = nullptr )

protected

Definition at line 54 of file qquickanimator.cpp.

Member Function Documentation

◆ createJob()

virtual QQuickAnimatorJob * QQuickAnimator::createJob ( ) const

protectedpure virtual

Implemented in QQuickScaleAnimator, QQuickXAnimator, QQuickYAnimator, QQuickOpacityAnimator, and QQuickRotationAnimator.

Referenced by transition().

Here is the caller graph for this function:

◆ duration()

int QQuickAnimator::duration ( ) const

Definition at line 97 of file qquickanimator.cpp.

References d.

◆ durationChanged

void QQuickAnimator::durationChanged ( int duration )

signal

Referenced by setDuration().

Here is the caller graph for this function:

◆ easing()

QEasingCurve QQuickAnimator::easing ( ) const

Definition at line 122 of file qquickanimator.cpp.

References d.

◆ easingChanged

void QQuickAnimator::easingChanged ( const QEasingCurve & curve )

signal

Referenced by setEasing().

Here is the caller graph for this function:

◆ from()

qreal QQuickAnimator::from ( ) const

Definition at line 176 of file qquickanimator.cpp.

References d.

◆ fromChanged

void QQuickAnimator::fromChanged ( qreal from )

signal

Referenced by setFrom().

Here is the caller graph for this function:

◆ propertyName()

virtual QString QQuickAnimator::propertyName ( ) const

protectedpure virtual

Implemented in QQuickScaleAnimator, QQuickXAnimator, QQuickYAnimator, QQuickOpacityAnimator, and QQuickRotationAnimator.

Referenced by transition().

Here is the caller graph for this function:

◆ setDuration()

void QQuickAnimator::setDuration ( int duration )

\qmlproperty int QtQuick::Animator::duration This property holds the duration of the animation in milliseconds.

The default value is 250.

Definition at line 88 of file qquickanimator.cpp.

References d, duration, durationChanged(), and Q_EMIT.

Here is the call graph for this function:

◆ setEasing()

void QQuickAnimator::setEasing ( const QEasingCurve & easing )

\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

propertyanimation.easing

Definition at line 113 of file qquickanimator.cpp.

References d, easing, easingChanged(), and Q_EMIT.

Here is the call graph for this function:

◆ setFrom()

void QQuickAnimator::setFrom ( qreal from )

\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.

See also: {Animation and Transitions in Qt Quick}

Definition at line 166 of file qquickanimator.cpp.

References d, from, fromChanged(), and Q_EMIT.

Here is the call graph for this function:

◆ setTargetItem()

void QQuickAnimator::setTargetItem ( QQuickItem * target )

\qmlproperty QtQuick::Item QtQuick::Animator::target

This property holds the target item of the animator.

Note: Animator targets must be Item based types.

Definition at line 67 of file qquickanimator.cpp.

References d, Q_EMIT, target, and targetItemChanged().

Here is the call graph for this function:

◆ setTo()

void QQuickAnimator::setTo ( qreal to )

\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.

Definition at line 138 of file qquickanimator.cpp.

References d, Q_EMIT, to, and toChanged().

Here is the call graph for this function:

◆ targetItem()

QQuickItem * QQuickAnimator::targetItem ( ) const

Definition at line 76 of file qquickanimator.cpp.

References d.

◆ targetItemChanged

void QQuickAnimator::targetItemChanged ( QQuickItem * )

signal

Referenced by setTargetItem().

Here is the caller graph for this function:

◆ threadingModel()

ThreadingModel QQuickAnimator::threadingModel ( ) const

inlineoverrideprotectedvirtual

Reimplemented from QQuickAbstractAnimation.

Definition at line 57 of file qquickanimator_p.h.

◆ to()

qreal QQuickAnimator::to ( ) const

Definition at line 148 of file qquickanimator.cpp.

References d.

◆ toChanged

void QQuickAnimator::toChanged ( qreal to )

signal

Referenced by setTo().

Here is the caller graph for this function:

◆ transition()

QAbstractAnimationJob * QQuickAnimator::transition	(	QQuickStateActions &	actions,
		QQmlProperties &	modified,
		TransitionDirection	direction,
		QObject *	defaultTarget )

overrideprotectedvirtual

Reimplemented from QQuickAbstractAnimation.

Definition at line 242 of file qquickanimator.cpp.

References QQuickAbstractAnimation::Backward, createJob(), d, direction, propertyName(), qmlWarning(), and QQuickAnimatorJob::target().

Here is the call graph for this function:

Property Documentation

◆ duration

int QQuickAnimator::duration

readwrite

Definition at line 32 of file qquickanimator_p.h.

Referenced by setDuration().

◆ easing

QEasingCurve QQuickAnimator::easing

readwrite

Definition at line 31 of file qquickanimator_p.h.

Referenced by setEasing().

◆ from

qreal QQuickAnimator::from

readwrite

Definition at line 34 of file qquickanimator_p.h.

Referenced by setFrom().

◆ target

QQuickItem * QQuickAnimator::target

readwrite

Definition at line 30 of file qquickanimator_p.h.

Referenced by setTargetItem().

◆ to

qreal QQuickAnimator::to

readwrite

Definition at line 33 of file qquickanimator_p.h.

Referenced by setTo().

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

qtdeclarative/src/quick/util/qquickanimator_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/util/qquickanimator.cpp (47be6f59695998ef2f120045cef16d0e7fa8b705)

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickAnimator() [1/2]

◆ QQuickAnimator() [2/2]

Member Function Documentation

◆ createJob()

◆ duration()

◆ durationChanged

◆ easing()

◆ easingChanged

◆ from()

◆ fromChanged

◆ propertyName()

◆ setDuration()

◆ setEasing()

◆ setFrom()

◆ setTargetItem()

◆ setTo()

◆ targetItem()

◆ targetItemChanged

◆ threadingModel()

◆ to()

◆ toChanged

◆ transition()

Property Documentation

◆ duration

◆ easing

◆ from

◆ target

◆ to