Windows Dev Center

IUIAnimationPrimitiveInterpolation::AddSinusoidal method

Adds a sinusoidal segment that describes the shape of a transition curve to the animation function.

Syntax


HRESULT AddSinusoidal(
  [in] UINT                 dimension,
  [in] UI_ANIMATION_SECONDS beginOffset,
  [in] FLOAT                bias,
  [in] FLOAT                amplitude,
  [in] FLOAT                frequency,
  [in] FLOAT                phase
);

Parameters

dimension [in]

The dimension in which to apply the new segment.

beginOffset [in]

The begin offset for the segment, where 0 corresponds to the start of the transition.

bias [in]

The bias constant in the sinusoidal function.

amplitude [in]

The amplitude constant in the sinusoidal function.

frequency [in]

The frequency constant in the sinusoidal function.

phase [in]

The phase constant in the sinusoidal function.

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

Defined by the function Y(t) = bias + amplitude*sin(360*frequency*t + phase), where 'sin' is the sin of an angle specified in degrees (for example, sin(n + 360) == sin(n) for any real number 'n').

This method will fail with an error code of UI_E_INVALID_PRIMITIVE if the start time is either less than 0 or less than the start time of a previous segment.

Requirements

Minimum supported client

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

Minimum supported server

None supported

Header

UIAnimation.h

IDL

UIAnimation.idl

DLL

UIAnimation.dll

IID

IID_IUIAnimationPrimitiveInterpolation is defined as BAB20D63-4361-45DA-A24F-AB8508846B5B

See also

IUIAnimationPrimitiveInterpolation

 

 

Community Additions

ADD
Show:
© 2015 Microsoft