ActionTween Class Reference

ActionTween. More...

#include <ActionTween.h>

Inherits ActionInterval.

Public Member Functions
bool	initWithDuration (float duration, std::string_view key, float from, float to)
	Initializes the action with the property name (key), and the from and to parameters.
Public Member Functions inherited from ActionInterval
float	getElapsed ()
	How many seconds had elapsed since the actions started to run.
void	setAmplitudeRate (float amp)
	Sets the amplitude rate, extension in GridAction.
float	getAmplitudeRate ()
	Gets the amplitude rate, extension in GridAction.
virtual void	step (float dt) override
bool	initWithDuration (float d)
	initializes the action

Static Public Member Functions
static ActionTween *	create (float duration, std::string_view key, float from, float to)
	Create and initializes the action with the property name (key), and the from and to parameters.

Detailed Description

ActionTween.

ActionTween is an action that lets you update any property of an object. For example, if you want to modify the "width" property of a target from 200 to 300 in 2 seconds, then:

auto modifyWidth = ActionTween::create(2, "width", 200, 300);
target->runAction(modifyWidth);

Another example: ScaleTo action could be rewritten using PropertyAction:

// scaleA and scaleB are equivalents
auto scaleA = ScaleTo::create(2, 3);                 // (duration, to)
auto scaleB = ActionTween::create(2, "scale", 1, 3); // (duration, key, from, to)

Since

v0.99.2

Member Function Documentation

create()

static ActionTween * create ( float duration, std::string_view key, float from, float to )

static

Create and initializes the action with the property name (key), and the from and to parameters.

Parameters

duration	The duration of the ActionTween. It's a value in seconds.
key	The key of property which should be updated.
from	The value of the specified property when the action begin.
to	The value of the specified property when the action end.

Returns

If the creation success, return a pointer of ActionTween; otherwise, return nil.

initWithDuration()

bool initWithDuration	(	float	duration,
		std::string_view	key,
		float	from,
		float	to )

Initializes the action with the property name (key), and the from and to parameters.

Parameters

duration	The duration of the ActionTween. It's a value in seconds.
key	The key of property which should be updated.
from	The value of the specified property when the action begin.
to	The value of the specified property when the action end.

Returns

If the initialization success, return true; otherwise, return false.

---

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

• ActionTween.h