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

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 Animate3D 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...
 
var getDuration ()
 Get duration in seconds of the action. More...
 
local getDuration ()
 Get duration in seconds of the action. More...
 
void setDuration (float duration)
 Set duration in seconds of the action. More...
 
var setDuration ( var duration)
 Set duration in seconds of the action. More...
 
local setDuration ( local duration)
 Set duration in seconds of the action. More...
 
virtual FiniteTimeActionreverse () const override
 Returns a new action that performs the exactly the reverse action. More...
 
local reverse ()
 Returns a new action that performs the exactly the reverse action. More...
 
virtual FiniteTimeActionclone () const override
 Returns a clone of action. More...
 
local clone ()
 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. More...
 
var startWithTarget ( var target)
 Called before the action start. More...
 
local startWithTarget ( local target)
 Called before the action start. More...
 
virtual void stop ()
 Called after the action has finished. More...
 
virtual void step (float dt)
 Called every frame with it's delta time, dt in seconds. More...
 
local step ( local dt)
 Called every frame with it's delta time, dt in seconds. More...
 
virtual void update (float time)
 Called once per frame. More...
 
var update ( var time)
 Called once per frame. More...
 
local update ( local time)
 Called once per frame. More...
 
NodegetTarget () const
 Return certain target. More...
 
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
 Return a original Target. More...
 
var getOriginalTarget ()
 Return a original Target. More...
 
local getOriginalTarget ()
 Return a original Target. More...
 
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
int getTag () const
 Returns a tag that is used to identify the action easily. More...
 
var getTag ()
 Returns a tag that is used to identify the action easily. More...
 
local getTag ()
 Returns a tag that is used to identify the action easily. More...
 
void setTag (int tag)
 Changes the tag that is used to identify the action easily. More...
 
var setTag ( var tag)
 Changes the tag that is used to identify the action easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the action easily. More...
 
virtual ~Action ()
var ~Action ()
local ~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 ()
 Destructor. More...
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 Returns a copy of the Ref. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
var __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
local __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()

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...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 
- 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...
 
local _referenceCount
 count of references 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.

Member Function Documentation

virtual FiniteTimeAction* clone ( ) const
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Action.

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

var clone ( )
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Action.

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

local clone ( )
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Action.

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

float getDuration ( ) const
inline

Get duration in seconds of the action.

Returns
The duration in seconds of the action.
var getDuration ( )
inline

Get duration in seconds of the action.

Returns
The duration in seconds of the action.
local getDuration ( )
inline

Get duration in seconds of the action.

Returns
The duration in seconds of the action.
virtual FiniteTimeAction* reverse ( void  ) const
inlineoverridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from Action.

Reimplemented in TargetedAction, Animate, ReverseTime, DelayTime, TintBy, TintTo, EaseCubicActionInOut, FadeOut, EaseCubicActionOut, EaseCubicActionIn, FadeIn, EaseCircleActionInOut, FadeTo, EaseCircleActionOut, EaseCircleActionIn, Blink, EaseQuinticActionInOut, ScaleBy, EaseQuinticActionOut, EaseQuinticActionIn, EaseQuarticActionInOut, ScaleTo, EaseQuarticActionOut, EaseQuarticActionIn, BezierTo, EaseQuadraticActionInOut, EaseQuadraticActionOut, BezierBy, EaseQuadraticActionIn, EaseBezierAction, JumpTo, EaseBackInOut, JumpBy, EaseBackOut, SkewBy, EaseBackIn, EaseBounceInOut, SkewTo, EaseBounceOut, MoveTo, EaseBounceIn, EaseBounce, MoveBy, EaseElasticInOut, EaseElasticOut, RotateBy, EaseElasticIn, RotateTo, EaseElastic, EaseSineInOut, ReuseGrid, Spawn, EaseSineOut, StopGrid, CallFunc, EaseSineIn, DeccelAmplitude, CatmullRomBy, EaseExponentialInOut, RepeatForever, CatmullRomTo, Place, AccelAmplitude, EaseExponentialOut, CCBEaseInstant, CardinalSplineBy, FlipY, EaseExponentialIn, CCBRotateYTo, Repeat, AccelDeccelAmplitude, CCBRotateXTo, EaseInOut, CardinalSplineTo, FlipX, CCBRotateTo, CCBSoundEffect, EaseOut, RemoveSelf, CCBSetSpriteFrame, Sequence, EaseIn, ToggleVisibility, Hide, EaseRateAction, ProgressFromTo, ActionTween, ActionInterval, Show, Animate3D, ActionEase, GridAction, ActionCamera, ProgressTo, and ActionInstant.

