[devel] CCSpriteSheet renamed to CCBatchNode

cocos2d for iPhone » Programming » cocos2d internals

[devel] CCSpriteSheet renamed to CCBatchNode

(26 posts) (16 voices)

Started 1 year ago by riq
Latest reply from Diego R.

Tags:

riq
Key Master
Hi,

I'll probably rename the class CCSpriteSheet to CCBatchNode for v0.99.5
CCSpriteSheet will be deprecated and it will generate a compile warning.

Why ?
Because I think that CCSpriteSheet is confusing.
- You can still use sprite sheets without using the CCSpriteSheet class.
- Sometimes the term spritesheet is also used as a replacement of texture altas, but cocos2d already has a CCTextureAltas class
- The raison d'être of CCSpriteSheet is to create a single opengl batch, that's why I think CCBatchNode is a better name
What do you think ? Against ? For ? Why ? Do you have another name in mind ?
Posted 1 year ago #
Omegas7
Member

So whenever we call CCSpriteSheet we just say CCBatchNode?

Posted 1 year ago #
riq
Key Master

@Omeags7: Yes, just that

Posted 1 year ago #
araker
Moderator

I think the new name describes the functionality of the class better, so yes I'm for renaming.

Posted 1 year ago #
Joethemonkey101
On probation

Well yeah, it has a better name, but does that really matter? I'm sure most people are used to the name CCSpriteSheet, I know I am, and I haven't even known of cocos2d for more than 4 months.

Posted 1 year ago #
JonKean
Member

I like the idea of renaming it, although intuitively 'BatchNode' doesn't give clues to what it's used for (ie: what's batching? can it batch any kind of node?). Maybe SpriteBatch?

But as-is I think BatchNode > SpriteSheet

Posted 1 year ago #
mobilebros
Moderator

I sorta agree with @JonKean about the name.... but of course I have nothing better either... CCSharedTextureNode maybe?

Posted 1 year ago #
MikeSz
Member

I'm also for CCSpriteBatch, for a few reasons:

1) There can be a batch calls of other kinds than spritesheets

2) I think that Sprites and their batch class should share the CCSprite "prefix" - much less confusion that way

3) Just sounds better

Posted 1 year ago #
Clain
Member

I like CCBatchSprite and CCSpriteBatchNode. I think it's important that it ends with 'Sprite' or 'Node' because that would explain why we need to add it to the current scene/layer/node and then add the atlas sub-sprites to it.

Posted 1 year ago #
cybergreg
Member

@MikeSz +1 for CCSpriteBatch -> same reasons

I'm a cocos2d n00b and so far the naming convention has been one of the easiest things to pick up on, CCSpriteBatch seems a natural, but hey that's just me. :-]

Posted 1 year ago #
joew
Member

The "proper" name would be CCSpriteBatchNode if you wanted to match the verbose naming scheme currently used by Cocos2d

Posted 1 year ago #
MrMojo
Member
I think the Batch idea is pretty good... but maybe something like
```
CCRepeatedSprites 

CCRepeatSameSprites

CCRepeatIdenticalSpritesQuickly
```
might be something to consider.... Lots of newbies might not get "batch". These approaches push the idea of basic english language ability, which once again, may be better understood by the international crowd that uses Cocos2d....
Posted 1 year ago #
robodude666
Member

Best name ever: CCLotsOfSpritesInASingleImageNode. Agreed?

Otherwise... CCBatchNode is full of win. Makes much more sense. I've also realized I used Sprite Sheets wrong... Time to use the texture atlas class, as that's what I needed.

Posted 1 year ago #
MrMojo
Member

@robodude666 - very witty. thanks for your insightful commentary. please, continue your life... as a robot.

that having been said, for what it's worth, there were 3 names suggested, not just CCRepeatIdenticalSpritesQuickly ;-)

Posted 1 year ago #
CJ
Moderator

+1 for CCSpriteBatchNode

I'd also like to see a CCPrimitiveBatchNode added. I'll get around to making it myself eventually :)

Posted 1 year ago #
crmagicxxx
Member

+1 for CCSpriteBatchNode

@CJ I'd also like something easier for drawing primitives, not just batch draw of them. I always draw lines and dots for testing purposes and it would be nice if I don't have to pass everything to draw method...

Posted 1 year ago #
hactar
Member
To add my two cents, Im against changing the name:
- it breaks existing projects, fixable but annoying just for a small name adjustment
- it breaks existing documentation. And while some will be updated a lot will not, causing headaches for new developers
- spritesheet is a well known term in 2d programming, one that can easily be looked up using google if one has not heard it before. Batch mode on the other hand can mean anything, and will not help a new developer understand what its about.
Posted 1 year ago #
CJ
Moderator

@hactar I agree that spritesheet is well known, however you can use a sprite sheet (aka texture atlas) in cocos2d without drawing those sprites with a CCSpriteSheet (aka sprite batch draw node)

Perhaps an even longer name is appropriate:
CCSpriteBatchDrawNode

I'm not against radical changes pre 1.0 release. If you can't change things now, then it just becomes more and more difficult with time and maturity.

Posted 1 year ago #
hactar
Member

@cj I know you can, but should you? :)

Posted 1 year ago #
riq
Key Master

Thanks for the suggestions.

I also like CCSpriteBatchNode. I'll make that change.

I've just looked at cocos2d python source code we are using: BatchNode and BatchableNode... I can't remember the difference between those two. BatchNode if I remember correctly also has the limitation of only batching sprites.

I understand that "Batch" might sound weird for new comers, but as soon he/she starts reading the Apple documentation regarding best practices, the term "batch" will appear.

@hactar: you will be continue to use CCSpriteSheet until 1.0 or 1.1, but it will generate a compiler warning.

@CJ: CCPrimitivesBatchNode would be a very nice addition :)

Posted 1 year ago #
CJ
Moderator

@riq I have a CCPrimitive shape class that stores the points of a polygon as well as specific subclasses for circle, star, regular polygon, and rectangle. This is better than the current primitive drawing code because the data isn't created on the stack every draw call. Once I complete the batch drawing code I'll make a patch for you to integrate with the dev branch.

Posted 1 year ago #
riq
Key Master

@CJ thanks

Posted 1 year ago #
Joethemonkey101
On probation

I agree completely with @hactar's first post

Posted 1 year ago #
Diego R.
Member

Riq,

You included the deprecated directive, the problem is that I get warnings even after migrating to use the new name, because cocos code itsef references to the old APIs. Is there a way to warn the user only if he uses the old APIs?

Thanks!

Posted 1 year ago #
riq
Key Master

@boca_jrs: fixed. Could you try again with "develop" branch ? thanks.

I tested everything with LLVM, and it was compiling OK. It seems that GCC catches better the deprecation warnings.

Posted 1 year ago #
Diego R.
Member

Fixed, thanks!

Posted 1 year ago #

RSS feed for this topic

Reply

You must log in to post.