Color mixer: WIP: Undo/Redo feature

docs/CHANGES.txt

@@ -7,7 +7,7 @@ Various contributors (see below, and AUTHORS.txt)
 http://www.tuxpaint.org/
 
 
-2022.January.27 (0.9.28)
+2022.January.28 (0.9.28)
   * Improvements to "Paint" and "Lines" tools:
     ------------------------------------------
     * Brush spacing may now be altered within Tux Paint.
@@ -75,10 +75,10 @@ http://www.tuxpaint.org/
       Closes https://sourceforge.net/p/tuxpaint/feature-requests/209/
 
     * A new color mixer has been added, allowing red (magenta-ish),
-      yellow, and blue (cyan-ish), along with white ("tint"),
+      yellow, and blue (cyan-ish) primary colors, along with white
-      grey ("tone"), and black ("shade") to be added together to
+      ("tint"), grey ("tone"), and black ("shade") to be added together to
       form a desired color.
-      + WIP: I'd like to add Undo/Redo options to the dialog. -bjk 2021.01.27
+      + WIP: Undo/Redo options
 
     * Show a "pipette"-shaped mouse pointer when selecting a
       color from the color palette, or the picture.

src/tuxpaint.c

@@ -22,7 +22,7 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   (See COPYING.txt)
 
-  June 14, 2002 - January 27, 2022
+  June 14, 2002 - January 28, 2022
 */
 
 #include "platform.h"
