CAnimationBaseObject, classe

Classe de base pour tous les objets d'animation.

Syntaxe

class CAnimationBaseObject : public CObject;

Membres

Constructeurs publics

Nom	Description
CAnimationBaseObject ::CAnimationBaseObject	Surcharge. Construit un objet d’animation.
CAnimationBaseObject ::~CAnimationBaseObject	Destructeur. Appelé lorsqu’un objet d’animation est détruit.

Méthodes publiques

Nom	Description
CAnimationBaseObject ::ApplyTransitions	Ajoute des transitions au storyboard avec une variable d’animation encapsulée.
CAnimationBaseObject ::ClearTransitions	Supprime toutes les transitions associées.
CAnimationBaseObject ::ContainsVariable	Détermine si un objet d’animation contient une variable d’animation particulière.
CAnimationBaseObject ::CreateTransitions	Crée des transitions associées à un objet d’animation.
CAnimationBaseObject ::D etachFromController	Détache un objet d’animation du contrôleur d’animation parent.
CAnimationBaseObject ::EnableIntegerValueChangedEvent	Configure le gestionnaire d’événements Integer Value Changed.
CAnimationBaseObject ::EnableValueChangedEvent	Configure le gestionnaire d’événements Value Changed.
CAnimationBaseObject ::GetAutodestroyTransitions	Indique si la transition associée est détruite automatiquement.
CAnimationBaseObject ::GetGroupID	Retourne l’ID de groupe actuel.
CAnimationBaseObject ::GetObjectID	Retourne l’ID d’objet actuel.
CAnimationBaseObject ::GetUserData	Retourne des données définies par l’utilisateur.
CAnimationBaseObject ::SetAutodestroyTransitions	Définit un indicateur pour détruire automatiquement les transitions.
CAnimationBaseObject ::SetID	Définit les nouveaux ID.
CAnimationBaseObject ::SetUserData	Définit les données définies par l’utilisateur.

Méthodes protégées

Nom	Description
CAnimationBaseObject ::GetAnimationVariableList	Collecte des pointeurs vers des variables d’animation contenues.
CAnimationBaseObject ::SetParentAnimationObjects	Établit une relation entre les variables d’animation, contenues dans un objet d’animation et leur conteneur.

Membres de données protégés

Nom	Description
CAnimationBaseObject ::m_bAutodestroyTransitions	Spécifie si les transitions associées doivent être détruites automatiquement.
CAnimationBaseObject ::m_dwUserData	Stocke les données définies par l’utilisateur.
CAnimationBaseObject ::m_nGroupID	Spécifie l’ID de groupe de l’objet d’animation.
CAnimationBaseObject ::m_nObjectID	Spécifie l’ID d’objet de l’objet d’animation.
CAnimationBaseObject ::m_pParentController	Pointeur vers le contrôleur d’animation parent.

Notes

Cette classe implémente des méthodes de base pour tous les objets d’animation. Un objet d’animation peut représenter une valeur, un point, une taille, un rectangle ou une couleur dans une application, ainsi que n’importe quelle entité personnalisée. Les objets d’animation sont stockés dans des groupes d’animations (voir CAnimationGroup). Chaque groupe peut être animé séparément et peut être traité comme un analogue du storyboard. Un objet d’animation encapsule une ou plusieurs variables d’animation (voir CAnimationVariable), en fonction de sa représentation logique. Par exemple, CAnimationRect contient quatre variables d’animation : une variable pour chaque côté du rectangle. Chaque classe d’objet d’animation expose la méthode AddTransition surchargée, qui doit être utilisée pour appliquer des transitions aux variables d’animation encapsulées. Un objet d’animation peut être identifié par l’ID d’objet (éventuellement) et par ID de groupe. Un ID de groupe est nécessaire pour placer un objet d’animation pour corriger le groupe, mais si un ID de groupe n’est pas spécifié, un objet est placé dans le groupe par défaut avec l’ID 0. Si vous appelez SetID avec un autre GroupID, un objet d’animation est déplacé vers un autre groupe (un nouveau groupe est créé si nécessaire).

Hiérarchie d'héritage

CObject

CAnimationBaseObject

Spécifications

En-tête : afxanimationcontroller.h

CAnimationBaseObject ::~CAnimationBaseObject

Destructeur. Appelé lorsqu’un objet d’animation est détruit.

virtual ~CAnimationBaseObject();

CAnimationBaseObject ::ApplyTransitions

Ajoute des transitions au storyboard avec une variable d’animation encapsulée.

virtual BOOL ApplyTransitions(
    IUIAnimationStoryboard* pStoryboard,
    BOOL bDependOnKeyframes);

Paramètres

pStoryboard
Pointeur vers un storyboard.

bDependOnKeyframes
Lorsque la valeur est FALSE, cette méthode ajoute uniquement les transitions qui ne dépendent pas des images clés.

Valeur de retour

TRUE si des transitions ont été ajoutées avec succès.

Notes

Ajoute des transitions associées, qui ont été ajoutées avec AddTransition (méthodes surchargées dans les classes dérivées), au storyboard.

CAnimationBaseObject ::CAnimationBaseObject

