improved global animation class "pointer" for animation at mouse position
[rocksndiamonds.git] / src / anim.c
index 49f346ee8e347959d29388ddf526f42007ae189e..be6c98f6d4ee82587a1b3c0cd3b23ad18e3fcdd3 100644 (file)
 #include "screens.h"
 
 
+#define DEBUG_ANIM_DELAY               0
+#define DEBUG_ANIM_EVENTS              0
+
+
 // values for global toon animation definition
 #define NUM_GLOBAL_TOON_ANIMS          1
 #define NUM_GLOBAL_TOON_PARTS          MAX_NUM_TOONS
@@ -113,6 +117,7 @@ struct GlobalAnimPartControlInfo
   boolean init_event_state;
   boolean anim_event_state;
 
+  boolean triggered;
   boolean clickable;
   boolean clicked;
 
@@ -205,6 +210,8 @@ struct AnimClassGameMode
 };
 
 // forward declaration for internal use
+static void DoGlobalAnim_DelayAction(struct GlobalAnimPartControlInfo *, int);
+static boolean DoGlobalAnim_EventAction(struct GlobalAnimPartControlInfo *);
 static void HandleGlobalAnim(int, int);
 static void DoAnimationExt(void);
 static void ResetGlobalAnim_Clickable(void);
@@ -806,13 +813,24 @@ static void DrawGlobalAnimationsExt(int drawing_target, int drawing_stage)
 
 void DrawGlobalAnimations(int drawing_target, int drawing_stage)
 {
+  int last_cursor_mode_override = gfx.cursor_mode_override;
+
   if (drawing_stage == DRAW_GLOBAL_ANIM_STAGE_1)
+  {
     ResetGlobalAnim_Clickable();
 
+    gfx.cursor_mode_override = CURSOR_UNDEFINED;
+  }
+
   DrawGlobalAnimationsExt(drawing_target, drawing_stage);
 
   if (drawing_stage == DRAW_GLOBAL_ANIM_STAGE_2)
+  {
     ResetGlobalAnim_Clicked();
+  }
+
+  if (gfx.cursor_mode_override != last_cursor_mode_override)
+    SetMouseCursor(gfx.cursor_mode);
 }
 
 static boolean SetGlobalAnimPart_Viewport(struct GlobalAnimPartControlInfo *part)
