#include <qquickanimation_p.h>

Inheritance diagram for QQuickPropertyAnimation:

Collaboration diagram for QQuickPropertyAnimation:

Signals
void	durationChanged (int)

void	fromChanged ()

void	toChanged ()

void	easingChanged (const QEasingCurve &)

void	propertiesChanged (const QString &)

void	targetChanged ()

void	propertyChanged ()

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
	QQuickPropertyAnimation (QObject *parent=nullptr)
	\qmltype PropertyAnimation \instantiates QQuickPropertyAnimation \inqmlmodule QtQuick\inherits Animation

	~QQuickPropertyAnimation () override

virtual int	duration () const
	\qmlproperty int QtQuick::PropertyAnimation::duration This property holds the duration of the animation, in milliseconds.

virtual void	setDuration (int)

QVariant	from () const
	\qmlproperty variant QtQuick::PropertyAnimation::from This property holds the starting value for the animation.

void	setFrom (const QVariant &)

QVariant	to () const
	\qmlproperty variant QtQuick::PropertyAnimation::to This property holds the end value for the animation.

void	setTo (const QVariant &)

QEasingCurve	easing () const
	Specifies the easing curve used for the animation.

void	setEasing (const QEasingCurve &)

QObject *	target () const

void	setTargetObject (QObject *)

QString	property () const

void	setProperty (const QString &)

QString	properties () const

void	setProperties (const QString &)

QQmlListProperty< QObject >	targets ()

QQmlListProperty< QObject >	exclude ()

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.

virtual ThreadingModel	threadingModel () const

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
QQuickStateActions	createTransitionActions (QQuickStateActions &actions, QQmlProperties &modified, QObject *defaultTarget=nullptr)

	QQuickPropertyAnimation (QQuickPropertyAnimationPrivate &dd, QObject *parent)

QAbstractAnimationJob *	transition (QQuickStateActions &actions, QQmlProperties &modified, TransitionDirection direction, QObject *defaultTarget=nullptr) override

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
int	duration

QVariant	from

QVariant	to

QEasingCurve	easing

QObject *	target

QString	property

QString	properties

QQmlListProperty< QObject >	targets

QQmlListProperty< QObject >	exclude
	\qmlproperty list<QtObject> QtQuick::PropertyAnimation::exclude This property holds the items not to be affected by this animation.

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 230 of file qquickanimation_p.h.

Constructor & Destructor Documentation

◆ QQuickPropertyAnimation() [1/2]

QQuickPropertyAnimation::QQuickPropertyAnimation ( QObject * parent = nullptr )

\qmltype PropertyAnimation \instantiates QQuickPropertyAnimation \inqmlmodule QtQuick\inherits Animation

Animates changes in property values.

PropertyAnimation provides a way to animate changes to a property's value.

It can be used to define animations in a number of ways:

\list

In a \l Transition

For example, to animate any objects that have changed their x or y properties as a result of a state change, using an InOutQuad easing curve:

Rectangle {
    id: rect
    width: 100; height: 100
    color: "red"
 
    //! [single state]
    states: State {
        name: "moved"
        PropertyChanges { target: rect; x: 50 }
    }
    //! [single state]
 
    transitions: Transition {
        PropertyAnimation { properties: "x,y"; easing.type: Easing.InOutQuad }
    }
}

In a \l Behavior

For example, to animate all changes to a rectangle's x property:

Rectangle {
    width: 100; height: 100
    color: "red"
 
    Behavior on x { PropertyAnimation {} }
 
    MouseArea { anchors.fill: parent; onClicked: parent.x = 50 }
}

As a property value source

For example, to repeatedly animate the rectangle's x property:

Rectangle {
    width: 100; height: 100
    color: "red"
 
    SequentialAnimation on x {
        loops: Animation.Infinite
        PropertyAnimation { to: 50 }
        PropertyAnimation { to: 0 }
    }
}

In a signal handler

For example, to fade out theObject when clicked: \qml MouseArea { anchors.fill: theObject onClicked: PropertyAnimation { target: theObject; property: "opacity"; to: 0 } } \endqml

Standalone

For example, to animate rect's width property over 500ms, from its current width to 30:

    Rectangle {
        id: theRect
        width: 100; height: 100
        color: "red"
 
        // this is a standalone animation, it's not running by default
        PropertyAnimation { id: animation;
                            target: theRect;
                            property: "width";
                            to: 30;
                            duration: 500 }
 
        MouseArea { anchors.fill: parent; onClicked: animation.running = true }
    }

\endlist

Depending on how the animation is used, the set of properties normally used will be different. For more information see the individual property documentation, as well as the \l{Animation and Transitions in Qt Quick} introduction.

Note that PropertyAnimation inherits the abstract \l Animation type. This includes additional properties and methods for controlling the animation.

Definition at line 2157 of file qquickanimation.cpp.

◆ ~QQuickPropertyAnimation()

QQuickPropertyAnimation::~QQuickPropertyAnimation ( )

override

Definition at line 2167 of file qquickanimation.cpp.

◆ QQuickPropertyAnimation() [2/2]

QQuickPropertyAnimation::QQuickPropertyAnimation	(	QQuickPropertyAnimationPrivate &	dd,
		QObject *	parent )

protected

Definition at line 2162 of file qquickanimation.cpp.

Member Function Documentation

◆ createTransitionActions()

QQuickStateActions QQuickPropertyAnimation::createTransitionActions	(	QQuickStateActions &	actions,
		QQmlProperties &	modified,
		QObject *	defaultTarget = nullptr )

protected

Definition at line 2742 of file qquickanimation.cpp.

References QQmlListProperty< T >::append, QString::at(), QQmlListProperty< T >::at, d, errorMessage(), errorMessages, QQuickStateAction::fromValue, i, QVariant::isValid(), j, myAction, QQmlProperty::name, QQmlProperty::object, QObject::property(), QQuickStateAction::property, QQmlProperty::propertyType(), qmlWarning(), QList< T >::size(), QQuickStateAction::specifiedObject, QQuickStateAction::specifiedProperty, and targets.

Referenced by transition(), QQuickSmoothedAnimation::transition(), and QQuickSpringAnimation::transition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ duration()

int QQuickPropertyAnimation::duration ( ) const

virtual

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

The default value is 250.

Reimplemented in QQuickSmoothedAnimation.

Definition at line 2177 of file qquickanimation.cpp.

References d.

◆ durationChanged

void QQuickPropertyAnimation::durationChanged ( int )

signal

Referenced by setDuration().

Here is the caller graph for this function:

◆ easing()

QEasingCurve QQuickPropertyAnimation::easing ( ) const

Specifies the easing curve used for the animation.

\qmlpropertygroup QtQuick::PropertyAnimation::easing
\qmlproperty enumeration QtQuick::PropertyAnimation::easing.type
\qmlproperty real QtQuick::PropertyAnimation::easing.amplitude
\qmlproperty real QtQuick::PropertyAnimation::easing.overshoot
\qmlproperty real QtQuick::PropertyAnimation::easing.period
\qmlproperty list<real> QtQuick::PropertyAnimation::easing.bezierCurve

! propertyanimation.easing

To specify an easing curve you need to specify at least the type. For some curves you can also specify amplitude, period and/or overshoot (more details provided after the table). The default easing curve is Easing.Linear.

\qml PropertyAnimation { properties: "y"; easing.type: Easing.InOutElastic; easing.amplitude: 2.0; easing.period: 1.5 } \endqml

Available types are:

\table \row

