CAnimationVariableIntegerChangeHandler Class
The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.
The latest version of this topic can be found at CAnimationVariableIntegerChangeHandler Class.
Implements a callback, which is called by the Animation API when the value of an animation variable changes.
class CAnimationVariableIntegerChangeHandler : public CUIAnimationVariableIntegerChangeHandlerBase<CAnimationVariableIntegerChangeHandler>;
Name | Description |
---|---|
CAnimationVariableIntegerChangeHandler::CAnimationVariableIntegerChangeHandler | Constructs a CAnimationVariableIntegerChangeHandler object. |
Name | Description |
---|---|
CAnimationVariableIntegerChangeHandler::CreateInstance | Creates an instance of CAnimationVariableIntegerChangeHandler callback. |
CAnimationVariableIntegerChangeHandler::OnIntegerValueChanged | Called when a value of an animation variable has changed. (Overrides CUIAnimationVariableIntegerChangeHandlerBase::OnIntegerValueChanged .) |
CAnimationVariableIntegerChangeHandler::SetAnimationController | Stores a pointer to animation controller to route events. |
This event handler is created and passed to IUIAnimationVariable::SetVariableIntegerChangeHandler method, when you call CAnimationVariable::EnableIntegerValueChangedEvent or CAnimationBaseObject::EnableIntegerValueChangedEvent (which enables this event for all animation variables encapsulated in an animation object).
CUIAnimationCallbackBase
CUIAnimationVariableIntegerChangeHandlerBase
CAnimationVariableIntegerChangeHandler
Header: afxanimationcontroller.h
Constructs a CAnimationVariableIntegerChangeHandler object.
CAnimationVariableIntegerChangeHandler ();
Creates an instance of CAnimationVariableIntegerChangeHandler callback.
static COM_DECLSPEC_NOTHROW HRESULT CreateInstance(
CAnimationController* pAnimationController,
IUIAnimationVariableIntegerChangeHandler** ppHandler);
pAnimationController
A pointer to animation controller, which will receive events.
ppHandler
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Called when a value of an animation variable has changed.
IFACEMETHOD(OnIntegerValueChanged) (
__in IUIAnimationStoryboard* storyboard,
__in IUIAnimationVariable* variable,
__in INT32 newValue,
__in INT32 previousValue);
storyboard
The storyboard that is animating the variable.
variable
The animation variable that was updated.
newValue
The new rounded value.
previousValue
The previous rounded value.
S_OK if the method succeeds; otherwise E_FAIL.
Stores a pointer to animation controller to route events.
void SetAnimationController(CAnimationController* pAnimationController);
pAnimationController
A pointer to animation controller, which will receive events.