cocos2d-x  3.0-alpha0
 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 Object Clonable

Public Member Functions

float getAmplitude (void) const
 returns the amplitude of the effect More...
 
void setAmplitude (float fAmplitude)
 sets the amplitude to the effect More...
 
float getAmplitudeRate (void) const
 returns the amplitude rate More...
 
void setAmplitudeRate (float fAmplitudeRate)
 sets the ampliture rate More...
 
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...
 
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 (void)
 returns the grid More...
 
local getGrid ()
 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
bool initWithDuration (float duration, const Size &gridSize)
 initializes the action with size and duration More...
 
var initWithDuration ( var duration, var gridSize)
 initializes the action with size and duration More...
 
local initWithDuration ( local duration, local gridSize)
 initializes the action with size and duration More...
 
virtual GridActionreverse () const override
 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...
 
local startWithTarget ( local target)
 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...
 
local getElapsed ()
 how many seconds had elapsed since the actions started to run. More...
 
bool initWithDuration (float d)
 initializes the action More...
 
var initWithDuration ( var d)
 initializes the action More...
 
local initWithDuration ( local d)
 initializes the action More...
 
void setAmplitudeRate (float amp)
float getAmplitudeRate (void)
virtual bool isDone (void) const override
 return true if the action has finished More...
 
var isDone ()
 return true if the action has finished More...
 
local isDone ()
 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
 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
float getDuration (void) 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
 Action (void)
 ctor ()
 Action ()
virtual ~Action (void)
const char * description () const
virtual void stop (void)
 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 (void) const
void setTarget (Node *target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget (void) const
local getOriginalTarget ()
void setOriginalTarget (Node *pOriginalTarget)
 Set the original target, since target can be nil. More...
 
int getTag (void) const
void setTag (int nTag)
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
CC_DEPRECATED_ATTRIBUTE Objectcopy () const
 returns a copy of the object. More...
 
local copy ()
 returns a copy of the object. 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...
 

Protected Attributes

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

Additional Inherited Members

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 
- 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.

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 ( void  ) 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 
)

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

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

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

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

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

void setAmplitude ( float  fAmplitude)
inline

sets the amplitude to the effect

var setAmplitude ( var  fAmplitude)
inline

sets the amplitude to the effect

local setAmplitude ( local  fAmplitude)
inline

sets the amplitude to the effect

void setAmplitudeRate ( float  fAmplitudeRate)
inline

sets the ampliture rate

var setAmplitudeRate ( var  fAmplitudeRate)
inline

sets the ampliture rate

local setAmplitudeRate ( local  fAmplitudeRate)
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: