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

Ripple3D action. More...

#include <CCActionGrid3D.h>

Inheritance diagram for Ripple3D:
Grid3DAction GridAction ActionInterval FiniteTimeAction Action Object Clonable

Public Member Functions

const PointgetPosition () const
 get center position More...
 
void setPosition (const Point &position)
 set center position More...
 
float getAmplitude () const
void setAmplitude (float fAmplitude)
float getAmplitudeRate () const
void setAmplitudeRate (float fAmplitudeRate)
virtual Ripple3Dclone () 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 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...
 
var startWithTarget ( var target)
 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...
 
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
float getDuration () const
 get duration in seconds of the action More...
 
var getDuration ()
 get duration in seconds of the action More...
 
local getDuration ()
 get duration in seconds of the action More...
 
void setDuration (float duration)
 set duration in seconds of the action More...
 
var setDuration ( var duration)
 set duration in seconds of the action More...
 
local setDuration ( local 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
var getTarget ()
local getTarget ()
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
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
var getTag ()
local getTag ()
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- 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...
 
unsigned int getReferenceCount () const
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 ()
Objectcopy () const
 returns a copy of the object. More...
 
var copy ()
 returns a copy of the object. More...
 
local copy ()
 returns a copy of the object. More...
 

Static Public Member Functions

static Ripple3Dcreate (float duration, const Size &gridSize, const Point &position, float radius, unsigned int waves, float amplitude)
 creates the action with radius, number of waves, amplitude, a grid size and duration More...
 

Protected Member Functions

 Ripple3D ()
virtual ~Ripple3D ()
bool initWithDuration (float duration, const Size &gridSize, const Point &position, float radius, unsigned int waves, float amplitude)
 initializes the action with radius, number of waves, amplitude, a grid size and duration More...
 

Protected Attributes

Point _position
float _radius
unsigned int _waves
float _amplitude
float _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

Ripple3D action.

Constructor & Destructor Documentation

Ripple3D ( )
inlineprotected
virtual ~Ripple3D ( )
inlineprotectedvirtual

Member Function Documentation

virtual Ripple3D* clone ( ) const
overridevirtual

returns a clone of action

Implements Grid3DAction.

static Ripple3D* create ( float  duration,
const Size gridSize,
const Point position,
float  radius,
unsigned int  waves,
float  amplitude 
)
static

creates the action with radius, number of waves, amplitude, a grid size and duration

float getAmplitude ( ) const
inline
float getAmplitudeRate ( void  ) const
inline
const Point& getPosition ( ) const
inline

get center position

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

initializes the action with radius, number of waves, amplitude, a grid size and duration

void setAmplitude ( float  fAmplitude)
inline
void setAmplitudeRate ( float  fAmplitudeRate)
inline
void setPosition ( const Point position)

set center position

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.

Member Data Documentation

float _amplitude
protected
float _amplitudeRate
protected
Point _position
protected
float _radius
protected
unsigned int _waves
protected

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