CCWaves3D Class Reference

CCWaves3D action. More...

#include <CCActionGrid3D.h>

Inheritance diagram for CCWaves3D:

Public Member Functions
float	getAmplitude (void)
void	setAmplitude (float fAmplitude)
float	getAmplitudeRate (void)
void	setAmplitudeRate (float fAmplitudeRate)
bool	initWithDuration (float duration, const CCSize &gridSize, unsigned int waves, float amplitude)
	initializes an action with duration, grid size, waves and amplitude
virtual CCObject *	copyWithZone (CCZone *pZone)
virtual void	update (float time)
	called once per frame.
Public Member Functions inherited from CCGrid3DAction
virtual CCGridBase *	getGrid (void)
	returns the grid
ccVertex3F	vertex (const CCPoint &position)
	returns the vertex than belongs to certain position in the grid
ccVertex3F	originalVertex (const CCPoint &position)
	returns the non-transformed vertex than belongs to certain position in the grid
void	setVertex (const CCPoint &position, const ccVertex3F &vertex)
	sets a new vertex to a certain position of the grid
Public Member Functions inherited from CCGridAction
virtual void	startWithTarget (CCNode *pTarget)
	called before the action start. It will also set the target.
virtual CCActionInterval *	reverse (void)
	returns a reversed action
virtual bool	initWithDuration (float duration, const CCSize &gridSize)
	initializes the action with size and duration
Public Member Functions inherited from CCActionInterval
float	getElapsed (void)
	how many seconds had elapsed since the actions started to run.
bool	initWithDuration (float d)
	initializes the action
virtual bool	isDone (void)
	returns true if the action has finished
virtual void	step (float dt)
	called every frame with it's delta time. DON'T override unless you know what you are doing.
void	setAmplitudeRate (float amp)
float	getAmplitudeRate (void)
Public Member Functions inherited from CCFiniteTimeAction
	CCFiniteTimeAction ()
virtual	~CCFiniteTimeAction ()
float	getDuration (void)
	get duration in seconds of the action
void	setDuration (float duration)
	set duration in seconds of the action
Public Member Functions inherited from CCAction
	CCAction (void)
virtual	~CCAction (void)
const char *	description ()
virtual void	stop (void)
	called after the action has finished.
CCNode *	getTarget (void)
void	setTarget (CCNode *pTarget)
	The action will modify the target properties.
CCNode *	getOriginalTarget (void)
void	setOriginalTarget (CCNode *pOriginalTarget)
	Set the original target, since target can be nil.
int	getTag (void)
void	setTag (int nTag)
Public Member Functions inherited from CCObject
	CCObject (void)
virtual	~CCObject (void)
void	release (void)
void	retain (void)
CCObject *	autorelease (void)
CCObject *	copy (void)
bool	isSingleReference (void)
unsigned int	retainCount (void)
virtual bool	isEqual (const CCObject *pObject)

Static Public Member Functions
static CCWaves3D *	create (float duration, const CCSize &gridSize, unsigned int waves, float amplitude)
	creates an action with duration, grid size, waves and amplitude
Static Public Member Functions inherited from CCGrid3DAction
static CCGrid3DAction *	create (float duration, const CCSize &gridSize)
	creates the action with size and duration
Static Public Member Functions inherited from CCGridAction
static CCGridAction *	create (float duration, const CCSize &gridSize)
Static Public Member Functions inherited from CCActionInterval
static CCActionInterval *	create (float d)
	creates the action

Protected Attributes
unsigned int	m_nWaves
float	m_fAmplitude
float	m_fAmplitudeRate

Additional Inherited Members
Public Attributes inherited from CCObject
unsigned int	m_uID
int	m_nLuaID

Detailed Description

CCWaves3D action.

Member Function Documentation

virtual CCObject* copyWithZone ( CCZone *  pZone )

virtual

Reimplemented from CCGridAction.

static CCWaves3D* create ( float  duration, const CCSize &  gridSize, unsigned int  waves, float  amplitude  )

static

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

float getAmplitude ( void  )

inline

float getAmplitudeRate ( void  )

inline

bool initWithDuration	(	float	duration,
		const CCSize &	gridSize,
		unsigned int	waves,
		float	amplitude
	)

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

void setAmplitude ( float  fAmplitude )

inline

void setAmplitudeRate ( float  fAmplitudeRate )

inline

virtual void update ( float  time )

virtual

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 CCAction.

Member Data Documentation

float m_fAmplitude

protected

float m_fAmplitudeRate

protected

unsigned int m_nWaves

protected

---

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

• /Users/zhangkoumyou/SourceCode/cocos2d-x/cocos2dx/actions/CCActionGrid3D.h