QQuickRotationAnimator Class Reference

#include <qquickanimator_p.h>

Inheritance diagram for QQuickRotationAnimator:

Collaboration diagram for QQuickRotationAnimator:

Public Types
enum	RotationDirection { Numerical , Shortest , Clockwise , Counterclockwise }
Public Types inherited from QQuickAbstractAnimation
enum	ThreadingModel { GuiThread , RenderThread , AnyThread }
enum	Loops { Infinite = -2 }
enum	TransitionDirection { Forward , Backward }

Signals
void	directionChanged (RotationDirection dir)
Signals inherited from QQuickAnimator
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
	QQuickRotationAnimator (QObject *parent=nullptr)
	\qmltype RotationAnimator \instantiates QQuickRotationAnimator \inqmlmodule QtQuick
void	setDirection (RotationDirection dir)
	\qmlproperty enumeration QtQuick::RotationAnimator::direction This property holds the direction of the rotation.
RotationDirection	direction () const
Public Member Functions inherited from QQuickAnimator
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.
virtual ThreadingModel	threadingModel () const
virtual QAbstractAnimationJob *	transition (QQuickStateActions &actions, QQmlProperties &modified, TransitionDirection direction, QObject *defaultTarget=nullptr)
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.
void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.
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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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.
virtual void	setTarget (const QQmlProperty &)=0
	Set the target property for the value source.
Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()
virtual	~QQmlParserStatus ()
virtual void	classBegin ()=0
	Invoked after class creation, but before any properties have been set.
virtual void	componentComplete ()=0
	Invoked after the root component that caused this instantiation has completed construction.

Protected Member Functions
QQuickAnimatorJob *	createJob () const override
QString	propertyName () const override
Protected Member Functions inherited from QQuickAnimator
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
RotationDirection	direction
Properties inherited from QQuickAnimator
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 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 125 of file qquickanimator_p.h.

Member Enumeration Documentation

RotationDirection

enum QQuickRotationAnimator::RotationDirection

Enumerator
Numerical
Shortest
Clockwise
Counterclockwise

Definition at line 134 of file qquickanimator_p.h.

Constructor & Destructor Documentation

QQuickRotationAnimator()

QQuickRotationAnimator::QQuickRotationAnimator

(

QObject *

parent = nullptr

)

\qmltype RotationAnimator \instantiates QQuickRotationAnimator \inqmlmodule QtQuick

Since

5.2

\inherits Animator

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.

Rectangle {
    id: rotatingBox
    width: 50
    height: 50
    color: "lightsteelblue"
    RotationAnimator {
        target: rotatingBox;
        from: 0;
        to: 360;
        duration: 1000
        running: true
    }
}

It is also possible to use the on keyword to tie the RotationAnimator directly to the rotation property of an Item instance.

Rectangle {
    width: 50
    height: 50
    color: "lightsteelblue"
    RotationAnimator on rotation {
        from: 0;
        to: 360;
        duration: 1000
    }
}

See also

Item::transformOrigin, ScaleAnimator

Definition at line 434 of file qquickanimator.cpp.

Member Function Documentation

createJob()

QQuickAnimatorJob * QQuickRotationAnimator::createJob ( ) const

overrideprotectedvirtual

Implements QQuickAnimator.

Definition at line 439 of file qquickanimator.cpp.

References d, and QQuickRotationAnimatorJob::setDirection().

Here is the call graph for this function:

direction()

QQuickRotationAnimator::RotationDirection QQuickRotationAnimator::direction

(

)

const

Definition at line 472 of file qquickanimator.cpp.

References d.

directionChanged

void QQuickRotationAnimator::directionChanged ( RotationDirection  dir )

signal

Referenced by setDirection().

Here is the caller graph for this function:

propertyName()

QString QQuickRotationAnimator::propertyName ( ) const

inlineoverrideprotectedvirtual

Implements QQuickAnimator.

Definition at line 147 of file qquickanimator_p.h.

References QStringLiteral.

setDirection()

void QQuickRotationAnimator::setDirection

(

RotationDirection

dir

)

\qmlproperty enumeration QtQuick::RotationAnimator::direction This property holds the direction of the rotation.

Possible values are:

\value RotationAnimator.Numerical (default) Rotate by linearly interpolating between the two numbers. A rotation from 10 to 350 will rotate 340 degrees clockwise. \value RotationAnimator.Clockwise Rotate clockwise between the two values \value RotationAnimator.Counterclockwise Rotate counterclockwise between the two values \value RotationAnimator.Shortest Rotate in the direction that produces the shortest animation path. A rotation from 10 to 350 will rotate 20 degrees counterclockwise.

Definition at line 463 of file qquickanimator.cpp.

References d, dir, directionChanged(), and Q_EMIT.

Here is the call graph for this function:

Property Documentation

direction

RotationDirection QQuickRotationAnimator::direction

readwrite

Definition at line 121 of file qquickanimator_p.h.

---

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

• qtdeclarative/src/quick/util/qquickanimator_p.h
• qtdeclarative/src/quick/util/qquickanimator.cpp