Easing.Linear
Easing curve for a linear (t) function: velocity is constant.
\inlineimage qeasingcurve-linear.png \row
Easing.InQuad
Easing curve for a quadratic (t^2) function: accelerating from zero velocity.
\inlineimage qeasingcurve-inquad.png \row
Easing.OutQuad
Easing curve for a quadratic (t^2) function: decelerating to zero velocity.
\inlineimage qeasingcurve-outquad.png \row
Easing.InOutQuad
Easing curve for a quadratic (t^2) function: acceleration until halfway, then deceleration.
\inlineimage qeasingcurve-inoutquad.png \row
Easing.OutInQuad
Easing curve for a quadratic (t^2) function: deceleration until halfway, then acceleration.
\inlineimage qeasingcurve-outinquad.png \row
Easing.InCubic
Easing curve for a cubic (t^3) function: accelerating from zero velocity.
\inlineimage qeasingcurve-incubic.png \row
Easing.OutCubic
Easing curve for a cubic (t^3) function: decelerating to zero velocity.
\inlineimage qeasingcurve-outcubic.png \row
Easing.InOutCubic
Easing curve for a cubic (t^3) function: acceleration until halfway, then deceleration.
\inlineimage qeasingcurve-inoutcubic.png \row
Easing.OutInCubic
Easing curve for a cubic (t^3) function: deceleration until halfway, then acceleration.
\inlineimage qeasingcurve-outincubic.png \row
Easing.InQuart
Easing curve for a quartic (t^4) function: accelerating from zero velocity.
\inlineimage qeasingcurve-inquart.png \row
Easing.OutQuart
Easing curve for a quartic (t^4) function: decelerating to zero velocity.
\inlineimage qeasingcurve-outquart.png \row
Easing.InOutQuart
Easing curve for a quartic (t^4) function: acceleration until halfway, then deceleration.
\inlineimage qeasingcurve-inoutquart.png \row
Easing.OutInQuart
Easing curve for a quartic (t^4) function: deceleration until halfway, then acceleration.
\inlineimage qeasingcurve-outinquart.png \row
Easing.InQuint
Easing curve for a quintic (t^5) function: accelerating from zero velocity.
\inlineimage qeasingcurve-inquint.png \row
Easing.OutQuint
Easing curve for a quintic (t^5) function: decelerating to zero velocity.
\inlineimage qeasingcurve-outquint.png \row
Easing.InOutQuint
Easing curve for a quintic (t^5) function: acceleration until halfway, then deceleration.
\inlineimage qeasingcurve-inoutquint.png \row
Easing.OutInQuint
Easing curve for a quintic (t^5) function: deceleration until halfway, then acceleration.
\inlineimage qeasingcurve-outinquint.png \row
Easing.InSine
Easing curve for a sinusoidal (sin(t)) function: accelerating from zero velocity.
\inlineimage qeasingcurve-insine.png \row
Easing.OutSine
Easing curve for a sinusoidal (sin(t)) function: decelerating to zero velocity.
\inlineimage qeasingcurve-outsine.png \row
Easing.InOutSine
Easing curve for a sinusoidal (sin(t)) function: acceleration until halfway, then deceleration.
\inlineimage qeasingcurve-inoutsine.png \row
Easing.OutInSine
Easing curve for a sinusoidal (sin(t)) function: deceleration until halfway, then acceleration.
\inlineimage qeasingcurve-outinsine.png \row
Easing.InExpo
Easing curve for an exponential (2^t) function: accelerating from zero velocity.
\inlineimage qeasingcurve-inexpo.png \row
Easing.OutExpo
Easing curve for an exponential (2^t) function: decelerating to zero velocity.
\inlineimage qeasingcurve-outexpo.png \row
Easing.InOutExpo
Easing curve for an exponential (2^t) function: acceleration until halfway, then deceleration.
\inlineimage qeasingcurve-inoutexpo.png \row
Easing.OutInExpo
Easing curve for an exponential (2^t) function: deceleration until halfway, then acceleration.
\inlineimage qeasingcurve-outinexpo.png \row
Easing.InCirc
Easing curve for a circular (sqrt(1-t^2)) function: accelerating from zero velocity.
\inlineimage qeasingcurve-incirc.png \row
Easing.OutCirc
Easing curve for a circular (sqrt(1-t^2)) function: decelerating to zero velocity.
\inlineimage qeasingcurve-outcirc.png \row
Easing.InOutCirc
Easing curve for a circular (sqrt(1-t^2)) function: acceleration until halfway, then deceleration.
\inlineimage qeasingcurve-inoutcirc.png \row
Easing.OutInCirc
Easing curve for a circular (sqrt(1-t^2)) function: deceleration until halfway, then acceleration.
\inlineimage qeasingcurve-outincirc.png \row
Easing.InElastic
Easing curve for an elastic (exponentially decaying sine wave) function: accelerating from zero velocity. \br The peak amplitude can be set with the amplitude parameter, and the period of decay by the period parameter.
\inlineimage qeasingcurve-inelastic.png \row
Easing.OutElastic
Easing curve for an elastic (exponentially decaying sine wave) function: decelerating to zero velocity. \br The peak amplitude can be set with the amplitude parameter, and the period of decay by the period parameter.
\inlineimage qeasingcurve-outelastic.png \row
Easing.InOutElastic
Easing curve for an elastic (exponentially decaying sine wave) function: acceleration until halfway, then deceleration.
\inlineimage qeasingcurve-inoutelastic.png \row
Easing.OutInElastic
Easing curve for an elastic (exponentially decaying sine wave) function: deceleration until halfway, then acceleration.
\inlineimage qeasingcurve-outinelastic.png \row
Easing.InBack
Easing curve for a back (overshooting cubic function: (s+1)*t^3 - s*t^2) easing in: accelerating from zero velocity.
\inlineimage qeasingcurve-inback.png \row
Easing.OutBack
Easing curve for a back (overshooting cubic function: (s+1)*t^3 - s*t^2) easing out: decelerating to zero velocity.
\inlineimage qeasingcurve-outback.png \row
Easing.InOutBack
Easing curve for a back (overshooting cubic function: (s+1)*t^3 - s*t^2) easing in/out: acceleration until halfway, then deceleration.
\inlineimage qeasingcurve-inoutback.png \row
Easing.OutInBack
Easing curve for a back (overshooting cubic easing: (s+1)*t^3 - s*t^2) easing out/in: deceleration until halfway, then acceleration.
\inlineimage qeasingcurve-outinback.png \row
Easing.InBounce
Easing curve for a bounce (exponentially decaying parabolic bounce) function: accelerating from zero velocity.
\inlineimage qeasingcurve-inbounce.png \row
Easing.OutBounce
Easing curve for a bounce (exponentially decaying parabolic bounce) function: decelerating to zero velocity.
\inlineimage qeasingcurve-outbounce.png \row
Easing.InOutBounce
Easing curve for a bounce (exponentially decaying parabolic bounce) function easing in/out: acceleration until halfway, then deceleration.
\inlineimage qeasingcurve-inoutbounce.png \row
Easing.OutInBounce
Easing curve for a bounce (exponentially decaying parabolic bounce) function easing out/in: deceleration until halfway, then acceleration.
\inlineimage qeasingcurve-outinbounce.png \row
Easing.BezierSpline
Custom easing curve defined by the easing.bezierCurve property.
\endtable

