cocos2d-x  3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ActionTimeline Class Reference

#include <CCActionTimeline.h>

Inheritance diagram for ActionTimeline:
Action Ref Clonable

Public Member Functions

 ActionTimeline ()
 
virtual ~ActionTimeline ()
 
virtual bool init ()
 
virtual void gotoFrameAndPlay (int startIndex)
 Goto the specified frame index, and start playing from this index. More...
 
virtual void gotoFrameAndPlay (int startIndex, bool loop)
 Goto the specified frame index, and start playing from this index. More...
 
virtual void gotoFrameAndPlay (int startIndex, int endIndex, bool loop)
 Goto the specified frame index, and start playing from start index, end at end index. More...
 
virtual void gotoFrameAndPlay (int startIndex, int endIndex, int currentFrameIndex, bool loop)
 Goto the specified frame index, and start playing from start index, end at end index. More...
 
virtual void gotoFrameAndPause (int startIndex)
 Goto the specified frame index, and pause at this index. More...
 
virtual void pause ()
 Pause the animation. More...
 
virtual void resume ()
 Resume the animation. More...
 
virtual bool isPlaying () const
 Whether or not Action is playing. More...
 
virtual void setTimeSpeed (float speed)
 Set the animation speed, this will speed up or slow down the speed. More...
 
virtual float getTimeSpeed () const
 Get current animation speed. More...
 
virtual void setDuration (int duration)
 duration of the whole action More...
 
virtual int getDuration () const
 
virtual int getStartFrame () const
 Start frame index of this action. More...
 
virtual int getEndFrame () const
 End frame of this action. More...
 
virtual void setCurrentFrame (int frameIndex)
 Set current frame index, this will cause action plays to this frame. More...
 
virtual int getCurrentFrame () const
 Get current frame. More...
 
virtual void addTimeline (Timeline *timeline)
 add Timeline to ActionTimeline More...
 
virtual void removeTimeline (Timeline *timeline)
 
virtual const cocos2d::Vector
< Timeline * > & 
getTimelines () const
 
void setFrameEventCallFunc (std::function< void(Frame *)> listener)
 Set ActionTimeline's frame event callback function. More...
 
void clearFrameEventCallFunc ()
 
void setLastFrameCallFunc (std::function< void()> listener)
 Last frame callback will call when arriving last frame. More...
 
void clearLastFrameCallFunc ()
 
virtual ActionTimelineclone () const override
 Inherit from Action. More...
 
virtual ActionTimelinereverse () const override
 Returns a reverse of ActionTimeline. More...
 
virtual void step (float delta) override
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
virtual void startWithTarget (cocos2d::Node *target) override
 called before the action start. It will also set the target. More...
 
virtual bool isDone () const override
 return true if the action has finished More...
 
- Public Member Functions inherited from Action
virtual std::string description () const
 NA NA More...
 
virtual void stop ()
 called after the action has finished. More...
 
virtual void update (float time)
 called once per frame. More...
 
NodegetTarget () const
 