@@ -823,7 +841,8 @@ static boolean SetGlobalAnimPart_Viewport(struct GlobalAnimPartControlInfo *part
   int viewport_height;
   boolean changed = FALSE;
 
-  if (part->last_anim_status == global.anim_status)
+  if (part->last_anim_status == global.anim_status &&
+      part->control_info.class != get_hash_from_key("pointer"))
     return FALSE;
 
   part->last_anim_status = global.anim_status;
@@ -840,6 +859,17 @@ static boolean SetGlobalAnimPart_Viewport(struct GlobalAnimPartControlInfo *part
 
     part->drawing_stage = DRAW_GLOBAL_ANIM_STAGE_2;
   }
+  else if (part->control_info.class == get_hash_from_key("pointer"))
+  {
+    viewport_x = gfx.mouse_x + part->control_info.x;
+    viewport_y = gfx.mouse_y + part->control_info.y;
+    viewport_width  = part->graphic_info.width;
+    viewport_height = part->graphic_info.height;
+
+    part->drawing_stage = DRAW_GLOBAL_ANIM_STAGE_2;
+
+    gfx.cursor_mode_override = CURSOR_NONE;
+  }
   else if (part->control_info.class == get_hash_from_key("door_1"))
   {
     viewport_x = DX;
@@ -849,10 +879,20 @@ static boolean SetGlobalAnimPart_Viewport(struct GlobalAnimPartControlInfo *part
   }
   else if (part->control_info.class == get_hash_from_key("door_2"))
   {
-    viewport_x = VX;
-    viewport_y = VY;
-    viewport_width  = VXSIZE;
-    viewport_height = VYSIZE;
+    if (part->mode_nr == GAME_MODE_EDITOR)
+    {
+      viewport_x = EX;
+      viewport_y = EY;
+      viewport_width  = EXSIZE;
+      viewport_height = EYSIZE;
+    }
+    else
+    {
+      viewport_x = VX;
+      viewport_y = VY;
+      viewport_width  = VXSIZE;
+      viewport_height = VYSIZE;
+    }
   }
   else         // default: "playfield"
   {
@@ -992,16 +1032,17 @@ static void PlayGlobalAnimSoundIfLoop(struct GlobalAnimPartControlInfo *part)
 
 static boolean checkGlobalAnimEvent(int anim_event, int mask)
 {
-  int trigger_mask = ANIM_EVENT_ANIM_MASK | ANIM_EVENT_PART_MASK;
-  int mask_anim_only = mask & ANIM_EVENT_ANIM_MASK;
+  int mask_anim_only = mask & ~ANIM_EVENT_PART_MASK;
 
   if (mask & ANIM_EVENT_ANY)
     return (anim_event & ANIM_EVENT_ANY);
   else if (mask & ANIM_EVENT_SELF)
     return (anim_event & ANIM_EVENT_SELF);
+  else if (mask & ANIM_EVENT_UNCLICK_ANY)
+    return (anim_event & ANIM_EVENT_UNCLICK_ANY);
   else
-    return ((anim_event & trigger_mask) == mask ||
-           (anim_event & trigger_mask) == mask_anim_only);
+    return (anim_event == mask ||
+           anim_event == mask_anim_only);
 }
 
 static boolean isClickablePart(struct GlobalAnimPartControlInfo *part, int mask)
@@ -1065,6 +1106,95 @@ static boolean clickConsumed(struct GlobalAnimPartControlInfo *part)
   return (part->control_info.style & STYLE_PASSTHROUGH ? FALSE : TRUE);
 }
 
+static void InitGlobalAnim_Triggered(struct GlobalAnimPartControlInfo *part,
+                                    boolean *anything_clicked,
+                                    boolean *any_event_action,
+                                    int event_value, char *info_text)
+{
+  struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[part->mode_nr];
+
+  int gic_anim_nr = part->old_anim_nr + 1;     // X as in "anim_X"
+  int gic_part_nr = part->old_nr + 1;          // Y as in "part_Y"
+  int mask = event_value | (gic_anim_nr << ANIM_EVENT_ANIM_BIT);
+
+  if (!part->is_base)
+    mask |= gic_part_nr << ANIM_EVENT_PART_BIT;
+
+  int anim2_nr;
+
+  for (anim2_nr = 0; anim2_nr < ctrl->num_anims; anim2_nr++)
+  {
+    struct GlobalAnimMainControlInfo *anim2 = &ctrl->anim[anim2_nr];
+    int part2_nr;
+
+    for (part2_nr = 0; part2_nr < anim2->num_parts_all; part2_nr++)
+    {
+      struct GlobalAnimPartControlInfo *part2 = &anim2->part[part2_nr];
+
+      if (part2->state != ANIM_STATE_RUNNING)
+       continue;
+
+      if (isClickablePart(part2, mask))
+      {
+       part2->triggered = TRUE;
+       *anything_clicked = clickConsumed(part);        // click was on "part"!
+
+#if DEBUG_ANIM_EVENTS
+       printf("::: => %d.%d TRIGGERED BY %s OF %d.%d\n",
+              part2->old_anim_nr + 1, part2->old_nr + 1, info_text,
+              part->old_anim_nr + 1, part->old_nr + 1);
+#endif
+#if 0
+       printf("::: %d.%d TRIGGER CLICKED [%d]\n", anim2_nr, part2_nr,
+              part2->control_info.anim_event_action);
+#endif
+
+       // after executing event action, ignore any further actions
+       if (!*any_event_action && DoGlobalAnim_EventAction(part2))
+         *any_event_action = TRUE;
+      }
+
+#if 0
+      struct GraphicInfo *c = &part2->control_info;
+
+      printf("::: - %d.%d: 0x%08x, 0x%08x [0x%08x]",
+            anim2_nr, part2_nr, c->init_event, c->anim_event, mask);
+
+      if (isClickablePart(part2, mask))
+       printf(" <--- TRIGGERED BY %d.%d",
+              anim_nr, part_nr);
+
+      printf("\n");
+#endif
+    }
+  }
+}
+
+static void HandleGlobalAnimDelay(struct GlobalAnimPartControlInfo *part,
+                                 int delay_type, char *info_text)
+{
+#if DEBUG_ANIM_DELAY
+  printf("::: %d.%d %s\n", part->old_anim_nr + 1, part->old_nr + 1, info_text);
+#endif
+
+  DoGlobalAnim_DelayAction(part, delay_type);
+}
+
+static void HandleGlobalAnimEvent(struct GlobalAnimPartControlInfo *part,
+                                 int event_value, char *info_text)
+{
+#if DEBUG_ANIM_EVENTS
+  printf("::: %d.%d %s\n", part->old_anim_nr + 1, part->old_nr + 1, info_text);
+#endif
+
+  boolean anything_clicked = FALSE;
+  boolean any_event_action = FALSE;
+
+  // check if this event is defined to trigger other animations
+  InitGlobalAnim_Triggered(part, &anything_clicked, &any_event_action,
+                          event_value, info_text);
+}
+
 static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
                                 int state)
 {
@@ -1092,6 +1222,8 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
     part->anim_delay_counter =
       (c->anim_delay_fixed + GetSimpleRandom(c->anim_delay_random));
 
+    part->post_delay_counter = 0;
+
     part->init_event_state = (c->init_event != ANIM_EVENT_UNDEFINED);
     part->anim_event_state = (c->anim_event != ANIM_EVENT_UNDEFINED);
 
@@ -1161,10 +1293,13 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
       part->step_yoffset = 0;
     }
 
-    if (c->x != ARG_UNDEFINED_VALUE)
-      part->x = c->x;
-    if (c->y != ARG_UNDEFINED_VALUE)
-      part->y = c->y;
+    if (part->control_info.class != get_hash_from_key("pointer"))
+    {
+      if (c->x != ARG_UNDEFINED_VALUE)
+       part->x = c->x;
+      if (c->y != ARG_UNDEFINED_VALUE)
+       part->y = c->y;
+    }
 
     if (c->position == POS_LAST &&
        anim->last_x > -g->width  && anim->last_x < part->viewport_width &&
@@ -1181,7 +1316,16 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
 
     if (part->init_delay_counter == 0 &&
        !part->init_event_state)
+    {
       PlayGlobalAnimSoundAndMusic(part);
+
+      HandleGlobalAnimDelay(part, ANIM_DELAY_INIT,  "START [INIT_DELAY]");
+      HandleGlobalAnimEvent(part, ANIM_EVENT_START, "START [ANIM]");
+    }
+    else
+    {
+      HandleGlobalAnimEvent(part, ANIM_EVENT_INIT, "START [INIT_DELAY/EVENT]");
+    }
   }
 
   if (part->clicked &&
@@ -1214,6 +1358,9 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
       part->init_event_state = FALSE;
 
       PlayGlobalAnimSoundAndMusic(part);
+
+      HandleGlobalAnimDelay(part, ANIM_DELAY_INIT,  "START [INIT_DELAY]");
+      HandleGlobalAnimEvent(part, ANIM_EVENT_START, "START [ANIM]");
     }
 
     return ANIM_STATE_WAITING;
@@ -1240,6 +1387,8 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
     {
       StopGlobalAnimSoundAndMusic(part);
 
+      HandleGlobalAnimEvent(part, ANIM_EVENT_END, "END [ANIM/OFF-SCREEN]");
+
       part->post_delay_counter =
        (c->post_delay_fixed + GetSimpleRandom(c->post_delay_random));
 
@@ -1261,6 +1410,9 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
 
       StopGlobalAnimSoundAndMusic(part);
 
+      HandleGlobalAnimDelay(part, ANIM_DELAY_ANIM, "END [ANIM_DELAY]");
+      HandleGlobalAnimEvent(part, ANIM_EVENT_END,  "END [ANIM_DELAY/EVENT]");
+
       part->post_delay_counter =
        (c->post_delay_fixed + GetSimpleRandom(c->post_delay_random));
 
@@ -1277,7 +1429,12 @@ static int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part,
     part->post_delay_counter--;
 
     if (part->post_delay_counter == 0)
+    {
+      HandleGlobalAnimDelay(part, ANIM_DELAY_POST, "END [POST_DELAY]");
+      HandleGlobalAnimEvent(part, ANIM_EVENT_POST, "END [POST_DELAY]");
+
       return ANIM_STATE_RESTART;
+    }
 
     return ANIM_STATE_WAITING;
   }
@@ -1505,22 +1662,37 @@ static void DoAnimationExt(void)
 #endif
 }
 
