CopperSpice API  1.7.2
QAbstractAnimation Class Referenceabstract

Base class for all animations. More...

Inheritance diagram for QAbstractAnimation:
QObject QAnimationGroup QPauseAnimation QVariantAnimation QParallelAnimationGroup QSequentialAnimationGroup QPropertyAnimation

Public Types

enum  DeletionPolicy
 
enum  Direction
 
enum  State
 

Public Signals

void currentLoopChanged (int currentLoop)
 
void directionChanged (QAbstractAnimation::Direction newDirection)
 
void finished ()
 
void stateChanged (QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
 
- Public Signals inherited from QObject
void destroyed (QObject *obj=nullptr)
 
void objectNameChanged (const QString &objectName)
 

Public Slots

void pause ()
 
void resume ()
 
void setCurrentTime (int msecs)
 
void setPaused (bool paused)
 
void start (QAbstractAnimation::DeletionPolicy policy=KeepWhenStopped)
 
void stop ()
 
- Public Slots inherited from QObject
void deleteLater ()
 

Public Methods

 QAbstractAnimation (QObject *parent=nullptr)
 
virtual ~QAbstractAnimation ()
 
int currentLoop () const
 
int currentLoopTime () const
 
int currentTime () const
 
Direction direction () const
 
virtual int duration () const = 0
 
QAnimationGroupgroup () const
 
int loopCount () const
 
void setDirection (Direction direction)
 
void setLoopCount (int loopCount)
 
State state () const
 
int totalDuration () const
 
- Public Methods inherited from QObject
 QObject (QObject *parent=nullptr)
 
 ~QObject ()
 
bool blockSignals (bool block)
 
const QList< QObject * > & children () const
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QStringdynamicPropertyNames () const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
template<typename T >
findChild (const QString &childName=QString ()) const
 
template<class T >
QList< T > findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<class T >
QList< T > findChildren (const QString &objName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
bool inherits (const QString &className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
QObject * parent () const
 
template<class T = QVariant>
property (const QString &name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const QString &name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 
QThreadthread () const
 

Protected Methods

bool event (QEvent *event) override
 
virtual void updateCurrentTime (int currentTime) = 0
 
virtual void updateDirection (QAbstractAnimation::Direction direction)
 
virtual void updateState (QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
 
- Protected Methods inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signalMethod) const
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signalMethod) const
 
bool isSignalConnected (const QMetaMethod &signalMethod) const
 
int receivers (const QString &signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Properties

 currentLoop
 
 currentTime
 
 direction
 
 duration
 
 loopCount
 
 state
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Static Public Methods inherited from QObject
static bool connect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())
 
static bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...))
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)
 
static QMetaObjectstaticMetaObject ()
 
static QString tr (const char *text, const char *comment=nullptr, std::optional< int > numArg=std::optional< int >())
 

Detailed Description

This class defines the methods for the functionality shared by all animations. By inheriting from this class you can create custom animations that plug into the rest of the Animation Technology.

The progress of an animation is given by its current time (currentLoopTime()), which is measured in milliseconds from the start of the animation (0) to its end (duration()). The value is updated automatically while the animation is running. It can also be set directly with setCurrentTime().

At any point an animation is in one of three states: Running, Stopped, or Paused–as defined by the State enum. The current state can be changed by calling start(), stop(), pause(), or resume(). An animation will always reset its current time when it is started. If paused, it will continue with the same current time when resumed. When an animation is stopped, it can not be resumed, but will keep its current time (until started again). QAbstractAnimation will emit stateChanged() whenever its state changes.

An animation can loop any number of times by setting the loopCount property. When an animation's current time reaches its duration(), it will reset the current time and keep running. A loop count of 1 (the default value) means that the animation will run one time. Note that a duration of -1 means that the animation will run until stopped; the current time will increase indefinitely. When the current time equals duration() and the animation is in its final loop, the Stopped state is entered, and the finished() signal is emitted.

QAbstractAnimation provides pure virtual functions used by subclasses to track the progress of the animation: duration() and updateCurrentTime(). The duration() function lets you report a duration for the animation (as discussed above). The animation technology calls updateCurrentTime() when current time has changed. By reimplementing this function, you can track the animation progress. Note that neither the interval between calls nor the number of calls to this function are defined; though, it will normally be 60 updates per second.

By reimplementing updateState(), you can track the animation's state changes, which is particularly useful for animations that are not driven by time.

See also
QVariantAnimation, QPropertyAnimation, QAnimationGroup, Animation Technology

Member Enumeration Documentation

