Méthode IUIAnimationStoryboard2 ::RepeatBetweenKeyframes (uianimation.h)

Crée une boucle entre deux images clés.

Syntaxe

HRESULT RepeatBetweenKeyframes(
  [in] UI_ANIMATION_KEYFRAME                   startKeyframe,
  [in] UI_ANIMATION_KEYFRAME                   endKeyframe,
  [in] DOUBLE                                  cRepetition,
  [in] UI_ANIMATION_REPEAT_MODE                repeatMode,
  [in] IUIAnimationLoopIterationChangeHandler2 *pIterationChangeHandler,
  [in] UINT_PTR                                id,
  [in] BOOL                                    fRegisterForNextAnimationEvent
);

Paramètres

[in] startKeyframe

Image clé à laquelle la boucle doit commencer.

[in] endKeyframe

Image clé au niveau de laquelle la boucle doit se terminer. endKeyframe ne doit pas se produire plus tôt dans le storyboard que startKeyframe.

[in] cRepetition

Nombre de fois que la boucle doit être répétée ; la dernière itération d’une boucle peut se terminer de façon fractionnée entre les images clés. La valeur zéro indique que la partie spécifiée d’un storyboard ne sera pas lue. La valeur UI_ANIMATION_REPEAT_INDEFINITELY (-1) indique que la boucle se répète indéfiniment jusqu’à ce que le storyboard soit supprimé ou terminé.

[in] repeatMode

Modèle de l’itération de boucle.

La valeur UI_ANIMATION_REPEAT_MODE_ALTERNATE (1) spécifie que le début de la boucle doit alterner entre les images clés (k1-k2>, k2-k1>, k1-k2>, etc.).

La valeur UI_ANIMATION_REPEAT_MODE_NORMAL (0) spécifie que le début de la boucle doit commencer par la première image clé (k1-k2>, k1-k2>, k1-k2, k1-k2>, etc.).

[in] pIterationChangeHandler

Gestionnaire pour chaque événement d’itération de boucle. La valeur par défaut est 0.

[in] id

ID de boucle à passer à pIterationChangeHandler. La valeur par défaut est 0.

[in] fRegisterForNextAnimationEvent

Si la valeur est true, spécifie que pIterationChangeHandler sera incorporé dans l’estimation de l’intervalle de temps jusqu’à l’événement d’animation suivant retourné par la méthode IUIAnimationManager2 ::EstimateNextEventTime . La valeur par défaut est 0 ou false.

Valeur retournée

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT. Pour obtenir la liste des codes d’erreur, consultez Codes d’erreur d’animation Windows .

Remarques

Cette méthode indique à un storyboard de lire l’intervalle entre les images clés données à plusieurs reprises avant de lire le reste du storyboard. Si un nombre de répétitions fini est spécifié, la boucle lit toujours ce nombre de fois. Si UI_ANIMATION_REPEAT_INDEFINITELY (-1) est spécifié, la boucle se répète jusqu’à ce que le storyboard soit terminé, auquel cas l’itération actuelle de la boucle se termine et le reste du storyboard est lu. Un storyboard qui boucle indéfiniment se termine également s’il est tronqué.

Les boucles imbriquées et qui se chevauchent ne sont pas prises en charge.

Une image clé représente un moment dans le temps dans un storyboard et peut être utilisée pour spécifier les heures de début ou de fin des transitions. Étant donné que les images clés peuvent être ajoutées à la fin des transitions, leurs décalages par rapport au début du storyboard peuvent ne pas être connus tant que le storyboard n’est pas en cours de lecture.

Configuration requise

Voir aussi

IUIAnimationStoryboard2

IUIAnimationStoryboard2 ::AddKeyframeAfterTransition

IUIAnimationStoryboard2 ::AddKeyframeAtOffset