QAbstractAnimation

La classe QAbstractAnimation est la base de toutes les animations. Plus d'informations...

#include <QAbstractAnimation>

Voir la position dans l'arbre des classes.

H�ritage

H�rite de QObject.

H�rit� par QAnimationGroup, QPauseAnimation et QVariantAnimation.

Classe introduite dans Qt 4.6.

Description d�taill�e

La classe QAbstractAnimation est la base de toutes les animations.

Cette classe d�finit les fonctions qui peuvent �tre partag�es par toutes les animations. En h�ritant de cette classe, vous pouvez cr�er des animations personnalis�es qui s'adaptent au reste du framework animation.

La progression d'une animation est donn�e par son temps courant (currentLoopTime()), qui est mesur�e en millisecondes � partir du d�but de l'animation (0) jusqu'� la fin (duration()). La valeur est mise � jour automatiquement pendant le d�roulement de l'animation. Elle peut �galement �tre modifi�e directement avec setCurrentTime().

� tout moment une animation est dans l'un des trois �tats : Running, Stopped ou Paused -- comme d�fini par l'�num�ration State. L'�tat courant peut �tre modifi� en appelant start(), stop(), pause() ou resume(). Une animation verra toujours son temps courant remis � z�ro quand elle est d�marr�e. Si elle est mise en pause, elle continuera avec le m�me temps courant quand elle sera reprise. Quand une animation est arr�t�e, elle ne peut pas �tre reprise, mais gardera son temps courant (jusqu'� ce qu'elle soit red�marr�e). QAbstractAnimation �mettra stateChanged() chaque fois qu'elle changera d'�tat.

Une animation peut boucler un certain nombre de fois en d�finissant la propri�t� loopCount. Quand le temps courant d'une animation atteindra sa duration(), il remettra � z�ro le temps courant et continuera de s'ex�cuter. Un compte de boucle de 1 (la valeur par d�faut) signifie que l'animation sera ex�cut�e une seule fois. Notez qu'une dur�e de -1 signifie que l'animation sera ex�cut�e jusqu'� ce qu'elle soit arr�t�e ; le temps courant augmentera ind�finiment. Quand le temps courant est �gal � duration() et que l'animation est dans sa derni�re boucle, elle entre dans l'�tat Stopped et le signal finished() est �mis.

QAbstractAnimation fournit des fonctions virtuelles pures utilis�es par les sous-classes pour suivre la progression de l'animation : duration() et updateCurrentTime(). La fonction duration() vous permet de signaler une dur�e pour l'animation (telle que discut�e ci-dessus). Le framework animation appelle updateCurrentTime() quand le temps courant a chang�. En r�impl�mentant cette fonction, vous pouvez suivre la progression de l'animation. Notez que ni l'intervalle entre deux appels, ni le nombre d'appels � cette fonction ne sont d�finis ; cependant, elle doit normalement �tre de 60 mises � jour par seconde.

En r�impl�mentant updateState(), vous pouvez suivre les changements d'�tats de l'animation, ce qui est particuli�rement utile pour celles qui ne sont pas temporelles.

Voir aussi QVariantAnimation, QPropertyAnimation, QAnimationGroup et animation-overview.

Type

enum QAbstractAnimation::DeletionPolicy

enum QAbstractAnimation::Direction

Cette �num�ration d�crit la direction de l'animation lorsqu'elle est dans l'�tat Running.

Voir aussi direction.

enum QAbstractAnimation::State

Cette �num�ration d�crit l'�tat de l'animation.

Voir aussi state() et stateChanged().

Propri�t�s

currentLoop : const int

Cette propri�t� contient et d�crit la boucle courante de l'animation. Par d�faut, le compte de boucle de l'animation est de 1, et ainsi la boucle courante sera toujours 0. Si le compte de boucle est 2 et que l'animation s'ex�cute au-del� de sa dur�e, il rembobine automatiquement et red�marre au temps courant 0, puis la boucle courante 1 et ainsi de suite.

