cocos2d-iphone  1.0.1
Improved Cocos2D API Reference (iOS version) for Kobold2D developers
Public Member Functions | Static Public Member Functions | Protected Attributes | Properties
CCNode Interface Reference

#include <CCNode.h>

+ Inheritance diagram for CCNode:
+ Collaboration diagram for CCNode:

List of all members.

Public Member Functions

id init ()
void onEnter ()
void onEnterTransitionDidFinish ()
void onExit ()
void addChild: (CCNode *node)
void addChild:z: (CCNode *node,[z] NSInteger z)
void addChild:z:tag: (CCNode *node,[z] NSInteger z,[tag] NSInteger tag)
void removeFromParentAndCleanup: (BOOL cleanup)
void removeChild:cleanup: (CCNode *node,[cleanup] BOOL cleanup)
void removeChildByTag:cleanup: (NSInteger tag,[cleanup] BOOL cleanup)
void removeAllChildrenWithCleanup: (BOOL cleanup)
CCNode * getChildByTag: (NSInteger tag)
void reorderChild:z: (CCNode *child,[z] NSInteger zOrder)
void cleanup ()
void draw ()
void visit ()
void transform ()
void transformAncestors ()
CGRect boundingBox ()
CGRect boundingBoxInPixels ()
CCAction * runAction: (CCAction *action)
void stopAllActions ()
void stopAction: (CCAction *action)
void stopActionByTag: (NSInteger tag)
CCAction * getActionByTag: (NSInteger tag)
NSUInteger numberOfRunningActions ()
void scheduleUpdate ()
void scheduleUpdateWithPriority: (NSInteger priority)
void unscheduleUpdate ()
void schedule: (SEL s)
void schedule:interval: (SEL s,[interval] ccTime seconds)
void unschedule: (SEL s)
void unscheduleAllSelectors ()
void resumeSchedulerAndActions ()
void pauseSchedulerAndActions ()
CGAffineTransform nodeToParentTransform ()
CGAffineTransform parentToNodeTransform ()
CGAffineTransform nodeToWorldTransform ()
CGAffineTransform worldToNodeTransform ()
CGPoint convertToNodeSpace: (CGPoint worldPoint)
CGPoint convertToWorldSpace: (CGPoint nodePoint)
CGPoint convertToNodeSpaceAR: (CGPoint worldPoint)
CGPoint convertToWorldSpaceAR: (CGPoint nodePoint)
CGPoint convertTouchToNodeSpace: (UITouch *touch)
CGPoint convertTouchToNodeSpaceAR: (UITouch *touch)

Static Public Member Functions

id node ()

Protected Attributes

float rotation_
float scaleX_
float scaleY_
CGPoint position_
CGPoint positionInPixels_
float skewX_
float skewY_
BOOL visible_
CGPoint anchorPointInPixels_
CGPoint anchorPoint_
BOOL isRelativeAnchorPoint_
CGSize contentSize_
CGSize contentSizeInPixels_
CGAffineTransform transform_
CGAffineTransform inverse_
GLfloat transformGL_ [16]
float vertexZ_
CCCamera * camera_
CCGridBase * grid_
NSInteger zOrder_
CCArray * children_
CCNode * parent_
NSInteger tag_
void * userData_
BOOL isRunning_
BOOL isTransformDirty_:1
BOOL isInverseDirty_:1
BOOL isTransformGLDirty_:1

Properties

NSInteger zOrder
float vertexZ
float skewX
float skewY
float rotation
float scale
float scaleX
float scaleY
CGPoint position
CGPoint positionInPixels
CCCamera * camera
CCArray * children
CCGridBase * grid
BOOL visible
CGPoint anchorPoint
CGPoint anchorPointInPixels
CGSize contentSize
CGSize contentSizeInPixels
BOOL isRunning
CCNode * parent
BOOL isRelativeAnchorPoint
NSInteger tag
void * userData

Detailed Description

CCNode is the main element. Anything thats gets drawn or contains things that get drawn is a CCNode. The most popular CCNodes are: CCScene, CCLayer, CCSprite, CCMenu.

The main features of a CCNode are:

  • They can contain other CCNode nodes (addChild, getChildByTag, removeChild, etc)
  • They can schedule periodic callback (schedule, unschedule, etc)
  • They can execute actions (runAction, stopAction, etc)

Some CCNode nodes provide extra functionality for them or their children.