@@ -2101,6 +2101,7 @@ static int do_new_dialog_add_colors(SDL_Surface * *thumbs, int num_files, int *d
 static int do_color_picker(void);
 static int do_color_sel(int temp_mode);
 static int do_color_mix(void);
+static void draw_color_mixer_tooltip(void);
 static void draw_color_mix_undo_redo(void);
 static void render_color_button(int the_color, SDL_Surface * decoration, SDL_Surface * icon);
 static void handle_color_changed(void);
@@ -22211,8 +22212,7 @@ int color_mixer_color_counts[NUM_MIXER_COLORS];
 
 #define NUM_COLOR_MIX_UNDO_BUFS 5
 int color_mix_cur_undo, color_mix_oldest_undo, color_mix_newest_undo;
-float mixer_undo_buf_current_hsv[NUM_COLOR_MIX_UNDO_BUFS][3];
+int mixer_undo_buf[NUM_COLOR_MIX_UNDO_BUFS];
-int mixer_undo_buf_added_color_idx[NUM_COLOR_MIX_UNDO_BUFS];
 
 
 /**
@@ -22242,10 +22242,7 @@ static int do_color_mix(void)
   SDL_Surface *backup;
   SDL_Rect r_final;
   int old_color_mixer_reset;
-  int num_colors_used, tot_count;
+  int tot_count;
-  int used_colors_color[NUM_MIXER_COLORS], used_colors_amount[NUM_MIXER_COLORS];
-  char tip_txt[1024];
-  char tip_txt_proportions[NUM_MIXER_COLORS][12];
 
   val_x = val_y = motioner = 0;
   valhat_x = valhat_y = hatmotioner = 0;
@@ -22271,7 +22268,7 @@ static int do_color_mix(void)
   cell_w = img_back->w + 2;
   cell_h = img_back->h + 2;
 
-  /* FIXME */
+  /* Area for the dialog window */
   r_final.x = r_canvas.x + (r_canvas.w - (cell_w * 6)) / 2 - 4;
   r_final.y = ((r_canvas.h - (cell_w * 4)) / 2) - 2;
   r_final.w = (cell_w * 6);
@@ -22525,8 +22522,9 @@ static int do_color_mix(void)
               if ((btn_clicked >= 0 && btn_clicked < NUM_MIXER_COLORS) ||
                   btn_clicked == COLOR_MIXER_BTN_CLEAR ||
                   (btn_clicked == COLOR_MIXER_BTN_USE && !color_mixer_reset) ||
-                  btn_clicked == COLOR_MIXER_BTN_BACK
+                  btn_clicked == COLOR_MIXER_BTN_BACK ||
-                  /* FIXME: Handle Undo & Redo */
+                  (btn_clicked == COLOR_MIXER_BTN_UNDO && color_mix_cur_undo != color_mix_oldest_undo) ||
+                  (btn_clicked == COLOR_MIXER_BTN_REDO && color_mix_cur_undo != color_mix_newest_undo)
                  )
                 {
                   do_setcursor(cursor_hand);
@@ -22552,6 +22550,8 @@ static int do_color_mix(void)
 
               if (btn_clicked >= 0 && btn_clicked < NUM_MIXER_COLORS)
                 {
+                  /* Clicked a color! */
+
                   if (color_mixer_reset)
                     {
                       /* Starting fresh; add the chosen paint 100% */
@@ -22573,6 +22573,8 @@ static int do_color_mix(void)
                     }
                   else
                     {
+                      /* Blending in some color */
+
                       float circ_mean_avg_sin, circ_mean_avg_cos;
                       int tot_count_hue;
                       float sat, val;
@@ -22623,15 +22625,253 @@ static int do_color_mix(void)
                       v = val / tot_count;
                     }
 
-                  hsvtorgb(h, s, v, &new_r, &new_g, &new_b);
+                  /* Record undo buffer */
 
-                  /* FIXME: Record undo buffer */
+                  /* FIXME: Record! */
+                  color_mix_cur_undo = (color_mix_cur_undo + 1) % NUM_COLOR_MIX_UNDO_BUFS;
+                  if (color_mix_cur_undo == color_mix_oldest_undo)
+                    color_mix_oldest_undo = (color_mix_oldest_undo + 1) % NUM_COLOR_MIX_UNDO_BUFS;
+                  color_mix_newest_undo = color_mix_cur_undo;
+
+                  draw_color_mix_undo_redo();
+
+
+                  /* Show the new color */
+
+                  hsvtorgb(h, s, v, &new_r, &new_g, &new_b);
 
                   SDL_FillRect(screen, &color_example_dest, SDL_MapRGB(screen->format, new_r, new_g, new_b));
                   SDL_UpdateRect(screen, color_example_dest.x, color_example_dest.y, color_example_dest.w, color_example_dest.h);
 
+                  /* Draw the tooltip and play a sound */
+                  draw_color_mixer_tooltip();
+
+                  playsound(screen, 1, SND_BUBBLE, 1, SNDPOS_CENTER, SNDDIST_NEAR);
+                }
+              else if (btn_clicked == COLOR_MIXER_BTN_BACK)
+                {
+                  /* Decided to go Back */
+
+                  chose = 0;
+                  done = 1;
+                }
+              else if (btn_clicked == COLOR_MIXER_BTN_USE && !color_mixer_reset)
+                {
+                  /* Decided to use this color */
+                  chose = 1;
+                  done = 1;
+                }
+              else if (btn_clicked == COLOR_MIXER_BTN_CLEAR)
+                {
+                  /* Decided to clear the color choice & start over */
+
+                  color_mixer_reset = 1;
+
+                  /* Wipe undo buffer */
+                  color_mix_cur_undo = color_mix_oldest_undo = color_mix_newest_undo = 0;
                   draw_color_mix_undo_redo();
 
+                  /* Clear color usage counts */
+                  for (i = 0; i < NUM_MIXER_COLORS; i++)
+                    color_mixer_color_counts[i] = 0;
+
+                  draw_tux_text(TUX_BORED, color_names[COLOR_MIXER], 1);
+
+                  /* Erase the "OK" button! */
+                  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_USE];
+                  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_USE];
+                  dest.w = cell_w;
+                  dest.h = cell_h;
+
+                  SDL_FillRect(screen, &dest, SDL_MapRGB(screen->format, 255, 255, 255));
+                  SDL_UpdateRect(screen, dest.x, dest.y, dest.w, dest.h);
+
+                  /* FIXME: Modularize; duplicated above! */
+                  SDL_FillRect(screen, &color_example_dest,
+                               SDL_MapRGB(screen->format, 192, 192, 192));
+            
+                  for (w = 0; w < color_example_dest.w; w += 4)
+                    {
+                      dest.x = color_example_dest.x + w;
+                      dest.y = color_example_dest.y;
+                      dest.w = 2;
+                      dest.h = color_example_dest.h;
+            
+                      SDL_FillRect(screen, &dest,
+                                   SDL_MapRGB(screen->format, 128, 128, 128));
+                    }
+
+                  SDL_UpdateRect(screen, color_example_dest.x, color_example_dest.y, color_example_dest.w, color_example_dest.h);
+
+#ifndef NOSOUND
+                  if (!mute && use_sound)
+                    {
+                      if (!Mix_Playing(0))
+                        {
+                          eraser_sound = (eraser_sound + 1) % 2;
+                
+                          playsound(screen, 0, SND_ERASER1 + eraser_sound, 0, SNDPOS_CENTER, SNDDIST_NEAR);
+                        }
+                    }
+#endif
+                }
+              else if (btn_clicked == COLOR_MIXER_BTN_UNDO && color_mix_cur_undo != color_mix_oldest_undo)
+                {
+                  /* Undo! */
+                  color_mix_cur_undo--;
+                  if (color_mix_cur_undo < 0)
+                    color_mix_cur_undo = NUM_COLOR_MIX_UNDO_BUFS - 1;
+
+                  printf("Undo! %d\n", color_mix_cur_undo);
+
+                  draw_color_mix_undo_redo();
+                }
+              else if (btn_clicked == COLOR_MIXER_BTN_REDO && color_mix_cur_undo != color_mix_newest_undo)
+                {
+                  /* Redo! */
+                  color_mix_cur_undo = (color_mix_cur_undo + 1) % NUM_COLOR_MIX_UNDO_BUFS;
+
+                  printf("Redo! %d\n", color_mix_cur_undo);
+
+                  draw_color_mix_undo_redo();
+                }
+            }
+          else if (event.type == SDL_JOYAXISMOTION)
+            handle_joyaxismotion(event, &motioner, &val_x, &val_y);
+
+          else if (event.type == SDL_JOYHATMOTION)
+            handle_joyhatmotion(event, oldpos_x, oldpos_y, &valhat_x, &valhat_y, &hatmotioner, &old_hat_ticks);
+
+          else if (event.type == SDL_JOYBALLMOTION)
+            handle_joyballmotion(event, oldpos_x, oldpos_y);
+
+          else if (event.type == SDL_JOYBUTTONDOWN || event.type == SDL_JOYBUTTONUP)
+            handle_joybuttonupdown(event, oldpos_x, oldpos_y);
+        }
+
+      if (motioner | hatmotioner)
+        handle_motioners(oldpos_x, oldpos_y, motioner, hatmotioner, old_hat_ticks, val_x, val_y, valhat_x, valhat_y);
+
+      SDL_Delay(10);
+    }
+  while (!done);
+
+
+  /* Set the new color: */
+
+  if (chose)
+    {
+      color_hexes[COLOR_MIXER][0] = new_r;
+      color_hexes[COLOR_MIXER][1] = new_g;
+      color_hexes[COLOR_MIXER][2] = new_b;
+
+
+      /* Re-render color mixer to show the current color it contains: */
+      render_color_button(COLOR_MIXER, NULL, img_color_mix);
+    }
+  else
+    {
+      color_mixer_reset = old_color_mixer_reset;
+    }
+
+  /* Remove the prompt: */
+
+  update_canvas(0, 0, canvas->w, canvas->h);
+
+
+  return (chose);
+}
+
+
+/**
+ * Draw the undo & redo buttons of the color mixer,
+ * making the buttons appear clickable ("up") or not ("off"),
+ * depending on the state of the color mixer's undo buffer
+ */
+static void draw_color_mix_undo_redo(void) {
+  SDL_Rect dest;
+  SDL_Surface * icon_label_color, * tmp_surf;
+
+  /* Show "Undo" button */
+
+  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_UNDO];
+  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_UNDO];
+
+  if (color_mix_cur_undo != color_mix_oldest_undo)
+    {
+      SDL_BlitSurface(img_btn_up, NULL, screen, &dest);
+      icon_label_color = img_black;
+    }
+  else
+    {
+      SDL_BlitSurface(img_btn_off, NULL, screen, &dest);
+      icon_label_color = img_grey;
+    }
+ 
+  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_UNDO] + (img_back->w - img_tools[TOOL_UNDO]->w) / 2;
+  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_UNDO];
+
+  tmp_surf = SDL_DisplayFormatAlpha(img_tools[TOOL_UNDO]);
+  SDL_BlitSurface(icon_label_color, NULL, tmp_surf, NULL);
+  SDL_BlitSurface(tmp_surf, NULL, screen, &dest);
+  SDL_FreeSurface(tmp_surf);
+
+  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_UNDO] + (img_back->w - img_tool_names[TOOL_UNDO]->w) / 2;
+  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_UNDO] + img_back->h - img_tool_names[TOOL_UNDO]->h;
+
+  tmp_surf = SDL_DisplayFormatAlpha(img_tool_names[TOOL_UNDO]);
+  SDL_BlitSurface(icon_label_color, NULL, tmp_surf, NULL);
+  SDL_BlitSurface(tmp_surf, NULL, screen, &dest);
+  SDL_FreeSurface(tmp_surf);
+
+  SDL_UpdateRect(screen, color_mix_btn_lefts[COLOR_MIXER_BTN_UNDO], color_mix_btn_tops[COLOR_MIXER_BTN_UNDO], img_back->w, img_back->h);
+
+
+  /* Show "Redo" button */
+
+  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_REDO];
+  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_REDO];
+
+  if (color_mix_cur_undo != color_mix_newest_undo)
+    {
+      SDL_BlitSurface(img_btn_up, NULL, screen, &dest);
+      icon_label_color = img_black;
+    }
+  else
+    {
+      SDL_BlitSurface(img_btn_off, NULL, screen, &dest);
+      icon_label_color = img_grey;
+    }
+
+  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_REDO] + (img_back->w - img_tools[TOOL_REDO]->w) / 2;
+  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_REDO];
+
+  tmp_surf = SDL_DisplayFormatAlpha(img_tools[TOOL_REDO]);
+  SDL_BlitSurface(icon_label_color, NULL, tmp_surf, NULL);
+  SDL_BlitSurface(tmp_surf, NULL, screen, &dest);
+  SDL_FreeSurface(tmp_surf);
+
+  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_REDO] + (img_back->w - img_tool_names[TOOL_REDO]->w) / 2;
+  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_REDO] + img_back->h - img_tool_names[TOOL_REDO]->h;
+
+  tmp_surf = SDL_DisplayFormatAlpha(img_tool_names[TOOL_REDO]);
+  SDL_BlitSurface(icon_label_color, NULL, tmp_surf, NULL);
+  SDL_BlitSurface(tmp_surf, NULL, screen, &dest);
+  SDL_FreeSurface(tmp_surf);
+
+  SDL_UpdateRect(screen, color_mix_btn_lefts[COLOR_MIXER_BTN_REDO], color_mix_btn_tops[COLOR_MIXER_BTN_REDO], img_back->w, img_back->h);
+}
+
+
+/**
+ * Show a tooltip describing the color the user has mixed
+ */
+static void draw_color_mixer_tooltip(void) {
+  int i, num_colors_used, tot_count;
+  char tip_txt[1024];
+  char tip_txt_proportions[NUM_MIXER_COLORS][12];
+  int used_colors_color[NUM_MIXER_COLORS], used_colors_amount[NUM_MIXER_COLORS];
+
   num_colors_used = 0;
   tot_count = 0;
   for (i = 0; i < NUM_MIXER_COLORS; i++)
@@ -22706,198 +22946,7 @@ static int do_color_mix(void)
     }
 
   draw_tux_text(TUX_GREAT, tip_txt, 1);