easing.amplitude is only applicable for bounce and elastic curves (curves of type Easing.InBounce, Easing.OutBounce, Easing.InOutBounce, Easing.OutInBounce, Easing.InElastic, Easing.OutElastic, Easing.InOutElastic or Easing.OutInElastic).

easing.overshoot is only applicable if easing.type is: Easing.InBack, Easing.OutBack, Easing.InOutBack or Easing.OutInBack.

easing.period is only applicable if easing.type is: Easing.InElastic, Easing.OutElastic, Easing.InOutElastic or Easing.OutInElastic.

easing.bezierCurve is only applicable if easing.type is: Easing.BezierSpline. This property is a list<real> containing groups of three points defining a curve from 0,0 to 1,1 - control1, control2, end point: [cx1, cy1, cx2, cy2, endx, endy, ...]. The last point must be 1,1.

See the \l {Qt Quick Examples - Animation::Easing Curves}{Easing Curves} for a demonstration of the different easing settings. ! propertyanimation.easing

Definition at line 2477 of file qquickanimation.cpp.

References d.

◆ easingChanged

void QQuickPropertyAnimation::easingChanged ( const QEasingCurve & )

signal

Referenced by setEasing().

Here is the caller graph for this function:

◆ exclude()

QQmlListProperty< QObject > QQuickPropertyAnimation::exclude ( )

◆ from()

QVariant QQuickPropertyAnimation::from ( ) const

\qmlproperty variant QtQuick::PropertyAnimation::from This property holds the starting value for the animation.

If the PropertyAnimation 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 2212 of file qquickanimation.cpp.

References d.

◆ fromChanged

void QQuickPropertyAnimation::fromChanged ( )

signal

Referenced by setFrom().

Here is the caller graph for this function:

◆ properties()

QString QQuickPropertyAnimation::properties ( ) const

Definition at line 2531 of file qquickanimation.cpp.

References d.

◆ propertiesChanged

void QQuickPropertyAnimation::propertiesChanged ( const QString & )

signal

Referenced by setProperties().

Here is the caller graph for this function:

◆ property()

QString QQuickPropertyAnimation::property ( ) const

Definition at line 2514 of file qquickanimation.cpp.

References d.

◆ propertyChanged

void QQuickPropertyAnimation::propertyChanged ( )

signal

Referenced by setProperty().

Here is the caller graph for this function:

◆ setDuration()

void QQuickPropertyAnimation::setDuration ( int duration )

virtual

Reimplemented in QQuickSmoothedAnimation.

Definition at line 2183 of file qquickanimation.cpp.

References d, duration, durationChanged(), emit, qmlWarning(), and tr.

Referenced by QQuickTableViewPrivate::scrollToColumn(), QQuickTableViewPrivate::scrollToRow(), and QQuickSmoothedAnimation::setDuration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEasing()