var reverse (   )
inlineoverridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from Action.

Reimplemented in TargetedAction, Animate, ReverseTime, DelayTime, TintBy, TintTo, EaseCubicActionInOut, FadeOut, EaseCubicActionOut, EaseCubicActionIn, FadeIn, EaseCircleActionInOut, FadeTo, EaseCircleActionOut, EaseCircleActionIn, Blink, EaseQuinticActionInOut, ScaleBy, EaseQuinticActionOut, EaseQuinticActionIn, EaseQuarticActionInOut, ScaleTo, EaseQuarticActionOut, EaseQuarticActionIn, BezierTo, EaseQuadraticActionInOut, EaseQuadraticActionOut, BezierBy, EaseQuadraticActionIn, EaseBezierAction, JumpTo, EaseBackInOut, JumpBy, EaseBackOut, SkewBy, EaseBackIn, EaseBounceInOut, SkewTo, EaseBounceOut, MoveTo, EaseBounceIn, EaseBounce, MoveBy, EaseElasticInOut, EaseElasticOut, RotateBy, EaseElasticIn, RotateTo, EaseElastic, EaseSineInOut, ReuseGrid, Spawn, EaseSineOut, StopGrid, CallFunc, EaseSineIn, DeccelAmplitude, CatmullRomBy, EaseExponentialInOut, RepeatForever, CatmullRomTo, Place, AccelAmplitude, EaseExponentialOut, CCBEaseInstant, CardinalSplineBy, FlipY, EaseExponentialIn, CCBRotateYTo, Repeat, AccelDeccelAmplitude, CCBRotateXTo, EaseInOut, CardinalSplineTo, FlipX, CCBRotateTo, CCBSoundEffect, EaseOut, RemoveSelf, CCBSetSpriteFrame, Sequence, EaseIn, ToggleVisibility, Hide, EaseRateAction, ProgressFromTo, ActionTween, ActionInterval, Show, Animate3D, ActionEase, GridAction, ActionCamera, ProgressTo, and ActionInstant.

local reverse (   )
inlineoverridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from Action.

Reimplemented in TargetedAction, Animate, ReverseTime, DelayTime, TintBy, TintTo, EaseCubicActionInOut, FadeOut, EaseCubicActionOut, EaseCubicActionIn, FadeIn, EaseCircleActionInOut, FadeTo, EaseCircleActionOut, EaseCircleActionIn, Blink, EaseQuinticActionInOut, ScaleBy, EaseQuinticActionOut, EaseQuinticActionIn, EaseQuarticActionInOut, ScaleTo, EaseQuarticActionOut, EaseQuarticActionIn, BezierTo, EaseQuadraticActionInOut, EaseQuadraticActionOut, BezierBy, EaseQuadraticActionIn, EaseBezierAction, JumpTo, EaseBackInOut, JumpBy, EaseBackOut, SkewBy, EaseBackIn, EaseBounceInOut, SkewTo, EaseBounceOut, MoveTo, EaseBounceIn, EaseBounce, MoveBy, EaseElasticInOut, EaseElasticOut, RotateBy, EaseElasticIn, RotateTo, EaseElastic, EaseSineInOut, ReuseGrid, Spawn, EaseSineOut, StopGrid, CallFunc, EaseSineIn, DeccelAmplitude, CatmullRomBy, EaseExponentialInOut, RepeatForever, CatmullRomTo, Place, AccelAmplitude, EaseExponentialOut, CCBEaseInstant, CardinalSplineBy, FlipY, EaseExponentialIn, CCBRotateYTo, Repeat, AccelDeccelAmplitude, CCBRotateXTo, EaseInOut, CardinalSplineTo, FlipX, CCBRotateTo, CCBSoundEffect, EaseOut, RemoveSelf, CCBSetSpriteFrame, Sequence, EaseIn, ToggleVisibility, Hide, EaseRateAction, ProgressFromTo, ActionTween, ActionInterval, Show, Animate3D, ActionEase, GridAction, ActionCamera, ProgressTo, and ActionInstant.

void setDuration ( float  duration)
inline

Set duration in seconds of the action.

Parameters
durationIn seconds of the action.
var setDuration ( var  duration)
inline

Set duration in seconds of the action.

Parameters
durationIn seconds of the action.
local setDuration ( local  duration)
inline

Set duration in seconds of the action.

Parameters
durationIn seconds of the action.

Member Data Documentation

var __pad0__
local __pad0__

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