Construit un objet d’animation.

CAnimationBaseObject();

CAnimationBaseObject(
    UINT32 nGroupID,
    UINT32 nObjectID = (UINT32)-1,
    DWORD dwUserData = 0);

Paramètres

nGroupID
Spécifie l’ID de groupe.

nObjectID
Spécifie l’ID d’objet.

dwUserData
Données définies par l’utilisateur, qui peuvent être associées à un objet d’animation et récupérées ultérieurement au moment de l’exécution.

Notes

Construit des objets d’animation et affecte l’ID d’objet par défaut (0) et l’ID de groupe (0).

CAnimationBaseObject ::ClearTransitions

Supprime toutes les transitions associées.

virtual void ClearTransitions(BOOL bAutodestroy);

Paramètres

bAutodestroy
Spécifie s’il faut détruire automatiquement des objets de transition ou les supprimer simplement de la liste associée.

Notes

Supprime toutes les transitions associées et les détruit si bAutodestroy ou m_bAutodestroyTransitions indicateur a la valeur TRUE. Les transitions doivent être détruites automatiquement uniquement si elles ne sont pas allouées sur la pile. Si les indicateurs ci-dessus sont FALSE, les transitions sont simplement supprimées de la liste interne des transitions associées.

CAnimationBaseObject ::ContainsVariable

Détermine si un objet d’animation contient une variable d’animation particulière.

virtual BOOL ContainsVariable(IUIAnimationVariable* pVariable);

Paramètres

pVariable
Pointeur vers une variable d’animation.

Valeur de retour

TRUE si la variable d’animation est contenue dans l’objet d’animation ; sinon FALSE.

Notes

Cette méthode peut être utilisée pour déterminer si une variable d’animation spécifiée par pVariable est contenue dans un objet d’animation. Un objet d’animation, selon son type, peut contenir plusieurs variables d’animation. Par exemple, CAnimationColor contient trois variables, une pour chaque composant de couleur (rouge, vert et bleu). Lorsqu’une valeur de variable d’animation a changé, l’API Animation Windows envoie des événements ValueChanged ou IntegerValueChanged (si activé) et le paramètre de cet événement est un pointeur vers l’interface IUIAnimationVariable de variable d’animation. Cette méthode permet d’obtenir un pointeur vers l’animation d’un pointeur vers un objet COM contenu.

CAnimationBaseObject ::CreateTransitions

Crée des transitions associées à un objet d’animation.

BOOL CreateTransitions();

Valeur de retour

TRUE si des transitions ont été créées avec succès ; sinon FALSE.

Notes

Effectue une boucle sur la liste des variables d’animation encapsulées dans un objet d’animation dérivé et crée des transitions associées à chaque variable d’animation.

CAnimationBaseObject ::D etachFromController

Détache un objet d’animation du contrôleur d’animation parent.

void DetachFromController();

Notes

Cette méthode est utilisée en interne.

CAnimationBaseObject ::EnableIntegerValueChangedEvent

Configure le gestionnaire d’événements Integer Value Changed.

virtual void EnableIntegerValueChangedEvent(
    CAnimationController* pController,
    BOOL bEnable);

Paramètres

pController
Pointeur vers un contrôleur parent.

bEnable
Spécifie s’il faut activer ou désactiver l’événement Integer Value Changed.

Notes

Si le gestionnaire d’événements Integer Value Changed est activé, vous pouvez gérer cet événement dans la méthode CAnimationController ::OnAnimationIntegerValueChanged, qui doit être substituée dans une classe dérivée de CAnimationController. Cette méthode est appelée chaque fois que la valeur entière d’animation a changé.

CAnimationBaseObject ::EnableValueChangedEvent

Configure le gestionnaire d’événements Value Changed.

virtual void EnableValueChangedEvent(
    CAnimationController* pController,
    BOOL bEnable);

Paramètres

pController
Pointeur vers un contrôleur parent.

bEnable
Spécifie s’il faut activer ou désactiver l’événement Value Changed.

Notes

Si le gestionnaire d’événements Value Changed est activé, vous pouvez gérer cet événement dans la méthode CAnimationController ::OnAnimationValueChanged, qui doit être substituée dans une classe dérivée de CAnimationController. Cette méthode est appelée chaque fois que la valeur d’animation a changé.

CAnimationBaseObject ::GetAnimationVariableList

Collecte des pointeurs vers des variables d’animation contenues.

virtual void GetAnimationVariableList(
    CList<CAnimationVariable*,
    CAnimationVariable*>& list) = 0;

Paramètres

list
Liste qui doit être remplie de variables d’animation contenues dans un objet d’animation.

Notes

Cette méthode virtuelle pure doit être substituée dans une classe dérivée. Un objet d’animation, selon son type, contient une ou plusieurs variables d’animation. Par exemple, CAnimationPoint contient deux variables, respectivement pour les coordonnées X et Y. La classe de base CAnimationBaseObject implémente certaines méthodes génériques, qui agissent sur une liste de variables d’animation : ApplyTransitions, ClearTransitions, EnableValueChangedEvent, EnableIntegerValueChangedEvent. Ces méthodes appellent GetAnimationVariableList, qui est renseignée dans une classe dérivée avec des variables d’animation réelles contenues dans un objet d’animation particulier, puis effectuent une boucle sur la liste et effectuent des actions nécessaires. Si vous créez un objet d’animation personnalisé, vous devez ajouter à la liste toutes les variables d’animation contenues dans cet objet.

