IUIAnimationInterpolator2::GetFinalValue method

Gets the final value at the end of the transition for the given dimension.

Syntax

HRESULT GetFinalValue(
  [out] DOUBLE *value,
  [in]  UINT   cDimension
);

Parameters

value [out]

The final value.

cDimension [in]

The dimension from which to retrieve the final 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 GetFinalValue, 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 GetFinalValue reflect the updated state.

Requirements

See also

IUIAnimationInterpolator2