From 9cd57b731ab1c666d4a1cb725538fdc137763d12 Mon Sep 17 00:00:00 2001 From: Starla Insigna Date: Sat, 30 Jul 2011 11:19:14 -0400 Subject: Initial commit (version 0.2.1) --- libs/cocos2d/CCSprite.h | 351 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 351 insertions(+) create mode 100755 libs/cocos2d/CCSprite.h (limited to 'libs/cocos2d/CCSprite.h') diff --git a/libs/cocos2d/CCSprite.h b/libs/cocos2d/CCSprite.h new file mode 100755 index 0000000..f01688e --- /dev/null +++ b/libs/cocos2d/CCSprite.h @@ -0,0 +1,351 @@ +/* + * 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 + +/** + Whether or not an CCSprite will rotate, scale or translate with it's parent. + Useful in health bars, when you want that the health bar translates with it's parent but you don't + want it to rotate with its parent. + @since v0.99.0 + */ +typedef enum { + //! Translate with it's parent + CC_HONOR_PARENT_TRANSFORM_TRANSLATE = 1 << 0, + //! Rotate with it's parent + CC_HONOR_PARENT_TRANSFORM_ROTATE = 1 << 1, + //! Scale with it's parent + CC_HONOR_PARENT_TRANSFORM_SCALE = 1 << 2, + //! Skew with it's parent + CC_HONOR_PARENT_TRANSFORM_SKEW = 1 << 3, + + //! All possible transformation enabled. Default value. + 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; + +/** CCSprite is a 2d image ( http://en.wikipedia.org/wiki/Sprite_(computer_graphics) ) + * + * CCSprite can be created with an image, or with a sub-rectangle of an image. + * + * If the parent or any of its ancestors is a CCSpriteBatchNode then the following features/limitations are valid + * - Features when the parent is a CCBatchNode: + * - MUCH faster rendering, specially if the CCSpriteBatchNode has many children. All the children will be drawn in a single batch. + * + * - Limitations + * - Camera is not supported yet (eg: CCOrbitCamera action doesn't work) + * - GridBase actions are not supported (eg: CCLens, CCRipple, CCTwirl) + * - The Alias/Antialias property belongs to CCSpriteBatchNode, so you can't individually set the aliased property. + * - The Blending function property belongs to CCSpriteBatchNode, so you can't individually set the blending function property. + * - Parallax scroller is not supported, but can be simulated with a "proxy" sprite. + * + * If the parent is an standard CCNode, then CCSprite behaves like any other CCNode: + * - It supports blending functions + * - It supports aliasing / antialiasing + * - But the rendering will be slower: 1 draw per children. + * + * The default anchorPoint in CCSprite is (0.5, 0.5). + */ +@interface CCSprite : CCNode +{ + + // + // 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); +} + +/** whether or not the Sprite needs to be updated in the Atlas */ +@property (nonatomic,readwrite) BOOL dirty; +/** the quad (tex coords, vertex coords and color) information */ +@property (nonatomic,readonly) ccV3F_C4B_T2F_Quad quad; +/** The index used on the TextureAtlas. Don't modify this value unless you know what you are doing */ +@property (nonatomic,readwrite) NSUInteger atlasIndex; +/** returns the rect of the CCSprite in points */ +@property (nonatomic,readonly) CGRect textureRect; +/** returns whether or not the texture rectangle is rotated */ +@property (nonatomic,readonly) BOOL textureRectRotated; +/** whether or not the sprite is flipped horizontally. + It only flips the texture of the sprite, and not the texture of the sprite's children. + Also, flipping the texture doesn't alter the anchorPoint. + If you want to flip the anchorPoint too, and/or to flip the children too use: + + sprite.scaleX *= -1; + */ +@property (nonatomic,readwrite) BOOL flipX; +/** whether or not the sprite is flipped vertically. + It only flips the texture of the sprite, and not the texture of the sprite's children. + Also, flipping the texture doesn't alter the anchorPoint. + If you want to flip the anchorPoint too, and/or to flip the children too use: + + sprite.scaleY *= -1; + */ +@property (nonatomic,readwrite) BOOL flipY; +/** opacity: conforms to CCRGBAProtocol protocol */ +@property (nonatomic,readwrite) GLubyte opacity; +/** RGB colors: conforms to CCRGBAProtocol protocol */ +@property (nonatomic,readwrite) ccColor3B color; +/** whether or not the Sprite is rendered using a CCSpriteBatchNode */ +@property (nonatomic,readwrite) BOOL usesBatchNode; +/** weak reference of the CCTextureAtlas used when the sprite is rendered using a CCSpriteBatchNode */ +@property (nonatomic,readwrite,assign) CCTextureAtlas *textureAtlas; +/** weak reference to the CCSpriteBatchNode that renders the CCSprite */ +@property (nonatomic,readwrite,assign) CCSpriteBatchNode *batchNode; +/** whether or not to transform according to its parent transfomrations. + Useful for health bars. eg: Don't rotate the health bar, even if the parent rotates. + IMPORTANT: Only valid if it is rendered using an CCSpriteBatchNode. + @since v0.99.0 + */ +@property (nonatomic,readwrite) ccHonorParentTransform honorParentTransform; +/** offset position in pixels of the sprite in points. Calculated automatically by editors like Zwoptex. + @since v0.99.0 + */ +@property (nonatomic,readonly) CGPoint offsetPositionInPixels; +/** conforms to CCTextureProtocol protocol */ +@property (nonatomic,readwrite) ccBlendFunc blendFunc; + +#pragma mark CCSprite - Initializers + +/** Creates an sprite with a texture. + The rect used will be the size of the texture. + The offset will be (0,0). + */ ++(id) spriteWithTexture:(CCTexture2D*)texture; + +/** Creates an sprite with a texture and a rect. + The offset will be (0,0). + */ ++(id) spriteWithTexture:(CCTexture2D*)texture rect:(CGRect)rect; + +/** Creates an sprite with an sprite frame. + */ ++(id) spriteWithSpriteFrame:(CCSpriteFrame*)spriteFrame; + +/** Creates an sprite with an sprite frame name. + An CCSpriteFrame will be fetched from the CCSpriteFrameCache by name. + If the CCSpriteFrame doesn't exist it will raise an exception. + @since v0.9 + */ ++(id) spriteWithSpriteFrameName:(NSString*)spriteFrameName; + +/** Creates an sprite with an image filename. + The rect used will be the size of the image. + The offset will be (0,0). + */ ++(id) spriteWithFile:(NSString*)filename; + +/** Creates an sprite with an image filename and a rect. + The offset will be (0,0). + */ ++(id) spriteWithFile:(NSString*)filename rect:(CGRect)rect; + +/** Creates an sprite with a CGImageRef and a key. + The key is used by the CCTextureCache to know if a texture was already created with this CGImage. + For example, a valid key is: @"sprite_frame_01". + If key is nil, then a new texture will be created each time by the CCTextureCache. + @since v0.99.0 + */ ++(id) spriteWithCGImage: (CGImageRef)image key:(NSString*)key; + + +/** Creates an sprite with an CCBatchNode and a rect + */ ++(id) spriteWithBatchNode:(CCSpriteBatchNode*)batchNode rect:(CGRect)rect; + + +/** Initializes an sprite with a texture. + The rect used will be the size of the texture. + The offset will be (0,0). + */ +-(id) initWithTexture:(CCTexture2D*)texture; + +/** Initializes an sprite with a texture and a rect in points. + The offset will be (0,0). + */ +-(id) initWithTexture:(CCTexture2D*)texture rect:(CGRect)rect; + +/** Initializes an sprite with an sprite frame. + */ +-(id) initWithSpriteFrame:(CCSpriteFrame*)spriteFrame; + +/** Initializes an sprite with an sprite frame name. + An CCSpriteFrame will be fetched from the CCSpriteFrameCache by name. + If the CCSpriteFrame doesn't exist it will raise an exception. + @since v0.9 + */ +-(id) initWithSpriteFrameName:(NSString*)spriteFrameName; + +/** Initializes an sprite with an image filename. + The rect used will be the size of the image. + The offset will be (0,0). + */ +-(id) initWithFile:(NSString*)filename; + +/** Initializes an sprite with an image filename, and a rect. + The offset will be (0,0). + */ +-(id) initWithFile:(NSString*)filename rect:(CGRect)rect; + +/** Initializes an sprite with a CGImageRef and a key + The key is used by the CCTextureCache to know if a texture was already created with this CGImage. + For example, a valid key is: @"sprite_frame_01". + If key is nil, then a new texture will be created each time by the CCTextureCache. + @since v0.99.0 + */ +-(id) initWithCGImage:(CGImageRef)image key:(NSString*)key; + +/** Initializes an sprite with an CCSpriteBatchNode and a rect in points + */ +-(id) initWithBatchNode:(CCSpriteBatchNode*)batchNode rect:(CGRect)rect; + +/** Initializes an sprite with an CCSpriteBatchNode and a rect in pixels + @since v0.99.5 + */ +-(id) initWithBatchNode:(CCSpriteBatchNode*)batchNode rectInPixels:(CGRect)rect; + + + +#pragma mark CCSprite - BatchNode methods + +/** updates the quad according the the rotation, position, scale values. + */ +-(void)updateTransform; + +/** updates the texture rect of the CCSprite in points. + */ +-(void) setTextureRect:(CGRect) rect; +/** updates the texture rect, rectRotated and untrimmed size of the CCSprite in pixels + */ +-(void) setTextureRectInPixels:(CGRect)rect rotated:(BOOL)rotated untrimmedSize:(CGSize)size; + +/** tell the sprite to use self-render. + @since v0.99.0 + */ +-(void) useSelfRender; + +/** tell the sprite to use sprite batch node + @since v0.99.0 + */ +-(void) useBatchNode:(CCSpriteBatchNode*)batchNode; + + +#pragma mark CCSprite - Frames + +/** sets a new display frame to the CCSprite. */ +-(void) setDisplayFrame:(CCSpriteFrame*)newFrame; + +/** returns whether or not a CCSpriteFrame is being displayed */ +-(BOOL) isFrameDisplayed:(CCSpriteFrame*)frame; + +/** returns the current displayed frame. */ +-(CCSpriteFrame*) displayedFrame; + +#pragma mark CCSprite - Animation + +/** changes the display frame based on an animation and an index. + @deprecated Will be removed in 1.0.1. Use setDisplayFrameWithAnimationName:index instead + */ +-(void) setDisplayFrame: (NSString*) animationName index:(int) frameIndex DEPRECATED_ATTRIBUTE; + +/** changes the display frame with animation name and index. + The animation name will be get from the CCAnimationCache + @since v0.99.5 + */ +-(void) setDisplayFrameWithAnimationName:(NSString*)animationName index:(int) frameIndex; + +/** returns an Animation given it's name. + + @deprecated Use CCAnimationCache instead. Will be removed in 1.0.1 + */ +-(CCAnimation*)animationByName: (NSString*) animationName DEPRECATED_ATTRIBUTE; + +/** adds an Animation to the Sprite. + + @deprecated Use CCAnimationCache instead. Will be removed in 1.0.1 + */ +-(void) addAnimation: (CCAnimation*) animation DEPRECATED_ATTRIBUTE; + +@end -- cgit 1.4.1