NNS_G2dSetMCAnimationCurrentFrame

C Specification

#include <nnsys/g2d/g2d_MultiCellAnimation.h>

void NNS_G2dSetMCAnimationCurrentFrame
( 
NNSG2dMultiCellAnimation*   pMultiCellAnim,
u16                     frameIndex )
);
  

Arguments

pMultiCellAnim [OUT] Multicell animation
frameIndex [IN] Animation frame number

Return Values

None.

Description

Sets the play animation frame of the multicell animation. No action will occur if an invalid index is specified.

Note: 
If a STOP-method animation sequence has played to the end, the animation controller is set to the Stop state.
Because of this, you will need to call NNS_G2dStartAnimCtrl() for the animation controller of that mutli-cell animation to update the animation again.
To get the animation controller of that cell animation, use the NNS_G2dGetMCAnimAnimCtrl() function.

The NNS_G2dStartMCCellAnimationAll() function is available for calling NNS_G2dStartAnimCtrl() for all of the cell animations that comprise the mutli-cell animation.

To restart the animation from the beginning, use the NNS_G2dRestartMCAnimation() function.

See Also

NNS_G2dSetAnimCtrlCurrentFrame
NNS_G2dSetMCAnimationCellAnimFrame
NNS_G2dGetMCAnimAnimCtrl
NNS_G2dStartAnimCtrl
NNS_G2dStartMCCellAnimationAll
NNS_G2dRestartMCAnimation

Revision History

05/29/2006 Added a warning note.

05/28/2004 Initial version.


CONFIDENTIAL