LImageViewer::StartAnimation

#include "ltwrappr.h"

L_INT LImageViewer::StartAnimation(nCellIndex, nStartFrame, nFrameCount, bAnimateAllSubCells, uFlags)

L_INT nCellIndex;	/* index of a cell */
L_INT nStartFrame;	/* animation start index */
L_INT nFrameCount;	/* animation total frames */
L_BOOL bAnimateAllSubCells;	/* flag */
L_UINT uFlags;	/* reserved for future use */

Starts an animation in the specific cell(s).

Parameter	Description
nCellIndex	A zero-based index of the cell the user wants to animate. Pass -1 to apply this effect on all cells. Pass -2 to apply this effect on the selected cells.
nStartFrame	Value that represents the initial frame to start animation from.
nFrameCount	Value that represents the number of frames that the animation will go through.
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:
	Value	Meaning
	TRUE	Animate all sub-cells.
	FALSE	Do not animate all sub-cells
uFlags	Reserved for future use. Pass 0.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

The cell(s) must contain multiple frames.

To stop the animation, call the LImageViewer::StopAnimation function.

To check whether the cell is in an animation phase, call the LImageViewer::IsCellAnimated 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 LImageViewer::GetAnimationProperties function.

To change the animation properties of a specific cell, call the LImageViewer::SetAnimationProperties function.

The Image viewer must be created before calling this function or an error will be returned.

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:	LImageViewer::Create, LImageViewer::Destroy, LImageViewer::StopAnimation, LImageViewer::GetAnimationProperties, LImageViewer::SetAnimationProperties, LImageViewer::IsCellAnimated.
Topics:	Image Viewer Functions: Implementing Animation
	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 LImageViewer_StartAnimation(LImageViewer& ImageViewer) 
{
   DISPANIMATIONPROPS DispAnimationProps; 
   HBITMAPLIST        hBitmapList = NULL; 
   L_INT              nCount; 
   L_INT nCellIndex = 0;
   if (nCellIndex < 0 || nCellIndex > ImageViewer.GetCellCount(0)) 
      return ERROR_INV_PARAMETER; 
   ImageViewer.GetAnimationProperties(nCellIndex, &DispAnimationProps, 0); 
   DispAnimationProps.uInterval = 100; 
   DispAnimationProps.uFlags = CONTAINER_ANIMATION_DIRECTION_FORWARD; 
   ImageViewer.SetAnimationProperties(nCellIndex, &DispAnimationProps, 0); 
   ImageViewer.GetCellBitmapList(nCellIndex, &hBitmapList, 0); 
   LBitmapList BitmapList;
   BitmapList.SetHandle(hBitmapList);
   nCount = BitmapList.GetItemsCount();
   if (!ImageViewer.IsCellAnimated(nCellIndex, 0)) 
      ImageViewer.StartAnimation(nCellIndex, 0, nCount, TRUE, 0); 
   return SUCCESS; 
}