Edit

Share via

CAnimationVariable Class

  • Article

Represents an animation variable.

Syntax

class CAnimationVariable;

Members

Public Constructors

Name Description
CAnimationVariable::CAnimationVariable Constructs an animation variable object.
CAnimationVariable::~CAnimationVariable The destructor. Called when a CAnimationVariable object is being destroyed.

Public Methods

Name Description
CAnimationVariable::AddTransition Adds a transition.
CAnimationVariable::ApplyTransitions Adds transitions from the internal list to storyboard.
CAnimationVariable::ClearTransitions Clears transitions.
CAnimationVariable::Create Creates the underlying animation variable COM object.
CAnimationVariable::CreateTransitions Creates all transitions to be applied to this animation variable.
CAnimationVariable::EnableIntegerValueChangedEvent Enables or disables the IntegerValueChanged event.
CAnimationVariable::EnableValueChangedEvent Enables or disables the ValueChanged event.
CAnimationVariable::GetDefaultValue Returns default value.
CAnimationVariable::GetParentAnimationObject Returns the parent animation object.
CAnimationVariable::GetValue Overloaded. Returns the current value of animation variable.
CAnimationVariable::GetVariable Returns a pointer to IUIAnimationVariable COM object.
CAnimationVariable::SetDefaultValue Sets default value and releases IUIAnimationVariable COM object.

Protected Methods

Name Description
CAnimationVariable::SetParentAnimationObject Sets the relationship between an animation variable and an animation object.

Public Data Members

Name Description
CAnimationVariable::m_bAutodestroyTransitions Specifies whether related transition objects should be deleted.

Protected Data Members

Name Description
CAnimationVariable::m_dblDefaultValue Specifies the default value, which is propagated to IUIAnimationVariable.
CAnimationVariable::m_lstTransitions Contains a list of transitions that animate this animation variable.
CAnimationVariable::m_pParentObject A pointer to an animation object that encapsulates this animation variable.
CAnimationVariable::m_variable Stores a pointer to IUIAnimationVariable COM object. NULL if the COM object has not been created yet, or if creation failed.

Remarks

The CAnimationVariable class encapsulates IUIAnimationVariable COM object. It also holds a list of transitions to be applied to the animation variable in a storyboard. CAnimationVariable objects are embedded to animation objects, which can represent in an application an animated value, point, size, color and rectangle.

Inheritance Hierarchy

CAnimationVariable

Requirements

Header: afxanimationcontroller.h

CAnimationVariable::~CAnimationVariable

The destructor. Called when a CAnimationVariable object is being destroyed.

virtual ~CAnimationVariable();

CAnimationVariable::AddTransition

Adds a transition.

void AddTransition(CBaseTransition* pTransition);

Parameters

pTransition
A pointer to a transition to add.

Remarks

This method is called to add a transition to the internal list of transitions to be applied to the animation variable. This list should be cleared when an animation has been scheduled.

CAnimationVariable::ApplyTransitions

Adds transitions from the internal list to storyboard.

void ApplyTransitions(
    CAnimationController* pController,
    IUIAnimationStoryboard* pStoryboard,
    BOOL bDependOnKeyframes);

Parameters

pController
A pointer to parent animation controller.

pStoryboard
A pointer to storyboard.

bDependOnKeyframes
TRUE, if this method should add transitions that depend on keyframes.

Remarks

This method adds transitions from the internal list to storyboard. It's called from the top level code several times to add transitions that do not depend on keyframes and add transitions that depend on keyframes. If the underlying animation variable COM object has not been created, this method creates it at this stage.

CAnimationVariable::CAnimationVariable

Constructs an animation variable object.

CAnimationVariable(DOUBLE dblDefaultValue = 0.0);

Parameters

dblDefaultValue
Specifies the default value.

Remarks

Constructs an animation variable object and sets its default value. A default value is used when a variable is not animated, or can't be animated.

CAnimationVariable::ClearTransitions

Clears transitions.

void ClearTransitions(BOOL bAutodestroy);

Parameters

bAutodestroy
Specifies whether this method should delete transition objects.

Remarks

This method removes all transitions from the internal list of transitions. If bAutodestroy is TRUE, or m_bAutodestroyTransitions is TRUE, then transitions are deleted. Otherwise the caller should deallocate the transition objects.

CAnimationVariable::Create

Creates the underlying animation variable COM object.

virtual BOOL Create(IUIAnimationManager* pManager);

Parameters

pManager
A pointer to animation manager.

Return Value

TRUE if the animation variable was successfully created; otherwise FALSE.

Remarks

This method creates the underlying animation variable COM object and sets its default value.

CAnimationVariable::CreateTransitions

Creates all transitions to be applied to this animation variable.

