notgne2/tuxpaint-pencil-sharpener
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

api->retract_undo() added to Magic API; used by Filled Polygon

Browse source 
New API function which rolls back the Undo buffer (which is snapshotted
upon a mousedown event ahead of calling the Magic tool's `_click()`
function.)  Dangerous; use sparingly!

Filled Polygon uses this to prevent partially-created (aka unfinished
aka incomplete) polygons -- the preview lines and control points -- from
being recorded and wasting space in the Undo history, or reappearing
upon Redo.

TODO - Other tools (e.g., Clone) would certainly benefit from this.
TODO - Needs more testing to help identify any bugs/issues introduced
by this!
TODO - Magic API docs need updating.

This is probably a sufficient solution that will make
https://sourceforge.net/p/tuxpaint/feature-requests/246/,
'"Overlay" surface in Magic API', unnecessary.
This commit is contained in:
Bill Kendrick 2024-06-01 01:35:50 -07:00
parent 2e9f4b7f42
commit 01afb5846c
5 changed files with 63 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

34
magic/src/polyfill.c
View file

@ -7,7 +7,7 @@
Scanline polygon fill routine based on public-domain code
by Darel Rex Finley, 2007 <https://alienryderflex.com/polygon_fill/>
Last updated: May 30, 2024
Last updated: June 1, 2024
*/
@ -19,6 +19,9 @@
#include "SDL_image.h"
#include "SDL_mixer.h"
// #define DEBUG
enum
{
TOOL_POLYFILL,
@ -222,7 +225,7 @@ polyfill_click(magic_api * api, int which ATTRIBUTE_UNUSED, int mode ATTRIBUTE_U
polyfill_dragged = 0;
#ifdef DEBUG
printf("Click. num_pts = %d\n", polyfill_num_pts);
printf("\nClick. num_pts = %d\n", polyfill_num_pts);
#endif
/* See if we're clicking a pre-existing point, to edit it? */
@ -242,6 +245,7 @@ polyfill_click(magic_api * api, int which ATTRIBUTE_UNUSED, int mode ATTRIBUTE_U
#endif
polyfill_draw_preview(api, canvas, 1);
return;
}
@ -407,7 +411,7 @@ polyfill_release(magic_api * api, int which ATTRIBUTE_UNUSED,
}
/* Moved (or placed) the final spot at the beginning? */
if (polyfill_num_pts > 2 &&
if (polyfill_num_pts > 3 &&
((polyfill_editing == polyfill_num_pts - 1 &&
abs(x - polyfill_pt_x[0]) <= SNAP_SIZE &&
abs(y - polyfill_pt_y[0]) <= SNAP_SIZE) ||
@ -442,6 +446,12 @@ polyfill_release(magic_api * api, int which ATTRIBUTE_UNUSED,
/* Play "finish" sound effect */
api->playsound(snd_effects[SND_FINISH], 128 /* TODO could be clever and determine midpoint of polygon */, 255);
#ifdef DEBUG
printf("Retract the undo we just took (ahead of finishing polygon)!\n");
#endif
api->retract_undo();
SDL_BlitSurface(canvas, NULL, snapshot, NULL);
}
else
{
@ -493,6 +503,16 @@ polyfill_release(magic_api * api, int which ATTRIBUTE_UNUSED,
update_rect->y = 0;
update_rect->w = canvas->w;
update_rect->h = canvas->h;
/* Unless we just started a new polygon, don't let
Tux Paint take more undo snapshots */
if (polyfill_num_pts > 1)
{
#ifdef DEBUG
printf("Retract the undo we just took!\n");
#endif
api->retract_undo();
}
}
void polyfill_set_color(magic_api * api, int which ATTRIBUTE_UNUSED, SDL_Surface * canvas,
@ -555,6 +575,14 @@ void polyfill_switchin(magic_api * api ATTRIBUTE_UNUSED, int which ATTRIBUTE_UNU
void polyfill_switchout(magic_api * api ATTRIBUTE_UNUSED, int which ATTRIBUTE_UNUSED, int mode ATTRIBUTE_UNUSED,
SDL_Surface * canvas)
{
if (polyfill_num_pts > 0)
{
#ifdef DEBUG
printf("Retract the undo we just took (on our way out)!\n");
#endif
api->retract_undo();
}
polyfill_num_pts = 0;
polyfill_editing = MAX_PTS;
polyfill_active = 0;