Cocos2d-x  v4
ScaleTo Class Reference

Scales a Node object to a zoom factor by modifying it's scale attribute. More...

Inherits ActionInterval.

Inherited by ScaleBy.

Public Member Functions

virtual ScaleToclone () const override
 Returns a clone of action. More...
 
virtual ScaleToreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
virtual void update (float time) override
 
- Public Member Functions inherited from ActionInterval
float getElapsed ()
 How many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
 Sets the amplitude rate, extension in GridAction. More...
 
float getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
virtual bool isDone () const override
 Return true if the action has finished. More...
 
virtual void step (float dt) override
 
- Public Member Functions inherited from FiniteTimeAction
float getDuration () const
 Get duration in seconds of the action. More...
 
void setDuration (float duration)
 Set duration in seconds of the action. More...
 
- Public Member Functions inherited from Action
virtual std::string description () const
 @js NA @lua NA
 
virtual void stop ()
 Called after the action has finished. More...
 
NodegetTarget () const
 Return certain target. More...
 
void setTarget (Node *target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
 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...
 
void setTag (int tag)
 Changes the tag that is used to identify the action easily. More...
 
unsigned int getFlags () const
 Returns a flag field that is used to group the actions easily. More...
 
void setFlags (unsigned int flags)
 Changes the flag field that is used to group the actions easily. More...
 
- 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 ()
 @js NA @lua NA
 

Static Public Member Functions

static ScaleTocreate (float duration, float s)
 Creates the action with the same scale factor for X and Y. More...
 
static ScaleTocreate (float duration, float sx, float sy)
 Creates the action with and X factor and a Y factor. More...
 
static ScaleTocreate (float duration, float sx, float sy, float sz)
 Creates the action with X Y Z factor. More...
 

Protected Member Functions

bool initWithDuration (float duration, float s)
 initializes the action with the same scale factor for X and Y More...
 
bool initWithDuration (float duration, float sx, float sy)
 initializes the action with and X factor and a Y factor More...
 
bool initWithDuration (float duration, float sx, float sy, float sz)
 initializes the action with X Y Z factor More...
 
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions.
 

Detailed Description

Scales a Node object to a zoom factor by modifying it's scale attribute.

Warning
This action doesn't support "reverse".
The physics body contained in Node doesn't support this action.

Member Function Documentation

◆ create() [1/3]

static ScaleTo* create ( float  duration,
float  s 
)
static

Creates the action with the same scale factor for X and Y.

Parameters
durationDuration time, in seconds.
sScale factor of x and y.
Returns
An autoreleased ScaleTo object.

◆ create() [2/3]

static ScaleTo* create ( float  duration,
float  sx,
float  sy 
)
static

Creates the action with and X factor and a Y factor.

Parameters
durationDuration time, in seconds.
sxScale factor of x.
syScale factor of y.
Returns
An autoreleased ScaleTo object.

◆ create() [3/3]

static ScaleTo* create ( float  duration,
float  sx,
float  sy,
float  sz 
)
static

Creates the action with X Y Z factor.

Parameters
durationDuration time, in seconds.
sxScale factor of x.
syScale factor of y.
szScale factor of z.
Returns
An autoreleased ScaleTo object.

◆ clone()

virtual ScaleTo* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

Reimplemented in ScaleBy.

◆ reverse()

virtual ScaleTo* reverse ( ) const
overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns
A new action that performs the exact reverse of the action. @js NA

Reimplemented from ActionInterval.

Reimplemented in ScaleBy.

◆ startWithTarget()

virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

Reimplemented in ScaleBy.

◆ update()

virtual void update ( float  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

◆ initWithDuration() [1/3]

bool initWithDuration ( float  duration,
float  s 
)
protected

initializes the action with the same scale factor for X and Y

Parameters
durationin seconds

◆ initWithDuration() [2/3]

bool initWithDuration ( float  duration,
float  sx,
float  sy 
)
protected

initializes the action with and X factor and a Y factor

Parameters
durationin seconds

◆ initWithDuration() [3/3]

bool initWithDuration ( float  duration,
float  sx,
float  sy,
float  sz 
)
protected

initializes the action with X Y Z factor

Parameters
durationin seconds

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