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

\inmodule QtCore More...

#include <qabstractanimation_p.h>

+ Inheritance diagram for QUnifiedTimer:
+ Collaboration diagram for QUnifiedTimer:

Public Member Functions

 ~QUnifiedTimer () override
 
void setTimingInterval (int interval)
 
void setConsistentTiming (bool consistent)
 
void setSlowModeEnabled (bool enabled)
 
void setSlowdownFactor (qreal factor)
 
void installAnimationDriver (QAnimationDriver *driver)
 
void uninstallAnimationDriver (QAnimationDriver *driver)
 
bool canUninstallAnimationDriver (QAnimationDriver *driver)
 Returns true if d is the currently installed animation driver and is not the default animation driver (which can never be uninstalled).
 
void restart ()
 
void maybeUpdateAnimationsToCurrentTime ()
 
void updateAnimationTimers ()
 
int runningAnimationCount ()
 
void registerProfilerCallback (void(*cb)(qint64))
 
void startAnimationDriver ()
 
void stopAnimationDriver ()
 
qint64 elapsed () const
 
- 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 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.
 

Static Public Member Functions

static QUnifiedTimerinstance ()
 
static QUnifiedTimerinstance (bool create)
 
static void startAnimationTimer (QAbstractAnimationTimer *timer)
 
static void stopAnimationTimer (QAbstractAnimationTimer *timer)
 
static void pauseAnimationTimer (QAbstractAnimationTimer *timer, int duration)
 
static void resumeAnimationTimer (QAbstractAnimationTimer *timer)
 
- 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

void timerEvent (QTimerEvent *) override
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
- 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 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 QDefaultAnimationDriver
 
class QAnimationDriver
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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.
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

\inmodule QtCore

QUnifiedTimer provides a unified timing mechanism for animations in Qt C++ and QML.

QUnifiedTimer allows animations run by Qt to share a single timer. This keeps animations visually in sync, as well as being more efficient than running numerous timers.

QUnifiedTimer drives animations indirectly, via QAbstractAnimationTimer.

Definition at line 126 of file qabstractanimation_p.h.

Constructor & Destructor Documentation

◆ ~QUnifiedTimer()

QUnifiedTimer::~QUnifiedTimer ( )
overridedefault

Member Function Documentation

◆ canUninstallAnimationDriver()

bool QUnifiedTimer::canUninstallAnimationDriver ( QAnimationDriver * driver)

Returns true if d is the currently installed animation driver and is not the default animation driver (which can never be uninstalled).

Definition at line 510 of file qabstractanimation.cpp.

References d.

◆ elapsed()

qint64 QUnifiedTimer::elapsed ( ) const

Definition at line 218 of file qabstractanimation.cpp.

References QAnimationDriver::elapsed(), QElapsedTimer::elapsed(), QAnimationDriver::isRunning(), and QElapsedTimer::isValid().

Referenced by maybeUpdateAnimationsToCurrentTime(), startAnimationDriver(), stopAnimationDriver(), and updateAnimationTimers().

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

◆ installAnimationDriver()

void QUnifiedTimer::installAnimationDriver ( QAnimationDriver * driver)

Definition at line 473 of file qabstractanimation.cpp.

References d, QAnimationDriver::isRunning(), QObject::property(), qWarning, running, startAnimationDriver(), stopAnimationDriver(), and QVariant::toBool().

+ Here is the call graph for this function:

◆ instance() [1/2]

QUnifiedTimer * QUnifiedTimer::instance ( )
static

Definition at line 207 of file qabstractanimation.cpp.

References instance().

Referenced by QSGDefaultAnimationDriver::QSGDefaultAnimationDriver(), QSGGuiThreadRenderLoop::QSGGuiThreadRenderLoop(), QAnimationDriver::~QAnimationDriver(), QAnimationDriver::advanceAnimation(), QAnimationTimer::ensureTimerUpdate(), QQmlAnimationTimer::ensureTimerUpdate(), QAnimationDriver::install(), instance(), pauseAnimationTimer(), QmlJSDebugger::GlobalInspector::processMessage(), resumeAnimationTimer(), QQmlAnimationTimer::startAnimations(), startAnimationTimer(), stopAnimationTimer(), QQuickDesignerSupportItems::stopUnifiedTimer(), and QAnimationDriver::uninstall().

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

◆ instance() [2/2]

QUnifiedTimer * QUnifiedTimer::instance ( bool create)
static

Definition at line 194 of file qabstractanimation.cpp.

References create().

+ Here is the call graph for this function:

◆ maybeUpdateAnimationsToCurrentTime()

void QUnifiedTimer::maybeUpdateAnimationsToCurrentTime ( )

Definition at line 212 of file qabstractanimation.cpp.

References elapsed(), and updateAnimationTimers().

+ Here is the call graph for this function:

◆ pauseAnimationTimer()

void QUnifiedTimer::pauseAnimationTimer ( QAbstractAnimationTimer * timer,
int duration )
static

Definition at line 437 of file qabstractanimation.cpp.

References instance(), startAnimationTimer(), and timer.

Referenced by QAnimationTimer::restartAnimationTimer(), and QQmlAnimationTimer::restartAnimationTimer().

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

