cocos2d-x  3.3
 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...
 
virtual Waves3Dclone () 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...
 
Vec3 getVertex (const Vec2 &position) const
 returns the vertex than belongs to certain position in the grid NA NA More...
 
Vec3 vertex (const Vec2 &position)
 
Vec3 getOriginalVertex (const Vec2 &position) const
 returns the non-transformed vertex than belongs to certain position in the grid NA NA More...
 
Vec3 originalVertex (const Vec2 &position)
 
void setVertex (const Vec2 &position, const Vec3 &vertex)
 sets a new vertex to a certain position of the grid NA NA More...
 
- Public Member Functions inherited from GridAction
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...
 
- 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...
 
- 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
 NA NA More...
 
virtual void stop ()
 called after the action has finished. More...
 
NodegetTarget () const
 
void setTarget (Node *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...
 
int getTag () const
 
void setTag (int tag)
 
virtual ~Action ()
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 NA NA More...
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
 NA NA More...
 
Refcopy () const
 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...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: Waves3D() {} virtual ~Waves3D() {} bool initWithDuration(float duration
 
CC_CONSTRUCTOR_ACCESS const SizegridSize
 
CC_CONSTRUCTOR_ACCESS const
Size unsigned int 
waves
 
CC_CONSTRUCTOR_ACCESS const
Size unsigned int float 
amplitude
 
- Public Attributes inherited from GridAction
CC_CONSTRUCTOR_ACCESS __pad0__: GridAction() {} virtual ~GridAction() {} bool initWithDuration(float duration
 
CC_CONSTRUCTOR_ACCESS const SizegridSize
 
- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __pad0__: bool initWithDuration(float d)
 
- Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
 
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()
 

Protected Attributes

unsigned int _waves
 
float _amplitude
 
float _amplitudeRate
 
- Protected Attributes inherited from GridAction
Size _gridSize
 
NodeGrid_gridNodeTarget
 
- Protected Attributes inherited from ActionInterval
float _elapsed
 
bool _firstTick
 
- Protected Attributes inherited from Action
Node_originalTarget
 
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 
- Protected Member Functions inherited from GridAction
void cacheTargetAsGridNode ()
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Detailed Description

Waves3D action.

Member Function Documentation

virtual Waves3D* clone ( ) const
overridevirtual

returns a clone of action

Reimplemented from 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

float getAmplitude ( ) const
inline

returns the amplitude of the effect

float getAmplitudeRate ( void  ) const
inline

returns the amplitude rate

void setAmplitude ( float  amplitude)
inline

sets the amplitude to the effect

void setAmplitudeRate ( float  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.

Member Data Documentation

float _amplitude
protected
float _amplitudeRate
protected
unsigned int _waves
protected
CC_CONSTRUCTOR_ACCESS const Size unsigned int float amplitude
CC_CONSTRUCTOR_ACCESS const Size& gridSize
CC_CONSTRUCTOR_ACCESS const Size unsigned int waves

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