+static void DoGlobalAnim_DelayAction(struct GlobalAnimPartControlInfo *part,
+                                    int delay_type)
+{
+  int delay_action =
+    (delay_type == ANIM_DELAY_INIT ? part->control_info.init_delay_action :
+     delay_type == ANIM_DELAY_ANIM ? part->control_info.anim_delay_action :
+     delay_type == ANIM_DELAY_POST ? part->control_info.post_delay_action :
+     ANIM_DELAY_ACTION_NONE);
+
+  if (delay_action == ANIM_DELAY_ACTION_NONE)
+    return;
+
+  PushUserEvent(USEREVENT_ANIM_DELAY_ACTION, delay_action, 0);
+}
+
 static boolean DoGlobalAnim_EventAction(struct GlobalAnimPartControlInfo *part)
 {
-  int anim_event_action = part->control_info.anim_event_action;
+  int event_action = (part->init_event_state ?
+                     part->control_info.init_event_action :
+                     part->control_info.anim_event_action);
 
-  if (anim_event_action == -1)
+  if (event_action == ANIM_EVENT_ACTION_NONE)
     return FALSE;
 
-  boolean action_executed = (DoGadgetAction(anim_event_action) ||
-                            DoScreenAction(anim_event_action) ||
-                            DoKeysymAction(anim_event_action));
+  PushUserEvent(USEREVENT_ANIM_EVENT_ACTION, event_action, 0);
 
   // check if further actions are allowed to be executed
   if (part->control_info.style & STYLE_MULTIPLE_ACTIONS)
     return FALSE;
 
-  return action_executed;
+  return TRUE;
 }
 
 static void InitGlobalAnim_Clickable(void)
