#import <CCSprite.h>
Inherits CCNode, CCRGBAProtocol-p, and CCTextureProtocol-p.
Inherited by CCLabel.
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 CCSpriteSheet then the following features/limitations are valid
If the parent is an standard CCNode, then CCSprite behaves like any other CCNode:
Definition at line 82 of file CCSprite.h.
| - (void) addAnimation: | (CCAnimation *) | animation |
adds an Animation to the Sprite.
| - (CCAnimation*) animationByName: | (NSString *) | animationName |
returns an Animation given it's name.
| - (CCSpriteFrame*) displayedFrame |
returns the current displayed frame.
| - (id) initWithCGImage: | (CGImageRef) | DEPRECATED_ATTRIBUTE |
Initializes an sprite with a CGImageRef
| - (id) initWithCGImage: | (CGImageRef) | image | ||
| key: | (NSString *) | key | ||
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.
| - (id) initWithFile: | (NSString *) | filename |
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 | ||
| rect: | (CGRect) | rect | ||
Initializes an sprite with an image filename, and a rect. The offset will be (0,0).
| - (id) initWithSpriteFrame: | (CCSpriteFrame *) | spriteFrame |
Initializes an sprite with an sprite frame.
| - (id) initWithSpriteFrameName: | (NSString *) | spriteFrameName |
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.
| - (id) initWithSpriteSheet: | (CCSpriteSheet *) | spritesheet | ||
| rect: | (CGRect) | rect | ||
Initializes an sprite with an CCSpriteSheet and a rect
| - (id) initWithTexture: | (CCTexture2D *) | texture |
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 | ||
| rect: | (CGRect) | rect | ||
Initializes an sprite with a texture and a rect. The offset will be (0,0).
| - (BOOL) isFrameDisplayed: | (CCSpriteFrame *) | frame |
returns whether or not a CCSpriteFrame is being displayed
| - (void) setDisplayFrame: | (CCSpriteFrame *) | newFrame |
sets a new display frame to the CCSprite.
| - (void) setDisplayFrame: | (NSString *) | animationName | ||
| index: | (int) | frameIndex | ||
changes the display frame based on an animation and an index.
| - (void) setTextureRect: | (CGRect) | rect |
updates the texture rect of the CCSprite.
| + (id) spriteWithCGImage: | (CGImageRef) | DEPRECATED_ATTRIBUTE |
Creates an sprite with a CGImageRef.
| + (id) spriteWithCGImage: | (CGImageRef) | image | ||
| key: | (NSString *) | key | ||
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.
| + (id) spriteWithFile: | (NSString *) | filename |
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 | ||
| rect: | (CGRect) | rect | ||
Creates an sprite with an image filename and a rect. The offset will be (0,0).
| + (id) spriteWithSpriteFrame: | (CCSpriteFrame *) | spriteFrame |
Creates an sprite with an sprite frame.
| + (id) spriteWithSpriteFrameName: | (NSString *) | spriteFrameName |
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.
| + (id) spriteWithSpriteSheet: | (CCSpriteSheet *) | spritesheet | ||
| rect: | (CGRect) | rect | ||
Creates an sprite with an CCSpriteSheet and a rect
| + (id) spriteWithTexture: | (CCTexture2D *) | texture |
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 | ||
| rect: | (CGRect) | rect | ||
Creates an sprite with a texture and a rect. The offset will be (0,0).
| + (id) spriteWithTexture: | (CCTexture2D *) | texture | ||
| rect: | (CGRect) | rect | ||
| offset: | (CGPoint) | offset | ||
Creates an sprite with a texture, a rect and offset.
| - (void) updateTransform |
updates the quad according the the rotation, position, scale values.
| - (void) useSelfRender |
tell the sprite to use self-render.
| - (void) useSpriteSheetRender: | (CCSpriteSheet *) | spriteSheet |
tell the sprite to use sprite sheet render.
- (NSUInteger) atlasIndex [read, write, assign] |
The index used on the TextureATlas. Don't modify this value unless you know what you are doing
Definition at line 140 of file CCSprite.h.
- (ccBlendFunc) blendFunc [read, write, assign] |
conforms to CCTextureProtocol protocol
Definition at line 180 of file CCSprite.h.
- (ccColor3B) color [read, write, assign] |
RGB colors: conforms to CCRGBAProtocol protocol
Definition at line 162 of file CCSprite.h.
- (BOOL) dirty [read, write, assign] |
whether or not the Sprite needs to be updated in the Atlas
Definition at line 136 of file CCSprite.h.
- (BOOL) flipX [read, write, assign] |
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;
Definition at line 150 of file CCSprite.h.
- (BOOL) flipY [read, write, assign] |
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;
Definition at line 158 of file CCSprite.h.
- (ccHonorParentTransform) honorParentTransform [read, write, assign] |
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 CCSpriteSheet.
Definition at line 174 of file CCSprite.h.
- (CGPoint) offsetPosition [read, assign] |
offset position of the sprite. Calculated automatically by editors like Zwoptex.
Definition at line 178 of file CCSprite.h.
- (GLubyte) opacity [read, write, assign] |
opacity: conforms to CCRGBAProtocol protocol
Definition at line 160 of file CCSprite.h.
- (ccV3F_C4B_T2F_Quad) quad [read, assign] |
the quad (tex coords, vertex coords and color) information
Definition at line 138 of file CCSprite.h.
- (CCSpriteSheet*) spriteSheet [read, write, assign] |
weak reference to the CCSpriteSheet that renders the CCSprite
Definition at line 168 of file CCSprite.h.
- (CCTextureAtlas*) textureAtlas [read, write, assign] |
weak reference of the CCTextureAtlas used when the sprite is rendered using a CCSpriteSheet
Definition at line 166 of file CCSprite.h.
- (CGRect) textureRect [read, assign] |
returns the rect of the CCSprite
Definition at line 142 of file CCSprite.h.
- (BOOL) usesSpriteSheet [read, write, assign] |
whether or not the Sprite is rendered using a CCSpriteSheet
Definition at line 164 of file CCSprite.h.
