Stuck in v0.8.2 and want to use Zwoptex? Check here

cocos2d for iPhone » Programming » cocos2d support (graphics engine)

Stuck in v0.8.2 and want to use Zwoptex? Check here

(13 posts) (4 voices)

Started 1 year ago by itlgames
Latest reply from itlgames

Tags:

Hi, if you happen to be stuck on cocos2d v0.8.2 like me, and can't upgrade to latest versions 0.99.X for any reason (probably something wrong on our code), but still want to use Zwoptex to manage your sprite sheets, here it is a simple solution based on the CCSpriteFrameCache class on v0.99.3:

SpriteManager.h

#import "cocos2d.h"

@interface AtlasSpriteManager (SpriteManager) 

NSDictionary *frames;
int formatPlist; 

+(id)spriteManagerWithFile:(NSString*)fileImage plist:(NSString*)plist capacity:(NSUInteger)capacity;
+(id)spriteManagerWithFile:(NSString*) imageFile plist:(NSString*)plist;
+(void)createDictionaryFromPlist:(NSString*)plist;

-(AtlasSprite *)createSprite:(NSString*) imageFileName;

@end

SpriteManager.m:

#import "SpriteManager.h"

const int _defaultCapacity = 29;

@implementation AtlasSpriteManager (SpriteManager)

+(id)spriteManagerWithFile:(NSString*)fileImage plist:(NSString*)plist capacity:(NSUInteger)capacity
{
	[AtlasSpriteManager createDictionaryFromPlist:plist];
	return [[[AtlasSpriteManager alloc] initWithFile:fileImage capacity:capacity] autorelease];
}

+(id)spriteManagerWithFile:(NSString*) imageFile plist:(NSString*)plist
{
	[AtlasSpriteManager createDictionaryFromPlist:plist];
	return [[[AtlasSpriteManager alloc] initWithFile:imageFile capacity:_defaultCapacity] autorelease];
}

+(void)createDictionaryFromPlist:(NSString*)plist
{
	NSString *path = [[[NSBundle mainBundle] resourcePath] stringByAppendingPathComponent:plist];
	NSDictionary *dict = [NSDictionary dictionaryWithContentsOfFile:path];
	NSDictionary *metadataDict = [dict objectForKey:@"metadata"];

	// get the format
	if (metadataDict != nil) {
		formatPlist = [[metadataDict objectForKey:@"format"] intValue];
	} else {
		formatPlist = 0;
	}

	frames = [dict objectForKey:@"frames"];

	//NSLog(@"SpriteManager.spriteManagerWithFile: %@", frames);
}

-(AtlasSprite *)createSprite:(NSString*) imageFileName
{
	if(formatPlist == 0) {
		NSDictionary *properties = [frames objectForKey:imageFileName];
		float x = [[properties objectForKey:@"x"] floatValue];
		float y = [[properties objectForKey:@"y"] floatValue];
		float w = [[properties objectForKey:@"width"] floatValue];
		float h = [[properties objectForKey:@"height"] floatValue];
		float ox = [[properties objectForKey:@"offsetX"] floatValue];
		float oy = [[properties objectForKey:@"offsetY"] floatValue];
		//int ow = [[properties objectForKey:@"originalWidth"] intValue];
		//int oh = [[properties objectForKey:@"originalHeight"] intValue];
		//NSLog(@"SpriteManager.createSprite: %@", properties);

		AtlasSprite *sprite = [AtlasSprite spriteWithRect:CGRectMake(x + ox, y + oy, w, h) spriteManager:self];
		[self addChild:sprite];
		return sprite;

	} else if (formatPlist == 1) {
		NSDictionary *properties = [frames objectForKey:imageFileName];
		CGRect frame = CGRectFromString([properties objectForKey:@"frame"]);
		CGPoint offset = CGPointFromString([properties objectForKey:@"offset"]);
		//CGSize sourceSize = CGSizeFromString([properties objectForKey:@"sourceSize"]);

		frame.origin.x += offset.x;
		frame.origin.y += offset.y;

		AtlasSprite *sprite = [AtlasSprite spriteWithRect:frame spriteManager:self];
		[self addChild:sprite];
		return sprite;

	} else {
		NSAssert(NO,@"cocos2d: WARNING: format is not supported for SpriteManager");
		return nil;
	}

}

@end

To use it, easy:

AtlasSpriteManager *spriteManager = [AtlasSpriteManager spriteManagerWithFile:@"sprite_sheet.png" plist:@"sprite_sheet.plist"];
[self addChild:spriteManager z:1];
AtlasSprite *spriteAtlas = [spriteManager createSprite:@"file_name.png"];

Posted 1 year ago #

itlgames
Moderator

I just added the offsets as well, as I forgot, not 100% sure it's right to be honest, need to do some more testing, but I think it should be fine.

And in case you don't know Zwoptex, check here:
http://zwoptexapp.com/

Posted 1 year ago #

itlgames
Moderator