@@ -1541,13 +1713,21 @@ static void InitGlobalAnim_Clickable(void)
       {
        struct GlobalAnimPartControlInfo *part = &anim->part[part_nr];
 
+       if (part->triggered)
+         part->clicked = TRUE;
+
+       part->triggered = FALSE;
        part->clickable = FALSE;
       }
     }
   }
 }
 
-static boolean InitGlobalAnim_Clicked(int mx, int my, boolean clicked)
+#define ANIM_CLICKED_RESET     0
+#define ANIM_CLICKED_PRESSED   1
+#define ANIM_CLICKED_RELEASED  2
+
+static boolean InitGlobalAnim_Clicked(int mx, int my, int clicked_event)
 {
   boolean anything_clicked = FALSE;
   boolean any_part_clicked = FALSE;
@@ -1571,7 +1751,7 @@ static boolean InitGlobalAnim_Clicked(int mx, int my, boolean clicked)
       {
        struct GlobalAnimPartControlInfo *part = &anim->part[part_nr];
 
-       if (!clicked)
+       if (clicked_event == ANIM_CLICKED_RESET)
        {
          part->clicked = FALSE;
 
@@ -1585,8 +1765,27 @@ static boolean InitGlobalAnim_Clicked(int mx, int my, boolean clicked)
          continue;
 
        // always handle "any" click events (clicking anywhere on screen) ...
-       if (isClickablePart(part, ANIM_EVENT_ANY))
+       if (clicked_event == ANIM_CLICKED_PRESSED &&
+           isClickablePart(part, ANIM_EVENT_ANY))
        {
+#if DEBUG_ANIM_EVENTS
+         printf("::: => %d.%d TRIGGERED BY ANY\n",
+                part->old_anim_nr + 1, part->old_nr + 1);
+#endif
+
+         part->clicked = TRUE;
+         anything_clicked = clickConsumed(part);
+       }
+
+       // always handle "unclick:any" events (releasing anywhere on screen) ...
+       if (clicked_event == ANIM_CLICKED_RELEASED &&
+           isClickablePart(part, ANIM_EVENT_UNCLICK_ANY))
+       {
+#if DEBUG_ANIM_EVENTS
+         printf("::: => %d.%d TRIGGERED BY UNCLICK:ANY\n",
+                part->old_anim_nr + 1, part->old_nr + 1);
+#endif
+
          part->clicked = TRUE;
          anything_clicked = clickConsumed(part);
        }
@@ -1595,7 +1794,8 @@ static boolean InitGlobalAnim_Clicked(int mx, int my, boolean clicked)
        if (any_part_clicked)
          continue;
 
-       if (isClickedPart(part, mx, my, clicked))
+       if (clicked_event == ANIM_CLICKED_PRESSED &&
+           isClickedPart(part, mx, my, TRUE))
        {
 #if 0
          printf("::: %d.%d CLICKED [%d]\n", anim_nr, part_nr,
@@ -1611,61 +1811,18 @@ static boolean InitGlobalAnim_Clicked(int mx, int my, boolean clicked)
 
          if (isClickablePart(part, ANIM_EVENT_SELF))
          {
+#if DEBUG_ANIM_EVENTS
+           printf("::: => %d.%d TRIGGERED BY SELF\n",
+                  part->old_anim_nr + 1, part->old_nr + 1);
+#endif
+
            part->clicked = TRUE;
            anything_clicked = clickConsumed(part);
          }
 
          // check if this click is defined to trigger other animations
-         int gic_anim_nr = part->old_anim_nr + 1;      // X as in "anim_X"
-         int gic_part_nr = part->old_nr + 1;           // Y as in "part_Y"
-         int mask = gic_anim_nr << ANIM_EVENT_ANIM_BIT;
-
-         if (!part->is_base)
-           mask |= gic_part_nr << ANIM_EVENT_PART_BIT;
-
-         int anim2_nr;
-
-         for (anim2_nr = 0; anim2_nr < ctrl->num_anims; anim2_nr++)
-         {
-           struct GlobalAnimMainControlInfo *anim2 = &ctrl->anim[anim2_nr];
-           int part2_nr;
-
-           for (part2_nr = 0; part2_nr < anim2->num_parts_all; part2_nr++)
-           {
-             struct GlobalAnimPartControlInfo *part2 = &anim2->part[part2_nr];
-
-             if (part2->state != ANIM_STATE_RUNNING)
-               continue;
-
-             if (isClickablePart(part2, mask))
-             {
-               part2->clicked = TRUE;
-               anything_clicked = clickConsumed(part); // click was on "part"!
-
-#if 0
-               printf("::: %d.%d TRIGGER CLICKED [%d]\n", anim2_nr, part2_nr,
-                      part2->control_info.anim_event_action);
-#endif
-
-               // after executing event action, ignore any further actions
-               if (!any_event_action && DoGlobalAnim_EventAction(part2))
-                 any_event_action = TRUE;
-             }
-
-#if 0
-             struct GraphicInfo *c = &part2->control_info;
-
-             printf("::: - %d.%d: 0x%08x, 0x%08x [0x%08x]",
-                    anim2_nr, part2_nr, c->init_event, c->anim_event, mask);
-
-             if (isClickablePart(part2, mask))
-               printf(" <--- TRIGGERED BY %d.%d",
-                      anim_nr, part_nr);
-
-             printf("\n");
-#endif
-           }
-         }
+         InitGlobalAnim_Triggered(part, &anything_clicked, &any_event_action,
+                                  ANIM_EVENT_CLICK, "CLICK");
        }
       }
     }
@@ -1681,10 +1838,10 @@ static void ResetGlobalAnim_Clickable(void)
 
 static void ResetGlobalAnim_Clicked(void)
 {
-  InitGlobalAnim_Clicked(-1, -1, FALSE);
+  InitGlobalAnim_Clicked(-1, -1, ANIM_CLICKED_RESET);
 }
 
-boolean HandleGlobalAnimClicks(int mx, int my, int button)
+boolean HandleGlobalAnimClicks(int mx, int my, int button, boolean force_click)
 {
   static boolean click_consumed = FALSE;
   static int last_button = 0;
@@ -1692,6 +1849,9 @@ boolean HandleGlobalAnimClicks(int mx, int my, int button)
   boolean release_event;
   boolean click_consumed_current = click_consumed;
 
+  if (button != 0 && force_click)
+    last_button = 0;
+
   // check if button state has changed since last invocation
   press_event   = (button != 0 && last_button == 0);
   release_event = (button == 0 && last_button != 0);
@@ -1699,12 +1859,15 @@ boolean HandleGlobalAnimClicks(int mx, int my, int button)
 
   if (press_event)
   {
-    click_consumed = InitGlobalAnim_Clicked(mx, my, TRUE);
+    click_consumed = InitGlobalAnim_Clicked(mx, my, ANIM_CLICKED_PRESSED);
     click_consumed_current = click_consumed;
   }
 
   if (release_event)
+  {
+    InitGlobalAnim_Clicked(mx, my, ANIM_CLICKED_RELEASED);
     click_consumed = FALSE;
+  }
 
   return click_consumed_current;
 }