L_DispContainerStartAnimation

Summary

Starts an animation in the specific cell(s).

Syntax

L_LTIVW_API L_INT L_DispContainerStartAnimation(hCellWnd, nStartFrame, nFrameCount, bAnimateAllSubCells, uFlags)

Parameters

L_HWND hCellWnd

A handle to the window that represents the cell on which the function's effect will be applied.

L_INT nStartFrame

Value that represents the initial frame to start animation from.

L_INT nFrameCount

Value that represents the number of frames that the animation will go through.

L_BOOL bAnimateAllSubCells

Flag that indicates whether to animate all sub-cells (If the cell layout shows more than one frame at a time). Possible values are:

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Comments

The cell(s) must contain multiple frames.

• To stop the animation, call the L_DispContainerStopAnimation function.

• To check whether the cell is in an animation phase, call the L_DispContainerIsCellAnimated function.

• The user can change or retrieve the animation properties even if the animation is started.

• To retrieve the animation properties of a specific cell, call the L_DispContainerGetAnimationProperties function.

• To change the animation properties of a specific cell, call the L_DispContainerSetAnimationProperties function.

Required DLLs and Libraries

• LTIVW
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions

• L_DispContainerCreate
• L_DispContainerDestroy
• L_DispContainerStopAnimation
• L_DispContainerGetAnimationProperties
• L_DispContainerSetAnimationProperties
• L_DispContainerIsCellAnimated

Topics

• Implementing Animation
• Image Viewer Functions: Implementing Animation

Example

This function starts an animation for the pass nCellIndex, we assumed that the cell with index (nCellIndex) contains multiple frames.

L_INT DispContainerStartAnimationExample(HDISPCONTAINER hCon, L_INT nCellIndex) 
{ 
   DISPANIMATIONPROPS DispAnimationProps; 
   HBITMAPLIST        hBitmapList; 
   L_INT              nCount; 
 
   if (nCellIndex < 0 || nCellIndex > L_DispContainerGetCellCount(hCon, 0)) 
      return ERROR_INV_PARAMETER; 
 
   HWND hCellWnd = L_DispContainerGetCellWindowHandle(hCon, nCellIndex, 0); 
 
 
   L_DispContainerGetAnimationProperties(hCellWnd, &DispAnimationProps, 0); 
 
   DispAnimationProps.uInterval = 100; 
   DispAnimationProps.uFlags = CONTAINER_ANIMATION_DIRECTION_FORWARD; 
 
   L_DispContainerSetAnimationProperties(hCellWnd, &DispAnimationProps, 0); 
 
   L_DispContainerGetCellBitmapList(hCellWnd, &hBitmapList, 0); 
   L_GetBitmapListCount(hBitmapList, (L_UINT*)&nCount); 
 
   if (!L_DispContainerIsCellAnimated(hCellWnd, 0)) 
      L_DispContainerStartAnimation(hCellWnd, 0, nCount, TRUE, 0); 
 
   return SUCCESS; 
}