Umm, I may be wrong, but I think we can ignore the offset, definitively I dind't need it on my first tests:

SpriteManager.m:

#import "SpriteManager.h"

const int _defaultCapacity = 29;

@implementation AtlasSpriteManager (SpriteManager)

+(id)spriteManagerWithFile:(NSString*)fileImage plist:(NSString*)plist capacity:(NSUInteger)capacity
{
	[AtlasSpriteManager createDictionaryFromPlist:plist];
	return [[[AtlasSpriteManager alloc] initWithFile:fileImage capacity:capacity] autorelease];
}

+(id)spriteManagerWithFile:(NSString*) imageFile plist:(NSString*)plist
{
	[AtlasSpriteManager createDictionaryFromPlist:plist];
	return [[[AtlasSpriteManager alloc] initWithFile:imageFile capacity:_defaultCapacity] autorelease];
}

+(void)createDictionaryFromPlist:(NSString*)plist
{
	NSString *path = [[[NSBundle mainBundle] resourcePath] stringByAppendingPathComponent:plist];
	NSDictionary *dict = [NSDictionary dictionaryWithContentsOfFile:path];
	NSDictionary *metadataDict = [dict objectForKey:@"metadata"];

	// get the format
	if (metadataDict != nil) {
		formatPlist = [[metadataDict objectForKey:@"format"] intValue];
	} else {
		formatPlist = 0;
	}

	frames = [dict objectForKey:@"frames"];

	//NSLog(@"SpriteManager.spriteManagerWithFile: %@", frames);
}

-(AtlasSprite *)createSprite:(NSString*) imageFileName
{
	if(formatPlist == 0) {
		NSDictionary *properties = [frames objectForKey:imageFileName];
		float x = [[properties objectForKey:@"x"] floatValue];
		float y = [[properties objectForKey:@"y"] floatValue];
		float w = [[properties objectForKey:@"width"] floatValue];
		float h = [[properties objectForKey:@"height"] floatValue];
		//float ox = [[properties objectForKey:@"offsetX"] floatValue];
		//float oy = [[properties objectForKey:@"offsetY"] floatValue];
		//int ow = [[properties objectForKey:@"originalWidth"] intValue];
		//int oh = [[properties objectForKey:@"originalHeight"] intValue];
		//NSLog(@"SpriteManager.createSprite: %@", properties);

		//AtlasSprite *sprite = [AtlasSprite spriteWithRect:CGRectMake(x + ox, y + oy, w, h) spriteManager:self];
		AtlasSprite *sprite = [AtlasSprite spriteWithRect:CGRectMake(x, y, w, h) spriteManager:self];
		[self addChild:sprite];
		return sprite;

	} else if (formatPlist == 1) {
		NSDictionary *properties = [frames objectForKey:imageFileName];
		CGRect frame = CGRectFromString([properties objectForKey:@"frame"]);
		//CGPoint offset = CGPointFromString([properties objectForKey:@"offset"]);
		//CGSize sourceSize = CGSizeFromString([properties objectForKey:@"sourceSize"]);
		//frame.origin.x += offset.x;
		//frame.origin.y += offset.y;

		AtlasSprite *sprite = [AtlasSprite spriteWithRect:frame spriteManager:self];
		[self addChild:sprite];
		return sprite;

	} else {
		NSAssert(NO,@"cocos2d: WARNING: format is not supported for SpriteManager");
		return nil;
	}

}

@end

Posted 1 year ago #

itlgames
Moderator

Sorry, just to update we do need to use the offset and the original size as well, not sure yet how, tryign to figure out. Will psot update as soon as I am 100% sure. Or if anyone has an idea, please share!

Posted 1 year ago #
itlgames
Moderator

Ok, I figured out the problem, I need to draw the sprite on the x/y coordinates plus the x/y offsets. So I guess I need to create a category of Sprite again to add the offsets when drawing. It's actually what id does the CCSprite in v0.99.3 I think.

Posted 1 year ago #
itlgames
Moderator

Ok, found an easy solution, using Zwoptex just be sure before exporting the texture/coordinates, you untrim all images, select all images, then go to Modify > Untrim Selected Images.
Basically Zwoptex trim by default any 100% transparent border left on the images, and adds the offsets. If we untrim all images, then offsets will be zero, so we can just use the code I posted above. Remember use the updated SpriteManager.m on the third post, where we ignore the offsets.

Posted 1 year ago #
agorsky
Member

thanks
i try that now. I have same constraints, stucked in 0.82 and i updated to 0.99 but had lot of performance problems. So get back to 0.82.

Posted 1 year ago #
itlgames
Moderator

Cool, let me know if you have any problems.

Posted 1 year ago #

itlgames
Moderator

If anyone was using this class, I recommend update with following code, as it was preventing to use multiple sprite sheets, stupid me used a static class variable to store the frames, so here it goes the new update:

#import "cocos2d.h"

@interface SpriteManager : AtlasSpriteManager {
	int formatPlist;
	NSDictionary *frames;
}