BOOL CreateTransitions(
    IUIAnimationTransitionLibrary* pLibrary,
    IUIAnimationTransitionFactory* \*not used*\);

Parameters

pLibrary
A pointer to an IUIAnimationTransitionLibrary interface, which defines a library of standard transitions.

Return Value

TRUE if transitions were created successfully; otherwise FALSE.

Remarks

This method is called by the framework when it needs to create transitions that have been added to the variable's internal list of transitions.

CAnimationVariable::EnableIntegerValueChangedEvent

Enables or disables the IntegerValueChanged event.

void EnableIntegerValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parameters

pController
A pointer to parent controller.

bEnable
TRUE - enable event, FALSE - disable event.

Remarks

When ValueChanged event is enabled, the framework calls virtual method CAnimationController::OnAnimationIntegerValueChanged. You need to override it in a class derived from CAnimationController in order to process this event. This method is called every time the integer value of animation variable is changed.

CAnimationVariable::EnableValueChangedEvent

Enables or disables the ValueChanged event.

void EnableValueChangedEvent (
    CAnimationController* pController,
    BOOL bEnable);

Parameters

pController
A pointer to parent controller.

bEnable
TRUE - enable event, FALSE - disable event.

Remarks

When ValueChanged event is enabled, the framework calls virtual method CAnimationController::OnAnimationValueChanged. You need to override it in a class derived from CAnimationController in order to process this event. This method is called every time the value of animation variable is changed.

CAnimationVariable::GetDefaultValue

Returns default value.

DOUBLE GetDefaultValue() const;

Return Value

The default value.

Remarks

Use this function to obtain default value of animation variable. The default value can be set in constructor or by SetDefaultValue method.

CAnimationVariable::GetParentAnimationObject

Returns the parent animation object.

CAnimationBaseObject* GetParentAnimationObject();

Return Value

A pointer to parent animation object, if relationship was established, otherwise NULL.

Remarks

This method can be called to retrieve a pointer to a parent animation object (a container).

CAnimationVariable::GetValue

Returns the current value of animation variable.

HRESULT GetValue(DOUBLE& dblValue);
HRESULT GetValue(INT32& nValue);

Parameters

dblValue
The current value of the animation variable.

nValue
The current value of the animation variable.

Return Value

S_OK if the value was obtained successfully, or underlying animation variable has not been created. Otherwise HRESULT error code.

Remarks

This method can be called to retrieve the current value of animation variable. If the underlying COM object has not been created, dblValue will contain a default value, when the function returns.

CAnimationVariable::GetVariable

Returns a pointer to IUIAnimationVariable COM object.

IUIAnimationVariable* GetVariable();

Return Value

A valid pointer to IUIAnimationVariable COM object, or NULL if animation variable was not created, or can't be created.

Remarks

Use this function to access the underlying IUIAnimationVariable COM object and call its methods directly if needed.

CAnimationVariable::m_bAutodestroyTransitions

Specifies whether related transition objects should be deleted.

BOOL m_bAutodestroyTransitions;

Remarks

Set this value to TRUE to force deletion of transition objects when they are being removed from the internal list of transitions. If this value is FALSE the transitions should be deleted by calling application. The list of transitions is always cleared after an animation has been scheduled. The default value is FALSE.

CAnimationVariable::m_dblDefaultValue

Specifies the default value, which is propagated to IUIAnimationVariable.

DOUBLE m_dblDefaultValue;

CAnimationVariable::m_lstTransitions

Contains a list of transitions that animate this animation variable.

CObList m_lstTransitions;

CAnimationVariable::m_pParentObject

A pointer to an animation object that encapsulates this animation variable.

CAnimationBaseObject* m_pParentObject;

CAnimationVariable::m_variable

Stores a pointer to IUIAnimationVariable COM object. NULL if the COM object has not been created yet, or if creation failed.

ATL::CComPtr<IUIAnimationVariable> m_variable;

CAnimationVariable::SetDefaultValue

Sets default value and releases IUIAnimationVariable COM object.

void SetDefaultValue(DOUBLE dblDefaultValue);

Parameters

dblDefaultValue
Specifies the new default value.

Remarks

Use this method to reset the default value. This method releases the internal IUIAnimationVariable COM object, therefore when animation variable is recreated, the underlying COM object gets the new default value. The default value is returned by GetValue if the COM object representing the animation variable is not created, or if the variable has not been animated.

CAnimationVariable::SetParentAnimationObject

Sets the relationship between an animation variable and an animation object.

void SetParentAnimationObject(CAnimationBaseObject* pParentObject);

Parameters

pParentObject
A pointer to an animation object that contains this variable.

Remarks

This method is called internally to establish one-to-one relationship between an animation variable and an animation object that encapsulates it.

See also

Classes