AccelAmplitude Class Reference

AccelAmplitude 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.
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 AccelAmplitude *	create (Action *action, float duration)
	Create the action with an inner action that has the amplitude property, and a duration time.

Detailed Description

AccelAmplitude action.

@js NA

Member Function Documentation

create()

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

static

Create 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 AccelAmplitude action.

Returns

Return a pointer of AccelAmplitude action. 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 of amplitude rate.

---

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

• ActionGrid.h