#include <CCAnimation.h>
Classes | |
struct | DisplayedEventInfo |
When the animation display,Dispatches the event of UserData. More... | |
Public Member Functions | |
SpriteFrame * | getSpriteFrame () const |
Return a SpriteFrameName to be used. More... | |
var | getSpriteFrame () |
Return a SpriteFrameName to be used. More... | |
local | getSpriteFrame () |
Return a SpriteFrameName to be used. More... | |
void | setSpriteFrame (SpriteFrame *frame) |
Set the SpriteFrame. More... | |
var | setSpriteFrame ( var frame) |
Set the SpriteFrame. More... | |
local | setSpriteFrame ( local frame) |
Set the SpriteFrame. More... | |
float | getDelayUnits () const |
Gets the units of time the frame takes. More... | |
var | getDelayUnits () |
Gets the units of time the frame takes. More... | |
local | getDelayUnits () |
Gets the units of time the frame takes. More... | |
void | setDelayUnits (float delayUnits) |
Sets the units of time the frame takes. More... | |
var | setDelayUnits ( var delayUnits) |
Sets the units of time the frame takes. More... | |
local | setDelayUnits ( local delayUnits) |
Sets the units of time the frame takes. More... | |
const ValueMap & | getUserInfo () const |
Gets user infomation A AnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this dictionary as UserInfo. More... | |
ValueMap & | getUserInfo () |
var | getUserInfo () |
local | getUserInfo () |
void | setUserInfo (const ValueMap &userInfo) |
Sets user infomation. More... | |
var | setUserInfo ( var userInfo) |
Sets user infomation. More... | |
local | setUserInfo ( local userInfo) |
Sets user infomation. More... | |
virtual AnimationFrame * | clone () const override |
Returns a copy of the Ref. More... | |
virtual | ~AnimationFrame () |
bool | initWithSpriteFrame (SpriteFrame *spriteFrame, float delayUnits, const ValueMap &userInfo) |
initializes the animation frame with a spriteframe, number of delay units and a notification user info More... | |
var | initWithSpriteFrame ( var spriteFrame, var delayUnits, var userInfo) |
initializes the animation frame with a spriteframe, number of delay units and a notification user info More... | |
local | initWithSpriteFrame ( local spriteFrame, local delayUnits, local userInfo) |
initializes the animation frame with a spriteframe, number of delay units and a notification user info More... | |
Public Member Functions inherited from Ref | |
void | retain () |
Retains the ownership. More... | |
void | release () |
Releases the ownership immediately. More... | |
Ref * | autorelease () |
Releases the ownership sometime soon automatically. More... | |
unsigned int | getReferenceCount () const |
Returns the Ref's current reference count. More... | |
virtual | ~Ref () |
Destructor. More... | |
Public Member Functions inherited from Clonable | |
virtual | ~Clonable () |
Ref * | copy () const |
Returns a copy of the Ref. More... | |
Static Public Member Functions | |
static AnimationFrame * | create (SpriteFrame *spriteFrame, float delayUnits, const ValueMap &userInfo) |
Creates the animation frame with a spriteframe, number of delay units and a notification user info. More... | |
local | create ( local spriteFrame, local delayUnits, local userInfo) |
Creates the animation frame with a spriteframe, number of delay units and a notification user info. More... | |
Public Attributes | |
CC_CONSTRUCTOR_ACCESS | __pad0__: AnimationFrame() |
Protected Attributes | |
SpriteFrame * | _spriteFrame |
SpriteFrameName to be used. More... | |
float | _delayUnits |
how many units of time the frame takes More... | |
var | _delayUnits |
how many units of time the frame takes More... | |
local | _delayUnits |
how many units of time the frame takes More... | |
ValueMap | _userInfo |
A AnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this dictionary as UserInfo. More... | |
Protected Attributes inherited from Ref | |
unsigned int | _referenceCount |
count of references More... | |
local | _referenceCount |
count of references More... | |
Additional Inherited Members | |
Protected Member Functions inherited from Ref | |
Ref () | |
Constructor. More... | |
Ref () | |
Constructor. More... | |
A frame of the animation. It contains information like:
# of delay units.
|
virtual |
|
overridevirtual |
|
static |
Creates the animation frame with a spriteframe, number of delay units and a notification user info.
spriteFrame | The animation frame with a spriteframe. |
delayUnits | Number of delay units. |
userInfo | A notification user info. |
|
static |
Creates the animation frame with a spriteframe, number of delay units and a notification user info.
spriteFrame | The animation frame with a spriteframe. |
delayUnits | Number of delay units. |
userInfo | A notification user info. |
|
static |
Creates the animation frame with a spriteframe, number of delay units and a notification user info.
spriteFrame | The animation frame with a spriteframe. |
delayUnits | Number of delay units. |
userInfo | A notification user info. |
|
inline |
Gets the units of time the frame takes.
|
inline |
Gets the units of time the frame takes.
|
inline |
Gets the units of time the frame takes.
|
inline |
Return a SpriteFrameName to be used.
|
inline |
Return a SpriteFrameName to be used.
|
inline |
Return a SpriteFrameName to be used.
|
inline |
Gets user infomation A AnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this dictionary as UserInfo.
If UserInfo is nil, then no notification will be broadcast.
|
inline |
Gets user infomation A AnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this dictionary as UserInfo.
If UserInfo is nil, then no notification will be broadcast.
|
inline |
Gets user infomation A AnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this dictionary as UserInfo.
If UserInfo is nil, then no notification will be broadcast.
|
inline |
|
inline |
|
inline |
bool initWithSpriteFrame | ( | SpriteFrame * | spriteFrame, |
float | delayUnits, | ||
const ValueMap & | userInfo | ||
) |
initializes the animation frame with a spriteframe, number of delay units and a notification user info
var initWithSpriteFrame | ( | var | spriteFrame, |
var | delayUnits, | ||
var | userInfo | ||
) |
initializes the animation frame with a spriteframe, number of delay units and a notification user info
local initWithSpriteFrame | ( | local | spriteFrame, |
local | delayUnits, | ||
local | userInfo | ||
) |
initializes the animation frame with a spriteframe, number of delay units and a notification user info
|
inline |
Sets the units of time the frame takes.
delayUnits | The units of time the frame takes. |
|
inline |
Sets the units of time the frame takes.
delayUnits | The units of time the frame takes. |
|
inline |
Sets the units of time the frame takes.
delayUnits | The units of time the frame takes. |
|
inline |
Set the SpriteFrame.
frame | A SpriteFrame will be used. |
|
inline |
Set the SpriteFrame.
frame | A SpriteFrame will be used. |
|
inline |
Set the SpriteFrame.
frame | A SpriteFrame will be used. |
|
inline |
Sets user infomation.
userInfo | A dictionary as UserInfo. |
|
inline |
Sets user infomation.
userInfo | A dictionary as UserInfo. |
|
inline |
Sets user infomation.
userInfo | A dictionary as UserInfo. |
CC_CONSTRUCTOR_ACCESS __pad0__ |
var __pad0__ |
local __pad0__ |
|
protected |
how many units of time the frame takes
|
protected |
how many units of time the frame takes
|
protected |
how many units of time the frame takes
|
protected |
SpriteFrameName to be used.
|
protected |
SpriteFrameName to be used.
|
protected |
SpriteFrameName to be used.
|
protected |
A AnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this dictionary as UserInfo.
If UserInfo is nil, then no notification will be broadcast.
|
protected |
A AnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this dictionary as UserInfo.
If UserInfo is nil, then no notification will be broadcast.
|
protected |
A AnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this dictionary as UserInfo.
If UserInfo is nil, then no notification will be broadcast.