void QQuickPropertyAnimation::setEasing ( const QEasingCurve & e )

Definition at line 2483 of file qquickanimation.cpp.

References d, easingChanged(), and emit.

Referenced by QQuickTableViewPrivate::init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFrom()

void QQuickPropertyAnimation::setFrom ( const QVariant & f )

Definition at line 2218 of file qquickanimation.cpp.

References d, emit, and fromChanged().

Referenced by QQuickColorAnimation::setFrom(), QQuickGeoCoordinateAnimation::setFrom(), QQuick3DQuaternionAnimation::setFrom(), QQuickNumberAnimation::setFrom(), QQuickRotationAnimation::setFrom(), and QQuickVector3dAnimation::setFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setProperties()

void QQuickPropertyAnimation::setProperties ( const QString & prop )

Definition at line 2537 of file qquickanimation.cpp.

References d, emit, and propertiesChanged().

Here is the call graph for this function:

◆ setProperty()

void QQuickPropertyAnimation::setProperty ( const QString & n )

Definition at line 2520 of file qquickanimation.cpp.

References d, emit, and propertyChanged().

Referenced by QQuickTableViewPrivate::init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTargetObject()

void QQuickPropertyAnimation::setTargetObject ( QObject * o )

Definition at line 2503 of file qquickanimation.cpp.

References d, emit, o, and targetChanged().

Referenced by QQuickTableViewPrivate::init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTo()

void QQuickPropertyAnimation::setTo ( const QVariant & t )

Definition at line 2249 of file qquickanimation.cpp.

References d, emit, and toChanged().

Referenced by QQuickTableViewPrivate::scrollToColumn(), QQuickTableViewPrivate::scrollToRow(), QQuickColorAnimation::setTo(), QQuickGeoCoordinateAnimation::setTo(), QQuick3DQuaternionAnimation::setTo(), QQuickNumberAnimation::setTo(), QQuickRotationAnimation::setTo(), and QQuickVector3dAnimation::setTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ target()

QObject * QQuickPropertyAnimation::target ( ) const

Definition at line 2497 of file qquickanimation.cpp.

References d.

◆ targetChanged

void QQuickPropertyAnimation::targetChanged ( )

signal

Referenced by setTargetObject().

Here is the caller graph for this function:

◆ targets()

QQmlListProperty< QObject > QQuickPropertyAnimation::targets ( )

◆ to()

QVariant QQuickPropertyAnimation::to ( ) const

\qmlproperty variant QtQuick::PropertyAnimation::to This property holds the end value for the animation.

If the PropertyAnimation 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.

See also: {Animation and Transitions in Qt Quick}

Definition at line 2243 of file qquickanimation.cpp.

References d.

◆ toChanged

void QQuickPropertyAnimation::toChanged ( )

signal

Referenced by setTo().

Here is the caller graph for this function:

◆ transition()

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

overrideprotectedvirtual

Reimplemented from QQuickAbstractAnimation.

Reimplemented in QQuickSmoothedAnimation, and QQuickSpringAnimation.

Definition at line 2859 of file qquickanimation.cpp.

References QQuickAbstractAnimation::Backward, createTransitionActions(), d, direction, QQuickAbstractAnimation::initInstance(), QQuickAnimationPropertyUpdater::interpolatorType, and QQuickBulkValueAnimator::setDuration().

Here is the call graph for this function:

Property Documentation

◆ duration

int QQuickPropertyAnimation::duration

readwrite

Definition at line 235 of file qquickanimation_p.h.

Referenced by setDuration().

◆ easing

QEasingCurve QQuickPropertyAnimation::easing

readwrite

Definition at line 238 of file qquickanimation_p.h.

◆ exclude

QQmlListProperty< QObject > QQuickPropertyAnimation::exclude

read

\qmlproperty list<QtObject> QtQuick::PropertyAnimation::exclude This property holds the items not to be affected by this animation.

See also: PropertyAnimation::targets

Definition at line 243 of file qquickanimation_p.h.

◆ from

QVariant QQuickPropertyAnimation::from

readwrite

Definition at line 236 of file qquickanimation_p.h.

◆ properties

QString QQuickPropertyAnimation::properties

readwrite

Definition at line 241 of file qquickanimation_p.h.

◆ property

QString QQuickPropertyAnimation::property

readwrite

Definition at line 240 of file qquickanimation_p.h.