CAnimationBaseObject ::GetAutodestroyTransitions

Indique si la transition associée est détruite automatiquement.

BOOL GetAutodestroyTransitions() const;

Valeur de retour

Si la valeur EST TRUE, les transitions associées sont détruites automatiquement ; si la valeur est FALSE, les objets de transition doivent être désalloués en appelant l’application.

Notes

Par défaut, cet indicateur a la valeur TRUE. Définissez cet indicateur uniquement si vous avez alloué la transition sur la pile et/ou si les transitions doivent être libérées par l’application appelante.

CAnimationBaseObject ::GetGroupID

Retourne l’ID de groupe actuel.

UINT32 GetGroupID() const;

Valeur de retour

ID de groupe actuel.

Notes

Utilisez cette méthode pour récupérer l’ID de groupe. Il s’agit de 0 si l’ID de groupe n’a pas été défini explicitement dans le constructeur ou avec SetID.

CAnimationBaseObject ::GetObjectID

Retourne l’ID d’objet actuel.

UINT32 GetObjectID() const;

Valeur de retour

ID d’objet actuel.

Notes

Utilisez cette méthode pour récupérer l’ID d’objet. Il s’agit de 0 si l’ID d’objet n’a pas été défini explicitement dans le constructeur ou avec SetID.

CAnimationBaseObject ::GetUserData

Retourne des données définies par l’utilisateur.

DWORD GetUserData() const;

Valeur de retour

Valeur des données personnalisées.

Notes

Appelez cette méthode pour récupérer les données personnalisées au moment de l’exécution. La valeur retournée est 0 si elle n’a pas été initialisée explicitement dans le constructeur ou avec SetUserData.

CAnimationBaseObject ::m_bAutodestroyTransitions

Spécifie si les transitions associées doivent être détruites automatiquement.

BOOL m_bAutodestroyTransitions;

CAnimationBaseObject ::m_dwUserData

Stocke les données définies par l’utilisateur.

DWORD m_dwUserData;

CAnimationBaseObject ::m_nGroupID

Spécifie l’ID de groupe de l’objet d’animation.

UINT32 m_nGroupID;

CAnimationBaseObject ::m_nObjectID

Spécifie l’ID d’objet de l’objet d’animation.

UINT32 m_nObjectID;

CAnimationBaseObject ::m_pParentController

Pointeur vers le contrôleur d’animation parent.

CAnimationController* m_pParentController;

CAnimationBaseObject ::SetAutodestroyTransitions

Définit un indicateur pour détruire automatiquement les transitions.

void SetAutodestroyTransitions(BOOL bValue);

Paramètres

bValue
Spécifie l’indicateur de destruction automatique.

Notes

Définissez cet indicateur uniquement si vous avez alloué des objets de transition à l’aide de l’opérateur nouveau. Si, pour une raison quelconque, les objets de transition sont alloués sur la pile, l’indicateur de destruction automatique doit être FALSE. Par défaut, cet indicateur a la valeur TRUE.

CAnimationBaseObject ::SetID

Définit les nouveaux ID.

void SetID(
    UINT32 nObjectID,
    UINT32 nGroupID = 0);

Paramètres

nObjectID
Spécifie un nouvel ID d’objet.

nGroupID
Spécifie un nouvel ID de groupe.

Notes

Vous permet de modifier l’ID d’objet et l’ID de groupe. Si le nouvel ID de groupe diffère de l’ID actuel, un objet d’animation est déplacé vers un autre groupe (un nouveau groupe sera créé, si nécessaire).

CAnimationBaseObject ::SetParentAnimationObjects

Établit une relation entre les variables d’animation, contenues dans un objet d’animation et leur conteneur.

virtual void SetParentAnimationObjects();

Notes

Cet assistance peut être utilisé pour établir une relation entre les variables d’animation contenues dans un objet d’animation et leur conteneur. Il effectue une boucle sur les variables d’animation et définit un pointeur vers un objet d’animation parent vers chaque variable d’animation. Dans l’implémentation actuelle, la relation réelle est établie dans CAnimationBaseObject ::ApplyTransitions. Par conséquent, les pointeurs back ne sont pas définis tant que vous n’appelez pas CAnimationGroup ::Animate. Connaître la relation peut être utile lorsque vous traitez des événements et que vous devez obtenir un objet d’animation parent à partir de CAnimationVariable. Utilisez CAnimationVariable ::GetParentAnimationObject.

CAnimationBaseObject ::SetUserData

Définit les données définies par l’utilisateur.

void SetUserData (DWORD dwUserData);

Paramètres

dwUserData
Spécifie les données personnalisées.

Notes

Utilisez cette méthode pour associer des données personnalisées à un objet d’animation. Ces données peuvent être récupérées ultérieurement au moment de l’exécution par GetUserData.

Voir aussi

Classes