Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Signals | Public Member Functions | Protected Member Functions | Friends | List of all members
QAnimationDriver Class Reference

\inmodule QtCore More...

#include <qabstractanimation.h>

+ Inheritance diagram for QAnimationDriver:
+ Collaboration diagram for QAnimationDriver:

Signals

void started ()
 This signal is emitted by the animation framework to notify the driver that continuous animation has started.
 
void stopped ()
 This signal is emitted by the animation framework to notify the driver that continuous animation has stopped.
 
- 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

 QAnimationDriver (QObject *parent=nullptr)
 
 ~QAnimationDriver ()
 
virtual void advance ()
 Advances the animation.
 
void install ()
 Installs this animation driver.
 
void uninstall ()
 Uninstalls this animation driver.
 
bool isRunning () const
 
virtual qint64 elapsed () const
 Returns the number of milliseconds since the animations was started.
 
- 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.
 

Protected Member Functions

void advanceAnimation ()
 Advances the animation.
 
virtual void start ()
 
virtual void stop ()
 
 QAnimationDriver (QAnimationDriverPrivate &dd, QObject *parent=nullptr)
 
- 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)
 

Friends

class QUnifiedTimer
 

Additional Inherited Members

- 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
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

\inmodule QtCore

The QAnimationDriver class is used to exchange the mechanism that drives animations.

The default animation system is driven by a timer that fires at regular intervals. In some scenarios, it is better to drive the animation based on other synchronization mechanisms, such as the vertical refresh rate of the screen.

Definition at line 106 of file qabstractanimation.h.

Constructor & Destructor Documentation

◆ QAnimationDriver() [1/2]

QAnimationDriver::QAnimationDriver ( QObject * parent = nullptr)

Definition at line 725 of file qabstractanimation.cpp.

◆ ~QAnimationDriver()

QAnimationDriver::~QAnimationDriver ( )

Definition at line 735 of file qabstractanimation.cpp.

References QUnifiedTimer::instance(), timer, and uninstall().

+ Here is the call graph for this function:

◆ QAnimationDriver() [2/2]

QAnimationDriver::QAnimationDriver ( QAnimationDriverPrivate & dd,
QObject * parent = nullptr )
protected

Definition at line 730 of file qabstractanimation.cpp.

Member Function Documentation

◆ advance()

void QAnimationDriver::advance ( )
virtual

Advances the animation.

This function should be continuously called by the driver while the animation is running.

Reimplemented in QSGDefaultAnimationDriver, QSGElapsedTimerAnimationDriver, and QOpenXRAnimationDriver.

Definition at line 766 of file qabstractanimation.cpp.

References advanceAnimation().

Referenced by QSGThreadedRenderLoop::event(), QSGSoftwareThreadedRenderLoop::event(), QSGSoftwareRenderThread::syncAndRender(), QSGRenderThread::syncAndRender(), and QDefaultAnimationDriver::timerEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ advanceAnimation()

void QAnimationDriver::advanceAnimation ( )
protected

Advances the animation.

This function should be continuously called by the driver subclasses while the animation is running.

The calculation of the new current time will use elapsed() in combination with the internal time offsets of the animation system.

Definition at line 750 of file qabstractanimation.cpp.

References QUnifiedTimer::instance(), QUnifiedTimer::restart(), and QUnifiedTimer::updateAnimationTimers().

Referenced by advance(), QSGDefaultAnimationDriver::advance(), QSGElapsedTimerAnimationDriver::advance(), and QOpenXRAnimationDriver::advance().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ elapsed()

qint64 QAnimationDriver::elapsed ( ) const
virtual

Returns the number of milliseconds since the animations was started.

Reimplemented in QSGDefaultAnimationDriver, QSGElapsedTimerAnimationDriver, and QOpenXRAnimationDriver.

Definition at line 829 of file qabstractanimation.cpp.

References d.

Referenced by QUnifiedTimer::elapsed().

+ Here is the caller graph for this function:

◆ install()

void QAnimationDriver::install ( )

Installs this animation driver.

The animation driver is thread local and will only apply for the thread its installed in.

Definition at line 778 of file qabstractanimation.cpp.

References QUnifiedTimer::instance(), and timer.

Referenced by QSGSoftwareThreadedRenderLoop::QSGSoftwareThreadedRenderLoop(), QSGThreadedRenderLoop::QSGThreadedRenderLoop(), QSGSoftwareRenderThread::run(), and QSGRenderThread::run().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isRunning()

bool QAnimationDriver::isRunning ( ) const

Definition at line 796 of file qabstractanimation.cpp.

Referenced by QUnifiedTimer::elapsed(), QUnifiedTimer::installAnimationDriver(), QSGSoftwareThreadedRenderLoop::interleaveIncubation(), QSGThreadedRenderLoop::interleaveIncubation(), QUnifiedTimer::setTimingInterval(), QUnifiedTimer::startAnimationDriver(), QUnifiedTimer::stopAnimationDriver(), QSGSoftwareRenderThread::syncAndRender(), QSGRenderThread::syncAndRender(), and QUnifiedTimer::uninstallAnimationDriver().

+ Here is the caller graph for this function:

◆ start()

void QAnimationDriver::start ( )
protectedvirtual

Reimplemented in QSGDefaultAnimationDriver, and QSGElapsedTimerAnimationDriver.

Definition at line 802 of file qabstractanimation.cpp.

References d, emit, and started().

Referenced by QSGDefaultAnimationDriver::start(), QSGElapsedTimerAnimationDriver::start(), and QUnifiedTimer::startAnimationDriver().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ started

QAnimationDriver::started ( )
signal

This signal is emitted by the animation framework to notify the driver that continuous animation has started.

Referenced by QDefaultAnimationDriver::QDefaultAnimationDriver(), QSGSoftwareThreadedRenderLoop::QSGSoftwareThreadedRenderLoop(), QDefaultAnimationDriver::~QDefaultAnimationDriver(), and start().

+ Here is the caller graph for this function:

◆ stop()

void QAnimationDriver::stop ( )
protectedvirtual

Definition at line 813 of file qabstractanimation.cpp.

References d, emit, and stopped().

Referenced by QUnifiedTimer::stopAnimationDriver().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ stopped

QAnimationDriver::stopped ( )
signal

This signal is emitted by the animation framework to notify the driver that continuous animation has stopped.

Referenced by QDefaultAnimationDriver::QDefaultAnimationDriver(), QQuickWindowIncubationController::QQuickWindowIncubationController(), QSGSoftwareThreadedRenderLoop::QSGSoftwareThreadedRenderLoop(), QDefaultAnimationDriver::~QDefaultAnimationDriver(), and stop().

+ Here is the caller graph for this function:

◆ uninstall()

void QAnimationDriver::uninstall ( )

Uninstalls this animation driver.

Definition at line 790 of file qabstractanimation.cpp.

References QUnifiedTimer::instance(), and timer.

Referenced by ~QAnimationDriver().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QUnifiedTimer

friend class QUnifiedTimer
friend

Definition at line 136 of file qabstractanimation.h.

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