ConstantValueDescription
QAbstractAnimation::KeepWhenStopped0 Animation will not be deleted when stopped.
QAbstractAnimation::DeleteWhenStopped1 Animation will be automatically deleted when stopped.

This enum describes the direction of the animation when in Running state.

ConstantValueDescription
QAbstractAnimation::Forward 0 Animation increases with time, moves from 0 and towards the end / duration
QAbstractAnimation::Backward 1qstyleoption_cast() Animation decreases with time, moves from the end / duration and towards 0
See also
direction

This enum describes the state of the animation.

ConstantValueDescription
QAbstractAnimation::Stopped0 Animation is not running. This is the initial state and the state QAbstractAnimation reenters when finished. The current time remain unchanged until either setCurrentTime() is called, or the animation is started by calling start().
QAbstractAnimation::Paused1 Animation is paused, temporarily suspended. Call resume() to continue the animation activity.
QAbstractAnimation::Running2 Animation is running. While control is in the event loop, QAbstractAnimation will update its current time at regular intervals, calling updateCurrentTime() when appropriate.
See also
state(), stateChanged()

Constructor & Destructor Documentation

QAbstractAnimation::QAbstractAnimation ( QObject parent = nullptr)

Constructs the QAbstractAnimation base class, and passes parent to QObject's constructor.

See also
QVariantAnimation, QAnimationGroup
QAbstractAnimation::~QAbstractAnimation ( )
virtual

Stops the animation if it is running, then destroys the QAbstractAnimation. If the animation is part of a QAnimationGroup, it is automatically removed before being destroyed.

Method Documentation

int QAbstractAnimation::currentLoop ( ) const

Returns the value of the currentLoop property.

void QAbstractAnimation::currentLoopChanged ( int  currentLoop)
signal

QAbstractAnimation emits this signal whenever the current loop changes. currentLoop is the current loop.

See also
currentLoop(), loopCount()
int QAbstractAnimation::currentLoopTime ( ) const

Returns the current time inside the current loop. It can go from 0 to duration().

See also
duration(), currentTime
int QAbstractAnimation::currentTime ( ) const

Returns the value of the currentTime property.

Direction QAbstractAnimation::direction ( ) const

Returns the value of the Direction property.

void QAbstractAnimation::directionChanged ( QAbstractAnimation::Direction  newDirection)
signal

QAbstractAnimation emits this signal whenever the direction has been changed. newDirection is the new direction.

See also
direction
int QAbstractAnimation::duration ( ) const
pure virtual

Returns the value of the Duration property.

Implemented in QVariantAnimation, QSequentialAnimationGroup, QPauseAnimation, and QParallelAnimationGroup.

bool QAbstractAnimation::event ( QEvent event)
overrideprotectedvirtual

This virtual method receives events to an object and should return true if the event event was recognized and processed. The event() method can be overridden to customize the behavior of an object.

See also
installEventFilter(), timerEvent(), QApplication::sendEvent(), QApplication::postEvent(), QWidget::event()

Reimplemented from QObject.

Reimplemented in QVariantAnimation, QSequentialAnimationGroup, QPropertyAnimation, QAnimationGroup, QParallelAnimationGroup, and QPauseAnimation.

void QAbstractAnimation::finished ( )
signal

QAbstractAnimation emits this signal after the animation has stopped and has reached the end.

This signal is emitted after stateChanged().

See also
stateChanged()
QAnimationGroup * QAbstractAnimation::group ( ) const

If this animation is part of a QAnimationGroup, this method returns a pointer to the group, otherwise it returns a nullptr.

See also
QAnimationGroup::addAnimation()
int QAbstractAnimation::loopCount ( ) const

Returns the value of the loopCount property.

void QAbstractAnimation::pause ( )
slot

Pauses the animation. When the animation is paused, state() returns Paused. The value of currentTime will remain unchanged until resume() or start() is called. If you want to continue from the current time, call resume().

See also
start(), state(), resume()
void QAbstractAnimation::resume ( )
slot

Resumes the animation after it was paused. When the animation is resumed, it emits the resumed() and stateChanged() signals. The currenttime is not changed.

See also
start(), pause(), state()
void QAbstractAnimation::setCurrentTime ( int  msecs)
slot

Sets the value of the property to msecs.

void QAbstractAnimation::setDirection ( Direction  direction)

Sets the value of the Direction property to direction.

void QAbstractAnimation::setLoopCount ( int  loopCount)

Sets the value of the property to loopCount.

void QAbstractAnimation::setPaused ( bool  paused)
slot