void setTarget (Node *target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
 
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
int getTag () const
 
void setTag (int tag)
 
virtual ~Action ()
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 NA NA More...
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
 NA NA More...
 
Refcopy () const
 returns a copy of the Ref. More...
 

Static Public Member Functions

static ActionTimelinecreate ()
 

Protected Member Functions

virtual void gotoFrame (int frameIndex)
 
virtual void stepToFrame (int frameIndex)
 
virtual void emitFrameEvent (Frame *frame)
 emit frame event, call it when enter a frame More...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Protected Attributes

std::map< int, cocos2d::Vector
< Timeline * > > 
_timelineMap
 
cocos2d::Vector< Timeline * > _timelineList
 
int _duration
 
double _time
 
float _timeSpeed
 
float _frameInternal
 
bool _playing
 
int _currentFrame
 
int _startFrame
 
int _endFrame
 
bool _loop
 
std::function< void(Frame *)> _frameEventListener
 
std::function< void()> _lastFrameListener
 
- Protected Attributes inherited from Action
Node_originalTarget
 
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Friends

class Frame
 

Additional Inherited Members

- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()
 
- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 

Constructor & Destructor Documentation

virtual ~ActionTimeline ( )
virtual

Member Function Documentation

virtual void addTimeline ( Timeline timeline)
virtual
void clearFrameEventCallFunc ( )
void clearLastFrameCallFunc ( )
virtual ActionTimeline* clone ( ) const
overridevirtual

Inherit from Action.

Returns a clone of ActionTimeline

Reimplemented from Action.

static ActionTimeline* create ( )
static
virtual void emitFrameEvent ( Frame frame)
protectedvirtual

emit frame event, call it when enter a frame

virtual int getCurrentFrame ( ) const
inlinevirtual

Get current frame.

virtual int getDuration ( ) const
inlinevirtual
virtual int getEndFrame ( ) const
inlinevirtual

End frame of this action.

When action play to this frame, if action is not loop, then it will stop, or it will play from start frame again.

virtual int getStartFrame ( ) const
inlinevirtual

Start frame index of this action.

virtual const cocos2d::Vector<Timeline*>& getTimelines ( ) const
inlinevirtual
virtual float getTimeSpeed ( ) const
inlinevirtual

Get current animation speed.

virtual void gotoFrame ( int  frameIndex)
protectedvirtual
virtual void gotoFrameAndPause ( int  startIndex)
virtual

Goto the specified frame index, and pause at this index.

Parameters
startIndexThe animation will pause at this index.
virtual void gotoFrameAndPlay ( int  startIndex)
virtual

Goto the specified frame index, and start playing from this index.

Parameters
startIndexThe animation will play from this index.
virtual void gotoFrameAndPlay ( int  startIndex,
bool  loop 
)
virtual

Goto the specified frame index, and start playing from this index.

Parameters
startIndexThe animation will play from this index.
loopWhether or not the animation need loop.
virtual void gotoFrameAndPlay ( int  startIndex,
int  endIndex,
bool  loop 
)
virtual

Goto the specified frame index, and start playing from start index, end at end index.

Parameters
startIndexThe animation will play from this index.
endIndexThe animation will end at this index.
loopWhether or not the animation need loop.
virtual void gotoFrameAndPlay ( int  startIndex,
int  endIndex,
int  currentFrameIndex,
bool  loop 
)
virtual

Goto the specified frame index, and start playing from start index, end at end index.

Parameters
startIndexThe animation will play from this index.
endIndexThe animation will end at this index.
currentFrameIndexset current frame index.
loopWhether or not the animation need loop.
virtual bool init ( )
virtual
virtual bool isDone ( ) const
inlineoverridevirtual

return true if the action has finished

Reimplemented from Action.

virtual bool isPlaying ( ) const
virtual

Whether or not Action is playing.

virtual void pause ( )
virtual

Pause the animation.

virtual void removeTimeline ( Timeline timeline)
virtual
virtual void resume ( )
virtual

Resume the animation.

virtual ActionTimeline* reverse ( void  ) const
inlineoverridevirtual

Returns a reverse of ActionTimeline.

Not implement yet.

Reimplemented from Action.

virtual void setCurrentFrame ( int  frameIndex)
virtual

Set current frame index, this will cause action plays to this frame.

virtual void setDuration ( int  duration)
inlinevirtual

duration of the whole action

void setFrameEventCallFunc ( std::function< void(Frame *)>  listener)

Set ActionTimeline's frame event callback function.

void setLastFrameCallFunc ( std::function< void()>  listener)

Last frame callback will call when arriving last frame.

virtual void setTimeSpeed ( float  speed)
inlinevirtual

Set the animation speed, this will speed up or slow down the speed.

virtual void startWithTarget ( cocos2d::Node target)
overridevirtual

called before the action start. It will also set the target.

Reimplemented from Action.

virtual void step ( float  dt)
overridevirtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

Reimplemented from Action.

virtual void stepToFrame ( int  frameIndex)
protectedvirtual

Friends And Related Function Documentation

friend class Frame
friend

Member Data Documentation

int _currentFrame
protected
int _duration
protected
int _endFrame
protected
std::function<void(Frame*)> _frameEventListener
protected
float _frameInternal
protected
std::function<void()> _lastFrameListener
protected
bool _loop
protected
bool _playing
protected
int _startFrame
protected
double _time
protected
cocos2d::Vector<Timeline*> _timelineList
protected
std::map<int, cocos2d::Vector<Timeline*> > _timelineMap
protected
float _timeSpeed
protected

The documentation for this class was generated from the following file: