IUIAnimationTransitionLibrary2::CreateSmoothStopTransition method (uianimation.h)

Creates a smooth-stop scalar transition.

Syntax

HRESULT CreateSmoothStopTransition(
  [in]  UI_ANIMATION_SECONDS    maximumDuration,
  [in]  DOUBLE                  finalValue,
  [out] IUIAnimationTransition2 **transition
);

Parameters

[in] maximumDuration

The maximum duration of the transition.

[in] finalValue

The value of the animation variable at the end of the transition.

[out] transition

The new smooth-stop transition.

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

A smooth-stop transition slows down as it approaches the specified final value, and reaches the final value with a velocity of zero. The duration of the transition is determined by the initial velocity, the difference between the initial and final values, and the specified maximum duration. If there is no solution consisting of a single parabolic arc, this method creates a cubic transition.

The following figure shows the change in value over time of an animation variable during a smooth-stop transition.

Diagram showing a smooth stop transition

Requirements

Requirement Value
Minimum supported client Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps | UWP apps]
Minimum supported server None supported
Target Platform Windows
Header uianimation.h
DLL UIAnimation.dll

See also

IUIAnimationTransition2

IUIAnimationTransitionLibrary2