commit a873ff35fbe4fca0307876b8ca0306e5e34600e5 · cduck.me/drawsvg

+52 -8

README.md

···

       1
       1
        
       # drawSvg

     

       2
       2
        
       

     

       3
       3
       -
       A Python 3 library for programmatically generating SVG images (vector drawings) and rendering them or displaying them in an iPython notebook.

     

       3
       3
       +
       A Python 3 library for programmatically generating SVG images (vector drawings) and rendering them or displaying them in a Jupyter notebook.

     

       4
       4
        
       

     

       5
       5
        
       Most common SVG tags are supported and others can easily be added by writing a small subclass of `DrawableBasicElement` or `DrawableParentElement`.

     

       6
       6
        
       

     
···

       72
       72
        
       d.saveSvg('example.svg')

     

       73
       73
        
       d.savePng('example.png')

     

       74
       74
        
       

     

       75
       75
       -
       # Display in iPython notebook

     

       75
       75
       +
       # Display in Jupyter notebook

     

       76
       76
        
       d.rasterize()  # Display as PNG

     

       77
       77
        
       d  # Display as SVG

     

       78
       78
        
       ```

     

       79
       79
        
       

     

       80
       80
       -
       ![Example output image](https://raw.githubusercontent.com/cduck/drawSvg/master/examples/example1.png)

     

       80
       80
       +
       [![Example output image](https://raw.githubusercontent.com/cduck/drawSvg/master/examples/example1.png)](https://github.com/cduck/drawSvg/blob/master/examples/example1.svg)

     

       81
       81
        
       

     

       82
       82
        
       ### Gradients

     

       83
       83
        
       ```python

     
···

       119
       119
        
       d

     

       120
       120
        
       ```

     

       121
       121
        
       

     

       122
       122
       -
       ![Example output image](https://raw.githubusercontent.com/cduck/drawSvg/master/examples/example2.png)

     

       122
       122
       +
       [![Example output image](https://raw.githubusercontent.com/cduck/drawSvg/master/examples/example2.png)](https://github.com/cduck/drawSvg/blob/master/examples/example2.svg)

     

       123
       123
        
       

     

       124
       124
        
       ### Duplicate geometry and clip paths

     

       125
       125
        
       ```python

     
···

       147
       147
        
       d.rasterize()

     

       148
       148
        
       ```

     

       149
       149
        
       

     

       150
       150
       -
       ![Example output image](https://raw.githubusercontent.com/cduck/drawSvg/master/examples/example3.png)

     

       150
       150
       +
       [![Example output image](https://raw.githubusercontent.com/cduck/drawSvg/master/examples/example3.png)](https://github.com/cduck/drawSvg/blob/master/examples/example3.svg)

     

       151
       151
        
       

     

       152
       152
        
       ### Implementing other SVG tags

     

       153
       153
        
       ```python

     
···

       179
       179
        
       d

     

       180
       180
        
       ```

     

       181
       181
        
       

     

       182
       182
       -
       ![Example output image](https://raw.githubusercontent.com/cduck/drawSvg/master/examples/example4.png)

     

       182
       182
       +
       [![Example output image](https://raw.githubusercontent.com/cduck/drawSvg/master/examples/example4.png)](https://github.com/cduck/drawSvg/blob/master/examples/example4.svg)

     

       183
       183
        
       

     

       184
       184
        
       ### Interactive Widget

     

       185
       185
        
       ```python

     
···

       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)

     

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

     

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

     

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

     

       277
       277
       +
           d.append(draw.Text('{:0.1f}'.format(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
        
       ```

     

       283
       283
       +
       

     

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

     

       285
       285
       +
       

     

       286
       286
       +
       ### SVG-Native Animation

     

       287
       287
       +
       ```python

     

       288
       288
       +
       import drawSvg as draw

     

       289
       289
       +
       

     

       290
       290
       +
       d = draw.Drawing(200, 200, origin='center')

     

       291
       291
       +
       

     

       292
       292
       +
       # Animate the position and color of circle

     

       293
       293
       +
       c = draw.Circle(0, 0, 20, fill='red')

     

       294
       294
       +
       # See for supported attributes:

     

       295
       295
       +
       # https://developer.mozilla.org/en-US/docs/Web/SVG/Element/animate

     

       296
       296
       +
       c.appendAnim(draw.Animate('cy', '6s', '-80;80;-80',

     

       297
       297
       +
                                 repeatCount='indefinite'))

     

       298
       298
       +
       c.appendAnim(draw.Animate('cx', '6s', '0;80;0;-80;0',

     

       299
       299
       +
                                 repeatCount='indefinite'))

     

       300
       300
       +
       c.appendAnim(draw.Animate('fill', '6s', 'red;green;blue;yellow',

     

       301
       301
       +
                                 calcMode='discrete',

     

       302
       302
       +
                                 repeatCount='indefinite'))

     

       303
       303
       +
       d.append(c)

     

       304
       304
       +
       

     

       305
       305
       +
       # Animate a black circle around an ellipse

     

       306
       306
       +
       ellipse = draw.Path()

     

       307
       307
       +
       ellipse.M(-90, 0)

     

       308
       308
       +
       ellipse.A(90, 40, 360, True, True, 90, 0)  # Ellipse path

     

       309
       309
       +
       ellipse.A(90, 40, 360, True, True, -90, 0)

     

       310
       310
       +
       ellipse.Z()

     

       311
       311
       +
       c2 = draw.Circle(0, 0, 10)

     

       312
       312
       +
       # See for supported attributes:

     

       313
       313
       +
       # https://developer.mozilla.org/en-US/docs/Web/SVG/Element/animateMotion

     

       314
       314
       +
       c2.appendAnim(draw.AnimateMotion(ellipse, '3s',

     

       315
       315
       +
                                        repeatCount='indefinite'))

     

       316
       316
       +
       # See for supported attributes:

     

       317
       317
       +
       # https://developer.mozilla.org/en-US/docs/Web/SVG/Element/animateTransform

     

       318
       318
       +
       c2.appendAnim(draw.AnimateTransform('scale', '3s', '1,2;2,1;1,2;2,1;1,2',

     

       319
       319
       +
                                           repeatCount='indefinite'))

     

       320
       320
       +
       d.append(c2)

     

       321
       321
       +
       

     

       322
       322
       +
       d.saveSvg('/Users/cduck/Downloads/animated.svg')  # Save to file

     

       323
       323
       +
       d  # Display in Jupyter notebook

     

       324
       324
       +
       ```

     

       325
       325
       +
       

     

       326
       326
       +
       [![Example output image](https://raw.githubusercontent.com/cduck/drawSvg/master/examples/animated-fix-github.svg?sanitize=true)](https://github.com/cduck/drawSvg/blob/master/examples/animated.svg)

+35 -8

drawSvg/drawing.py

···

       1
       1
        
       

     

       2
       2
        
       from io import StringIO

     

       3
       3
       +
       import base64

     

       3
       4
        
       

     

       4
       5
        
       from . import Raster

     

       5
       6
        
       from . import elements as elementsModule

     
···

       10
       11
        
       

     

       11
       12
        
               Supports iPython: If a Drawing is the last line of a cell, it will be

     

       12
       13
        
               displayed as an SVG below. '''

     

       13
       13
       -
           def __init__(self, width, height, origin=(0,0), **svgArgs):

     

       14
       14
       +
           def __init__(self, width, height, origin=(0,0), idPrefix='d',

     

       15
       15
       +
                        displayInline=True, **svgArgs):

     

       14
       16
        
               assert float(width) == width

     

       15
       17
        
               assert float(height) == height

     

       16
       18
        
               self.width = width

     
···

       28
       30
        
               self.pixelScale = 1

     

       29
       31
        
               self.renderWidth = None

     

       30
       32
        
               self.renderHeight = None

     

       31
       31
       -
               self.svgArgs = svgArgs

     

       33
       33
       +
               self.idPrefix = str(idPrefix)

     

       34
       34
       +
               self.displayInline = displayInline

     

       35
       35
       +
               self.svgArgs = {}

     

       36
       36
       +
               for k, v in svgArgs.items():

     

       37
       37
       +
                   k = k.replace('__', ':')

     

       38
       38
       +
                   k = k.replace('_', '-')

     

       39
       39
       +
                   if k[-1] == '-':

     

       40
       40
       +
                       k = k[:-1]

     

       41
       41
       +
                   self.svgArgs[k] = v

     

       32
       42
        
           def setRenderSize(self, w=None, h=None):

     

       33
       43
        
               self.renderWidth = w

     

       34
       44
        
               self.renderHeight = h

     
···

       97
       107
        
               outputFile.write('>\n<defs>\n')

     

       98
       108
        
               # Write definition elements

     

       99
       109
        
               idIndex = 0

     

       100
       100
       -
               def idGen(base='d'):

     

       110
       110
       +
               def idGen(base=''):

     

       101
       111
        
                   nonlocal idIndex

     

       102
       102
       -
                   idStr = base + str(idIndex)

     

       112
       112
       +
                   idStr = self.idPrefix + base + str(idIndex)

     

       103
       113
        
                   idIndex += 1

     

       104
       114
        
                   return idStr

     

       105
       115
        
               prevSet = set((id(defn) for defn in self.otherDefs))

     
···

       110
       120
        
                   return dup

     

       111
       121
        
               for element in self.otherDefs:

     

       112
       122
        
                   try:

     

       113
       113
       -
                       element.writeSvgElement(outputFile)

     

       123
       123
       +
                       element.writeSvgElement(idGen, isDuplicate, outputFile, False)

     

       114
       124
        
                       outputFile.write('\n')

     

       115
       125
        
                   except AttributeError:

     

       116
       126
        
                       pass

     

       117
       127
        
               for element in self.elements:

     

       118
       128
        
                   try:

     

       119
       119
       -
                       element.writeSvgDefs(idGen, isDuplicate, outputFile)

     

       129
       129
       +
                       element.writeSvgDefs(idGen, isDuplicate, outputFile, False)

     

       120
       130
        
                   except AttributeError:

     

       121
       131
        
                       pass

     

       122
       132
        
               outputFile.write('</defs>\n')

     

       133
       133
       +
               # Generate ids for normal elements

     

       134
       134
       +
               prevDefSet = set(prevSet)

     

       135
       135
       +
               for element in self.elements:

     

       136
       136
       +
                   try:

     

       137
       137
       +
                       element.writeSvgElement(idGen, isDuplicate, outputFile, True)

     

       138
       138
       +
                   except AttributeError:

     

       139
       139
       +
                       pass

     

       140
       140
       +
               prevSet = prevDefSet

     

       123
       141
        
               # Write normal elements

     

       124
       142
        
               for element in self.elements:

     

       125
       143
        
                   try:

     

       126
       126
       -
                       element.writeSvgElement(outputFile)

     

       144
       144
       +
                       element.writeSvgElement(idGen, isDuplicate, outputFile, False)

     

       127
       145
        
                       outputFile.write('\n')

     

       128
       146
        
                   except AttributeError:

     

       129
       147
        
                       pass

     
···

       142
       160
        
                   return Raster.fromSvg(self.asSvg())

     

       143
       161
        
           def _repr_svg_(self):

     

       144
       162
        
               ''' Display in Jupyter notebook '''

     

       163
       163
       +
               if not self.displayInline:

     

       164
       164
       +
                   return None

     

       145
       165
        
               return self.asSvg()

     

       146
       146
       -
       

     

       166
       166
       +
           def _repr_html_(self):

     

       167
       167
       +
               ''' Display in Jupyter notebook '''

     

       168
       168
       +
               if self.displayInline:

     

       169
       169
       +
                   return None

     

       170
       170
       +
               prefix = b'data:image/svg+xml;base64,'

     

       171
       171
       +
               data = base64.b64encode(self.asSvg().encode())

     

       172
       172
       +
               src = (prefix+data).decode()

     

       173
       173
       +
               return '<img src="{}">'.format(src)

+187 -37

drawSvg/elements.py

···

       15
       15
        
       def writeXmlNodeArgs(args, outputFile):

     

       16
       16
        
           for k, v in args.items():

     

       17
       17
        
               if v is None: continue

     

       18
       18
       -
               k = k.replace('__', ':')

     

       19
       19
       -
               k = k.replace('_', '-')

     

       20
       20
       -
               if k[-1]=='-':

     

       21
       21
       -
                   k = k[:-1]

     

       22
       22
       -
               if isinstance(v, defs.DrawingElement):

     

       18
       18
       +
               if isinstance(v, DrawingElement):

     

       19
       19
       +
                   if v.id is None:

     

       20
       20
       +
                       continue

     

       23
       21
        
                   if k == 'xlink:href':

     

       24
       22
        
                       v = '#{}'.format(v.id)

     

       25
       23
        
                   else:

     
···

       31
       29
        
           ''' Base class for drawing elements

     

       32
       30
        
       

     

       33
       31
        
               Subclasses must implement writeSvgElement '''

     

       34
       34
       -
           def writeSvgElement(self, outputFile):

     

       32
       32
       +
           def writeSvgElement(self, idGen, isDuplicate, outputFile, dryRun,

     

       33
       33
       +
                               forceDup=False):

     

       35
       34
        
               raise NotImplementedError('Abstract base class')

     

       36
       35
        
           def getSvgDefs(self):

     

       37
       36
        
               return ()

     

       38
       38
       -
           def writeSvgDefs(self, idGen, isDuplicate, outputFile):

     

       37
       37
       +
           def getLinkedElems(self):

     

       38
       38
       +
               return ()

     

       39
       39
       +
           def writeSvgDefs(self, idGen, isDuplicate, outputFile, dryRun):

     

       39
       40
        
               for defn in self.getSvgDefs():

     

       40
       41
        
                   if isDuplicate(defn): continue

     

       41
       41
       -
                   defn.writeSvgDefs(idGen, isDuplicate, outputFile)

     

       42
       42
       -
                   defn.id = idGen()

     

       43
       43
       -
                   defn.writeSvgElement(outputFile)

     

       44
       44
       -
                   outputFile.write('\n')

     

       42
       42
       +
                   defn.writeSvgDefs(idGen, isDuplicate, outputFile, dryRun)

     

       43
       43
       +
                   if defn.id is None:

     

       44
       44
       +
                       defn.id = idGen()

     

       45
       45
       +
                   defn.writeSvgElement(idGen, isDuplicate, outputFile, dryRun,

     

       46
       46
       +
                                        forceDup=True)

     

       47
       47
       +
                   if not dryRun:

     

       48
       48
       +
                       outputFile.write('\n')

     

       45
       49
        
           def __eq__(self, other):

     

       46
       50
        
               return self is other

     

       47
       51
        
       

     
···

       51
       55
        
           TAG_NAME = '_'

     

       52
       56
        
           hasContent = False

     

       53
       57
        
           def __init__(self, **args):

     

       54
       54
       -
               self.args = args

     

       58
       58
       +
               self.args = {}

     

       59
       59
       +
               for k, v in args.items():

     

       60
       60
       +
                   k = k.replace('__', ':')

     

       61
       61
       +
                   k = k.replace('_', '-')

     

       62
       62
       +
                   if k[-1] == '-':

     

       63
       63
       +
                       k = k[:-1]

     

       64
       64
       +
                   self.args[k] = v

     

       65
       65
       +
               self.children = []

     

       66
       66
       +
           def checkChildrenAllowed(self):

     

       67
       67
       +
               if not self.hasContent:

     

       68
       68
       +
                   raise RuntimeError(

     

       69
       69
       +
                       '{} does not support children'.format(type(self)))

     

       55
       70
        
           @property

     

       56
       71
        
           def id(self):

     

       57
       72
        
               return self.args.get('id', None)

     

       58
       73
        
           @id.setter

     

       59
       74
        
           def id(self, newId):

     

       60
       75
        
               self.args['id'] = newId

     

       61
       61
       -
           def writeSvgElement(self, outputFile):

     

       76
       76
       +
           def writeSvgElement(self, idGen, isDuplicate, outputFile, dryRun,

     

       77
       77
       +
                               forceDup=False):

     

       78
       78
       +
               if dryRun:

     

       79
       79
       +
                   if isDuplicate(self) and self.id is None:

     

       80
       80
       +
                       self.id = idGen()

     

       81
       81
       +
                   for elem in self.getLinkedElems():

     

       82
       82
       +
                       if elem.id is None:

     

       83
       83
       +
                           elem.id = idGen()

     

       84
       84
       +
                   if self.hasContent:

     

       85
       85
       +
                       self.writeContent(idGen, isDuplicate, outputFile, dryRun)

     

       86
       86
       +
                   if self.children:

     

       87
       87
       +
                       self.writeChildrenContent(idGen, isDuplicate, outputFile,

     

       88
       88
       +
                                                 dryRun)

     

       89
       89
       +
                   return

     

       90
       90
       +
               if isDuplicate(self) and not forceDup:

     

       91
       91
       +
                   outputFile.write('<use xlink:href="#{}" />'.format(self.id))

     

       92
       92
       +
                   return

     

       62
       93
        
               outputFile.write('<')

     

       63
       94
        
               outputFile.write(self.TAG_NAME)

     

       64
       95
        
               writeXmlNodeArgs(self.args, outputFile)

     

       65
       65
       -
               if not self.hasContent:

     

       96
       96
       +
               if not self.hasContent and not self.children:

     

       66
       97
        
                   outputFile.write(' />')

     

       67
       98
        
               else:

     

       68
       99
        
                   outputFile.write('>')

     

       69
       69
       -
                   self.writeContent(outputFile)

     

       100
       100
       +
                   if self.hasContent:

     

       101
       101
       +
                       self.writeContent(idGen, isDuplicate, outputFile, dryRun)

     

       102
       102
       +
                   if self.children:

     

       103
       103
       +
                       self.writeChildrenContent(idGen, isDuplicate, outputFile,

     

       104
       104
       +
                                                 dryRun)

     

       70
       105
        
                   outputFile.write('</')

     

       71
       106
        
                   outputFile.write(self.TAG_NAME)

     

       72
       107
        
                   outputFile.write('>')

     

       73
       73
       -
           def writeContent(self, outputFile):

     

       108
       108
       +
           def writeContent(self, idGen, isDuplicate, outputFile, dryRun):

     

       74
       109
        
               ''' Override in a subclass to add data between the start and end

     

       75
       110
        
                   tags.  This will not be called if hasContent is False. '''

     

       76
       111
        
               raise RuntimeError('This element has no content')

     

       112
       112
       +
           def writeChildrenContent(self, idGen, isDuplicate, outputFile, dryRun):

     

       113
       113
       +
               ''' Override in a subclass to add data between the start and end

     

       114
       114
       +
                   tags.  This will not be called if hasContent is False. '''

     

       115
       115
       +
               if dryRun:

     

       116
       116
       +
                   for child in self.children:

     

       117
       117
       +
                       child.writeSvgElement(idGen, isDuplicate, outputFile, dryRun)

     

       118
       118
       +
                   return

     

       119
       119
       +
               outputFile.write('\n')

     

       120
       120
       +
               for child in self.children:

     

       121
       121
       +
                   child.writeSvgElement(idGen, isDuplicate, outputFile, dryRun)

     

       122
       122
       +
                   outputFile.write('\n')

     

       77
       123
        
           def getSvgDefs(self):

     

       78
       124
        
               return [v for v in self.args.values()

     

       79
       79
       -
                       if isinstance(v, defs.DrawingElement)]

     

       125
       125
       +
                       if isinstance(v, DrawingElement)]

     

       126
       126
       +
           def writeSvgDefs(self, idGen, isDuplicate, outputFile, dryRun):

     

       127
       127
       +
               super().writeSvgDefs(idGen, isDuplicate, outputFile, dryRun)

     

       128
       128
       +
               for child in self.children:

     

       129
       129
       +
                   child.writeSvgDefs(idGen, isDuplicate, outputFile, dryRun)

     

       80
       130
        
           def __eq__(self, other):

     

       81
       131
        
               if isinstance(other, type(self)):

     

       82
       132
        
                   return (self.TAG_NAME == other.TAG_NAME and

     

       83
       83
       -
                           self.args == other.args)

     

       133
       133
       +
                           self.args == other.args and

     

       134
       134
       +
                           self.children == other.children)

     

       84
       135
        
               return False

     

       136
       136
       +
           def appendAnim(self, animateElement):

     

       137
       137
       +
               self.children.append(animateElement)

     

       138
       138
       +
           def extendAnim(self, animateIterable):

     

       139
       139
       +
               self.children.extend(animateIterable)

     

       85
       140
        
       

     

       86
       141
        
       class DrawingParentElement(DrawingBasicElement):

     

       87
       142
        
           ''' Base class for SVG elements that can have child nodes '''

     
···

       91
       146
        
               self.children = list(children)

     

       92
       147
        
               if len(self.children) > 0:

     

       93
       148
        
                   self.checkChildrenAllowed()

     

       94
       94
       -
           def checkChildrenAllowed(self):

     

       95
       95
       -
               if not self.hasContent:

     

       96
       96
       -
                   raise RuntimeError('{} does not support children'.format(type(self)))

     

       97
       149
        
           def draw(self, obj, **kwargs):

     

       98
       150
        
               if not hasattr(obj, 'writeSvgElement'):

     

       99
       151
        
                   elements = obj.toDrawables(elements=elementsModule, **kwargs)

     
···

       107
       159
        
           def extend(self, iterable):

     

       108
       160
        
               self.checkChildrenAllowed()

     

       109
       161
        
               self.children.extend(iterable)

     

       110
       110
       -
           def writeContent(self, outputFile):

     

       111
       111
       -
               outputFile.write('\n')

     

       112
       112
       -
               for child in self.children:

     

       113
       113
       -
                   child.writeSvgElement(outputFile)

     

       114
       114
       -
                   outputFile.write('\n')

     

       115
       115
       -
           def writeSvgDefs(self, idGen, isDuplicate, outputFile):

     

       116
       116
       -
               super().writeSvgDefs(idGen, isDuplicate, outputFile)

     

       117
       117
       -
               for child in self.children:

     

       118
       118
       -
                   child.writeSvgDefs(idGen, isDuplicate, outputFile)

     

       162
       162
       +
           def writeContent(self, idGen, isDuplicate, outputFile, dryRun):

     

       163
       163
       +
               pass

     

       119
       164
        
       

     

       120
       165
        
       class NoElement(DrawingElement):

     

       121
       166
        
           ''' A drawing element that has no effect '''

     

       122
       167
        
           def __init__(self): pass

     

       123
       123
       -
           def writeSvgElement(self, outputFile):

     

       168
       168
       +
           def writeSvgElement(self, idGen, isDuplicate, outputFile, dryRun,

     

       169
       169
       +
                               forceDup=False):

     

       124
       170
        
               pass

     

       125
       171
        
           def __eq__(self, other):

     

       126
       172
        
               if isinstance(other, type(self)):

     
···

       146
       192
        
                   otherElem = '#' + otherElem

     

       147
       193
        
               super().__init__(xlink__href=otherElem, x=x, y=y, **kwargs)

     

       148
       194
        
       

     

       195
       195
       +
       class Animate(DrawingBasicElement):

     

       196
       196
       +
           ''' Animation for a specific property of another element

     

       197
       197
       +
       

     

       198
       198
       +
               This should be added as a child of the element to animate.  Otherwise

     

       199
       199
       +
               the other element and this element must both be added to the drawing.

     

       200
       200
       +
           '''

     

       201
       201
       +
           TAG_NAME = 'animate'

     

       202
       202
       +
           def __init__(self, attributeName, dur, from_or_values=None, to=None,

     

       203
       203
       +
                        begin=None, otherElem=None, **kwargs):

     

       204
       204
       +
               if to is None:

     

       205
       205
       +
                   values = from_or_values

     

       206
       206
       +
                   from_ = None

     

       207
       207
       +
               else:

     

       208
       208
       +
                   values = None

     

       209
       209
       +
                   from_ = from_or_values

     

       210
       210
       +
               if isinstance(otherElem, str) and not otherElem.startswith('#'):

     

       211
       211
       +
                   otherElem = '#' + otherElem

     

       212
       212
       +
               kwargs.update(attributeName=attributeName, to=to, dur=dur, begin=begin)

     

       213
       213
       +
               kwargs.setdefault('values', values)

     

       214
       214
       +
               kwargs.setdefault('from_', from_)

     

       215
       215
       +
               super().__init__(xlink__href=otherElem, **kwargs)

     

       216
       216
       +
       

     

       217
       217
       +
           def getSvgDefs(self):

     

       218
       218
       +
               return [v for k, v in self.args.items()

     

       219
       219
       +
                       if isinstance(v, DrawingElement)

     

       220
       220
       +
                       if k != 'xlink:href']

     

       221
       221
       +
       

     

       222
       222
       +
           def getLinkedElems(self):

     

       223
       223
       +
               return (self.args['xlink:href'],)

     

       224
       224
       +
       

     

       225
       225
       +
       class _Mpath(DrawingBasicElement):

     

       226
       226
       +
           ''' Used by AnimateMotion '''

     

       227
       227
       +
           TAG_NAME = 'mpath'

     

       228
       228
       +
           def __init__(self, otherPath, **kwargs):

     

       229
       229
       +
               super().__init__(xlink__href=otherPath, **kwargs)

     

       230
       230
       +
       

     

       231
       231
       +
       class AnimateMotion(Animate):

     

       232
       232
       +
           ''' Animation for the motion another element along a path

     

       233
       233
       +
       

     

       234
       234
       +
               This should be added as a child of the element to animate.  Otherwise

     

       235
       235
       +
               the other element and this element must both be added to the drawing.

     

       236
       236
       +
           '''

     

       237
       237
       +
           TAG_NAME = 'animateMotion'

     

       238
       238
       +
           def __init__(self, path, dur, from_or_values=None, to=None, begin=None,

     

       239
       239
       +
                        otherElem=None, **kwargs):

     

       240
       240
       +
               useMpath = False

     

       241
       241
       +
               if isinstance(path, DrawingElement):

     

       242
       242
       +
                   useMpath = True

     

       243
       243
       +
                   pathElem = path

     

       244
       244
       +
                   path = None

     

       245
       245
       +
               kwargs.setdefault('attributeName', None)

     

       246
       246
       +
               super().__init__(dur=dur, from_or_values=from_or_values, to=to,

     

       247
       247
       +
                                begin=begin, path=path, otherElem=otherElem, **kwargs)

     

       248
       248
       +
               if useMpath:

     

       249
       249
       +
                   self.children.append(_Mpath(pathElem))

     

       250
       250
       +
       

     

       251
       251
       +
       class AnimateTransform(Animate):

     

       252
       252
       +
           ''' Animation for the transform property of another element

     

       253
       253
       +
       

     

       254
       254
       +
               This should be added as a child of the element to animate.  Otherwise

     

       255
       255
       +
               the other element and this element must both be added to the drawing.

     

       256
       256
       +
           '''

     

       257
       257
       +
           TAG_NAME = 'animateTransform'

     

       258
       258
       +
           def __init__(self, type, dur, from_or_values, to=None, begin=None,

     

       259
       259
       +
                        attributeName='transform', otherElem=None, **kwargs):

     

       260
       260
       +
               super().__init__(attributeName, dur=dur, from_or_values=from_or_values,

     

       261
       261
       +
                                to=to, begin=begin, type=type, otherElem=otherElem,

     

       262
       262
       +
                                **kwargs)

     

       263
       263
       +
       

     

       264
       264
       +
       class Set(Animate):

     

       265
       265
       +
           ''' Animation for a specific property of another element that sets the new

     

       266
       266
       +
               value without a transition.

     

       267
       267
       +
       

     

       268
       268
       +
               This should be added as a child of the element to animate.  Otherwise

     

       269
       269
       +
               the other element and this element must both be added to the drawing.

     

       270
       270
       +
           '''

     

       271
       271
       +
           TAG_NAME = 'set'

     

       272
       272
       +
           def __init__(self, attributeName, dur, to=None, begin=None,

     

       273
       273
       +
                        otherElem=None, **kwargs):

     

       274
       274
       +
               super().__init__(attributeName, dur=dur, from_or_values=None,

     

       275
       275
       +
                                to=to, begin=begin, otherElem=otherElem, **kwargs)

     

       276
       276
       +
       

     

       277
       277
       +
       class Discard(Animate):

     

       278
       278
       +
           ''' Animation configuration specifying when it is safe to discard another

     

       279
       279
       +
               element.  E.g. when it will no longer be visible after an animation.

     

       280
       280
       +
       

     

       281
       281
       +
               This should be added as a child of the element to animate.  Otherwise

     

       282
       282
       +
               the other element and this element must both be added to the drawing.

     

       283
       283
       +
           '''

     

       284
       284
       +
           TAG_NAME = 'discard'

     

       285
       285
       +
           def __init__(self, attributeName, begin=None, **kwargs):

     

       286
       286
       +
               kwargs.setdefault('attributeName', None)

     

       287
       287
       +
               kwargs.setdefault('to', None)

     

       288
       288
       +
               kwargs.setdefault('dur', None)

     

       289
       289
       +
               super().__init__(from_or_values=None, begin=begin, otherElem=None,

     

       290
       290
       +
                                **kwargs)

     

       291
       291
       +
       

     

       149
       292
        
       class Image(DrawingBasicElement):

     

       150
       293
        
           ''' A linked or embedded raster image '''

     

       151
       294
        
           TAG_NAME = 'image'

     
···

       174
       317
        
                           mimeType = self.MIME_MAP[ext]

     

       175
       318
        
                       else:

     

       176
       319
        
                           mimeType = self.MIME_DEFAULT

     

       177
       177
       -
                           warnings.warn('Unknown image file type "{}"'.format(ext), Warning)

     

       320
       320
       +
                           warnings.warn('Unknown image file type "{}"'.format(ext),

     

       321
       321
       +
                                         Warning)

     

       178
       322
        
               if mimeType is None:

     

       179
       323
        
                   mimeType = self.MIME_DEFAULT

     

       180
       180
       -
                   warnings.warn('Unspecified image type; assuming png'.format(ext), Warning)

     

       324
       324
       +
                   warnings.warn('Unspecified image type; assuming png'.format(ext),

     

       325
       325
       +
                                 Warning)

     

       181
       326
        
               if data is not None:

     

       182
       327
        
                   embed = True

     

       183
       328
        
               if embed and data is None:

     
···

       213
       358
        
                       pass

     

       214
       359
        
               super().__init__(x=x, y=-y, font_size=fontSize, **kwargs)

     

       215
       360
        
               self.escapedText = xml.escape(text)

     

       216
       216
       -
           def writeContent(self, outputFile):

     

       361
       361
       +
           def writeContent(self, idGen, isDuplicate, outputFile, dryRun):

     

       362
       362
       +
               if dryRun:

     

       363
       363
       +
                   return

     

       217
       364
        
               outputFile.write(self.escapedText)

     

       218
       365
        
       

     

       219
       366
        
       class Rectangle(DrawingBasicElement):

     
···

       317
       464
        
           def T(self, ex, ey): self.append('T', ex, -ey)

     

       318
       465
        
           def t(self, ex, ey): self.append('t', ex, -ey)

     

       319
       466
        
           def A(self, rx, ry, rot, largeArc, sweep, ex, ey):

     

       320
       320
       -
               self.append('A', rx, ry, rot, int(bool(largeArc)), int(bool(sweep)), ex, -ey)

     

       467
       467
       +
               self.append('A', rx, ry, rot, int(bool(largeArc)), int(bool(sweep)), ex,

     

       468
       468
       +
                           -ey)

     

       321
       469
        
           def a(self, rx, ry, rot, largeArc, sweep, ex, ey):

     

       322
       322
       -
               self.append('a', rx, ry, rot, int(bool(largeArc)), int(bool(sweep)), ex, -ey)

     

       323
       323
       -
           def arc(self, cx, cy, r, startDeg, endDeg, cw=False, includeM=True, includeL=False):

     

       470
       470
       +
               self.append('a', rx, ry, rot, int(bool(largeArc)), int(bool(sweep)), ex,

     

       471
       471
       +
                           -ey)

     

       472
       472
       +
           def arc(self, cx, cy, r, startDeg, endDeg, cw=False, includeM=True,

     

       473
       473
       +
                   includeL=False):

     

       324
       474
        
               ''' Uses A() to draw a circular arc '''

     

       325
       475
        
               largeArc = (endDeg - startDeg) % 360 > 180

     

       326
       476
        
               startRad, endRad = startDeg*math.pi/180, endDeg*math.pi/180

+37

examples/animated-fix-github.svg

···

       1
       1
       +
       <?xml version="1.0" encoding="UTF-8"?>

     

       2
       2
       +
       <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       +
            width="200" height="200" viewBox="-100.0 -100.0 200 200">

     

       4
       4
       +
       <defs>

     

       5
       5
       +
       <path d="M-90,0 A90,40,360,1,1,90,0 A90,40,360,1,1,-90,0 Z" id="d0" />

     

       6
       6
       +
       </defs>

     

       7
       7
       +
       <g>

     

       8
       8
       +
       <circle cx="0" cy="0" r="19" fill="red">

     

       9
       9
       +
       <animateTransform type="scale" repeatCount="indefinite" attributeName="transform" dur="6s" values="1;1;1;1;1;1;0;0;0;0;0;0" />

     

       10
       10
       +
       </circle>

     

       11
       11
       +
       <animateTransform type="translate" repeatCount="indefinite" attributeName="transform" dur="6s" values="0,-80;80,0;0,80;-80,0;0,-80" />

     

       12
       12
       +
       </g>

     

       13
       13
       +
       <g>

     

       14
       14
       +
       <circle cx="0" cy="0" r="19.25" fill="green" transform="scale(0)">

     

       15
       15
       +
       <animateTransform type="scale" repeatCount="indefinite" attributeName="transform" dur="6s" begin="1.5s" values="1;1;1;1;1;1;0;0;0;0;0;0" />

     

       16
       16
       +
       </circle>

     

       17
       17
       +
       <animateTransform type="translate" repeatCount="indefinite" attributeName="transform" dur="6s" values="0,-80;80,0;0,80;-80,0;0,-80" />

     

       18
       18
       +
       </g>

     

       19
       19
       +
       <g>

     

       20
       20
       +
       <circle cx="0" cy="0" r="19.5" fill="blue" transform="scale(0)">

     

       21
       21
       +
       <animateTransform type="scale" repeatCount="indefinite" attributeName="transform" dur="6s" begin="3s" values="1;1;1;1;1;0;0;0;0;0;0;0" />

     

       22
       22
       +
       </circle>

     

       23
       23
       +
       <animateTransform type="translate" repeatCount="indefinite" attributeName="transform" dur="6s" values="0,-80;80,0;0,80;-80,0;0,-80" />

     

       24
       24
       +
       </g>

     

       25
       25
       +
       <g>

     

       26
       26
       +
       <circle cx="0" cy="0" r="20.1" fill="yellow" transform="scale(0)">

     

       27
       27
       +
       <animateTransform type="scale" repeatCount="indefinite" attributeName="transform" dur="6s" begin="4.5s" values="1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;1;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;" />

     

       28
       28
       +
       </circle>

     

       29
       29
       +
       <animateTransform type="translate" repeatCount="indefinite" attributeName="transform" dur="6s" values="0,-80;80,0;0,80;-80,0;0,-80" />

     

       30
       30
       +
       </g>

     

       31
       31
       +
       <circle cx="0" cy="0" r="10">

     

       32
       32
       +
       <animateMotion repeatCount="indefinite" dur="3s">

     

       33
       33
       +
       <mpath xlink:href="#d0" />

     

       34
       34
       +
       </animateMotion>

     

       35
       35
       +
       <animateTransform type="scale" repeatCount="indefinite" attributeName="transform" dur="3s" values="1,2;2,1;1,2;2,1;1,2" />

     

       36
       36
       +
       </circle>

     

       37
       37
       +
       </svg>

+18

examples/animated.svg

···

       1
       1
       +
       <?xml version="1.0" encoding="UTF-8"?>

     

       2
       2
       +
       <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       +
            width="200" height="200" viewBox="-100.0 -100.0 200 200">

     

       4
       4
       +
       <defs>

     

       5
       5
       +
       <path d="M-90,0 A90,40,360,1,1,90,0 A90,40,360,1,1,-90,0 Z" id="d0" />

     

       6
       6
       +
       </defs>

     

       7
       7
       +
       <circle cx="0" cy="0" r="20" fill="red">

     

       8
       8
       +
       <animate repeatCount="indefinite" attributeName="cy" dur="6s" values="-80;80;-80" />

     

       9
       9
       +
       <animate repeatCount="indefinite" attributeName="cx" dur="6s" values="0;80;0;-80;0" />

     

       10
       10
       +
       <animate calcMode="discrete" repeatCount="indefinite" attributeName="fill" dur="6s" values="red;green;blue;yellow" />

     

       11
       11
       +
       </circle>

     

       12
       12
       +
       <circle cx="0" cy="0" r="10">

     

       13
       13
       +
       <animateMotion repeatCount="indefinite" dur="3s">

     

       14
       14
       +
       <mpath xlink:href="#d0" />

     

       15
       15
       +
       </animateMotion>

     

       16
       16
       +
       <animateTransform type="scale" repeatCount="indefinite" attributeName="transform" dur="3s" values="1,2;2,1;1,2;2,1;1,2" />

     

       17
       17
       +
       </circle>

     

       18
       18
       +
       </svg>

examples/example7.gif

This is a binary file and will not be displayed.