If paused is true, the animation is paused. If paused is false, the animation is resumed.

See also
state(), pause(), resume()
void QAbstractAnimation::start ( QAbstractAnimation::DeletionPolicy  policy = KeepWhenStopped)
slot

Starts the animation. The policy argument says whether or not the animation should be deleted when it is done. When the animation starts, the stateChanged() signal is emitted, and state() returns Running. When control reaches the event loop, the animation will run by itself, periodically calling updateCurrentTime() as the animation progresses.

If the animation is currently stopped or has already reached the end, calling start() will rewind the animation and start again from the beginning. When the animation reaches the end, the animation will either stop, or if the loop level is more than 1, it will rewind and continue from the beginning.

If the animation is already running, this function does nothing.

See also
stop(), state()
State QAbstractAnimation::state ( ) const

Returns the value of the property.

void QAbstractAnimation::stateChanged ( QAbstractAnimation::State  newState,
QAbstractAnimation::State  oldState 
)
signal

QAbstractAnimation emits this signal whenever the state of the animation has changed from <oldState to newState. This signal is emitted after the virtual updateState() function is called.

See also
updateState()
void QAbstractAnimation::stop ( )
slot

Stops the animation. When the animation is stopped, it emits the stateChanged() signal, and state() returns Stopped. The current time is not changed.

If the animation stops by itself after reaching the end (i.e., currentLoopTime() == duration() and currentLoop() > loopCount() - 1), the finished() signal is emitted.

See also
start(), state()
int QAbstractAnimation::totalDuration ( ) const

Returns the total and effective duration of the animation, including the loop count.

See also
duration(), currentTime
void QAbstractAnimation::updateCurrentTime ( int  currentTime)
protectedpure virtual

This pure virtual method is called every time the animation's currentTime changes.

See also
updateState()

Implemented in QVariantAnimation, QSequentialAnimationGroup, QPauseAnimation, and QParallelAnimationGroup.

void QAbstractAnimation::updateDirection ( QAbstractAnimation::Direction  direction)
protectedvirtual

A virtual method invoked by QAbstractAnimation when the direction of the animation is changed. The direction argument is the new direction.

See also
setDirection(), direction()

Reimplemented in QSequentialAnimationGroup, and QParallelAnimationGroup.

void QAbstractAnimation::updateState ( QAbstractAnimation::State  newState,
QAbstractAnimation::State  oldState 
)
protectedvirtual

This method is called by QAbstractAnimation when the state of the animation is changed from oldState to newState.

See also
start(), stop(), pause(), resume()

Reimplemented in QVariantAnimation, QSequentialAnimationGroup, QPropertyAnimation, and QParallelAnimationGroup.

Property Documentation

QAbstractAnimation::currentLoop

This property holds the current loop of the animation.

By default the animation's loop count is 1, and so the current loop will always be 0. If the loop count is 2 and the animation runs past its duration, it will automatically rewind and restart at current time 0, and current loop 1, and so on.

When the current loop changes QAbstractAnimation emits the currentLoopChanged() signal.

PropertiesClass Methods
read currentLoop
notify currentLoopChanged
QAbstractAnimation::currentTime

This property holds the current time and progress of the animation.

You can change the current time by calling setCurrentTime, or you can call start() and let the animation run, setting the current time automatically as the animation progresses. The animation's current time starts at 0 and ends at totalDuration().

See also
loopCount, currentLoopTime()
PropertiesClass Methods
read currentTime
write setCurrentTime
QAbstractAnimation::direction

This property holds the direction of the animation when it is in Running state. This direction indicates whether the time moves from 0 towards the animation duration, or from the value of the duration and towards 0 after start() has been called. By default this property is set to Forward.

PropertiesClass Methods
read direction
write setDirection
notify directionChanged
QAbstractAnimation::duration

This property holds the duration of the animation. If the duration is -1, it means that the duration is undefined. In this case, loopCount is ignored.

PropertiesClass Methods
read duration
QAbstractAnimation::loopCount

This property holds the loop count of the animation which is an integer.

By default this value is 1, indicating that the animation should run once only, and then stop. By changing it you can let the animation loop several times. With a value of 0, the animation will not run at all, and with a value of -1, the animation will loop forever until stopped. It is not supported to have loop on an animation that has an undefined duration. It will only run once.

PropertiesClass Methods
read loopCount
write setLoopCount
QAbstractAnimation::state

This property holds current state of the animation. When the animation state changes, QAbstractAnimation emits the stateChanged() signal.

PropertiesClass Methods
read state
notify stateChanged