IUIAnimationTransitionLibrary::CreateSmoothStopTransition method (uianimation.h)

Creates a smooth-stop transition.

Syntax

HRESULT CreateSmoothStopTransition(
  [in]  UI_ANIMATION_SECONDS   maximumDuration,
  [in]  DOUBLE                 finalValue,
  [out] IUIAnimationTransition **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 the 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 it 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 figure below shows the effect on an animation variable over time during a smooth-stop transition.

Diagram showing a smooth stop transition

Requirements

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

See also

IUIAnimationTransition

IUIAnimationTransitionLibrary