Quand la boucle courante change, QAbstractAnimation �met le signal currentLoopChanged().

Fonction d'acc�s

int currentLoop () const

Signal de notification

void currentLoopChanged() ( int currentLoop )

currentTime : int

Cette propri�t� contient le temps courant et la progression de l'animation.

Cette propri�t� d�crit le temps courant de l'animation. Vous pouvez changer le temps courant en appelant setCurrentTime ou vous pouvez appeler start() et laisser l'animation s'ex�cuter, mettant � jour automatiquement le temps courant au fur et � mesure de la progression de l'animation.

Le temps courant de l'animation commence � 0 et se termine � totalDuration().

Fonctions d'acc�s

int currentTime () const
void setCurrentTime ( int msecs )

Voir aussi loopCount et currentLoopTime.

direction : Direction

Cette propri�t� contient la direction de l'animation quand elle est dans l'�tat Running.

La direction indique soit que le temps se d�place de 0 vers la dur�e de l'animation ou de la valeur de la dur�e vers 0 apr�s l'appel de start().

Par d�faut, cette propri�t� est d�finie � Forward.

Fonctions d'acc�s

Direction direction () const
void setDirection ( Direction direction )

Signal de notification

void directionChanged ( QAbstractAnimation::Direction newDirection )

duration : const int

Cette propri�t� contient la dur�e de l'animation.

Si la dur�e est -1, cela signifie qu'elle est ind�finie. Dans ce cas, loopCount est ignor�e.

Fonctions d'acc�s

virtual int duration () const = 0

loopCount : int

Cette propri�t� contient le compte de boucles de l'animation et le d�crit sous la forme d'un entier. Par d�faut, cette valeur est 1, indiquant que l'animation devra s'ex�cuter une seule fois, puis s'arr�ter. En le changeant, vous pouvez laisser l'animation boucler plusieurs fois. Avec une valeur de 0, l'animation ne s'ex�cutera pas du tout ; avec une valeur de -1, l'animation s'ex�cutera ind�finiment jusqu'� ce qu'elle soit stopp�e. Il n'est pas support� d'avoir une boucle sur une animation qui a une dur�e ind�finie. Elle sera lanc�e uniquement une fois.

Fonctions d'acc�s

int loopCount () const
void setLoopCount ( int loopCount )

state : const State

Cette propri�t� contient l'�tat de l'animation.

Cette propri�t� d�crit l'�tat courant de l'animation. Quand l'�tat de l'animation change, QAbstractAnimation �met le signal stateChanged().

Fonctions d'acc�s

State state () const

Signal de notification

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

Fonctions membres

QAbstractAnimation::QAbstractAnimation ( QObject * parent = 0 )

Construit la base de la classe QAbstractAnimation et passe parent au constructeur de QObject.

Voir aussi QVariantAnimation et QAnimationGroup.

QAbstractAnimation::~QAbstractAnimation () [virtual]

Arr�te l'animation si elle est en cours d'ex�cution, puis d�truit la QAbstractAnimation. Si l'animation fait partie d'un QAnimationGroup, celui-ci est automatiquement supprim� avant d'�tre d�truit.

void QAbstractAnimation::currentLoopChanged ( int currentLoop ) [signal]

QAbstractAnimation �met ce signal chaque fois que la boucle courante change. currentLoop est la boucle courante.

Voir aussi currentLoop() et loopCount().

int QAbstractAnimation::currentLoopTime () const

Retourne le temps courant � l'int�rieur de la boucle courante. Il peut aller de 0 � duration().

Voir aussi duration() et currentTime.

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

QAbstractAnimation �met le signal chaque fois que la direction a �t� chang�e. newDirection est la nouvelle direction.

Voir aussi direction.

bool QAbstractAnimation::event ( QEvent * event ) [virtual protected]

R�impl�mentation de QObject::event().

void QAbstractAnimation::finished () [signal]

QAbstractAnimation �met le signal apr�s que l'animation se soit arr�t�e et qu'elle ait atteint la fin.

