Class cc.Ripple3D

Class Summary
Constructor Attributes Constructor Name and Description
 
cc.Ripple3D(duration, gridSize, position, radius, waves, amplitude)
cc.Ripple3D action.

Method Summary

Class Detail

cc.Ripple3D(duration, gridSize, position, radius, waves, amplitude)
cc.Ripple3D action.
Reference the test cases (Effects Test)
Parameters:
{Number} duration
{cc.Size} gridSize
{cc.Point} position
{Number} radius
{Number} waves
{Number} amplitude

Field Detail

<static> {cc.Ripple3D} cc.Ripple3D.create
Please use cc.ripple3D instead creates a ripple 3d action with radius, number of waves, amplitude
Deprecated:
since v3.0
Please use cc.ripple3D instead.

Method Detail

  • ctor(duration, gridSize, position, radius, waves, amplitude)
    Constructor function, override it to extend the construction behavior, remember to call "this._super()" in the extended "ctor" function.
    creates a ripple 3d action with radius, number of waves, amplitude.
    Parameters:
    {Number} duration
    {cc.Size} gridSize
    {cc.Point} position
    {Number} radius
    {Number} waves
    {Number} amplitude
  • {Number} getAmplitude()
    get Amplitude
    Returns:
    {Number}
  • {*} getAmplitudeRate()
    get Amplitude rate
    Returns:
    {*}
  • {cc.Point} getPosition()
    get center position
    Returns:
    {cc.Point}
  • {Boolean} initWithDuration(duration, gridSize, position, radius, waves, amplitude)
    initializes the action with radius, number of waves, amplitude, a grid size and duration
    Parameters:
    {Number} duration
    {cc.Size} gridSize
    {cc.Point} position
    {Number} radius
    {Number} waves
    {Number} amplitude
    Returns:
    {Boolean}
  • setAmplitude(amplitude)
    set Amplitude
    Parameters:
    {Number} amplitude
  • setAmplitudeRate(amplitudeRate)
    get amplitude rate
    Parameters:
    {Number} amplitudeRate
  • setPosition(position)
    set center position
    Parameters:
    {cc.Point} position
  • update(dt)
    Called once per frame. Time is the number of seconds of a frame interval.
    Parameters:
    {Number} dt