CCFollow Class Reference

CCFollow is an action that "follows" a node. More...

#include <CCAction.h>

Inheritance diagram for CCFollow:

Collaboration diagram for CCFollow:

Public Member Functions
	CCFollow ()
	ctor More...
virtual	~CCFollow (void)
	NA NA. More...
bool	isBoundarySet (void)
void	setBoudarySet (bool bValue)
	alter behavior - turn on/off boundary More...
bool	initWithTarget (CCNode *pFollowedNode, const CCRect &rect=CCRectZero)
	initializes the action with a set boundary More...
virtual CCObject *	copyWithZone (CCZone *pZone)
	NA NA. More...
virtual void	step (float dt)
	called every frame with it's delta time. DON'T override unless you know what you are doing. More...
virtual bool	isDone (void)
	return true if the action has finished More...
virtual void	stop (void)
	called after the action has finished. More...
Public Member Functions inherited from CCAction
	CCAction (void)
	ctor More...
virtual	~CCAction (void)
	NA NA. More...
const char *	description ()
	NA NA. More...
virtual CCObject *	copyWithZone (CCZone *pZone)
	NA NA. More...
virtual bool	isDone (void)
	return true if the action has finished More...
virtual void	startWithTarget (CCNode *pTarget)
	called before the action start. It will also set the target. More...
virtual void	stop (void)
	called after the action has finished. More...
virtual void	step (float dt)
	called every frame with it's delta time. DON'T override unless you know what you are doing. More...
virtual void	update (float time)
	called once per frame. More...
CCNode *	getTarget (void)
void	setTarget (CCNode *pTarget)
	The action will modify the target properties. More...
CCNode *	getOriginalTarget (void)
void	setOriginalTarget (CCNode *pOriginalTarget)
	Set the original target, since target can be nil. More...
int	getTag (void)
void	setTag (int nTag)
void	setSpeedMod (float mod)
Public Member Functions inherited from CCObject
	CCObject (void)
virtual	~CCObject (void)
	NA. More...
void	release (void)
void	retain (void)
CCObject *	autorelease (void)
CCObject *	copy (void)
bool	isSingleReference (void) const
unsigned int	retainCount (void) const
virtual bool	isEqual (const CCObject *pObject)
virtual void	acceptVisitor (CCDataVisitor &visitor)
virtual void	update (float dt)
	CCObject (const CCObject &)
CCObject &	operator= (const CCObject &)
virtual void	encodeWithCoder (DS_Dictionary *)
virtual bool	canEncode ()
CCObjectType	getObjType () const
void	setObjType (CCObjectType)
virtual CCObject *	copyWithZone (CCZone *pZone)

Static Public Member Functions
static CCFollow *	create (CCNode *pFollowedNode, const CCRect &rect=CCRectZero)
	creates the action with a set boundary, It will work with no boundary if More...
Static Public Member Functions inherited from CCAction
static CCAction *	create ()
	Create an action. More...
Static Public Member Functions inherited from CCObject
static CCObject *	createWithCoder (DS_Dictionary *)

Protected Attributes
CCNode *	m_pobFollowedNode
bool	m_bBoundarySet
bool	m_bBoundaryFullyCovered
CCPoint	m_obHalfScreenSize
CCPoint	m_obFullScreenSize
float	m_fLeftBoundary
float	m_fRightBoundary
float	m_fTopBoundary
float	m_fBottomBoundary
Protected Attributes inherited from CCAction
CCNode *	m_pOriginalTarget
CCNode *	m_pTarget
	The "target". More...
int	m_nTag
	The action tag. More...
float	m_fSpeedMod
Protected Attributes inherited from CCObject
unsigned int	m_uReference
unsigned int	m_uAutoReleaseCount
int	m_nTag
int	m_eObjType
unsigned int	m_uObjectIdxInArray

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

Detailed Description

CCFollow is an action that "follows" a node.

Eg: layer->runAction(CCFollow::actionWithTarget(hero));

Instead of using CCCamera as a "follower", use this action instead.

Since

v0.99.2

Constructor & Destructor Documentation

CCFollow()

CCFollow ( )

inline

ctor

~CCFollow()

virtual ~CCFollow ( void  )

virtual

NA NA.

Member Function Documentation

copyWithZone()

virtual CCObject * copyWithZone ( CCZone *  pZone )

virtual

NA NA.

Reimplemented from CCAction.

create()

static CCFollow * create ( CCNode *  pFollowedNode, const CCRect &  rect = CCRectZero  )

static

creates the action with a set boundary, It will work with no boundary if

Parameters

rect	is equal to CCRectZero.

initWithTarget()

bool initWithTarget	(	CCNode *	pFollowedNode,
		const CCRect &	rect = CCRectZero
	)

initializes the action with a set boundary

isBoundarySet()

bool isBoundarySet ( void  )

inline

isDone()

virtual bool isDone ( void  )

virtual

return true if the action has finished

Reimplemented from CCAction.

setBoudarySet()

void setBoudarySet ( bool  bValue )

inline

alter behavior - turn on/off boundary

step()

virtual void step ( float  dt )

virtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

Reimplemented from CCAction.

stop()

virtual void stop ( void  )

virtual

called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "[action stop]" manually. Instead, use: "target->stopAction(action);"

Reimplemented from CCAction.

Member Data Documentation

m_bBoundaryFullyCovered

bool m_bBoundaryFullyCovered

protected

m_bBoundarySet

bool m_bBoundarySet

protected

m_fBottomBoundary

float m_fBottomBoundary

protected

m_fLeftBoundary

float m_fLeftBoundary

protected

m_fRightBoundary

float m_fRightBoundary

protected

m_fTopBoundary

float m_fTopBoundary

protected

m_obFullScreenSize

CCPoint m_obFullScreenSize

protected

m_obHalfScreenSize

CCPoint m_obHalfScreenSize

protected

m_pobFollowedNode

CCNode* m_pobFollowedNode

protected

---

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

• /home/runner/work/cocos-headers/cocos-headers/cocos2dx/actions/CCAction.h