commit cfa10d53647322ff9989db258cfbd42e98b8f8d4 · cduck.me/drawsvg

+20

README.md

···

       260
       260
        
       

     

       261
       261
        
       ![Example output image](https://raw.githubusercontent.com/cduck/drawSvg/master/examples/example6.gif)

     

       262
       262
        
       

     

       263
       263
       +
       ### Asynchronous Animation in Jupyter

     

       264
       264
       +
       ```python

     

       265
       265
       +
       # Jupyter cell 1:

     

       266
       266
       +
       widget = AsyncAnimation(fps=10)

     

       267
       267
       +
       widget

     

       268
       268
       +
       # [Animation is displayed here (click to pause)]

     

       269
       269
       +
       

     

       270
       270
       +
       # Jupyter cell 2:

     

       271
       271
       +
       global_variable = 'a'

     

       272
       272
       +
       @widget.set_draw_frame  # Animation above is automatically updated

     

       273
       273
       +
       def draw_frame(secs=0):

     

       274
       274
       +
           # Draw something...

     

       275
       275
       +
           d = draw.Drawing(300, 40)

     

       276
       276
       +
           d.append(draw.Text(global_variable, 20, 0, 10))

     

       277
       277
       +
           d.append(draw.Text(str(secs), 20, 30, 10))

     

       278
       278
       +
           return d

     

       279
       279
       +
       

     

       280
       280
       +
       # Jupyter cell 3:

     

       281
       281
       +
       global_variable = 'b'  # Animation above now displays 'b'

     

       282
       282
       +
       ```

drawSvg/widgets/__init__.py

···

       1
       1
        
       from .drawing_widget import DrawingWidget

     

       2
       2
       +
       from .async_animation import AsyncAnimation

+155

drawSvg/widgets/async_animation.py

···

       1
       1
       +
       import time

     

       2
       2
       +
       

     

       3
       3
       +
       from ..drawing import Drawing

     

       4
       4
       +
       from .drawing_widget import DrawingWidget

     

       5
       5
       +
       

     

       6
       6
       +
       

     

       7
       7
       +
       class AsyncAnimation(DrawingWidget):

     

       8
       8
       +
           '''AsyncAnimation is a Jupyter notebook widget for asynchronously displaying

     

       9
       9
       +
           an animation.

     

       10
       10
       +
       

     

       11
       11
       +
           Example:

     

       12
       12
       +
               # Jupyter cell 1:

     

       13
       13
       +
               widget = AsyncAnimation(fps=10)

     

       14
       14
       +
               widget

     

       15
       15
       +
               # [Animation is displayed here]

     

       16
       16
       +
       

     

       17
       17
       +
               # Jupyter cell 2:

     

       18
       18
       +
               global_variable = 'a'

     

       19
       19
       +
               @widget.set_draw_frame  # Animation above is automatically updated

     

       20
       20
       +
               def draw_frame(secs=0):

     

       21
       21
       +
                   # Draw something...

     

       22
       22
       +
                   d = draw.Drawing(300, 40)

     

       23
       23
       +
                   d.append(draw.Text(global_variable, 20, 0, 10))

     

       24
       24
       +
                   d.append(draw.Text(str(secs), 20, 30, 10))

     

       25
       25
       +
                   return d

     

       26
       26
       +
       

     

       27
       27
       +
               # Jupyter cell 3:

     

       28
       28
       +
               global_variable = 'b'  # Animation above now displays 'b'

     

       29
       29
       +
       

     

       30
       30
       +
           Attributes:

     

       31
       31
       +
               fps: The animation frame rate (frames per second).

     

       32
       32
       +
               draw_frame: A function that takes a single argument (animation time) and

     

       33
       33
       +
                   returns a Drawing.

     

       34
       34
       +
               paused: While True, the animation will not run.  Only the current frame

     

       35
       35
       +
                   will be shown.

     

       36
       36
       +
               disable: While True, the widget will not be interactive and the

     

       37
       37
       +
                   animation will not update.

     

       38
       38
       +
               click_pause: If True, clicking the drawing will pause or resume the

     

       39
       39
       +
                   animation.

     

       40
       40
       +
               mousemove_pause: If True, moving the mouse up across the drawing will

     

       41
       41
       +
                   pause the animation and moving the mouse down will resume it.

     

       42
       42
       +
               mousemove_y_threshold: Controls the sensitivity of mousemove_pause in

     

       43
       43
       +
                   web browser pixels.

     

       44
       44
       +
           '''

     

       45
       45
       +
       

     

       46
       46
       +
           def __init__(self, fps=10, draw_frame=None, *, paused=False, disable=False,

     

       47
       47
       +
                        click_pause=True, mousemove_pause=False,

     

       48
       48
       +
                        mousemove_y_threshold=10):

     

       49
       49
       +
               self._fps = fps

     

       50
       50
       +
               self._paused = paused

     

       51
       51
       +
               if draw_frame is None:

     

       52
       52
       +
                   def draw_frame(secs):

     

       53
       53
       +
                       return Drawing(0, 0)

     

       54
       54
       +
               self._draw_frame = draw_frame

     

       55
       55
       +
               self._last_secs = 0

     

       56
       56
       +
               self.click_pause = click_pause

     

       57
       57
       +
               self.mousemove_pause = mousemove_pause

     

       58
       58
       +
               self.mousemove_y_threshold = mousemove_y_threshold

     

       59
       59
       +
               self._start_time = 0

     

       60
       60
       +
               self._stop_time = 0

     

       61
       61
       +
               self._y_loc = 0

     

       62
       62
       +
               self._y_max = 0

     

       63
       63
       +
               self._y_min = 0

     

       64
       64
       +
               if self._paused:

     

       65
       65
       +
                   frame_delay = -1

     

       66
       66
       +
               else:

     

       67
       67
       +
                   frame_delay = 1000 // self._fps

     

       68
       68
       +
                   self._start_time = time.monotonic()

     

       69
       69
       +
               initial_drawing = self.draw_frame(0)

     

       70
       70
       +
               super().__init__(initial_drawing, throttle=True, disable=disable,

     

       71
       71
       +
                                frame_delay=frame_delay)

     

       72
       72
       +
       

     

       73
       73
       +
               # Register callbacks

     

       74
       74
       +
               @self.mousedown

     

       75
       75
       +
               def mousedown(self, x, y, info):

     

       76
       76
       +
                   if not self.click_pause:

     

       77
       77
       +
                       return

     

       78
       78
       +
                   self._y_min = self._y_max = self._y_loc

     

       79
       79
       +
                   self.paused = not self.paused

     

       80
       80
       +
       

     

       81
       81
       +
               @self.mousemove

     

       82
       82
       +
               def mousemove(self, x, y, info):

     

       83
       83
       +
                   self._y_loc += info['movementY']

     

       84
       84
       +
                   if not self.mousemove_pause:

     

       85
       85
       +
                       self._y_min = self._y_max = self._y_loc

     

       86
       86
       +
                       return

     

       87
       87
       +
                   self._y_max = max(self._y_max, self._y_loc)

     

       88
       88
       +
                   self._y_min = min(self._y_min, self._y_loc)

     

       89
       89
       +
                   thresh = self.mousemove_y_threshold

     

       90
       90
       +
                   invert = thresh < 0

     

       91
       91
       +
                   thresh = max(0.01, abs(thresh))

     

       92
       92
       +
                   down_triggered = self._y_loc - self._y_min >= thresh

     

       93
       93
       +
                   up_triggered = self._y_max - self._y_loc >= thresh

     

       94
       94
       +
                   if down_triggered:

     

       95
       95
       +
                       self._y_min = self._y_loc

     

       96
       96
       +
                   if up_triggered:

     

       97
       97
       +
                       self._y_max = self._y_loc

     

       98
       98
       +
                   if invert:

     

       99
       99
       +
                       down_triggered, up_triggered = up_triggered, down_triggered

     

       100
       100
       +
                   if down_triggered:

     

       101
       101
       +
                       self.paused = False

     

       102
       102
       +
                   if up_triggered:

     

       103
       103
       +
                       self.paused = True

     

       104
       104
       +
       

     

       105
       105
       +
               @self.timed

     

       106
       106
       +
               def timed(self, info):

     

       107
       107
       +
                   secs = time.monotonic() - self._start_time

     

       108
       108
       +
                   self.drawing = self.draw_frame(secs)

     

       109
       109
       +
                   self._last_secs = secs

     

       110
       110
       +
       

     

       111
       111
       +
               @self.on_exception

     

       112
       112
       +
               def on_exception(self, e):

     

       113
       113
       +
                   self.paused = True

     

       114
       114
       +
       

     

       115
       115
       +
           @property

     

       116
       116
       +
           def fps(self):

     

       117
       117
       +
               return self._fps

     

       118
       118
       +
       

     

       119
       119
       +
           @fps.setter

     

       120
       120
       +
           def fps(self, new_fps):

     

       121
       121
       +
               self._fps = new_fps

     

       122
       122
       +
               if self.paused:

     

       123
       123
       +
                   return

     

       124
       124
       +
               self.frame_delay = 1000 // self._fps

     

       125
       125
       +
       

     

       126
       126
       +
           @property

     

       127
       127
       +
           def paused(self):

     

       128
       128
       +
               return self._paused

     

       129
       129
       +
       

     

       130
       130
       +
           @paused.setter

     

       131
       131
       +
           def paused(self, new_paused):

     

       132
       132
       +
               if bool(self._paused) == bool(new_paused):

     

       133
       133
       +
                   return

     

       134
       134
       +
               self._paused = new_paused

     

       135
       135
       +
               if self._paused:

     

       136
       136
       +
                   self.frame_delay = -1

     

       137
       137
       +
                   self._stop_time = time.monotonic()

     

       138
       138
       +
               else:

     

       139
       139
       +
                   self._start_time += time.monotonic() - self._stop_time

     

       140
       140
       +
                   self.frame_delay = 1000 // self._fps

     

       141
       141
       +
       

     

       142
       142
       +
           @property

     

       143
       143
       +
           def draw_frame(self):

     

       144
       144
       +
               return self._draw_frame

     

       145
       145
       +
       

     

       146
       146
       +
           @draw_frame.setter

     

       147
       147
       +
           def draw_frame(self, new_draw_frame):

     

       148
       148
       +
               self._draw_frame = new_draw_frame

     

       149
       149
       +
               if self.paused:

     

       150
       150
       +
                   # Redraw if paused

     

       151
       151
       +
                   self.drawing = self._draw_frame(self._last_secs)

     

       152
       152
       +
       

     

       153
       153
       +
           def set_draw_frame(self, new_draw_frame):

     

       154
       154
       +
               self.draw_frame = new_draw_frame

     

       155
       155
       +
               return new_draw_frame

+20

drawSvg/widgets/drawing_widget.py

···

       46
       46
        
               self.mousemove_callbacks = []

     

       47
       47
        
               self.mouseup_callbacks = []

     

       48
       48
        
               self.timed_callbacks = []

     

       49
       49
       +
               self.exception_callbacks = []

     

       49
       50
        
       

     

       50
       51
        
               self.on_msg(self._receive_msg)

     

       51
       52
        
       

     
···

       81
       82
        
                       else:

     

       82
       83
        
                           self._call_handlers(callbacks, content.get('x'),

     

       83
       84
        
                                               content.get('y'), content)

     

       85
       85
       +
               except BaseException as e:

     

       86
       86
       +
                   suppress = any(

     

       87
       87
       +
                       handler(self, e)

     

       88
       88
       +
                       for handler in self.exception_callbacks

     

       89
       89
       +
                   )

     

       90
       90
       +
                   if not suppress:

     

       91
       91
       +
                       raise

     

       84
       92
        
               finally:

     

       85
       93
        
                   if name == 'timed':

     

       86
       94
        
                       self._frame_blocked += 1

     
···

       128
       136
        
               '''

     

       129
       137
        
               self._register_handler(

     

       130
       138
        
                   self.timed_callbacks, handler, remove=remove)

     

       139
       139
       +
       

     

       140
       140
       +
           def on_exception(self, handler, remove=False):

     

       141
       141
       +
               '''

     

       142
       142
       +
               Register (or unregister) a handler for exceptions in other handlers.

     

       143
       143
       +
       

     

       144
       144
       +
               If any handler returns True, the exception is suppressed.

     

       145
       145
       +
       

     

       146
       146
       +
               Arguments:

     

       147
       147
       +
                   remove: If True, unregister, otherwise register.

     

       148
       148
       +
               '''

     

       149
       149
       +
               self._register_handler(

     

       150
       150
       +
                   self.exception_callbacks, handler, remove=remove)

     

       131
       151
        
       

     

       132
       152
        
           def _register_handler(self, callback_list, handler, remove=False):

     

       133
       153
        
               if remove: