cleanup of (boolean) animation event state handling
[rocksndiamonds.git] / src / anim.c
index cdde423668a441c691c59bc273a558dc090e2047..4ea38b41afbb98bbd52e2566cb95ee3226e84b45 100644 (file)
 #include "anim.h"
 #include "main.h"
 #include "tools.h"
+#include "files.h"
 #include "events.h"
 #include "screens.h"
 
 
-/* values for global toon animation definition */
+// values for global toon animation definition
 #define NUM_GLOBAL_TOON_ANIMS          1
 #define NUM_GLOBAL_TOON_PARTS          MAX_NUM_TOONS
 
-/* values for global animation definition (including toons) */
+// values for global animation definition (including toons)
 #define NUM_GLOBAL_ANIMS_AND_TOONS     (NUM_GLOBAL_ANIMS +             \
                                         NUM_GLOBAL_TOON_ANIMS)
 #define NUM_GLOBAL_ANIM_PARTS_AND_TOONS        MAX(NUM_GLOBAL_ANIM_PARTS_ALL,  \
@@ -35,8 +36,9 @@
 #define ANIM_CLASS_BIT_SUBMENU         4
 #define ANIM_CLASS_BIT_MENU            5
 #define ANIM_CLASS_BIT_TOONS           6
+#define ANIM_CLASS_BIT_NO_TITLE                7
 
-#define NUM_ANIM_CLASSES               7
+#define NUM_ANIM_CLASSES               8
 
 #define ANIM_CLASS_NONE                        0
 #define ANIM_CLASS_TITLE_INITIAL       (1 << ANIM_CLASS_BIT_TITLE_INITIAL)
 #define ANIM_CLASS_SUBMENU             (1 << ANIM_CLASS_BIT_SUBMENU)
 #define ANIM_CLASS_MENU                        (1 << ANIM_CLASS_BIT_MENU)
 #define ANIM_CLASS_TOONS               (1 << ANIM_CLASS_BIT_TOONS)
+#define ANIM_CLASS_NO_TITLE            (1 << ANIM_CLASS_BIT_NO_TITLE)
 
-#define ANIM_CLASS_TOONS_SCORES                (ANIM_CLASS_TOONS |     \
-                                        ANIM_CLASS_SCORES)
+#define ANIM_CLASS_TOONS_SCORES                (ANIM_CLASS_TOONS       |       \
+                                        ANIM_CLASS_SCORES      |       \
+                                        ANIM_CLASS_NO_TITLE)
 
-#define ANIM_CLASS_TOONS_MENU_MAIN     (ANIM_CLASS_TOONS |     \
-                                        ANIM_CLASS_MENU  |     \
-                                        ANIM_CLASS_MAIN)
+#define ANIM_CLASS_TOONS_MENU_MAIN     (ANIM_CLASS_TOONS       |       \
+                                        ANIM_CLASS_MENU        |       \
+                                        ANIM_CLASS_MAIN        |       \
+                                        ANIM_CLASS_NO_TITLE)
 
-#define ANIM_CLASS_TOONS_MENU_SUBMENU  (ANIM_CLASS_TOONS |     \
-                                        ANIM_CLASS_MENU  |     \
-                                        ANIM_CLASS_SUBMENU)
+#define ANIM_CLASS_TOONS_MENU_SUBMENU  (ANIM_CLASS_TOONS       |       \
+                                        ANIM_CLASS_MENU        |       \
+                                        ANIM_CLASS_SUBMENU     |       \
+                                        ANIM_CLASS_NO_TITLE)
 
-/* values for global animation states */
+// values for global animation states
 #define ANIM_STATE_INACTIVE            0
 #define ANIM_STATE_RESTART             (1 << 0)
 #define ANIM_STATE_WAITING             (1 << 1)
 #define ANIM_STATE_RUNNING             (1 << 2)
 
-/* values for global animation control */
+// values for global animation control
 #define ANIM_NO_ACTION                 0
 #define ANIM_START                     1
 #define ANIM_CONTINUE                  2
@@ -174,6 +180,8 @@ struct GameModeAnimClass
   { GAME_MODE_PSEUDO_TYPENAME,         ANIM_CLASS_TOONS_MENU_MAIN      },
   { GAME_MODE_PSEUDO_SCORESOLD,                ANIM_CLASS_TOONS_SCORES         },
   { GAME_MODE_PSEUDO_SCORESNEW,                ANIM_CLASS_TOONS_SCORES         },
+  { GAME_MODE_EDITOR,                  ANIM_CLASS_NO_TITLE             },
+  { GAME_MODE_PLAYING,                 ANIM_CLASS_NO_TITLE             },
 
   { -1,                                        -1                              }
 };
@@ -191,11 +199,12 @@ struct AnimClassGameMode
   { ANIM_CLASS_BIT_SUBMENU,            GAME_MODE_PSEUDO_SUBMENU        },
   { ANIM_CLASS_BIT_MENU,               GAME_MODE_PSEUDO_MENU           },
   { ANIM_CLASS_BIT_TOONS,              GAME_MODE_PSEUDO_TOONS          },
+  { ANIM_CLASS_BIT_NO_TITLE,           GAME_MODE_PSEUDO_NO_TITLE       },
 
   { -1,                                        -1                              }
 };
 
-/* forward declaration for internal use */
+// forward declaration for internal use
 static void HandleGlobalAnim(int, int);
 static void DoAnimationExt(void);
 static void ResetGlobalAnim_Clickable(void);
@@ -215,9 +224,9 @@ static int anim_classes_last = ANIM_CLASS_NONE;
 static boolean drawing_to_fading_buffer = FALSE;
 
 
-/* ========================================================================= */
-/* generic animation frame calculation                                       */
-/* ========================================================================= */
+// ============================================================================
+// generic animation frame calculation
+// ============================================================================
 
 int getAnimationFrame(int num_frames, int delay, int mode, int start_frame,
                      int sync_frame)
@@ -226,34 +235,34 @@ int getAnimationFrame(int num_frames, int delay, int mode, int start_frame,
 
   sync_frame += start_frame * delay;
 
-  if (mode & ANIM_LOOP)                        /* looping animation */
+  if (mode & ANIM_LOOP)                        // looping animation
   {
     frame = (sync_frame % (delay * num_frames)) / delay;
   }
-  else if (mode & ANIM_LINEAR)         /* linear (non-looping) animation */
+  else if (mode & ANIM_LINEAR)         // linear (non-looping) animation
   {
     frame = sync_frame / delay;
 
     if (frame > num_frames - 1)
       frame = num_frames - 1;
   }
-  else if (mode & ANIM_PINGPONG)       /* oscillate (border frames once) */
+  else if (mode & ANIM_PINGPONG)       // oscillate (border frames once)
   {
     int max_anim_frames = (num_frames > 1 ? 2 * num_frames - 2 : 1);
 
     frame = (sync_frame % (delay * max_anim_frames)) / delay;
     frame = (frame < num_frames ? frame : max_anim_frames - frame);
   }
-  else if (mode & ANIM_PINGPONG2)      /* oscillate (border frames twice) */
+  else if (mode & ANIM_PINGPONG2)      // oscillate (border frames twice)
   {
     int max_anim_frames = 2 * num_frames;
 
     frame = (sync_frame % (delay * max_anim_frames)) / delay;
     frame = (frame < num_frames ? frame : max_anim_frames - frame - 1);
   }
-  else if (mode & ANIM_RANDOM)         /* play frames in random order */
+  else if (mode & ANIM_RANDOM)         // play frames in random order
   {
-    /* note: expect different frames for the same delay cycle! */
+    // note: expect different frames for the same delay cycle!
 
     if (gfx.anim_random_frame < 0)
       frame = GetSimpleRandom(num_frames);
@@ -265,16 +274,16 @@ int getAnimationFrame(int num_frames, int delay, int mode, int start_frame,
     frame = sync_frame % num_frames;
   }
 
-  if (mode & ANIM_REVERSE)             /* use reverse animation direction */
+  if (mode & ANIM_REVERSE)             // use reverse animation direction
     frame = num_frames - frame - 1;
 
   return frame;
 }
 
 
-/* ========================================================================= */
-/* global animation functions                                                */
-/* ========================================================================= */
+// ============================================================================
+// global animation functions
+// ============================================================================
 
 static int getGlobalAnimationPart(struct GlobalAnimMainControlInfo *anim)
 {
@@ -530,12 +539,12 @@ static void InitGlobalAnimControls(void)
 
   InitToonControls();
 
-  /* sort all animations according to draw_order and animation number */
+  // sort all animations according to draw_order and animation number
   for (m = 0; m < NUM_GAME_MODES; m++)
   {
     struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[m];
 
-    /* sort all main animations for this game mode */
+    // sort all main animations for this game mode
     qsort(ctrl->anim, ctrl->num_anims,
          sizeof(struct GlobalAnimMainControlInfo),
          compareGlobalAnimMainControlInfo);
@@ -544,7 +553,7 @@ static void InitGlobalAnimControls(void)
     {
       struct GlobalAnimMainControlInfo *anim = &ctrl->anim[a];
 
-      /* sort all animation parts for this main animation */
+      // sort all animation parts for this main animation
       qsort(anim->part, anim->num_parts,
            sizeof(struct GlobalAnimPartControlInfo),
            compareGlobalAnimPartControlInfo);
@@ -986,18 +995,20 @@ static boolean isClickablePart(struct GlobalAnimPartControlInfo *part, int mask)
   struct GraphicInfo *c = &part->control_info;
   int trigger_mask = ANIM_EVENT_ANIM_MASK | ANIM_EVENT_PART_MASK;
   int mask_anim_only = mask & ANIM_EVENT_ANIM_MASK;
+  int init_event = GetGlobalAnimEventValue(c->init_event, 0);
+  int anim_event = GetGlobalAnimEventValue(c->anim_event, 0);
 
   if (mask & ANIM_EVENT_ANY)
-    return (c->init_event & ANIM_EVENT_ANY ||
-           c->anim_event & ANIM_EVENT_ANY);
+    return (init_event & ANIM_EVENT_ANY ||
+           anim_event & ANIM_EVENT_ANY);
   else if (mask & ANIM_EVENT_SELF)
-    return (c->init_event & ANIM_EVENT_SELF ||
-           c->anim_event & ANIM_EVENT_SELF);
+    return (init_event & ANIM_EVENT_SELF ||
+           anim_event & ANIM_EVENT_SELF);
   else
-    return ((c->init_event & trigger_mask) == mask ||
-           (c->anim_event & trigger_mask) == mask ||
-           (c->init_event & trigger_mask) == mask_anim_only ||
-           (c->anim_event & trigger_mask) == mask_anim_only);
+    return ((init_event & trigger_mask) == mask ||
+           (anim_event & trigger_mask) == mask ||
+           (init_event & trigger_mask) == mask_anim_only ||
+           (anim_event & trigger_mask) == mask_anim_only);
 }
 
 static boolean isClickedPart(struct GlobalAnimPartControlInfo *part,
@@ -1062,8 +1073,8 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
     part->anim_delay_counter =
       (c->anim_delay_fixed + GetSimpleRandom(c->anim_delay_random));
 
-    part->init_event_state = c->init_event;
-    part->anim_event_state = c->anim_event;
+    part->init_event_state = (c->init_event != ANIM_EVENT_UNDEFINED);
+    part->anim_event_state = (c->anim_event != ANIM_EVENT_UNDEFINED);
 
     part->initial_anim_sync_frame =
       (g->anim_global_sync ? 0 : anim_sync_frame + part->init_delay_counter);
@@ -1150,27 +1161,27 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
       part->step_yoffset = c->step_yoffset;
 
     if (part->init_delay_counter == 0 &&
-       part->init_event_state == ANIM_EVENT_NONE)
+       !part->init_event_state)
       PlayGlobalAnimSoundAndMusic(part);
   }
 
   if (part->clicked &&
-      part->init_event_state != ANIM_EVENT_NONE)
+      part->init_event_state)
   {
     if (part->initial_anim_sync_frame > 0)
       part->initial_anim_sync_frame -= part->init_delay_counter - 1;
 
     part->init_delay_counter = 1;
-    part->init_event_state = ANIM_EVENT_NONE;
+    part->init_event_state = FALSE;
 
     part->clicked = FALSE;
   }
 
   if (part->clicked &&
-      part->anim_event_state != ANIM_EVENT_NONE)
+      part->anim_event_state)
   {
     part->anim_delay_counter = 1;
-    part->anim_event_state = ANIM_EVENT_NONE;
+    part->anim_event_state = FALSE;
 
     part->clicked = FALSE;
   }
@@ -1181,7 +1192,7 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
 
     if (part->init_delay_counter == 0)
     {
-      part->init_event_state = ANIM_EVENT_NONE;
+      part->init_event_state = FALSE;
 
       PlayGlobalAnimSoundAndMusic(part);
     }
@@ -1189,7 +1200,7 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
     return ANIM_STATE_WAITING;
   }
 
-  if (part->init_event_state != ANIM_EVENT_NONE)
+  if (part->init_event_state)
     return ANIM_STATE_WAITING;
 
   // animation part is now running/visible and therefore clickable
@@ -1202,7 +1213,7 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
       (part->y >=  part->viewport_height && part->step_yoffset >= 0))
   {
     // do not wait for "anim" events for off-screen animations
-    part->anim_event_state = ANIM_EVENT_NONE;
+    part->anim_event_state = FALSE;
 
     // do not stop animation before "anim" or "post" counter are finished
     if (part->anim_delay_counter == 0 &&
@@ -1227,7 +1238,7 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
 
     if (part->anim_delay_counter == 0)
     {
-      part->anim_event_state = ANIM_EVENT_NONE;
+      part->anim_event_state = FALSE;
 
       StopGlobalAnimSoundAndMusic(part);
 
@@ -1662,7 +1673,7 @@ boolean HandleGlobalAnimClicks(int mx, int my, int button)
   boolean release_event;
   boolean click_consumed_current = click_consumed;
 
-  /* check if button state has changed since last invocation */
+  // check if button state has changed since last invocation
   press_event   = (button != 0 && last_button == 0);
   release_event = (button == 0 && last_button != 0);
   last_button = button;