cocos2d-x  2.2.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
CCFollow Class Reference

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

#include <CCAction.h>

Inheritance diagram for CCFollow:
CCAction CCObject CCCopying

Public Member Functions

 CCFollow ()
virtual ~CCFollow (void)
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 CCObjectcopyWithZone (CCZone *pZone)
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 ()
 CCAction ()
virtual ~CCAction (void)
const char * description ()
virtual void startWithTarget (CCNode *pTarget)
 called before the action start. It will also set the target. More...
 
local startWithTarget ( local pTarget)
 called before the action start. It will also set the target. More...
 
virtual void update (float time)
 called once per frame. More...
 
local update ( local time)
 called once per frame. More...
 
CCNodegetTarget (void)
var getTarget ()
local getTarget ()
void setTarget (CCNode *pTarget)
 The action will modify the target properties. More...
 
local setTarget ( local pTarget)
 The action will modify the target properties. More...
 
CCNodegetOriginalTarget (void)
local getOriginalTarget ()
void setOriginalTarget (CCNode *pOriginalTarget)
 Set the original target, since target can be nil. More...
 
int getTag (void)
var getTag ()
local getTag ()
void setTag (int nTag)
var setTag ( var nTag)
local setTag ( local nTag)
- Public Member Functions inherited from CCObject
 CCObject (void)
virtual ~CCObject (void)
void release (void)
void retain (void)
CCObjectautorelease (void)
CCObjectcopy (void)
bool isSingleReference (void) const
unsigned int retainCount (void) const
virtual bool isEqual (const CCObject *pObject)
virtual void acceptVisitor (CCDataVisitor &visitor)

Static Public Member Functions

static CCFollowcreate (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 CCActioncreate ()
 Create an action. More...
 
var create ()
 Create an action. More...
 
local create ()
 Create an action. More...
 

Protected Attributes

CCNodem_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
CCNodem_pOriginalTarget
CCNodem_pTarget
 The "target". More...
 
local m_pTarget
 The "target". More...
 
int m_nTag
 The action tag. More...
 
- Protected Attributes inherited from CCObject
unsigned int m_uReference
unsigned int m_uAutoReleaseCount

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 ( )
inline
virtual ~CCFollow ( void  )
virtual

Member Function Documentation

virtual CCObject* copyWithZone ( CCZone pZone)
virtual

Reimplemented from CCAction.

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
rectis equal to CCRectZero.
bool initWithTarget ( CCNode pFollowedNode,
const CCRect rect = CCRectZero 
)

initializes the action with a set boundary

bool isBoundarySet ( void  )
inline
virtual bool isDone ( void  )
virtual

return true if the action has finished

Reimplemented from CCAction.

void setBoudarySet ( bool  bValue)
inline

alter behavior - turn on/off boundary

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.

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

bool m_bBoundaryFullyCovered
protected
bool m_bBoundarySet
protected
float m_fBottomBoundary
protected
float m_fLeftBoundary
protected
float m_fRightBoundary
protected
float m_fTopBoundary
protected
CCPoint m_obFullScreenSize
protected
CCPoint m_obHalfScreenSize
protected
CCNode* m_pobFollowedNode
protected

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