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

/*
 * cocos2d for iPhone: http://www.cocos2d-iphone.org
 *
 * 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 "CCNode.h"
#import "CCProtocols.h"
#import "CCTextureAtlas.h"

@class CCSpriteBatchNode;
@class CCSpriteFrame;
@class CCAnimation;

#pragma mark CCSprite

#define CCSpriteIndexNotInitialized 0xffffffff  /// CCSprite invalid index on the CCSpriteBatchode

typedef enum {
        CC_HONOR_PARENT_TRANSFORM_TRANSLATE =  1 << 0,
        CC_HONOR_PARENT_TRANSFORM_ROTATE        =  1 << 1,
        CC_HONOR_PARENT_TRANSFORM_SCALE         =  1 << 2,
        CC_HONOR_PARENT_TRANSFORM_SKEW          =  1 << 3,

        CC_HONOR_PARENT_TRANSFORM_ALL           =  CC_HONOR_PARENT_TRANSFORM_TRANSLATE | CC_HONOR_PARENT_TRANSFORM_ROTATE | CC_HONOR_PARENT_TRANSFORM_SCALE | CC_HONOR_PARENT_TRANSFORM_SKEW,

} ccHonorParentTransform;

@interface CCSprite : CCNode <CCRGBAProtocol, CCTextureProtocol>
{
        
        //
        // Data used when the sprite is rendered using a CCSpriteBatchNode
        //
        CCTextureAtlas                  *textureAtlas_;                 // Sprite Sheet texture atlas (weak reference)
        NSUInteger                              atlasIndex_;                    // Absolute (real) Index on the batch node
        CCSpriteBatchNode               *batchNode_;                    // Used batch node (weak reference)
        ccHonorParentTransform  honorParentTransform_;  // whether or not to transform according to its parent transformations
        BOOL                                    dirty_;                                 // Sprite needs to be updated
        BOOL                                    recursiveDirty_;                // Subchildren needs to be updated
        BOOL                                    hasChildren_;                   // optimization to check if it contain children
        
        //
        // Data used when the sprite is self-rendered
        //
        ccBlendFunc                             blendFunc_;                             // Needed for the texture protocol
        CCTexture2D                             *texture_;                              // Texture used to render the sprite

        //
        // Shared data
        //

        // whether or not it's parent is a CCSpriteBatchNode
        BOOL    usesBatchNode_;

        // texture
        CGRect  rect_;
        CGRect  rectInPixels_;
        BOOL    rectRotated_;
        
        // Offset Position (used by Zwoptex)
        CGPoint offsetPositionInPixels_;
        CGPoint unflippedOffsetPositionFromCenter_;

        // vertex coords, texture coords and color info
        ccV3F_C4B_T2F_Quad quad_;
        
        // opacity and RGB protocol
        GLubyte         opacity_;
        ccColor3B       color_;
        ccColor3B       colorUnmodified_;
        BOOL            opacityModifyRGB_;
        
        // image is flipped
        BOOL    flipX_;
        BOOL    flipY_;
        
        
        // Animations that belong to the sprite
        NSMutableDictionary *animations_;

@public
        // used internally.
        void (*updateMethod)(id, SEL);
}

@property (nonatomic,readwrite) BOOL dirty;
@property (nonatomic,readonly) ccV3F_C4B_T2F_Quad quad;
@property (nonatomic,readwrite) NSUInteger atlasIndex;
@property (nonatomic,readonly) CGRect textureRect;
@property (nonatomic,readonly) BOOL textureRectRotated;
@property (nonatomic,readwrite) BOOL flipX;
@property (nonatomic,readwrite) BOOL flipY;
@property (nonatomic,readwrite) GLubyte opacity;
@property (nonatomic,readwrite) ccColor3B color;
@property (nonatomic,readwrite) BOOL usesBatchNode;
@property (nonatomic,readwrite,assign) CCTextureAtlas *textureAtlas;
@property (nonatomic,readwrite,assign) CCSpriteBatchNode *batchNode;
@property (nonatomic,readwrite) ccHonorParentTransform honorParentTransform;
@property (nonatomic,readonly) CGPoint  offsetPositionInPixels;
@property (nonatomic,readwrite) ccBlendFunc blendFunc;

#pragma mark CCSprite - Initializers

+(id) spriteWithTexture:(CCTexture2D*)texture;

+(id) spriteWithTexture:(CCTexture2D*)texture rect:(CGRect)rect;

+(id) spriteWithSpriteFrame:(CCSpriteFrame*)spriteFrame;

+(id) spriteWithSpriteFrameName:(NSString*)spriteFrameName;

+(id) spriteWithFile:(NSString*)filename;

+(id) spriteWithFile:(NSString*)filename rect:(CGRect)rect;

+(id) spriteWithCGImage: (CGImageRef)image key:(NSString*)key;


+(id) spriteWithBatchNode:(CCSpriteBatchNode*)batchNode rect:(CGRect)rect;


-(id) initWithTexture:(CCTexture2D*)texture;

-(id) initWithTexture:(CCTexture2D*)texture rect:(CGRect)rect;

-(id) initWithSpriteFrame:(CCSpriteFrame*)spriteFrame;

-(id) initWithSpriteFrameName:(NSString*)spriteFrameName;

-(id) initWithFile:(NSString*)filename;

-(id) initWithFile:(NSString*)filename rect:(CGRect)rect;

-(id) initWithCGImage:(CGImageRef)image key:(NSString*)key;

-(id) initWithBatchNode:(CCSpriteBatchNode*)batchNode rect:(CGRect)rect;

-(id) initWithBatchNode:(CCSpriteBatchNode*)batchNode rectInPixels:(CGRect)rect;



#pragma mark CCSprite - BatchNode methods

-(void)updateTransform;

-(void) setTextureRect:(CGRect) rect;
-(void) setTextureRectInPixels:(CGRect)rect rotated:(BOOL)rotated untrimmedSize:(CGSize)size;

-(void) useSelfRender;

-(void) useBatchNode:(CCSpriteBatchNode*)batchNode;


#pragma mark CCSprite - Frames

-(void) setDisplayFrame:(CCSpriteFrame*)newFrame;

-(BOOL) isFrameDisplayed:(CCSpriteFrame*)frame;

-(CCSpriteFrame*) displayedFrame;

#pragma mark CCSprite - Animation

-(void) setDisplayFrame: (NSString*) animationName index:(int) frameIndex DEPRECATED_ATTRIBUTE;

-(void) setDisplayFrameWithAnimationName:(NSString*)animationName index:(int) frameIndex;

-(CCAnimation*)animationByName: (NSString*) animationName DEPRECATED_ATTRIBUTE;

-(void) addAnimation: (CCAnimation*) animation DEPRECATED_ATTRIBUTE;

@end