Subclassing a CCNode usually means (one/all) of:

  • overriding init to initialize resources and schedule callbacks
  • create callbacks to handle the advancement of time
  • overriding draw to render the node

Features of CCNode:

  • position
  • scale (x, y)
  • rotation (in degrees, clockwise)
  • CCCamera (an interface to gluLookAt )
  • CCGridBase (to do mesh transformations)
  • anchor point
  • size
  • visible
  • z-order
  • openGL z position

Default values:

  • rotation: 0
  • position: (x=0,y=0)
  • scale: (x=1,y=1)
  • contentSize: (x=0,y=0)
  • anchorPoint: (x=0,y=0)

Limitations:

  • A CCNode is a "void" object. It doesn't have a texture

Order in transformations with grid disabled

  1. The node will be translated (position)
  2. The node will be rotated (rotation)
  3. The node will be scaled (scale)
  4. The node will be moved according to the camera values (camera)

Order in transformations with grid enabled

  1. The node will be translated (position)
  2. The node will be rotated (rotation)
  3. The node will be scaled (scale)
  4. The grid will capture the screen
  5. The node will be moved according to the camera values (camera)
  6. The grid will render the captured screen

Camera:

  • Each node has a camera. By default it points to the center of the CCNode.

Member Function Documentation

void CCNode::addChild: ( CCNode *  node) [virtual]

Adds a child to the container with z-order as 0. If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Since:
v0.7.1
void CCNode::addChild:z: ( CCNode *  node,
[z] NSInteger  z 
) [virtual]

Adds a child to the container with a z-order. If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Since:
v0.7.1
void CCNode::addChild:z:tag: ( CCNode *  node,
[z] NSInteger  z,
[tag] NSInteger  tag 
) [virtual]

Adds a child to the container with z order and tag. If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Since:
v0.7.1

Implemented in CCTMXLayer.

CGRect CCNode::boundingBox ( ) [virtual]

returns a "local" axis aligned bounding box of the node in points. The returned box is relative only to its parent. The returned box is in Points.

Since:
v0.8.2
CGRect CCNode::boundingBoxInPixels ( ) [virtual]

returns a "local" axis aligned bounding box of the node in pixels. The returned box is relative only to its parent. The returned box is in Points.

Since:
v0.99.5
void CCNode::cleanup ( ) [virtual]

Stops all running actions and schedulers

Since:
v0.8
CGPoint CCNode::convertToNodeSpace: ( CGPoint  worldPoint) [virtual]

Converts a Point to node (local) space coordinates. The result is in Points.

Since:
v0.7.1
CGPoint CCNode::convertToNodeSpaceAR: ( CGPoint  worldPoint) [virtual]

Converts a Point to node (local) space coordinates. The result is in Points. treating the returned/received node point as anchor relative.

Since:
v0.7.1
CGPoint CCNode::convertTouchToNodeSpace: ( UITouch *  touch) [virtual]

Converts a UITouch to node (local) space coordinates. The result is in Points.

Since:
v0.7.1
CGPoint CCNode::convertTouchToNodeSpaceAR: ( UITouch *  touch) [virtual]

Converts a UITouch to node (local) space coordinates. The result is in Points. This method is AR (Anchor Relative)..

Since:
v0.7.1
CGPoint CCNode::convertToWorldSpace: ( CGPoint  nodePoint) [virtual]

Converts a Point to world space coordinates. The result is in Points.

Since:
v0.7.1
CGPoint CCNode::convertToWorldSpaceAR: ( CGPoint  nodePoint) [virtual]

Converts a local Point to world space coordinates.The result is in Points. treating the returned/received node point as anchor relative.

Since:
v0.7.1
void CCNode::draw ( ) [virtual]

Override this method to draw your own node. The following GL states will be enabled by default:

  • glEnableClientState(GL_VERTEX_ARRAY);
  • glEnableClientState(GL_COLOR_ARRAY);
  • glEnableClientState(GL_TEXTURE_COORD_ARRAY);
  • glEnable(GL_TEXTURE_2D);

AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE

But if you enable any other GL state, you should disable it after drawing your node.

CCAction* CCNode::getActionByTag: ( NSInteger  tag) [virtual]

Gets an action from the running action list given its tag

Since:
v0.7.1
Returns:
the Action the with the given tag
CCNode* CCNode::getChildByTag: ( NSInteger  tag) [virtual]

Gets a child from the container given its tag

Returns:
returns a CCNode object
Since:
v0.7.1
id CCNode::init ( ) [virtual]

initializes the node