Referenced by QQuickSmoothedAnimation::transition(), and QQuickSpringAnimation::transition().

◆ target

QObject * QQuickPropertyAnimation::target

readwrite

Definition at line 239 of file qquickanimation_p.h.

◆ targets

QQmlListProperty< QObject > QQuickPropertyAnimation::targets

read

\qmlproperty string QtQuick::PropertyAnimation::properties
\qmlproperty list<QtObject> QtQuick::PropertyAnimation::targets
\qmlproperty string QtQuick::PropertyAnimation::property
\qmlproperty QtObject QtQuick::PropertyAnimation::target

These properties are used as a set to determine which properties should be animated.
The singular and plural forms are functionally identical, e.g.
\qml
NumberAnimation { target: theItem; property: "x"; to: 500 }
\endqml
has the same meaning as
\qml
NumberAnimation { targets: theItem; properties: "x"; to: 500 }
\endqml
The singular forms are slightly optimized, so if you do have only a single target/property
to animate you should try to use them.

The \c targets property allows multiple targets to be set. For example, this animates the
\c x property of both \c itemA and \c itemB:

\qml
NumberAnimation { targets: [itemA, itemB]; properties: "x"; to: 500 }
\endqml

In many cases these properties do not need to be explicitly specified, as they can be
inferred from the animation framework:

\table 80%
\row
\li Value Source / Behavior
\li When an animation is used as a value source or in a Behavior, the default target and property
   name to be animated can both be inferred.
   \qml
   Rectangle {
       id: theRect
       width: 100; height: 100
       color: Qt.rgba(0,0,1)
       NumberAnimation on x { to: 500; loops: Animation.Infinite } //animate theRect's x property
       Behavior on y { NumberAnimation {} } //animate theRect's y property
   }
   \endqml
\row
\li Transition
\li When used in a transition, a property animation is assumed to match \e all targets
   but \e no properties. In practice, that means you need to specify at least the properties
   in order for the animation to do anything.
   \qml
   Rectangle {
       id: theRect
       width: 100; height: 100
       color: Qt.rgba(0,0,1)
       Item { id: uselessItem }
       states: State {
           name: "state1"
           PropertyChanges {
               theRect {
                   x: 200
                   y: 200
                   z: 4
               }
               uselessItem {
                   x: 10
                   y: 10
                   z: 2
               }
           }
       }
       transitions: Transition {

animate both theRect's and uselessItem's x and y to their final values NumberAnimation { properties: "x,y" }

animate theRect's z to its final value NumberAnimation { target: theRect; property: "z" } } } \endqml \row

Standalone
When an animation is used standalone, both the target and property need to be explicitly specified. \qml Rectangle { id: theRect width: 100; height: 100 color: Qt.rgba(0,0,1) need to explicitly specify target and property NumberAnimation { id: theAnim; target: theRect; property: "x"; to: 500 } MouseArea { anchors.fill: parent onClicked: theAnim.start() } } \endqml \endtable

As seen in the above example, properties is specified as a comma-separated string of property names to animate.

See also: exclude, {Animation and Transitions in Qt Quick}

Definition at line 242 of file qquickanimation_p.h.

Referenced by createTransitionActions().

◆ to

QVariant QQuickPropertyAnimation::to

readwrite

Definition at line 237 of file qquickanimation_p.h.

Referenced by QQuickTableViewPrivate::canUnloadTableEdge(), and QQuickTableViewPrivate::loadInitialTable().

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

qtdeclarative/src/quick/util/qquickanimation_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/util/qquickanimation.cpp (5f72764c876058e290e42b0b2f1e77d59f4c914d)

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickPropertyAnimation() [1/2]

◆ ~QQuickPropertyAnimation()

◆ QQuickPropertyAnimation() [2/2]

Member Function Documentation

◆ createTransitionActions()

◆ duration()

◆ durationChanged

◆ easing()

◆ easingChanged

◆ exclude()

◆ from()

◆ fromChanged

◆ properties()

◆ propertiesChanged

◆ property()

◆ propertyChanged

◆ setDuration()

◆ setEasing()

◆ setFrom()

◆ setProperties()

◆ setProperty()

◆ setTargetObject()

◆ setTo()

◆ target()

◆ targetChanged

◆ targets()

◆ to()

◆ toChanged

◆ transition()

Property Documentation

◆ duration

◆ easing

◆ exclude

◆ from

◆ properties

◆ property

◆ target

◆ targets

◆ to