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.

IUIAnimationTransitionLibrary::CreateSinusoidalTransitionFromRange method

Creates a sinusoidal-range transition, with a specified range of oscillation.

Syntax

C++


HRESULT CreateSinusoidalTransitionFromRange(
  [in]  UI_ANIMATION_SECONDS   duration,
  [in]  DOUBLE                 minimumValue,
  [in]  DOUBLE                 maximumValue,
  [in]  UI_ANIMATION_SECONDS   period,
  [in]  UI_ANIMATION_SLOPE     slope,
  [out] IUIAnimationTransition **transition
);

Parameters

duration [in]: The duration of the transition.
minimumValue [in]: The value of the animation variable at a trough of the sinusoidal wave.
maximumValue [in]: The value of the animation variable at a peak of the sinusoidal wave.
period [in]: The period of oscillation of the sinusoidal wave, in seconds.
slope [in]: The slope at the start of the transition.
transition [out]: The new sinusoidal-range 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

The value of the animation variable fluctuates between the specified minimum and maximum values over the entire duration of a sinusodial-range transition. The slope parameter is used to disambiguate between the two possible sine waves specified by the other parameters.

The figure below shows the effect on an animation variable over time during a sinusoidal-range transition. Passing in the UI_ANIMATION_SLOPE_INCREASING enumeration value yields a wave like the solid curve shown in the figure, whereas the UI_ANIMATION_SLOPE_DECREASING value yields a wave like the dashed curve.

Diagram showing a sinusoidal-range transition

Requirements

Minimum supported client	Windows 7, Windows Vista and Platform Update for Windows Vista [desktop apps \| Windows Store apps]
Minimum supported server	None supported
Header	UIAnimation.h
IDL	UIAnimation.idl
DLL	UIAnimation.dll