id CCNode::node ( ) [static, virtual]

allocates and initializes a node. The node will be created as "autorelease".

CGAffineTransform CCNode::nodeToParentTransform ( ) [virtual]

Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. The matrix is in Pixels.

Since:
v0.7.1
CGAffineTransform CCNode::nodeToWorldTransform ( ) [virtual]

Retrusn the world affine transform matrix. The matrix is in Pixels.

Since:
v0.7.1
NSUInteger CCNode::numberOfRunningActions ( ) [virtual]

Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). Composable actions are counted as 1 action. Example: If you are running 1 Sequence of 7 actions, it will return 1. If you are running 7 Sequences of 2 actions, it will return 7.

void CCNode::onEnter ( ) [virtual]

callback that is called every time the CCNode enters the 'stage'. If the CCNode enters the 'stage' with a transition, this callback is called when the transition starts. During onEnter you can't a "sister/brother" node.

void CCNode::onEnterTransitionDidFinish ( ) [virtual]

callback that is called when the CCNode enters in the 'stage'. If the CCNode enters the 'stage' with a transition, this callback is called when the transition finishes.

Since:
v0.8
void CCNode::onExit ( ) [virtual]

callback that is called every time the CCNode leaves the 'stage'. If the CCNode leaves the 'stage' with a transition, this callback is called when the transition finishes. During onExit you can't access a sibling node.

CGAffineTransform CCNode::parentToNodeTransform ( ) [virtual]

Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. The matrix is in Pixels.

Since:
v0.7.1
void CCNode::pauseSchedulerAndActions ( ) [virtual]

pauses all scheduled selectors and actions. Called internally by onExit

void CCNode::removeAllChildrenWithCleanup: ( BOOL  cleanup) [virtual]

Removes all children from the container and do a cleanup all running actions depending on the cleanup parameter.

Since:
v0.7.1
void CCNode::removeChild:cleanup: ( CCNode *  node,
[cleanup] BOOL  cleanup 
) [virtual]

Removes a child from the container. It will also cleanup all running actions depending on the cleanup parameter.

Since:
v0.7.1
void CCNode::removeChildByTag:cleanup: ( NSInteger  tag,
[cleanup] BOOL  cleanup 
) [virtual]

Removes a child from the container by tag value. It will also cleanup all running actions depending on the cleanup parameter

Since:
v0.7.1
void CCNode::removeFromParentAndCleanup: ( BOOL  cleanup) [virtual]

Remove itself from its parent node. If cleanup is YES, then also remove all actions and callbacks. If the node orphan, then nothing happens.

Since:
v0.99.3
void CCNode::reorderChild:z: ( CCNode *  child,
[z] NSInteger  zOrder 
) [virtual]

Reorders a child according to a new z value. The child MUST be already added.

void CCNode::resumeSchedulerAndActions ( ) [virtual]

resumes all scheduled selectors and actions. Called internally by onEnter

CCAction* CCNode::runAction: ( CCAction *  action) [virtual]

Executes an action, and returns the action that is executed. The node becomes the action's target.

Warning:
Starting from v0.8 actions don't retain their target anymore.
Since:
v0.7.1
Returns:
An Action pointer
void CCNode::schedule: ( SEL  s) [virtual]

schedules a selector. The scheduled selector will be ticked every frame

void CCNode::schedule:interval: ( SEL  s,
[interval] ccTime  seconds 
) [virtual]

schedules a custom selector with an interval time in seconds. If time is 0 it will be ticked every frame. If time is 0, it is recommended to use 'scheduleUpdate' instead.

If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

void CCNode::scheduleUpdate ( ) [virtual]

check whether a selector is scheduled. schedules the "update" method. It will use the order number 0. This method will be called every frame. Scheduled methods with a lower order value will be called before the ones that have a higher order value. Only one "udpate" method could be scheduled per node.

Since:
v0.99.3
void CCNode::scheduleUpdateWithPriority: ( NSInteger  priority) [virtual]

