/Users/rquesada/progs/cocos2d-iphone/cocos2d/CCNode.h

/*
 * cocos2d for iPhone: http://www.cocos2d-iphone.org
 *
 * Copyright (c) 2009 Valentin Milea
 *
 * Copyright (c) 2008-2010 Ricardo Quesada
 * Copyright (c) 2011 Zynga Inc.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#import <Availability.h>

#import "Platforms/CCGL.h"
#import "CCAction.h"
#import "ccTypes.h"
#import "CCTexture2D.h"
#import "CCProtocols.h"
#import "ccConfig.h"
#import "Support/CCArray.h"

enum {
        kCCNodeTagInvalid = -1,
};

@class CCCamera;
@class CCGridBase;

@interface CCNode : NSObject
{       
        // rotation angle
        float rotation_;        
        
        // scaling factors
        float scaleX_, scaleY_;
        
        // position of the node
        CGPoint position_;
        CGPoint positionInPixels_;
        
        // skew angles
        float skewX_, skewY_;

        // is visible
        BOOL visible_;
        
        // anchor point in pixels
        CGPoint anchorPointInPixels_;   
        // anchor point normalized
        CGPoint anchorPoint_;   
        // If YES the transformtions will be relative to (-transform.x, -transform.y).
        // Sprites, Labels and any other "small" object uses it.
        // Scenes, Layers and other "whole screen" object don't use it.
        BOOL isRelativeAnchorPoint_;
        
        // untransformed size of the node
        CGSize  contentSize_;
        CGSize  contentSizeInPixels_;
        
        // transform
        CGAffineTransform transform_, inverse_;
#if     CC_NODE_TRANSFORM_USING_AFFINE_MATRIX
        GLfloat transformGL_[16];
#endif

        // openGL real Z vertex
        float vertexZ_;
        
        // a Camera
        CCCamera *camera_;
        
        // a Grid
        CCGridBase *grid_;
        
        // z-order value
        NSInteger zOrder_;
        
        // array of children
        CCArray *children_;
        
        // weakref to parent
        CCNode *parent_;
        
        // a tag. any number you want to assign to the node
        NSInteger tag_;
    
        // user data field
        void *userData_;

        // Is running
        BOOL isRunning_;

        // To reduce memory, place BOOLs that are not properties here:
        BOOL isTransformDirty_:1;
        BOOL isInverseDirty_:1;
#if     CC_NODE_TRANSFORM_USING_AFFINE_MATRIX
        BOOL isTransformGLDirty_:1;
#endif
}

@property(nonatomic,readonly) NSInteger zOrder;
@property (nonatomic,readwrite) float vertexZ;

@property(nonatomic,readwrite,assign) float skewX;

@property(nonatomic,readwrite,assign) float skewY;
@property(nonatomic,readwrite,assign) float rotation;
@property(nonatomic,readwrite,assign) float scale;
@property(nonatomic,readwrite,assign) float scaleX;
@property(nonatomic,readwrite,assign) float scaleY;
@property(nonatomic,readwrite,assign) CGPoint position;
@property(nonatomic,readwrite,assign) CGPoint positionInPixels;
@property(nonatomic,readonly) CCCamera* camera;
@property(nonatomic,readonly) CCArray *children;
@property(nonatomic,readwrite,retain) CCGridBase* grid;
@property(nonatomic,readwrite,assign) BOOL visible;
@property(nonatomic,readwrite) CGPoint anchorPoint;
@property(nonatomic,readonly) CGPoint anchorPointInPixels;

@property (nonatomic,readwrite) CGSize contentSize;

@property (nonatomic,readwrite) CGSize contentSizeInPixels;

@property(nonatomic,readonly) BOOL isRunning;
@property(nonatomic,readwrite,assign) CCNode* parent;
@property(nonatomic,readwrite,assign) BOOL isRelativeAnchorPoint;
@property(nonatomic,readwrite,assign) NSInteger tag;
@property(nonatomic,readwrite,assign) void *userData;

// initializators
+(id) node;
-(id) init;


// scene managment

-(void) onEnter;
-(void) onEnterTransitionDidFinish;
-(void) onExit;


// composition: ADD

-(void) addChild: (CCNode*)node;

-(void) addChild: (CCNode*)node z:(NSInteger)z;

-(void) addChild: (CCNode*)node z:(NSInteger)z tag:(NSInteger)tag;

// composition: REMOVE

-(void) removeFromParentAndCleanup:(BOOL)cleanup;

-(void) removeChild: (CCNode*)node cleanup:(BOOL)cleanup;

-(void) removeChildByTag:(NSInteger) tag cleanup:(BOOL)cleanup;

-(void) removeAllChildrenWithCleanup:(BOOL)cleanup;

// composition: GET
-(CCNode*) getChildByTag:(NSInteger) tag;

-(void) reorderChild:(CCNode*)child z:(NSInteger)zOrder;

-(void) cleanup;

// draw

-(void) draw;
-(void) visit;

// transformations

-(void) transform;

-(void) transformAncestors;

- (CGRect) boundingBox;

- (CGRect) boundingBoxInPixels;


// actions

-(CCAction*) runAction: (CCAction*) action;
-(void) stopAllActions;
-(void) stopAction: (CCAction*) action;
-(void) stopActionByTag:(NSInteger) tag;
-(CCAction*) getActionByTag:(NSInteger) tag;
-(NSUInteger) numberOfRunningActions;

// timers

//-(BOOL) isScheduled: (SEL) selector;

-(void) scheduleUpdate;

-(void) scheduleUpdateWithPriority:(NSInteger)priority;

/* unschedules the "update" method.
 
 @since v0.99.3
 */
-(void) unscheduleUpdate;


-(void) schedule: (SEL) s;
-(void) schedule: (SEL) s interval:(ccTime)seconds;
-(void) unschedule: (SEL) s;

-(void) unscheduleAllSelectors;

-(void) resumeSchedulerAndActions;
-(void) pauseSchedulerAndActions;


// transformation methods

- (CGAffineTransform)nodeToParentTransform;
- (CGAffineTransform)parentToNodeTransform;
- (CGAffineTransform)nodeToWorldTransform;
- (CGAffineTransform)worldToNodeTransform;
- (CGPoint)convertToNodeSpace:(CGPoint)worldPoint;
- (CGPoint)convertToWorldSpace:(CGPoint)nodePoint;
- (CGPoint)convertToNodeSpaceAR:(CGPoint)worldPoint;
- (CGPoint)convertToWorldSpaceAR:(CGPoint)nodePoint;

#ifdef __IPHONE_OS_VERSION_MAX_ALLOWED

- (CGPoint)convertTouchToNodeSpace:(UITouch *)touch;
- (CGPoint)convertTouchToNodeSpaceAR:(UITouch *)touch;
#endif // __IPHONE_OS_VERSION_MAX_ALLOWED
@end