+(id)spriteManagerWithFile:(NSString*)fileImage plist:(NSString*)plist capacity:(NSUInteger)capacity;
+(id)spriteManagerWithFile:(NSString*) imageFile plist:(NSString*)plist;
-(id)initWithFile:(NSString *)fileImage plist:(NSString*)plist capacity:(NSUInteger)capacity;
-(void)createDictionaryFromPlist:(NSString*)plist;

-(CGRect)createRectangle:(NSString*) imageFileName;
-(AtlasSprite *)createSprite:(NSString*) imageFileName className:(NSString *)className;

@end

#import "SpriteManager.h"

const int _defaultCapacity = 29;

@implementation SpriteManager

+(id)spriteManagerWithFile:(NSString*)imageFile plist:(NSString*)plist capacity:(NSUInteger)capacity
{
	return [[[SpriteManager alloc] initWithFile:imageFile plist:plist capacity:capacity] autorelease];
}

+(id)spriteManagerWithFile:(NSString*) imageFile plist:(NSString*)plist
{
	return [[[SpriteManager alloc] initWithFile:imageFile plist:plist capacity:_defaultCapacity] autorelease];
}

-(id)initWithFile:(NSString *)fileImage plist:(NSString*)plist capacity:(NSUInteger)capacity
{
	self = [super initWithFile:fileImage capacity:capacity];

	[self createDictionaryFromPlist:plist];

	return self;
}

-(void)createDictionaryFromPlist:(NSString*)plist
{
	NSString *path = [[[NSBundle mainBundle] resourcePath] stringByAppendingPathComponent:plist];
	NSDictionary *dict = [NSDictionary dictionaryWithContentsOfFile:path];
	NSDictionary *metadataDict = [dict objectForKey:@"metadata"];

	// get the format
	if (metadataDict != nil) {
		formatPlist = [[metadataDict objectForKey:@"format"] intValue];
	} else {
		formatPlist = 0;
	}

	frames = [[dict objectForKey:@"frames"] retain];

	//NSLog(@"SpriteManager.spriteManagerWithFile: %@", frames);
}

-(CGRect)createRectangle:(NSString*) imageFileName
{
	if(formatPlist == 0) {
		NSDictionary *properties = [frames objectForKey:imageFileName];
		//NSLog(@"SpriteManager.createSprite: %@", properties);

		float x = [[properties objectForKey:@"x"] floatValue];
		float y = [[properties objectForKey:@"y"] floatValue];
		float w = [[properties objectForKey:@"width"] floatValue];
		float h = [[properties objectForKey:@"height"] floatValue];
		//float ox = [[properties objectForKey:@"offsetX"] floatValue];
		//float oy = [[properties objectForKey:@"offsetY"] floatValue];
		//int ow = [[properties objectForKey:@"originalWidth"] intValue];
		//int oh = [[properties objectForKey:@"originalHeight"] intValue];

		return CGRectMake(x, y, w, h);

	} else if (formatPlist == 1) {
		NSDictionary *properties = [frames objectForKey:imageFileName];
		//NSLog(@"SpriteManager.createSprite: %@", properties);

		CGRect frame = CGRectFromString([properties objectForKey:@"frame"]);
		//CGPoint offset = CGPointFromString([properties objectForKey:@"offset"]);
		//CGSize sourceSize = CGSizeFromString([properties objectForKey:@"sourceSize"]);

		return frame;

	} else {
		NSAssert(NO,@"cocos2d: WARNING: format is not supported for SpriteManager");
		return CGRectMake(0, 0, 0, 0);
	}
}

-(AtlasSprite *)createSprite:(NSString*) imageFileName;
{
	return [AtlasSprite spriteWithRect:[self createRectangle:imageFileName] spriteManager:self];
}

-(void) dealloc {
	[frames release];
	[super dealloc];
}

@end

If any problems please let me know.

Posted 1 year ago #

Verisutha
Member

Not that I use 0.8.2, but I just wanted to point out that zwoptex also supports rotation.

I didn't see it in you code. Although i could have missed it, and it may be only in the purchased version that it supports rotation.

Posted 1 year ago #
itlgames
Moderator

Yeah, I'm stuck in 0.8.2 yet, will try to update at some point, but in the mean time I'm polishing/optimizing my game.
I was using the free online version of zwoptex, no rotation there.
But why do you think we need rotation? Maybe it's only me but I can't think of a good use of rotation on my sprite frames, whenever I need to reuse the same sprite frame in different orientation, I just flip/rotate in run time.

Posted 1 year ago #
huika
Member

I think the good use of the rotate feature in zwoptex is to be able to better use all the available space in the 1024x1024 texture. There are some sprites that are too much tall that would better fit if they were rotated.

I also use the free version, so I'm just imagining it's one of the useful things when using it.

See ya!

Posted 1 year ago #
itlgames
Moderator

ah yeah, makes sense then.

Posted 1 year ago #

RSS feed for this topic

Reply

You must log in to post.