Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IUIAnimationInterpolator2::InterpolateValue method

Interpolates the value of an animation variable at the specified offset and for the given dimension.

Syntax


HRESULT InterpolateValue(
  [in]   UI_ANIMATION_SECONDS offset,
  [out]  DOUBLE *value,
  [in]   UINT cDimension
);

Parameters

offset [in]

The offset from the start of the transition.

This parameter is always greater than or equal to zero and less than the duration of the transition. This method is not called if the duration of the transition is zero.

value [out]

The interpolated value.

cDimension [in]

The dimension in which to interpolate the value.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See Windows Animation Error Codes for a list of error codes.

Remarks

Windows Animation always calls the IUIAnimationInterpolator2::SetInitialValueAndVelocity method to set the initial value and velocity before calling InterpolateValue, so a custom interpolator need not check whether the initial value and velocity have been set.

Windows Animation can call SetInitialValueAndVelocity multiple times with different parameters. Interpolators can cache internal state to improve performance, but they must update this cached state each time SetInitialValueAndVelocity is called and ensure that the results of subsequent calls to InterpolateValue reflect the updated state.

Requirements

Minimum supported client

Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

None supported [desktop apps | Windows Store apps]

Header

UIAnimation.h

IDL

UIAnimation.idl

DLL

UIAnimation.dll

IID

IID_IUIAnimationInterpolator2 is defined as EA76AFF8-EA22-4a23-A0EF-A6A966703518

See also

IUIAnimationInterpolator2
UI_ANIMATION_SECONDS

 

 

Community Additions

Show:
© 2014 Microsoft