cocos2d-x  3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
FiniteTimeAction Class Referenceabstract

Base class actions that do have a finite time duration. More...

#include <CCAction.h>

Inheritance diagram for FiniteTimeAction:
Action Ref Clonable ActionInstant ActionInterval CallFunc FlipX FlipY Hide Place RemoveSelf ReuseGrid Show StopGrid ToggleVisibility CCBSetSpriteFrame CCBSoundEffect AccelAmplitude AccelDeccelAmplitude ActionCamera ActionEase ActionTween Animate BezierBy Blink CardinalSplineTo DeccelAmplitude DelayTime FadeTo GridAction JumpBy MoveBy ProgressFromTo ProgressTo Repeat RepeatForever ReverseTime RotateBy RotateTo ScaleTo Sequence SkewTo Spawn TargetedAction TintBy TintTo CCBRotateTo CCBRotateXTo CCBRotateYTo

Public Member Functions

float getDuration () const
 get duration in seconds of the action More...
 
void setDuration (float duration)
 set duration in seconds of the action More...
 
virtual FiniteTimeActionreverse () const override=0
 returns a new action that performs the exactly the reverse action More...
 
virtual FiniteTimeActionclone () const override=0
 returns a clone of action More...
 
- Public Member Functions inherited from Action
virtual std::string description () const
virtual bool isDone () const
 return true if the action has finished More...
 
local isDone ()
 return true if the action has finished More...
 
virtual void startWithTarget (Node *target)
 called before the action start. It will also set the target. More...
 
virtual void stop ()
 called after the action has finished. More...
 
var stop ()
 called after the action has finished. More...
 
local stop ()
 called after the action has finished. More...
 
virtual void step (float dt)
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
local step ( local dt)
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
virtual void update (float time)
 called once per frame. More...
 
local update ( local time)
 called once per frame. More...
 
NodegetTarget () const
var getTarget ()
local getTarget ()
void setTarget (Node *target)
 The action will modify the target properties. More...
 
var setTarget ( var target)
 The action will modify the target properties. More...
 
local setTarget ( local target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
var getOriginalTarget ()
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
local setOriginalTarget ( local originalTarget)
 Set the original target, since target can be nil. More...
 
int getTag () const
var getTag ()
local getTag ()
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 returns a copy of the Ref. More...
 
var copy ()
 returns a copy of the Ref. More...
 
local copy ()
 returns a copy of the Ref. More...
 

Protected Member Functions

 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
- Protected Member Functions inherited from Action
 Action ()
 Action ()
 Action ()
virtual ~Action ()
var ~Action ()
local ~Action ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Protected Attributes

float _duration
 duration in seconds More...
 
- Protected Attributes inherited from Action
Node_originalTarget
local _originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 
var INVALID_TAG = -1
 Default tag used for all the actions. More...
 
local INVALID_TAG = -1
 Default tag used for all the actions. More...
 

Detailed Description

Base class actions that do have a finite time duration.

Possible actions:

  • An action with a duration of 0 seconds
  • An action with a duration of 35.5 seconds

Infinite time actions are valid

Constructor & Destructor Documentation

FiniteTimeAction ( )
inlineprotected
virtual ~FiniteTimeAction ( )
inlineprotectedvirtual

Member Function Documentation

virtual FiniteTimeAction* clone ( ) const
overridepure virtual

returns a clone of action

Implements Action.

Implemented in TargetedAction, Animate, ReverseTime, DelayTime, EaseCubicActionInOut, EaseCubicActionOut, TintBy, EaseCubicActionIn, TintTo, EaseCircleActionInOut, FadeOut, EaseCircleActionOut, EaseCircleActionIn, FadeIn, EaseQuinticActionInOut, FadeTo, EaseQuinticActionOut, EaseQuinticActionIn, Blink, EaseQuarticActionInOut, ScaleBy, EaseQuarticActionOut, EaseQuarticActionIn, ScaleTo, EaseQuadraticActionInOut, BezierTo, EaseQuadraticActionOut, EaseQuadraticActionIn, BezierBy, EaseBezierAction, JumpTo, EaseBackInOut, EaseBackOut, JumpBy, EaseBackIn, SkewBy, EaseBounceInOut, SkewTo, EaseBounceOut, EaseBounceIn, MoveTo, __CCCallFuncO, EaseBounce, MoveBy, EaseElasticInOut, __CCCallFuncND, EaseElasticOut, RotateBy, CallFuncN, SplitCols, EaseElasticIn, RotateTo, SplitRows, EaseElastic, Twirl, JumpTiles3D, Spawn, CallFunc, EaseSineInOut, ReuseGrid, EaseSineOut, Waves, StopGrid, CatmullRomBy, WavesTiles3D, CCBEaseInstant, CCBRotateYTo, EaseSineIn, CatmullRomTo, DeccelAmplitude, Liquid, Place, RepeatForever, CCBRotateXTo, TurnOffTiles, EaseExponentialInOut, CardinalSplineBy, CCBRotateTo, AccelAmplitude, Shaky3D, FlipY, FadeOutDownTiles, EaseExponentialOut, CCBSoundEffect, FadeOutUpTiles, EaseExponentialIn, CardinalSplineTo, Repeat, Ripple3D, CCBSetSpriteFrame, AccelDeccelAmplitude, FlipX, FadeOutBLTiles, EaseInOut, TiledGrid3DAction, RemoveSelf, FadeOutTRTiles, EaseOut, Lens3D, Sequence, ToggleVisibility, EaseIn, Grid3DAction, FlipY3D, ShuffleTiles, OrbitCamera, Hide, EaseRateAction, FlipX3D, ProgressFromTo, ActionInterval, ActionTween, LuaCallFunc, Show, ShatteredTiles3D, ActionCamera, Waves3D, ActionInstant, PageTurn3D, ActionEase, GridAction, ProgressTo, and ShakyTiles3D.

float getDuration ( ) const
inline

get duration in seconds of the action

void setDuration ( float  duration)
inline

set duration in seconds of the action

Member Data Documentation

float _duration
protected

duration in seconds


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