cocos2d-x  3.0rc1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Waves3D Class Reference

Waves3D action. More...

#include <CCActionGrid3D.h>

Inheritance diagram for Waves3D:
Grid3DAction GridAction ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

float getAmplitude () const
 returns the amplitude of the effect More...
 
void setAmplitude (float amplitude)
 sets the amplitude to the effect More...
 
float getAmplitudeRate () const
 returns the amplitude rate More...
 
void setAmplitudeRate (float amplitudeRate)
 sets the ampliture rate More...
 
var setAmplitudeRate ( var amplitudeRate)
 sets the ampliture rate More...
 
local setAmplitudeRate ( local amplitudeRate)
 sets the ampliture rate More...
 
virtual Waves3Dclone () const override
 returns a clone of action More...
 
virtual void update (float time) override
 called once per frame. More...
 
local update ( local time)
 called once per frame. More...
 
- Public Member Functions inherited from Grid3DAction
virtual GridBasegetGrid ()
 returns the grid More...
 
Vertex3F getVertex (const Point &position) const
 returns the vertex than belongs to certain position in the grid More...
 
CC_DEPRECATED_ATTRIBUTE Vertex3F vertex (const Point &position)
Vertex3F getOriginalVertex (const Point &position) const
 returns the non-transformed vertex than belongs to certain position in the grid More...
 
CC_DEPRECATED_ATTRIBUTE Vertex3F originalVertex (const Point &position)
void setVertex (const Point &position, const Vertex3F &vertex)
 sets a new vertex to a certain position of the grid More...
 
- Public Member Functions inherited from GridAction
virtual GridActionreverse () const override
 returns a new action that performs the exactly the reverse action More...
 
var reverse ()
 returns a new action that performs the exactly the reverse action More...
 
local reverse ()
 returns a new action that performs the exactly the reverse action More...
 
virtual void startWithTarget (Node *target) override
 called before the action start. It will also set the target. More...
 
- Public Member Functions inherited from ActionInterval
float getElapsed (void)
 how many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
float getAmplitudeRate (void)
virtual bool isDone (void) const override
 return true if the action has finished More...
 
virtual void step (float dt) override
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
local step ( local dt)
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
- 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
virtual void stop ()
 called after the action has finished. More...
 
var stop ()
 called after the action has finished. More...
 
local stop ()
 called after the action has finished. More...
 
NodegetTarget () const
void setTarget (Node *target)
 The action will modify the target properties. More...
 
var setTarget ( var target)
 The action will modify the target properties. More...
 
local setTarget ( local target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
local getOriginalTarget ()
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
local setOriginalTarget ( local originalTarget)
 Set the original target, since target can be nil. More...
 
int getTag () const
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
local release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 returns a copy of the Ref. More...
 
var copy ()
 returns a copy of the Ref. More...
 
local copy ()
 returns a copy of the Ref. More...
 

Static Public Member Functions

static Waves3Dcreate (float duration, const Size &gridSize, unsigned int waves, float amplitude)
 creates an action with duration, grid size, waves and amplitude More...
 
local create ( local duration, local gridSize, local waves, local amplitude)
 creates an action with duration, grid size, waves and amplitude More...
 

Protected Member Functions

 Waves3D ()
virtual ~Waves3D ()
local ~Waves3D ()
bool initWithDuration (float duration, const Size &gridSize, unsigned int waves, float amplitude)
 initializes an action with duration, grid size, waves and amplitude More...
 
var initWithDuration ( var duration, var gridSize, var waves, var amplitude)
 initializes an action with duration, grid size, waves and amplitude More...
 
local initWithDuration ( local duration, local gridSize, local waves, local amplitude)
 initializes an action with duration, grid size, waves and amplitude More...
 

Protected Attributes

unsigned int _waves
float _amplitude
var _amplitude
local _amplitude
float _amplitudeRate
var _amplitudeRate
local _amplitudeRate

Additional Inherited Members

- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 
var INVALID_TAG = -1
 Default tag used for all the actions. More...
 
local INVALID_TAG = -1
 Default tag used for all the actions. More...
 

Detailed Description

Waves3D action.

Constructor & Destructor Documentation

Waves3D ( )
inlineprotected
var Waves3D ( )
inlineprotected
local Waves3D ( )
inlineprotected
virtual ~Waves3D ( )
inlineprotectedvirtual
var ~Waves3D ( )
inlineprotectedvirtual
local ~Waves3D ( )
inlineprotectedvirtual

Member Function Documentation

virtual Waves3D* clone ( ) const
overridevirtual

returns a clone of action

Implements Grid3DAction.

var clone ( )
overridevirtual

returns a clone of action

Implements Grid3DAction.

local clone ( )
overridevirtual

returns a clone of action

Implements Grid3DAction.

static Waves3D* create ( float  duration,
const Size gridSize,
unsigned int  waves,
float  amplitude 
)
static

creates an action with duration, grid size, waves and amplitude

var create ( var  duration,
var  gridSize,
var  waves,
var  amplitude 
)
static

creates an action with duration, grid size, waves and amplitude

local create ( local  duration,
local  gridSize,
local  waves,
local  amplitude 
)
static

creates an action with duration, grid size, waves and amplitude

float getAmplitude ( ) const
inline

returns the amplitude of the effect

var getAmplitude ( )
inline

returns the amplitude of the effect

local getAmplitude ( )
inline

returns the amplitude of the effect

float getAmplitudeRate ( void  ) const
inline

returns the amplitude rate

var getAmplitudeRate (   )
inline

returns the amplitude rate

local getAmplitudeRate (   )
inline

returns the amplitude rate

bool initWithDuration ( float  duration,
const Size gridSize,
unsigned int  waves,
float  amplitude 
)
protected

initializes an action with duration, grid size, waves and amplitude

var initWithDuration ( var  duration,
var  gridSize,
var  waves,
var  amplitude 
)
protected

initializes an action with duration, grid size, waves and amplitude

local initWithDuration ( local  duration,
local  gridSize,
local  waves,
local  amplitude 
)
protected

initializes an action with duration, grid size, waves and amplitude

void setAmplitude ( float  amplitude)
inline

sets the amplitude to the effect

var setAmplitude ( var  amplitude)
inline

sets the amplitude to the effect

local setAmplitude ( local  amplitude)
inline

sets the amplitude to the effect

void setAmplitudeRate ( float  amplitudeRate)
inline

sets the ampliture rate

var setAmplitudeRate ( var  amplitudeRate)
inline

sets the ampliture rate

local setAmplitudeRate ( local  amplitudeRate)
inline

sets the ampliture rate

virtual void update ( float  time)
overridevirtual

called once per frame.

time a value between 0 and 1

For example:

  • 0 means that the action just started
  • 0.5 means that the action is in the middle
  • 1 means that the action is over

Reimplemented from Action.

var update ( var  time)
overridevirtual

called once per frame.

time a value between 0 and 1

For example:

  • 0 means that the action just started
  • 0.5 means that the action is in the middle
  • 1 means that the action is over

Reimplemented from Action.

local update ( local  time)
overridevirtual

called once per frame.

time a value between 0 and 1

For example:

  • 0 means that the action just started
  • 0.5 means that the action is in the middle
  • 1 means that the action is over

Reimplemented from Action.

Member Data Documentation

float _amplitude
protected
var _amplitude
protected
local _amplitude
protected
float _amplitudeRate
protected
var _amplitudeRate
protected
local _amplitudeRate
protected
unsigned int _waves
protected
var _waves
protected
local _waves
protected

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