Inherits Grid3DAction.
Public Member Functions | |
const Vec2 & | getPosition () const |
Get the center position of ripple effect. More... | |
void | setPosition (const Vec2 &position) |
Set the center position of ripple effect. More... | |
float | getAmplitude () const |
Get the amplitude of ripple effect. More... | |
void | setAmplitude (float fAmplitude) |
Set the amplitude of ripple effect. More... | |
float | getAmplitudeRate () const |
Get the amplitude rate of ripple effect. More... | |
void | setAmplitudeRate (float fAmplitudeRate) |
Set the amplitude rate of ripple effect. More... | |
virtual Ripple3D * | clone () const override |
Returns a clone of action. More... | |
virtual void | update (float time) override |
Called once per frame. More... | |
Public Member Functions inherited from Grid3DAction | |
virtual GridBase * | getGrid () override |
Get the pointer of GridBase. More... | |
Vec3 | getVertex (const Vec2 &position) const |
Get the vertex that belongs to certain position in the grid. More... | |
Vec3 | getOriginalVertex (const Vec2 &position) const |
Get the non-transformed vertex that belongs to certain position in the grid. More... | |
void | setVertex (const Vec2 &position, const Vec3 &vertex) |
Set a new vertex to a certain position of the grid. More... | |
Rect | getGridRect () const |
Get the effect grid rect. More... | |
Public Member Functions inherited from GridAction | |
virtual GridAction * | reverse () 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... | |
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... | |
Node * | getTarget () const |
Return certain target. More... | |
void | setTarget (Node *target) |
The action will modify the target properties. More... | |
Node * | getOriginalTarget () 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... | |
Ref * | autorelease () |
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 Ripple3D * | create (float duration, const Size &gridSize, const Vec2 &position, float radius, unsigned int waves, float amplitude) |
Create the action with center position, radius, number of waves, amplitude, a grid size and duration. More... | |
Protected Member Functions | |
bool | initWithDuration (float duration, const Size &gridSize, const Vec2 &position, float radius, unsigned int waves, float amplitude) |
Initializes the action with center position, radius, number of waves, amplitude, a grid size and duration. More... | |
Protected Member Functions inherited from GridAction | |
bool | initWithDuration (float duration, const Size &gridSize) |
Initializes the action with size and duration. 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. | |
Ripple3D action.
This action is used for take effect on the target node as ripple. You can create the action by these parameters: duration, grid size, center position of ripple, radius of ripple, waves count, amplitude.
|
static |
Create the action with center position, radius, number of waves, amplitude, a grid size and duration.
duration | Specify the duration of the Ripple3D action. It's a value in seconds. |
gridSize | Specify the size of the grid. |
position | Specify the center position of the ripple effect. |
radius | Specify the radius of the ripple effect. |
waves | Specify the waves count of the ripple effect. |
amplitude | Specify the amplitude of the ripple effect. |
|
inline |
Get the center position of ripple effect.
void setPosition | ( | const Vec2 & | position | ) |
Set the center position of ripple effect.
position | The center position of ripple effect will be set. |
|
inline |
Get the amplitude of ripple effect.
|
inline |
Set the amplitude of ripple effect.
fAmplitude | The amplitude of ripple effect. |
|
inline |
Get the amplitude rate of ripple effect.
|
inline |
Set the amplitude rate of ripple effect.
fAmplitudeRate | The amplitude rate of ripple effect. |
|
overridevirtual |
|
overridevirtual |
Called once per frame.
time a value between 0 and 1.
For example:
time | A value between 0 and 1. |
Reimplemented from Action.
|
protected |
Initializes the action with center position, radius, number of waves, amplitude, a grid size and duration.
duration | Specify the duration of the Ripple3D action. It's a value in seconds. |
gridSize | Specify the size of the grid. |
position | Specify the center position of the ripple effect. |
radius | Specify the radius of the ripple effect. |
waves | Specify the waves count of the ripple effect. |
amplitude | Specify the amplitude of the ripple effect. |