ProgressFromTo Class Reference

Progress from a percentage to another percentage. More...

#include <ActionProgressTimer.h>

Inherits ActionInterval.

Public Member Functions
bool	initWithDuration (float duration, float fromPercentage, float toPercentage)
	Initializes the action with a duration, a "from" percentage and a "to" percentage.
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 ProgressFromTo *	create (float duration, float fromPercentage, float toPercentage)
	Create and initializes the action with a duration, a "from" percentage and a "to" percentage.

Detailed Description

Progress from a percentage to another percentage.

Since

v0.99.1

Member Function Documentation

create()

static ProgressFromTo * create ( float duration, float fromPercentage, float toPercentage )

static

Create and initializes the action with a duration, a "from" percentage and a "to" percentage.

Parameters

duration	Specify the duration of the ProgressFromTo action. It's a value in seconds.
fromPercentage	Specify the source percentage.
toPercentage	Specify the destination percentage.

Returns

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

initWithDuration()

bool initWithDuration	(	float	duration,
		float	fromPercentage,
		float	toPercentage )

Initializes the action with a duration, a "from" percentage and a "to" percentage.

Parameters

duration	Specify the duration of the ProgressFromTo action. It's a value in seconds.
fromPercentage	Specify the source percentage.
toPercentage	Specify the destination percentage.

Returns

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

---

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

• ActionProgressTimer.h