Add tag support

RobLoach · RobLoach · commit 6c292d723bc3 · 2021-04-12T02:21:22.000-04:00
diff --git a/README.md b/README.md
@@ -22,13 +22,23 @@ int main() {
     // Load the backpacker Aseprite file.
     Aseprite backpacker = LoadAseprite("resources/backpacker.aseprite");
 
+    // Load the Walk Down tag.
+    AsepriteTag walkdown = LoadAsepriteTag(backpacker, "Walk Down");
+    walkdown.speed = 2; // Double the animation speed.
+
     while(!WindowShouldClose()) {
+        // Update the animation frame for walk down.
+        UpdateAsperiteTag(&walkdown);
+
         BeginDrawing();
         ClearBackground(RAYWHITE);
 
-        // Draw the 0th frame from the aseprite.
+        // Draw the 0th frame from the backpacker sprite.
         DrawAseprite(backpacker, 0, 100, 100, WHITE);
 
+        // Draw the walkdown animation tag.
+        DrawAsepriteTag(walkdown, 200, 100, WHITE);
+
         EndDrawing();
     }
 
@@ -43,15 +53,25 @@ int main() {
 ### Cheatsheet
 
 ``` c
-Aseprite LoadAseprite(const char* fileName);                  // Load an .aseprite file.
-Aseprite LoadAsepriteFromMemory(unsigned char* fileData, unsigned int size);  // Load an aseprite file from memory.
-void UnloadAseprite(Aseprite ase);                            // Unloads the aseprite file.
-void TraceAseprite(Aseprite ase);                             // Display all information associated with the aseprite.
-Texture GetAsepriteTexture(Aseprite ase);                     // Retrieve the raylib texture associated with the aseprite.
-void DrawAseprite(Aseprite ase, int frame, int posX, int posY, Color tint);
-void DrawAsepriteV(Aseprite ase, int frame, Vector2 position, Color tint);
-void DrawAsepriteEx(Aseprite ase, int frame, Vector2 position, float rotation, float scale, Color tint);
-void DrawAsepritePro(Aseprite ase, int frame, Rectangle dest, Vector2 origin, float rotation, Color tint);
+Aseprite LoadAseprite(const char* fileName);                        // Load an .aseprite file
+Aseprite LoadAsepriteFromMemory(unsigned char* fileData, unsigned int size);  // Load an aseprite file from memory
+void UnloadAseprite(Aseprite aseprite);                             // Unloads the aseprite file
+void TraceAseprite(Aseprite aseprite);                              // Display all information associated with the aseprite
+Texture GetAsepriteTexture(Aseprite aseprite);                      // Retrieve the raylib texture associated with the aseprite
+void DrawAseprite(Aseprite aseprite, int frame, int posX, int posY, Color tint);
+void DrawAsepriteV(Aseprite aseprite, int frame, Vector2 position, Color tint);
+void DrawAsepriteEx(Aseprite aseprite, int frame, Vector2 position, float rotation, float scale, Color tint);
+void DrawAsepritePro(Aseprite aseprite, int frame, Rectangle dest, Vector2 origin, float rotation, Color tint);
+
+AsepriteTag LoadAsepriteTag(Aseprite aseprite, const char* name);   // Load a Aseprite tag animation sequence
+AsepriteTag LoadAsepriteTagFromId(Aseprite aseprite, int id);       // Load a Aseprite tag animation sequence from its index
+void UpdateAsepriteTag(AsepriteTag* tag);                           // Update the tag animation frame if needed
+void DrawAsepriteTag(AsepriteTag tag, int posX, int posY, Color tint);
+void DrawAsepriteTagV(AsepriteTag tag, Vector2 position, Color tint);
+void DrawAsepriteTagEx(AsepriteTag tag, Vector2 position, float rotation, float scale, Color tint);
+void DrawAsepriteTagPro(AsepriteTag tag, Rectangle dest, Vector2 origin, float rotation, Color tint);
+const char* GetAsepriteTagName(AsepriteTag tag);                    // Retrieve the given tag's name
+int GetAspriteTagCount(Aseprite aseprite);                          // Get the total amount of available tags from the loaded Aseprite
 ```
 
 ## Development
diff --git a/example/raylib-aseprite-example.c b/example/raylib-aseprite-example.c
@@ -25,16 +25,15 @@ int main() {
 
     // Load the Aseprite file.
     Aseprite aseprite = LoadAseprite("resources/backpacker.aseprite");
-    ase_t* ase = aseprite.ase;
-
-    // TODO: Add a Tag Manager/Renderer.
-    //Tag tag = LoadAsepriteTag(ase, "Walk Down");
-    //UpdateAseprite(ase);
 
     // Display information about it.
     TraceAseprite(aseprite);
 
+    // Load the "Walk Down" tag from aseprite.
+    AsepriteTag walkdown = LoadAsepriteTag(aseprite, "Walk Down");
+
     // Build all the frame information for each tag.
+    ase_t* ase = aseprite.ase;
     int frame[ase->tag_count];
     float frameTimer[ase->tag_count];
     for (int i = 0; i < ase->tag_count; i++) {
@@ -47,6 +46,19 @@ int main() {
 
         // Update
         //----------------------------------------------------------------------------------
+
+        // Pause the animation if the space key is down.
+        if (IsKeyDown(KEY_SPACE)) {
+            walkdown.speed = 0;
+        }
+        else {
+            walkdown.speed = 2;
+        }
+
+        // Update the active animation of the walk down tag.
+        UpdateAsepriteTag(&walkdown);
+
+        // Manually update the sprites.
         float timeSpend = GetFrameTime();
         for (int i = 0; i < ase->tag_count; i++) {
             ase_tag_t tag = ase->tags[i];
@@ -64,18 +76,22 @@ int main() {
         // Draw
         //----------------------------------------------------------------------------------
         BeginDrawing();
-        ClearBackground(RAYWHITE);
+        {
+            ClearBackground(RAYWHITE);
 
-        // Loop through each tag, and display the animated sprite.
-        for (int i = 0; i < ase->tag_count; i++) {
-            ase_tag_t tag = ase->tags[i];
-            DrawText(tag.name, 170, i * 115 + 90, 40, BLACK);
-            Vector2 position = {100, i * 115 + 70};
+            // Loop through each tag, and display the animated sprite.
+            for (int i = 0; i < ase->tag_count; i++) {
+                ase_tag_t tag = ase->tags[i];
+                DrawText(tag.name, 170, i * 115 + 90, 40, BLACK);
+                Vector2 position = {100, i * 115 + 70};
 
-            // Draw the active frame.
-            DrawAsepriteEx(aseprite, frame[i], position, 0, 6, WHITE);
-        }
+                // Draw the active frame.
+                DrawAsepriteEx(aseprite, frame[i], position, 0, 6, WHITE);
+            }
 
+            // Display the loaded walkdown tag in animation.
+            DrawAsepriteTagEx(walkdown, (Vector2){470, 120}, 0, 16, WHITE);
+        }
         EndDrawing();
         //----------------------------------------------------------------------------------
     }
diff --git a/include/raylib-aseprite.h b/include/raylib-aseprite.h
@@ -43,16 +43,35 @@ typedef struct Aseprite {
     ase_t* ase;
 } Aseprite;
 
-Aseprite LoadAseprite(const char* fileName);                    // Load an .aseprite file.
-Aseprite LoadAsepriteFromMemory(unsigned char* fileData, unsigned int size);  // Load an aseprite file from memory.
-void UnloadAseprite(Aseprite aseprite);                         // Unloads the aseprite file.
-void TraceAseprite(Aseprite aseprite);                          // Display all information associated with the aseprite.
-Texture GetAsepriteTexture(Aseprite aseprite);                  // Retrieve the raylib texture associated with the aseprite.
+typedef struct AsepriteTag {
+    ase_tag_t* tag;
+    Aseprite aseprite;
+    int currentFrame;
+    float timer;
+    int direction;
+    float speed;
+} AsepriteTag;
+
+Aseprite LoadAseprite(const char* fileName);                        // Load an .aseprite file
+Aseprite LoadAsepriteFromMemory(unsigned char* fileData, unsigned int size);  // Load an aseprite file from memory
+void UnloadAseprite(Aseprite aseprite);                             // Unloads the aseprite file
+void TraceAseprite(Aseprite aseprite);                              // Display all information associated with the aseprite
+Texture GetAsepriteTexture(Aseprite aseprite);                      // Retrieve the raylib texture associated with the aseprite
 void DrawAseprite(Aseprite aseprite, int frame, int posX, int posY, Color tint);
 void DrawAsepriteV(Aseprite aseprite, int frame, Vector2 position, Color tint);
 void DrawAsepriteEx(Aseprite aseprite, int frame, Vector2 position, float rotation, float scale, Color tint);
 void DrawAsepritePro(Aseprite aseprite, int frame, Rectangle dest, Vector2 origin, float rotation, Color tint);
 
+AsepriteTag LoadAsepriteTag(Aseprite aseprite, const char* name);   // Load a Aseprite tag animation sequence
+AsepriteTag LoadAsepriteTagFromId(Aseprite aseprite, int id);       // Load a Aseprite tag animation sequence from its index
+void UpdateAsepriteTag(AsepriteTag* tag);                           // Update the tag animation frame if needed
+void DrawAsepriteTag(AsepriteTag tag, int posX, int posY, Color tint);
+void DrawAsepriteTagV(AsepriteTag tag, Vector2 position, Color tint);
+void DrawAsepriteTagEx(AsepriteTag tag, Vector2 position, float rotation, float scale, Color tint);
+void DrawAsepriteTagPro(AsepriteTag tag, Rectangle dest, Vector2 origin, float rotation, Color tint);
+const char* GetAsepriteTagName(AsepriteTag tag);                    // Retrieve the given tag's name
+int GetAspriteTagCount(Aseprite aseprite);                          // Get the total amount of available tags from the loaded Aseprite
+
 #ifdef __cplusplus
 }
 #endif
@@ -122,9 +141,9 @@ extern "C" {
 #endif
 
 Aseprite LoadAsepriteFromMemory(unsigned char* fileData, unsigned int size) {
+    struct Aseprite aseprite;
     ase_t* ase = cute_aseprite_load_from_memory(fileData, (int)size, 0);
     if (ase == 0) {
-        struct Aseprite aseprite;
         aseprite.ase = 0;
         return aseprite;
     }
@@ -174,7 +193,6 @@ Aseprite LoadAsepriteFromMemory(unsigned char* fileData, unsigned int size) {
     texturePointer->mipmaps = texture.mipmaps;
     texturePointer->width = texture.width;
     texturePointer->height = texture.height;
-    struct Aseprite aseprite;
     aseprite.ase = ase;
     return aseprite;
 }
@@ -221,19 +239,21 @@ void DrawAseprite(Aseprite aseprite, int frame, int posX, int posY, Color tint)
 
 void DrawAsepriteV(Aseprite aseprite, int frame, Vector2 position, Color tint) {
     ase_t* ase = aseprite.ase;
-    if (frame < 0 || frame >= ase->frame_count) {
+    if (ase == 0 || frame < 0 || frame >= ase->frame_count) {
         return;
     }
+
     Rectangle source = {(float)(frame * ase->w), 0, (float)ase->w, (float)ase->h};
     Texture2D texture = GetAsepriteTexture(aseprite);
     DrawTextureRec(texture, source, position, tint);
 }
 
 void DrawAsepriteEx(Aseprite aseprite, int frame, Vector2 position, float rotation, float scale, Color tint) {
     ase_t* ase = aseprite.ase;
-    if (frame < 0 || frame >= ase->frame_count) {
+    if (ase == 0 || frame < 0 || frame >= ase->frame_count) {
         return;
     }
+
     Rectangle source = {(float)(frame * ase->w), 0, (float)ase->w, (float)ase->h};
     Texture2D texture = GetAsepriteTexture(aseprite);
     Rectangle dest = {(float)position.x, (float)position.y, (float)(ase->w * scale), (float)(ase->h * scale)};
@@ -243,16 +263,22 @@ void DrawAsepriteEx(Aseprite aseprite, int frame, Vector2 position, float rotati
 
 void DrawAsepritePro(Aseprite aseprite, int frame, Rectangle dest, Vector2 origin, float rotation, Color tint) {
     ase_t* ase = aseprite.ase;
-    if (frame < 0 || frame >= ase->frame_count) {
+    if (ase == 0 || frame < 0 || frame >= ase->frame_count) {
         return;
     }
+
     Rectangle source = {(float)(frame * ase->w), 0, (float)ase->w, (float)ase->h};
     Texture2D texture = GetAsepriteTexture(aseprite);
     DrawTexturePro(texture, source, dest, origin, rotation, tint);
 }
 
 void TraceAseprite(Aseprite aseprite) {
     ase_t* ase = aseprite.ase;
+    if (ase == 0) {
+        TraceLog(LOG_INFO, "ASEPRITE: Empty file information");
+        return;
+    }
+
     TraceLog(LOG_INFO, "ASEPRITE: File information:");
     TraceLog(LOG_INFO, "    > Size:   %ix%i", ase->w, ase->h);
     TraceLog(LOG_INFO, "    > Frames: %i", ase->frame_count);
@@ -264,13 +290,153 @@ void TraceAseprite(Aseprite aseprite) {
         ase_layer_t* layer = ase->layers + i;
         TraceLog(LOG_INFO, "      - %s", layer->name);
     }
+
     TraceLog(LOG_INFO, "    > Tags:   %i", ase->tag_count);
     for (int i = 0; i < ase->tag_count; i++) {
         ase_tag_t* tag = ase->tags + i;
         TraceLog(LOG_INFO, "      - %s", tag->name);
     }
 }
 
+void UpdateAsepriteTag(AsepriteTag* tag) {
+    if (tag == 0 || tag->tag == 0 || tag->aseprite.ase == 0) {
+        TraceLog(LOG_ERROR, "ASEPRITE: Cannot update empty tag");
+        return;
+    }
+
+    ase_t* ase = tag->aseprite.ase;
+    ase_tag_t* aseTag = tag->tag;
+
+    // Count down the timer and see if it's time to update the frame.
+    tag->timer -= GetFrameTime() * tag->speed;
+    if (tag->timer > 0) {
+        return;
+    }
+
+    // Advance the frame and see if it's time to reset the position.
+    tag->currentFrame += tag->direction;
+    switch (aseTag->loop_animation_direction) {
+        case ASE_ANIMATION_DIRECTION_BACKWORDS:
+            if (tag->currentFrame < aseTag->from_frame) {
+                tag->currentFrame = aseTag->to_frame;
+            }
+        break;
+        case ASE_ANIMATION_DIRECTION_FORWARDS:
+            if (tag->currentFrame > aseTag->to_frame) {
+                tag->currentFrame = aseTag->from_frame;
+            }
+        break;
+        case ASE_ANIMATION_DIRECTION_PINGPONG:
+            if (tag->direction > 0) {
+                if (tag->currentFrame > aseTag->to_frame) {
+                    tag->direction = -1;
+                    tag->currentFrame = aseTag->to_frame - 1;
+                }
+            }
+            else {
+                if (tag->currentFrame < aseTag->from_frame) {
+                    tag->direction = 1;
+                    tag->currentFrame = aseTag->from_frame + 1;
+                }
+            }
+        break;
+    }
+
+    // Reset the timer.
+    // TODO: Add the original tag->timer to make up the different in frame time?
+    tag->timer = (float)(ase->frames[tag->currentFrame].duration_milliseconds) / 1000.0f/* + tag->timer; */;
+}
+
+void DrawAsepriteTag(AsepriteTag tag, int posX, int posY, Color tint) {
+    DrawAseprite(tag.aseprite, tag.currentFrame, posX, posY, tint);
+}
+
+void DrawAsepriteTagV(AsepriteTag tag, Vector2 position, Color tint) {
+    DrawAsepriteV(tag.aseprite, tag.currentFrame, position, tint);
+}
+
+void DrawAsepriteTagEx(AsepriteTag tag, Vector2 position, float rotation, float scale, Color tint) {
+    DrawAsepriteEx(tag.aseprite, tag.currentFrame, position, rotation, scale, tint);
+}
+
+void DrawAsepriteTagPro(AsepriteTag tag, Rectangle dest, Vector2 origin, float rotation, Color tint) {
+    DrawAsepritePro(tag.aseprite, tag.currentFrame, dest, origin, rotation, tint);
+}
+
+AsepriteTag LoadAsepriteTagFromId(Aseprite aseprite, int id) {
+    struct AsepriteTag tag;
+    tag.aseprite.ase = 0;
+    tag.currentFrame = 0;
+    tag.tag = 0;
+    tag.timer = 0;
+    tag.direction = 0;
+    tag.speed = 1.0f;
+    ase_t* ase = aseprite.ase;
+    if (ase == 0) {
+        TraceLog(LOG_ERROR, "ASEPRITE: Asprite not loaded when attempting to load tag #%i", id);
+        return tag;
+    }
+
+    if (id < 0 || id >= ase->tag_count) {
+        TraceLog(LOG_ERROR, "ASEPRITE: Tag index %i out of range for %i tags", id, ase->tag_count);
+        return tag;
+    }
+
+    tag.aseprite.ase = aseprite.ase;
+    tag.tag = &ase->tags[id];
+    tag.currentFrame = tag.tag->from_frame;
+    tag.direction = 1;
+    if (tag.tag->loop_animation_direction == ASE_ANIMATION_DIRECTION_BACKWORDS) {
+        tag.currentFrame = tag.tag->to_frame;
+        tag.direction = -1;
+    }
+    tag.timer = (float)(ase->frames[tag.currentFrame].duration_milliseconds) / 1000.0f; // Timer in seconds.
+    return tag;
+}
+
+AsepriteTag LoadAsepriteTag(Aseprite aseprite, const char* name) {
+    struct AsepriteTag tag;
+    tag.aseprite.ase = 0;
+    tag.currentFrame = 0;
+    tag.tag = 0;
+    tag.timer = 0;
+    tag.direction = 0;
+    tag.speed = 1.0f;
+    ase_t* ase = aseprite.ase;
+    if (ase == 0) {
+        TraceLog(LOG_ERROR, "ASEPRITE: Asprite not loaded when attempting to load tag '%s'", name);
+        return tag;
+    }
+
+    // Loop through all tags to find the correct name.
+    for (int i = 0; i < ase->tag_count; i++) {
+        if (TextIsEqual(name, ase->tags[i].name)) {
+            return LoadAsepriteTagFromId(aseprite, i);
+        }
+    }
+
+    TraceLog(LOG_WARNING, "ASEPRITE: Could not find tag %s", name);
+    return tag;
+}
+
+const char* GetAsepriteTagName(AsepriteTag tag) {
+    if (tag.tag == 0) {
+        TraceLog(LOG_WARNING, "ASEPRITE: Cannot get name of missing tag");
+        return 0;
+    }
+
+    return tag.tag->name;
+}
+
+int GetAspriteTagCount(Aseprite aseprite) {
+    if (aseprite.ase == 0) {
+        TraceLog(LOG_WARNING, "ASEPRITE: Cannot get tag count when there is not loaded aseprite");
+        return 0;
+    }
+
+    return aseprite.ase->tag_count;
+}
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/test/raylib-aseprite-test.c b/test/raylib-aseprite-test.c
