257 lines
10 KiB
Python
257 lines
10 KiB
Python
|
#!/usr/bin/env python
|
||
|
|
|
||
|
|
# Copyright (c) 2017, Veronika Irvine
|
||
|
|
# All rights reserved.
|
||
|
|
#
|
||
|
|
# Redistribution and use in source and binary forms, with or without
|
||
|
|
# modification, are permitted provided that the following conditions are met:
|
||
|
|
#
|
||
|
|
# 1. Redistributions of source code must retain the above copyright notice, this
|
||
|
|
# list of conditions and the following disclaimer.
|
||
|
|
# 2. Redistributions in binary form must reproduce the above copyright notice,
|
||
|
|
# this list of conditions and the following disclaimer in the documentation
|
||
|
|
# and/or other materials provided with the distribution.
|
||
|
|
#
|
||
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
|
|
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
|
|
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
||
|
|
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
|
|
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
|
|
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
|
|
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
|
|
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||
|
|
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
|
||
|
|
import sys
|
||
|
|
import os
|
||
|
|
from math import sin,cos,radians, ceil
|
||
|
|
|
||
|
|
import inkex, simplestyle
|
||
|
|
|
||
|
|
__author__ = 'Veronika Irvine'
|
||
|
|
__credits__ = ['Ben Connors', 'Veronika Irvine', 'Mark Shafer']
|
||
|
|
__license__ = 'Simplified BSD'
|
||
|
|
|
||
|
|
class LaceGround(inkex.Effect):
|
||
|
|
"""
|
||
|
|
Create a ground for lace from a text file descriptor
|
||
|
|
using specified angle and spacing
|
||
|
|
"""
|
||
|
|
|
||
|
|
def unitToUu(self,param):
|
||
|
|
""" Convert units.
|
||
|
|
Converts a number in some units into the units used internally by
|
||
|
|
Inkscape.
|
||
|
|
|
||
|
|
param is a string representing a number with units attached. An
|
||
|
|
example would be '3.8mm'. Any units supported by Inkscape
|
||
|
|
are supported by this function.
|
||
|
|
|
||
|
|
This wrapper function catches changes made to the location
|
||
|
|
of the function between Inkscape versions.
|
||
|
|
"""
|
||
|
|
try:
|
||
|
|
return self.unittouu(param)
|
||
|
|
except:
|
||
|
|
return inkex.unittouu(param)
|
||
|
|
|
||
|
|
def getColorString(self, longColor, verbose=False):
|
||
|
|
""" Convert the long into a #RRGGBB color value
|
||
|
|
- verbose=true pops up value for us in defaults
|
||
|
|
conversion back is A + B*256^1 + G*256^2 + R*256^3
|
||
|
|
"""
|
||
|
|
longColor = long(longColor)
|
||
|
|
if longColor <0: longColor = long(longColor) & 0xFFFFFFFF
|
||
|
|
hexColor = hex(longColor)[2:-3]
|
||
|
|
hexColor = '#' + hexColor.rjust(6, '0').upper()
|
||
|
|
return hexColor
|
||
|
|
|
||
|
|
def loadFile(self):
|
||
|
|
# Ensure that file exists and has the proper extension
|
||
|
|
if not self.options.file:
|
||
|
|
inkex.errormsg('You must specify a template file.')
|
||
|
|
exit()
|
||
|
|
self.options.file = self.options.file.strip()
|
||
|
|
if self.options.file == '':
|
||
|
|
inkex.errormsg('You must specify a template file.')
|
||
|
|
exit()
|
||
|
|
if not os.path.isfile(self.options.file):
|
||
|
|
inkex.errormsg('You have not specified a valid path for the template file.\n\nYour entry: '+self.options.file)
|
||
|
|
exit()
|
||
|
|
extension = os.path.splitext(self.options.file)[1]
|
||
|
|
if extension != '.txt':
|
||
|
|
inkex.errormsg('The file name must end with .txt.\n\nYour entry: '+self.options.file)
|
||
|
|
exit()
|
||
|
|
|
||
|
|
data = []
|
||
|
|
rowCount = 0
|
||
|
|
colCount = 0
|
||
|
|
with open(self.options.file,'r') as f:
|
||
|
|
first = True
|
||
|
|
for line in f:
|
||
|
|
if first:
|
||
|
|
# first line of file gives row count and column count
|
||
|
|
first = False
|
||
|
|
line = line.strip()
|
||
|
|
temp = line.split('\t')
|
||
|
|
type = temp[0]
|
||
|
|
rowCount = int(temp[1])
|
||
|
|
colCount = int(temp[-1])
|
||
|
|
|
||
|
|
else:
|
||
|
|
line = line.strip()
|
||
|
|
line = line.lstrip('[')
|
||
|
|
line = line.rstrip(']')
|
||
|
|
rowData = line.split(']\t[')
|
||
|
|
data.append([])
|
||
|
|
for cell in rowData:
|
||
|
|
cell = cell.strip()
|
||
|
|
data[-1].append([float(num) for num in cell.split(',')])
|
||
|
|
|
||
|
|
return {'type':type, 'rowCount':rowCount, 'colCount':colCount, 'data':data}
|
||
|
|
|
||
|
|
def line(self, x1, y1, x2, y2):
|
||
|
|
"""
|
||
|
|
Draw a line from point at (x1, y1) to point at (x2, y2).
|
||
|
|
Style of line is hard coded and specified by 's'.
|
||
|
|
"""
|
||
|
|
# define the motions
|
||
|
|
path = 'M %s,%s L %s,%s' %(x1,y1,x2,y2)
|
||
|
|
|
||
|
|
# define the stroke style
|
||
|
|
s = {'stroke-linejoin': 'miter',
|
||
|
|
'stroke-width': self.options.linewidth,
|
||
|
|
'stroke-opacity': '1.0',
|
||
|
|
'fill-opacity': '1.0',
|
||
|
|
'stroke': self.options.linecolor,
|
||
|
|
'stroke-linecap': 'round',
|
||
|
|
'fill': 'none'
|
||
|
|
}
|
||
|
|
|
||
|
|
# create attributes from style and path
|
||
|
|
attribs = {'style':simplestyle.formatStyle(s), 'd':path}
|
||
|
|
|
||
|
|
# insert path object into current layer
|
||
|
|
inkex.etree.SubElement(self.current_layer, inkex.addNS('path', 'svg'), attribs)
|
||
|
|
|
||
|
|
def draw(self, data, rowCount, colCount):
|
||
|
|
a = self.options.spacing
|
||
|
|
theta = self.options.angle
|
||
|
|
deltaX = a*sin(theta)
|
||
|
|
deltaY = a*cos(theta)
|
||
|
|
maxRows = ceil(self.options.height / deltaY)
|
||
|
|
maxCols = ceil(self.options.width / deltaX)
|
||
|
|
|
||
|
|
x = 0.0
|
||
|
|
y = 0.0
|
||
|
|
repeatY = 0
|
||
|
|
repeatX = 0
|
||
|
|
|
||
|
|
while repeatY * rowCount < maxRows:
|
||
|
|
x = 0.0
|
||
|
|
repeatX = 0
|
||
|
|
|
||
|
|
while repeatX * colCount < maxCols:
|
||
|
|
|
||
|
|
for row in data:
|
||
|
|
for coords in row:
|
||
|
|
x1 = x + coords[0]*deltaX
|
||
|
|
y1 = y + coords[1]*deltaY
|
||
|
|
x2 = x + coords[2]*deltaX
|
||
|
|
y2 = y + coords[3]*deltaY
|
||
|
|
x3 = x + coords[4]*deltaX
|
||
|
|
y3 = y + coords[5]*deltaY
|
||
|
|
|
||
|
|
self.line(x1,y1,x2,y2)
|
||
|
|
self.line(x1,y1,x3,y3)
|
||
|
|
|
||
|
|
repeatX += 1
|
||
|
|
x += deltaX * colCount
|
||
|
|
|
||
|
|
repeatY += 1
|
||
|
|
y += deltaY * rowCount
|
||
|
|
|
||
|
|
def __init__(self):
|
||
|
|
"""
|
||
|
|
Constructor.
|
||
|
|
Defines the '--centerx' option of the script.
|
||
|
|
"""
|
||
|
|
# Call the base class constructor.
|
||
|
|
inkex.Effect.__init__(self)
|
||
|
|
|
||
|
|
# file
|
||
|
|
self.OptionParser.add_option('-f', '--file', action='store', type='string', dest='file', help='File containing lace ground description')
|
||
|
|
# Grid description
|
||
|
|
self.OptionParser.add_option('--angle',
|
||
|
|
action='store',
|
||
|
|
type='float',
|
||
|
|
dest='angle')
|
||
|
|
self.OptionParser.add_option('--distance',
|
||
|
|
action='store',
|
||
|
|
type='float',
|
||
|
|
dest='spacing')
|
||
|
|
self.OptionParser.add_option('--pinunits',
|
||
|
|
action='store',
|
||
|
|
type='string',
|
||
|
|
dest='pinunits')
|
||
|
|
self.OptionParser.add_option('--width',
|
||
|
|
action='store',
|
||
|
|
type='float',
|
||
|
|
dest='width')
|
||
|
|
self.OptionParser.add_option('--patchwidthunits',
|
||
|
|
action='store',
|
||
|
|
type='string',
|
||
|
|
dest='patchwidthunits')
|
||
|
|
self.OptionParser.add_option('--height',
|
||
|
|
action='store',
|
||
|
|
type='float',
|
||
|
|
dest='height')
|
||
|
|
self.OptionParser.add_option('--patchheightunits',
|
||
|
|
action='store',
|
||
|
|
type='string',
|
||
|
|
dest='patchheightunits')
|
||
|
|
self.OptionParser.add_option('--linewidth',
|
||
|
|
action='store',
|
||
|
|
type='float',
|
||
|
|
dest='linewidth')
|
||
|
|
self.OptionParser.add_option('--lineunits',
|
||
|
|
action='store',
|
||
|
|
type='string',
|
||
|
|
dest='lineunits')
|
||
|
|
self.OptionParser.add_option('--linecolor',
|
||
|
|
action='store',
|
||
|
|
type='string',
|
||
|
|
dest='linecolor')
|
||
|
|
|
||
|
|
def effect(self):
|
||
|
|
"""
|
||
|
|
Effect behaviour.
|
||
|
|
Overrides base class' method and draws something.
|
||
|
|
"""
|
||
|
|
result = self.loadFile()
|
||
|
|
|
||
|
|
# Convert input to universal units
|
||
|
|
self.options.width = self.unitToUu(str(self.options.width)+self.options.patchwidthunits)
|
||
|
|
self.options.height = self.unitToUu(str(self.options.height)+self.options.patchheightunits)
|
||
|
|
self.options.linewidth = self.unitToUu(str(self.options.linewidth)+self.options.lineunits)
|
||
|
|
self.options.spacing = self.unitToUu(str(self.options.spacing)+self.options.pinunits)
|
||
|
|
|
||
|
|
# Users expect spacing to be the vertical distance between footside pins
|
||
|
|
# (vertical distance between every other row) but in the script we use it
|
||
|
|
# as as diagonal distance between grid points
|
||
|
|
# therefore convert spacing based on the angle chosen
|
||
|
|
self.options.angle = radians(self.options.angle)
|
||
|
|
self.options.spacing = self.options.spacing/(2.0*cos(self.options.angle))
|
||
|
|
|
||
|
|
# Convert color from long integer to hexidecimal string
|
||
|
|
self.options.linecolor = self.getColorString(self.options.linecolor)
|
||
|
|
|
||
|
|
# Draw a ground based on file description and user inputs
|
||
|
|
# For now, assume style is Checker but could change in future
|
||
|
|
self.draw(result['data'],result['rowCount'],result['colCount'])
|
||
|
|
|
||
|
|
# Create effect instance and apply it.
|
||
|
|
effect = LaceGround()
|
||
|
|
effect.affect()
|