DeccelAmplitude Class Reference

DeccelAmplitude action. More...

#include <ActionGrid.h>

Inherits ActionInterval.

Public Member Functions
float	getRate () const
	Get the value of amplitude rate.
void	setRate (float rate)
	Set the value of amplitude rate.
bool	initWithAction (Action *action, float duration)
	Initializes the action with an inner action that has the amplitude property, and a duration time.
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 DeccelAmplitude *	create (Action *action, float duration)
	Creates the action with an inner action that has the amplitude property, and a duration time.

Detailed Description

DeccelAmplitude action.

@js NA

Member Function Documentation

create()

static DeccelAmplitude * create ( Action * action, float duration )

static

Creates the action with an inner action that has the amplitude property, and a duration time.

Parameters

action	A pointer of the inner action.
duration	Specify the duration of the DeccelAmplitude action.

Returns

Return a pointer of DeccelAmplitude. When the creation failed, return nil.

getRate()

float getRate ( ) const

inline

Get the value of amplitude rate.

Returns

The value of amplitude rate.

setRate()

void setRate ( float rate )

inline

Set the value of amplitude rate.

Parameters

rate	Specify the value.

initWithAction()

bool initWithAction	(	Action *	action,
		float	duration )

Initializes the action with an inner action that has the amplitude property, and a duration time.

Parameters

action	The pointer of inner action.
duration	The duration of the DeccelAmplitude action.

Returns

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

---

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

• ActionGrid.h