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
QQuickRotationAnimation Class Reference

#include <qquickanimation_p.h>

Inheritance diagram for QQuickRotationAnimation:
Collaboration diagram for QQuickRotationAnimation:

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 ()
Signals inherited from QQuickPropertyAnimation
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

 QQuickRotationAnimation (QObject *parent=nullptr)
 ~QQuickRotationAnimation () override
qreal from () const
void setFrom (qreal)
qreal to () const
 \qmlproperty real QtQuick::RotationAnimation::to This property holds the end value for the animation.
void setTo (qreal)
RotationDirection direction () const
 \qmlproperty enumeration QtQuick::RotationAnimation::direction This property holds the direction of the rotation.
void setDirection (RotationDirection direction)
Public Member Functions inherited from QQuickPropertyAnimation
 QQuickPropertyAnimation (QObject *parent=nullptr)
 \qmltype PropertyAnimation \nativetype 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 &)
QObjecttarget () const
void setTargetObject (QObject *)
QString property () const
void setProperty (const QString &)
QString properties () const
void setProperties (const QString &)
QQmlListProperty< QObjecttargets ()
QQmlListProperty< QObjectexclude ()
Public Member Functions inherited from QQuickAbstractAnimation
 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
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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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 ()

Properties

qreal from
qreal to
RotationDirection direction
Properties inherited from QQuickPropertyAnimation
int duration
QVariant from
QVariant to
QEasingCurve easing
QObjecttarget
QString property
QString properties
QQmlListProperty< QObjecttargets
QQmlListProperty< QObjectexclude
 \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 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 Member Functions inherited from QQuickPropertyAnimation
QQuickStateActions createTransitionActions (QQuickStateActions &actions, QQmlProperties &modified, QObject *defaultTarget=nullptr)
 QQuickPropertyAnimation (QQuickPropertyAnimationPrivate &dd, QObject *parent)
QAbstractAnimationJobtransition (QQuickStateActions &actions, QQmlProperties &modified, TransitionDirection direction, QObject *defaultTarget=nullptr) override
Protected Member Functions inherited from QQuickAbstractAnimation
 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)
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Detailed Description

Definition at line 365 of file qquickanimation_p.h.

Member Enumeration Documentation

◆ RotationDirection

Enumerator
Numerical 
Shortest 
Clockwise 
Counterclockwise 

Definition at line 386 of file qquickanimation_p.h.

Constructor & Destructor Documentation

◆ QQuickRotationAnimation()

QQuickRotationAnimation::QQuickRotationAnimation ( QObject * parent = nullptr)

Definition at line 1581 of file qquickanimation.cpp.

◆ ~QQuickRotationAnimation()

QQuickRotationAnimation::~QQuickRotationAnimation ( )
override

Definition at line 1590 of file qquickanimation.cpp.

Member Function Documentation

◆ direction()

QQuickRotationAnimation::RotationDirection QQuickRotationAnimation::direction ( ) const

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

Possible values are:

\value RotationAnimation.Numerical (default) Rotate by linearly interpolating between the two numbers. A rotation from 10 to 350 will rotate 340 degrees clockwise. \value RotationAnimation.Clockwise Rotate clockwise between the two values \value RotationAnimation.Counterclockwise Rotate counterclockwise between the two values \value RotationAnimation.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 1670 of file qquickanimation.cpp.

◆ directionChanged

void QQuickRotationAnimation::directionChanged ( )
signal

◆ from()

qreal QQuickRotationAnimation::from ( ) const
\qmlproperty real QtQuick::RotationAnimation::from
This property holds the starting value for the animation.

For example, the following animation is not applied until the \c angle value
has reached 100:

\qml
Item {
    states: [

... ]

transitions: Transition { RotationAnimation { properties: "angle"; from: 100; duration: 2000 } } } \endqml

If the RotationAnimation 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 1620 of file qquickanimation.cpp.

◆ setDirection()

void QQuickRotationAnimation::setDirection ( QQuickRotationAnimation::RotationDirection direction)

Definition at line 1676 of file qquickanimation.cpp.

◆ setFrom()

void QQuickRotationAnimation::setFrom ( qreal f)

Definition at line 1626 of file qquickanimation.cpp.

◆ setTo()

void QQuickRotationAnimation::setTo ( qreal t)

Definition at line 1648 of file qquickanimation.cpp.

◆ to()

qreal QQuickRotationAnimation::to ( ) const

\qmlproperty real QtQuick::RotationAnimation::to This property holds the end value for the animation.

If the RotationAnimation 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 1642 of file qquickanimation.cpp.

Property Documentation

◆ direction

RotationDirection QQuickRotationAnimation::direction
readwrite

Definition at line 372 of file qquickanimation_p.h.

◆ from

qreal QQuickRotationAnimation::from
readwrite

Definition at line 370 of file qquickanimation_p.h.

◆ to

qreal QQuickRotationAnimation::to
readwrite

Definition at line 371 of file qquickanimation_p.h.


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