cocos2d-x  3.3rc0
 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...
 
- Public Member Functions inherited from Action
virtual std::string description () const
virtual bool isDone () const
 return true if the action has finished More...
 
var isDone ()
 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...
 
var step ( var 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 ()
local getOriginalTarget ()
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
var setOriginalTarget ( var 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)
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...
 
local getReferenceCount ()
 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...
 

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

Reimplemented from Action.

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

var clone ( )
inlineoverridevirtual

returns a clone of action

Reimplemented from Action.

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

local clone ( )
inlineoverridevirtual

returns a clone of action

Reimplemented from Action.

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

float getDuration ( ) const
inline

get duration in seconds of the action

var getDuration ( )
inline

get duration in seconds of the action

local getDuration ( )
inline

get duration in seconds of the action

virtual FiniteTimeAction* reverse ( void  ) const
inlineoverridevirtual
void setDuration ( float  duration)
inline

set duration in seconds of the action

var setDuration ( var  duration)
inline

set duration in seconds of the action

local setDuration ( local  duration)
inline

set duration in seconds of the action

Member Data Documentation

var __pad0__
local __pad0__

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