-
-                  playsound(screen, 1, SND_BUBBLE, 1, SNDPOS_CENTER, SNDDIST_NEAR);
 }
-              else if (btn_clicked == COLOR_MIXER_BTN_BACK)
-                {
-                  /* Decided to go Back */
-
-                  chose = 0;
-                  done = 1;
-                }
-              else if (btn_clicked == COLOR_MIXER_BTN_USE && !color_mixer_reset)
-                {
-                  /* Decided to use this color */
-                  chose = 1;
-                  done = 1;
-                }
-              else if (btn_clicked == COLOR_MIXER_BTN_CLEAR)
-                {
-                  /* Decided to clear the color choice & start over */
-
-                  color_mixer_reset = 1;
-
-                  /* FIXME: Wipe undo buffer */
-
-                  draw_color_mix_undo_redo();
-
-                  /* Clear color usage counts */
-                  for (i = 0; i < NUM_MIXER_COLORS; i++)
-                    color_mixer_color_counts[i] = 0;
-
-                  draw_tux_text(TUX_BORED, color_names[COLOR_MIXER], 1);
-
-                  /* Erase the "OK" button! */
-                  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_USE];
-                  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_USE];
-                  dest.w = cell_w;
-                  dest.h = cell_h;
-
-                  SDL_FillRect(screen, &dest, SDL_MapRGB(screen->format, 255, 255, 255));
-                  SDL_UpdateRect(screen, dest.x, dest.y, dest.w, dest.h);
-
-                  /* FIXME: Modularize; duplicated above! */
-                  SDL_FillRect(screen, &color_example_dest,
-                               SDL_MapRGB(screen->format, 192, 192, 192));
-            
-                  for (w = 0; w < color_example_dest.w; w += 4)
-                    {
-                      dest.x = color_example_dest.x + w;
-                      dest.y = color_example_dest.y;
-                      dest.w = 2;
-                      dest.h = color_example_dest.h;
-            
-                      SDL_FillRect(screen, &dest,
-                                   SDL_MapRGB(screen->format, 128, 128, 128));
-                    }
-
-                  SDL_UpdateRect(screen, color_example_dest.x, color_example_dest.y, color_example_dest.w, color_example_dest.h);
-
-#ifndef NOSOUND
-                  if (!mute && use_sound)
-                    {
-                      if (!Mix_Playing(0))
-                        {
-                          eraser_sound = (eraser_sound + 1) % 2;
-                
-                          playsound(screen, 0, SND_ERASER1 + eraser_sound, 0, SNDPOS_CENTER, SNDDIST_NEAR);
-                        }
-                    }
-#endif
-                }
-              /* FIXME - All the other controls */
-            }
-          else if (event.type == SDL_JOYAXISMOTION)
-            handle_joyaxismotion(event, &motioner, &val_x, &val_y);
-
-          else if (event.type == SDL_JOYHATMOTION)
-            handle_joyhatmotion(event, oldpos_x, oldpos_y, &valhat_x, &valhat_y, &hatmotioner, &old_hat_ticks);
-
-          else if (event.type == SDL_JOYBALLMOTION)
-            handle_joyballmotion(event, oldpos_x, oldpos_y);
-
-          else if (event.type == SDL_JOYBUTTONDOWN || event.type == SDL_JOYBUTTONUP)
-            handle_joybuttonupdown(event, oldpos_x, oldpos_y);
-        }
-
-      if (motioner | hatmotioner)
-        handle_motioners(oldpos_x, oldpos_y, motioner, hatmotioner, old_hat_ticks, val_x, val_y, valhat_x, valhat_y);
-
-      SDL_Delay(10);
-    }
-  while (!done);
-
-
-  /* Set the new color: */
-
-  if (chose)
-    {
-      color_hexes[COLOR_MIXER][0] = new_r;
-      color_hexes[COLOR_MIXER][1] = new_g;
-      color_hexes[COLOR_MIXER][2] = new_b;
-
-
-      /* Re-render color mixer to show the current color it contains: */
-      render_color_button(COLOR_MIXER, NULL, img_color_mix);
-    }
-  else
-    {
-      color_mixer_reset = old_color_mixer_reset;
-    }
-
-  /* Remove the prompt: */
-
-  update_canvas(0, 0, canvas->w, canvas->h);
-
-
-  return (chose);
-}
-
-
-/**
- * Draw the undo & redo buttons of the color mixer,
- * making the buttons appear clickable ("up") or not ("off"),
- * depending on the state of the color mixer's undo buffer
- */
-static void draw_color_mix_undo_redo(void) {
-  SDL_Rect dest;
-  SDL_Surface * icon_label_color, * tmp_surf;
-
-  /* Show "Undo" button */
-
-  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_UNDO];
-  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_UNDO];
-
-  if (0) /* FIXME */
-    {
-      SDL_BlitSurface(img_btn_up, NULL, screen, &dest);
-      icon_label_color = img_black;
-    }
-  else
-    {
-      SDL_BlitSurface(img_btn_off, NULL, screen, &dest);
-      icon_label_color = img_grey;
-    }
- 
-  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_UNDO] + (img_back->w - img_tools[TOOL_UNDO]->w) / 2;
-  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_UNDO];
-
-  tmp_surf = SDL_DisplayFormatAlpha(img_tools[TOOL_UNDO]);
-  SDL_BlitSurface(icon_label_color, NULL, tmp_surf, NULL);
-  SDL_BlitSurface(tmp_surf, NULL, screen, &dest);
-  SDL_FreeSurface(tmp_surf);
-
-  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_UNDO] + (img_back->w - img_tool_names[TOOL_UNDO]->w) / 2;
-  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_UNDO] + img_back->h - img_tool_names[TOOL_UNDO]->h;
-
-  tmp_surf = SDL_DisplayFormatAlpha(img_tool_names[TOOL_UNDO]);
-  SDL_BlitSurface(icon_label_color, NULL, tmp_surf, NULL);
-  SDL_BlitSurface(tmp_surf, NULL, screen, &dest);
-  SDL_FreeSurface(tmp_surf);
-
-  /* Show "Redo" button */
-
-  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_REDO];
-  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_REDO];
-  if (0) /* FIXME */
-    {
-      SDL_BlitSurface(img_btn_up, NULL, screen, &dest);
-      icon_label_color = img_black;
-    }
-  else
-    {
-      SDL_BlitSurface(img_btn_off, NULL, screen, &dest);
-      icon_label_color = img_grey;
-    }
-
-  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_REDO] + (img_back->w - img_tools[TOOL_REDO]->w) / 2;
-  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_REDO];
-
-  tmp_surf = SDL_DisplayFormatAlpha(img_tools[TOOL_REDO]);
-  SDL_BlitSurface(icon_label_color, NULL, tmp_surf, NULL);
-  SDL_BlitSurface(tmp_surf, NULL, screen, &dest);
-  SDL_FreeSurface(tmp_surf);
-
-  dest.x = color_mix_btn_lefts[COLOR_MIXER_BTN_REDO] + (img_back->w - img_tool_names[TOOL_REDO]->w) / 2;
-  dest.y = color_mix_btn_tops[COLOR_MIXER_BTN_REDO] + img_back->h - img_tool_names[TOOL_REDO]->h;
-
-  tmp_surf = SDL_DisplayFormatAlpha(img_tool_names[TOOL_REDO]);
-  SDL_BlitSurface(icon_label_color, NULL, tmp_surf, NULL);
-  SDL_BlitSurface(tmp_surf, NULL, screen, &dest);
-  SDL_FreeSurface(tmp_surf);
-}
-
 
 /**
  * Render an interactive color button (selector, picker, mixer)