CAnimationVariable, classe
Représente une variable de l'animation.
Syntaxe
class CAnimationVariable;
Membres
Constructeurs publics
| Nom | Description |
|---|---|
| CAnimationVariable ::CAnimationVariable | Construit un objet variable d’animation. |
| CAnimationVariable ::~CAnimationVariable | Destructeur. Appelé lorsqu’un objet CAnimationVariable est détruit. |
Méthodes publiques
| Nom | Description |
|---|---|
| CAnimationVariable ::AddTransition | Ajoute une transition. |
| CAnimationVariable ::ApplyTransitions | Ajoute des transitions de la liste interne au storyboard. |
| CAnimationVariable ::ClearTransitions | Efface les transitions. |
| CAnimationVariable ::Create | Crée l’objet COM de la variable d’animation sous-jacente. |
| CAnimationVariable ::CreateTransitions | Crée toutes les transitions à appliquer à cette variable d’animation. |
| CAnimationVariable ::EnableIntegerValueChangedEvent | Active ou désactive l’événement IntegerValueChanged. |
| CAnimationVariable ::EnableValueChangedEvent | Active ou désactive l’événement ValueChanged. |
| CAnimationVariable ::GetDefaultValue | Retourne la valeur par défaut. |
| CAnimationVariable ::GetParentAnimationObject | Retourne l’objet d’animation parent. |
| CAnimationVariable ::GetValue | Surcharge. Retourne la valeur actuelle de la variable d’animation. |
| CAnimationVariable ::GetVariable | Retourne un pointeur vers un objet COM IUIAnimationVariable. |
| CAnimationVariable ::SetDefaultValue | Définit la valeur par défaut et libère l’objet COM IUIAnimationVariable. |
Méthodes protégées
| Nom | Description |
|---|---|
| CAnimationVariable ::SetParentAnimationObject | Définit la relation entre une variable d’animation et un objet d’animation. |
Membres de données publics
| Nom | Description |
|---|---|
| CAnimationVariable ::m_bAutodestroyTransitions | Spécifie si les objets de transition connexes doivent être supprimés. |
Membres de données protégés
| Nom | Description |
|---|---|
| CAnimationVariable ::m_dblDefaultValue | Spécifie la valeur par défaut, propagée à IUIAnimationVariable. |
| CAnimationVariable ::m_lstTransitions | Contient une liste de transitions qui animent cette variable d’animation. |
| CAnimationVariable ::m_pParentObject | Pointeur vers un objet d’animation qui encapsule cette variable d’animation. |
| CAnimationVariable ::m_variable | Stocke un pointeur vers un objet COM IUIAnimationVariable. NULL si l’objet COM n’a pas encore été créé ou si la création a échoué. |
Notes
La classe CAnimationVariable encapsule l’objet COM IUIAnimationVariable. Il contient également une liste de transitions à appliquer à la variable d’animation dans un storyboard. Les objets CAnimationVariable sont incorporés aux objets d’animation, qui peuvent représenter dans une application une valeur animée, un point, une taille, une couleur et un rectangle.
Hiérarchie d'héritage
CAnimationVariable
Spécifications
En-tête : afxanimationcontroller.h
CAnimationVariable ::~CAnimationVariable
Destructeur. Appelé lorsqu’un objet CAnimationVariable est détruit.
virtual ~CAnimationVariable();
CAnimationVariable ::AddTransition
Ajoute une transition.
void AddTransition(CBaseTransition* pTransition);
Paramètres
pTransition
Pointeur vers une transition à ajouter.
Notes
Cette méthode est appelée pour ajouter une transition à la liste interne des transitions à appliquer à la variable d’animation. Cette liste doit être effacée lorsqu’une animation a été planifiée.
CAnimationVariable ::ApplyTransitions
Ajoute des transitions de la liste interne au storyboard.
void ApplyTransitions(
CAnimationController* pController,
IUIAnimationStoryboard* pStoryboard,
BOOL bDependOnKeyframes);
Paramètres
pController
Pointeur vers le contrôleur d’animation parent.
pStoryboard
Pointeur vers le storyboard.
bDependOnKeyframes
TRUE, si cette méthode doit ajouter des transitions qui dépendent des images clés.
Notes
Cette méthode ajoute des transitions de la liste interne au storyboard. Il est appelé à partir du code de niveau supérieur plusieurs fois pour ajouter des transitions qui ne dépendent pas des images clés et ajouter des transitions qui dépendent des images clés. Si l’objet COM de la variable d’animation sous-jacente n’a pas été créé, cette méthode la crée à ce stade.
CAnimationVariable ::CAnimationVariable
Construit un objet variable d’animation.
CAnimationVariable(DOUBLE dblDefaultValue = 0.0);
Paramètres
dblDefaultValue
Spécifie la valeur par défaut.
Notes
Construit un objet variable d’animation et définit sa valeur par défaut. Une valeur par défaut est utilisée lorsqu’une variable n’est pas animée ou ne peut pas être animée.
CAnimationVariable ::ClearTransitions
Efface les transitions.
void ClearTransitions(BOOL bAutodestroy);
Paramètres
bAutodestroy
Spécifie si cette méthode doit supprimer des objets de transition.
Notes
Cette méthode supprime toutes les transitions de la liste interne des transitions. Si bAutodestroy a la valeur TRUE ou m_bAutodestroyTransitions a la valeur TRUE, les transitions sont supprimées. Sinon, l’appelant doit libérer les objets de transition.
CAnimationVariable ::Create
Crée l’objet COM de la variable d’animation sous-jacente.
virtual BOOL Create(IUIAnimationManager* pManager);
Paramètres
pManager
Pointeur vers le gestionnaire d’animations.
Valeur de retour
TRUE si la variable d’animation a été créée avec succès ; sinon FALSE.
Notes
Cette méthode crée l’objet COM de la variable d’animation sous-jacente et définit sa valeur par défaut.
CAnimationVariable ::CreateTransitions
Crée toutes les transitions à appliquer à cette variable d’animation.
BOOL CreateTransitions(
IUIAnimationTransitionLibrary* pLibrary,
IUIAnimationTransitionFactory* \*not used*\);
Paramètres
pLibrary
Pointeur vers une interface IUIAnimationTransitionLibrary, qui définit une bibliothèque de transitions standard.
Valeur de retour
TRUE si des transitions ont été créées avec succès ; sinon FALSE.
Notes
Cette méthode est appelée par l’infrastructure lorsqu’elle doit créer des transitions qui ont été ajoutées à la liste interne de transitions de la variable.
CAnimationVariable ::EnableIntegerValueChangedEvent
Active ou désactive l’événement IntegerValueChanged.
void EnableIntegerValueChangedEvent (
CAnimationController* pController,
BOOL bEnable);
Paramètres
pController
Pointeur vers le contrôleur parent.
bEnable
TRUE - activer l’événement, FALSE - désactiver l’événement.
Notes
Lorsque l’événement ValueChanged est activé, l’infrastructure appelle la méthode virtuelle CAnimationController ::OnAnimationIntegerValueChanged. Vous devez le remplacer dans une classe dérivée de CAnimationController pour traiter cet événement. Cette méthode est appelée chaque fois que la valeur entière de la variable d’animation est modifiée.
CAnimationVariable ::EnableValueChangedEvent
Active ou désactive l’événement ValueChanged.
void EnableValueChangedEvent (
CAnimationController* pController,
BOOL bEnable);
Paramètres
pController
Pointeur vers le contrôleur parent.
bEnable
TRUE - activer l’événement, FALSE - désactiver l’événement.
Notes
Lorsque l’événement ValueChanged est activé, l’infrastructure appelle la méthode virtuelle CAnimationController ::OnAnimationValueChanged. Vous devez le remplacer dans une classe dérivée de CAnimationController pour traiter cet événement. Cette méthode est appelée chaque fois que la valeur de la variable d’animation est modifiée.
CAnimationVariable ::GetDefaultValue
Retourne la valeur par défaut.
DOUBLE GetDefaultValue() const;
Valeur de retour
La valeur par défaut est .
Notes
Utilisez cette fonction pour obtenir la valeur par défaut de la variable d’animation. La valeur par défaut peut être définie dans le constructeur ou par la méthode SetDefaultValue.
CAnimationVariable ::GetParentAnimationObject
Retourne l’objet d’animation parent.
CAnimationBaseObject* GetParentAnimationObject();
Valeur de retour
Pointeur vers l’objet d’animation parent, si la relation a été établie, sinon NULL.
Notes
Cette méthode peut être appelée pour récupérer un pointeur vers un objet d’animation parent (un conteneur).
CAnimationVariable ::GetValue
Retourne la valeur actuelle de la variable d’animation.
HRESULT GetValue(DOUBLE& dblValue);
HRESULT GetValue(INT32& nValue);
Paramètres
dblValue
Valeur actuelle de la variable d’animation.
nValue
Valeur actuelle de la variable d’animation.
Valeur de retour
S_OK si la valeur a été obtenue correctement ou si la variable d’animation sous-jacente n’a pas été créée. Sinon, code d’erreur HRESULT.
Notes
Cette méthode peut être appelée pour récupérer la valeur actuelle de la variable d’animation. Si l’objet COM sous-jacent n’a pas été créé, dblValue contient une valeur par défaut, lorsque la fonction retourne.
CAnimationVariable ::GetVariable
Retourne un pointeur vers un objet COM IUIAnimationVariable.
IUIAnimationVariable* GetVariable();
Valeur de retour
Pointeur valide vers l’objet COM IUIAnimationVariable, ou NULL si la variable d’animation n’a pas été créée ou ne peut pas être créée.
Notes
Utilisez cette fonction pour accéder à l’objet COM IUIAnimationVariable sous-jacent et appeler ses méthodes directement si nécessaire.
CAnimationVariable ::m_bAutodestroyTransitions
Spécifie si les objets de transition connexes doivent être supprimés.
BOOL m_bAutodestroyTransitions;
Notes
Définissez cette valeur sur TRUE pour forcer la suppression d’objets de transition lorsqu’ils sont supprimés de la liste interne des transitions. Si cette valeur est FALSE, les transitions doivent être supprimées en appelant l’application. La liste des transitions est toujours effacée une fois qu’une animation a été planifiée. La valeur par défaut est FALSE.
CAnimationVariable ::m_dblDefaultValue
Spécifie la valeur par défaut, propagée à IUIAnimationVariable.
DOUBLE m_dblDefaultValue;
CAnimationVariable ::m_lstTransitions
Contient une liste de transitions qui animent cette variable d’animation.
CObList m_lstTransitions;
CAnimationVariable ::m_pParentObject
Pointeur vers un objet d’animation qui encapsule cette variable d’animation.
CAnimationBaseObject* m_pParentObject;
CAnimationVariable ::m_variable
Stocke un pointeur vers un objet COM IUIAnimationVariable. NULL si l’objet COM n’a pas encore été créé ou si la création a échoué.
ATL::CComPtr<IUIAnimationVariable> m_variable;
CAnimationVariable ::SetDefaultValue
Définit la valeur par défaut et libère l’objet COM IUIAnimationVariable.
void SetDefaultValue(DOUBLE dblDefaultValue);
Paramètres
dblDefaultValue
Spécifie la nouvelle valeur par défaut.
Notes
Utilisez cette méthode pour réinitialiser la valeur par défaut. Cette méthode libère l’objet COM IUIAnimationVariable interne. Par conséquent, lorsque la variable d’animation est recréée, l’objet COM sous-jacent obtient la nouvelle valeur par défaut. La valeur par défaut est retournée par GetValue si l’objet COM représentant la variable d’animation n’est pas créé ou si la variable n’a pas été animée.
CAnimationVariable ::SetParentAnimationObject
Définit la relation entre une variable d’animation et un objet d’animation.
void SetParentAnimationObject(CAnimationBaseObject* pParentObject);
Paramètres
pParentObject
Pointeur vers un objet d’animation qui contient cette variable.
Notes
Cette méthode est appelée en interne pour établir une relation un-à-un entre une variable d’animation et un objet d’animation qui l’encapsule.