◆ registerProfilerCallback()

void QUnifiedTimer::registerProfilerCallback ( void(*)(qint64) cb)

Definition at line 302 of file qabstractanimation.cpp.

References cb.

◆ restart()

void QUnifiedTimer::restart ( )

Definition at line 326 of file qabstractanimation.cpp.

References QList< T >::at(), i, QAbstractAnimationTimer::restartAnimationTimer(), and QList< T >::size().

Referenced by QAnimationDriver::advanceAnimation(), and timerEvent().

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

◆ resumeAnimationTimer()

void QUnifiedTimer::resumeAnimationTimer ( QAbstractAnimationTimer * timer)
static

Definition at line 451 of file qabstractanimation.cpp.

References instance(), QList< T >::removeOne(), and timer.

Referenced by QAnimationTimer::restartAnimationTimer(), QQmlAnimationTimer::restartAnimationTimer(), and QQmlAnimationTimer::stopTimer().

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

◆ runningAnimationCount()

int QUnifiedTimer::runningAnimationCount ( )

Definition at line 294 of file qabstractanimation.cpp.

References QList< T >::at(), i, QAbstractAnimationTimer::runningAnimationCount(), and QList< T >::size().

+ Here is the call graph for this function:

◆ setConsistentTiming()

void QUnifiedTimer::setConsistentTiming ( bool consistent)
inline

Definition at line 151 of file qabstractanimation_p.h.

◆ setSlowdownFactor()

void QUnifiedTimer::setSlowdownFactor ( qreal factor)
inline

Definition at line 155 of file qabstractanimation_p.h.

◆ setSlowModeEnabled()

void QUnifiedTimer::setSlowModeEnabled ( bool enabled)
inline

Definition at line 154 of file qabstractanimation_p.h.

References enabled.

◆ setTimingInterval()

void QUnifiedTimer::setTimingInterval ( int interval)

Definition at line 337 of file qabstractanimation.cpp.

References QBasicTimer::isActive(), QAnimationDriver::isRunning(), startAnimationDriver(), and stopAnimationDriver().

+ Here is the call graph for this function:

◆ startAnimationDriver()

void QUnifiedTimer::startAnimationDriver ( )

Definition at line 231 of file qabstractanimation.cpp.

References elapsed(), QAnimationDriver::isRunning(), qWarning, and QAnimationDriver::start().

Referenced by installAnimationDriver(), setTimingInterval(), and uninstallAnimationDriver().

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

◆ startAnimationTimer()

void QUnifiedTimer::startAnimationTimer ( QAbstractAnimationTimer * timer)
static

Definition at line 395 of file qabstractanimation.cpp.

References instance(), QMetaObject::invokeMethod(), Qt::QueuedConnection, and timer.

Referenced by pauseAnimationTimer(), QAnimationTimer::restartAnimationTimer(), and QQmlAnimationTimer::restartAnimationTimer().

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

◆ stopAnimationDriver()

void QUnifiedTimer::stopAnimationDriver ( )

Definition at line 244 of file qabstractanimation.cpp.

References elapsed(), QElapsedTimer::elapsed(), QAnimationDriver::isRunning(), qWarning, and QAnimationDriver::stop().

Referenced by installAnimationDriver(), setTimingInterval(), and uninstallAnimationDriver().

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

◆ stopAnimationTimer()

void QUnifiedTimer::stopAnimationTimer ( QAbstractAnimationTimer * timer)
static

Definition at line 409 of file qabstractanimation.cpp.

References QListSpecialMethodsBase< T >::indexOf(), instance(), QMetaObject::invokeMethod(), QList< T >::isEmpty(), Qt::QueuedConnection, QList< T >::removeAt(), QList< T >::removeOne(), and timer.

Referenced by QQmlAnimationTimer::stopTimer().

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

◆ timerEvent()

void QUnifiedTimer::timerEvent ( QTimerEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QChronoTimer provides higher-level interfaces to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also
startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 377 of file qabstractanimation.cpp.

References restart(), QBasicTimer::timerId(), and updateAnimationTimers().

+ Here is the call graph for this function:

◆ uninstallAnimationDriver()

void QUnifiedTimer::uninstallAnimationDriver ( QAnimationDriver * driver)

Definition at line 490 of file qabstractanimation.cpp.

References d, QAnimationDriver::isRunning(), qWarning, running, startAnimationDriver(), and stopAnimationDriver().

+ Here is the call graph for this function:

◆ updateAnimationTimers()

void QUnifiedTimer::updateAnimationTimers ( )

Definition at line 257 of file qabstractanimation.cpp.

References animation, QList< T >::at(), elapsed(), QBasicTimer::isActive(), qRound(), and QList< T >::size().

Referenced by QAnimationDriver::advanceAnimation(), maybeUpdateAnimationsToCurrentTime(), and timerEvent().

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

Friends And Related Symbol Documentation

◆ QAnimationDriver

friend class QAnimationDriver
friend

Definition at line 182 of file qabstractanimation_p.h.

◆ QDefaultAnimationDriver

friend class QDefaultAnimationDriver
friend

Definition at line 181 of file qabstractanimation_p.h.


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