schedules the "update" selector with a custom priority. This selector will be called every frame. Scheduled selectors with a lower priority will be called before the ones that have a higher value. Only one "udpate" selector could be scheduled per node (You can't have 2 'update' selectors).

Since:
v0.99.3
void CCNode::stopAction: ( CCAction *  action) [virtual]

Removes an action from the running action list

void CCNode::stopActionByTag: ( NSInteger  tag) [virtual]

Removes an action from the running action list given its tag

Since:
v0.7.1
void CCNode::stopAllActions ( ) [virtual]

Removes all actions from the running action list

void CCNode::transform ( ) [virtual]

performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes.

void CCNode::transformAncestors ( ) [virtual]

performs OpenGL view-matrix transformation of it's ancestors. Generally the ancestors are already transformed, but in certain cases (eg: attaching a FBO) it's necessary to transform the ancestors again.

Since:
v0.7.2
void CCNode::unschedule: ( SEL  s) [virtual]

unschedules a custom selector.

void CCNode::unscheduleAllSelectors ( ) [virtual]

unschedule all scheduled selectors: custom selectors, and the 'update' selector. Actions are not affected by this method.

Since:
v0.99.3
void CCNode::visit ( ) [virtual]

recursive method that visit its children and draw them

CGAffineTransform CCNode::worldToNodeTransform ( ) [virtual]

Returns the inverse world affine transform matrix. The matrix is in Pixels.

Since:
v0.7.1

Property Documentation

CGPoint CCNode::anchorPoint [read, write, assign]

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0,0). It starts in the bottom-left corner. CCSprite and other subclasses have a different default anchorPoint.

Since:
v0.8
CGPoint CCNode::anchorPointInPixels [read, assign]

The anchorPoint in absolute pixels. Since v0.8 you can only read it. If you wish to modify it, use anchorPoint instead

CCCamera* CCNode::camera [read, assign]

A CCCamera object that lets you move the node using a gluLookAt

CCArray* CCNode::children [read, assign]

Array of children

CGSize CCNode::contentSize [read, write, assign]

The untransformed size of the node in Points The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Since:
v0.8
CGSize CCNode::contentSizeInPixels [read, write, assign]

The untransformed size of the node in Pixels The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Since:
v0.8
CCGridBase* CCNode::grid [read, write, retain]

A CCGrid object that is used when applying effects

BOOL CCNode::isRelativeAnchorPoint [read, write, assign]

If YES the transformtions will be relative to it's anchor point. Sprites, Labels and any other sizeble object use it have it enabled by default. Scenes, Layers and other "whole screen" object don't use it, have it disabled by default.

BOOL CCNode::isRunning [read, assign]

whether or not the node is running

CCNode* CCNode::parent [read, write, assign]

A weak reference to the parent

CGPoint CCNode::position [read, write, assign]

Position (x,y) of the node in points. (0,0) is the left-bottom corner.

CGPoint CCNode::positionInPixels [read, write, assign]

Position (x,y) of the node in points. (0,0) is the left-bottom corner.

float CCNode::rotation [read, write, assign]

The rotation (angle) of the node in degrees. 0 is the default rotation angle. Positive values rotate node CW.

float CCNode::scale [read, write, assign]

The scale factor of the node. 1.0 is the default scale factor. It modifies the X and Y scale at the same time.

float CCNode::scaleX [read, write, assign]

The scale factor of the node. 1.0 is the default scale factor. It only modifies the X scale factor.

float CCNode::scaleY [read, write, assign]

The scale factor of the node. 1.0 is the default scale factor. It only modifies the Y scale factor.

float CCNode::skewX [read, write, assign]

The X skew angle of the node in degrees. This angle describes the shear distortion in the X direction. Thus, it is the angle between the Y axis and the left edge of the shape The default skewX angle is 0. Positive values distort the node in a CW direction.

float CCNode::skewY [read, write, assign]

The Y skew angle of the node in degrees. This angle describes the shear distortion in the Y direction. Thus, it is the angle between the X axis and the bottom edge of the shape The default skewY angle is 0. Positive values distort the node in a CCW direction.

NSInteger CCNode::tag [read, write, assign]

A tag used to identify the node easily

void* CCNode::userData [read, write, assign]

A custom user data pointer

float CCNode::vertexZ [read, write, assign]

The real openGL Z vertex. Differences between openGL Z vertex and cocos2d Z order:

  • OpenGL Z modifies the Z vertex, and not the Z order in the relation between parent-children
  • OpenGL Z might require to set 2D projection
  • cocos2d Z order works OK if all the nodes uses the same openGL Z vertex. eg: vertexZ = 0
    Warning:
    : Use it at your own risk since it might break the cocos2d parent-children z order
    Since:
    v0.8
BOOL CCNode::visible [read, write, assign]

Whether of not the node is visible. Default is YES

NSInteger CCNode::zOrder [read, assign]

The z order of the node relative to it's "brothers": children of the same parent

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