Ce signal est �mis apr�s stateChanged().

Voir aussi stateChanged().

QAnimationGroup * QAbstractAnimation::group () const

Si l'animation fait partie d'un QAnimationGroup, cette fonction retourne un pointeur sur le groupe ; autrement, elle retourne 0.

Voir aussi QAnimationGroup::addAnimation().

void QAbstractAnimation::pause () [slot]

Met en pause l'animation. Lorsque l'animation est en pause, state() retourne Paused. La valeur de currentTime restera inchang�e jusqu'� ce que resume() ou start() soient appel�es. Si vous voulez continuer au temps courant, appelez resume().

Voir aussi start(), state() et resume().

void QAbstractAnimation::resume () [slot]

Reprend l'animation apr�s qu'elle ait �t� mise en pause. Lorsque l'animation est r�tablie, elle �met les signaux resume() et stateChanged(). Le currenttime est inchang�.

Voir aussi start(), pause() et state().

void QAbstractAnimation::setPaused ( bool paused ) [slot]

Si paused est vrai, l'animation est en pause. Si paused est faux, l'animation est reprise.

Voir aussi state(), pause() et resume().

void QAbstractAnimation::start ( QAbstractAnimation::DeletionPolicy policy = KeepWhenStopped ) [slot]

D�marre l'animation. L'argument policy indique si oui ou non l'animation doit �tre supprim�e lorsqu'elle est termin�e. Lorsque l'animation d�marre, le signal stateChanged() est �mis et state() retourne Running. Lorsque le contr�le atteint la boucle d'�v�nements, l'animation s'ex�cutera par elle-m�me, appelant p�riodiquement updateCurrentTime() au fur et � mesure de la progression de l'animation.

Si l'animation est actuellement arr�t�e ou a d�j� atteint la fin, appeler start() rembobinera l'animation et la red�marrera du d�but. Quand l'animation atteint la fin, elle s'arr�te ou, si le niveau de la boucle est sup�rieur � 1, elle se rembobine et red�marre au d�but.

Si l'animation est d�j� en cours d'ex�cution, cette fonction ne fait rien.

Voir aussi stop() et state().

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

QAbstractAnimation �met le signal chaque fois que l'�tat de l'animation a chang� de oldState � newState. Ce signal est �mis apr�s l'appel de la fonction virtuelle updateState().

Voir aussi updateState().

void QAbstractAnimation::stop () [slot]

Arr�te l'animation. Quand l'animation est arr�t�e, elle �met le signal stateChanged() et state() retourne Stopped. Le temps courant est inchang�.

Si l'animation s'arr�te d'elle-m�me apr�s avoir atteint la fin (c'est-�-dire que currentLoopTime() vaut duration() et currentLoop() est plus grand que loopCount() - 1), le signal finished() est �mis.

Voir aussi start() et state().

int QAbstractAnimation::totalDuration () const

Retourne la dur�e totale et effective de l'animation, incluant le compte de boucles.

Voir aussi duration() et currentTime.

void QAbstractAnimation::updateCurrentTime ( int currentTime ) [pure virtual protected]

Cette fonction virtuelle pure est appel�e chaque fois que le currentTime de l'animation change.

Voir aussi updateState().

void QAbstractAnimation::updateDirection ( QAbstractAnimation::Direction direction ) [virtual protected]

Cette fonction virtuelle est appel�e par QAbstractAnimation quand la direction de l'animation a chang�. L'argument direction est la nouvelle direction.

Voir aussi setDirection() et direction().

void QAbstractAnimation::updateState ( QAbstractAnimation::State newState, QAbstractAnimation::State oldState ) [virtual protected]

Cette fonction virtuelle est appel�e par QAbstractAnimation quand l'�tat de l'animation a chang� de oldState � newState.

Voir aussi start(), stop(), pause() et resume().

Remerciements

Merci � Jonathan Courtois pour la traduction ainsi qu'� Thibaut Cuvelier et � Jacques Thery pour la relecture !