mirror/aseprite
1
0
Fork 0
mirror of https://github.com/aseprite/aseprite.git synced 2025-03-29 19:20:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor comments in code and .aseprite specs about user data for tags

Browse Source
This commit is contained in:
David Capello 2020-08-21 19:11:59 -03:00
parent f630714547
commit 9ad8f8bf73
2 changed files with 35 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/ase-file-specs.md
View File

@ -279,6 +279,10 @@ Never used.
### Tags Chunk (0x2018)
After tha tags chunk, you can write one user data chunk for each tag.
E.g. if there are 10 tags, you can then write 10 user data chunks one
for each tag.
WORD Number of tags
BYTE[8] For future (set to zero)
+ For each tag
@ -290,6 +294,9 @@ Never used.
2 = Ping-pong
BYTE[8] For future (set to zero)
BYTE[3] RGB values of the tag color
Deprecated, used only for backward compatibility with Aseprite v1.2.x
The color of the tag is the one in the user data field following
the tags chunk
BYTE Extra byte (zero)
STRING Tag name
@ -313,7 +320,10 @@ Never used.
Insert this user data in the last read chunk. E.g. If we've read a
layer, this user data belongs to that layer, if we've read a cel, it
belongs to that cel, etc.
belongs to that cel, etc. There are some special cases: After a Tags
chunk, there will be several user data fields, one for each tag, you
should associate the user data in the same order as the tags are in
the Tags chunk.
DWORD Flags
1 = Has text

32
src/dio/aseprite_decoder.cpp
View File

@ -85,7 +85,10 @@ bool AsepriteDecoder::decode()
doc::Cel* last_cel = nullptr;
auto tag_it = sprite->tags().begin();
auto tag_end = sprite->tags().end();
// Used to read user data for each tag after a Tags chunk
bool tagsInProcess = false;
int current_level = -1;
doc::LayerList allLayers;
AsepriteExternalFiles extFiles;
@ -202,10 +205,13 @@ bool AsepriteDecoder::decode()
break;
case ASE_FILE_CHUNK_TAGS:
tagsInProcess = true;
readTagsChunk(&sprite->tags());
tag_it = sprite->tags().begin();
tag_end = sprite->tags().end();
// If there are tags, any following user data chunk will
// be for each tag (starting from tag_it to tag_end-1).
tagsInProcess = (tag_it != tag_end);
break;
case ASE_FILE_CHUNK_SLICES: {
@ -223,20 +229,25 @@ bool AsepriteDecoder::decode()
case ASE_FILE_CHUNK_USER_DATA: {
doc::UserData userData;
readUserDataChunk(&userData);
// The next condition implies user data is from tags
// Are we are reading the user data of tags?
if (tagsInProcess) {
// Tag user data:
doc::Tag* tag = *tag_it;
doc::color_t c = tag->color();// this line is for backward compatibility
// This will overwrite the tag color. The color field in
// Tags chunk is deprecated, only used for backward
// compatibility with old versions of Aseprite, we now
// use the color from the user data chunk.
tag->setUserData(userData);
tag->setColor(c);// this line is for backward compatibility
tag_it++;
// Avoid reading more user data chunks than tags (this
// can happen in ill-formed files only)
if (tag_it == tag_end)
tagsInProcess = false;
break;
}
else if (last_object_with_user_data)
else if (last_object_with_user_data) {
last_object_with_user_data->setUserData(userData);
}
break;
}
@ -948,7 +959,12 @@ void AsepriteDecoder::readTagsChunk(doc::Tags* tags)
std::string name = readString();
auto tag = new doc::Tag(from, to);
tag->setColor(doc::rgba(r, g, b, 255));// this line is for backward compatibility
// We read the color field just in case that this is a .aseprite
// file written by an old version of Aseprite (where the there are
// not user data for tags).
tag->setColor(doc::rgba(r, g, b, 255));
tag->setName(name);
tag->setAniDir((doc::AniDir)aniDir);
tags->add(tag);