L_DispContainerStartAnimation
#include "ltivw.h"
L_LTIVW_API L_INT L_DispContainerStartAnimation(hCon, nCellIndex, nStartFrame, nFrameCount, bAnimateAllSubCells, uFlags)
HDISPCONTAINER hCon; |
/* handle to the container */ |
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). This function is available only in the Medical Imaging Suite toolkits.
Parameter |
Description |
|
hCon |
Handle to the container. |
|
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 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
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; L_DispContainerGetAnimationProperties(hCon, nCellIndex, &DispAnimationProps, 0); DispAnimationProps.uInterval = 100; DispAnimationProps.uFlags = CONTAINER_ANIMATION_DIRECTION_FORWARD; L_DispContainerSetAnimationProperties(hCon, nCellIndex, &DispAnimationProps, 0); L_DispContainerGetCellBitmapList(hCon, nCellIndex, &hBitmapList, 0); L_GetBitmapListCount(hBitmapList, (L_UINT*)&nCount); if (!L_DispContainerIsCellAnimated(hCon, nCellIndex, 0)) L_DispContainerStartAnimation(hCon, nCellIndex, 0, nCount, TRUE, 0); return SUCCESS; }