Accueil » RW E2 » Ressources » Frame
  1. #!/usr/bin/env python
  2. '''
  3. frame.py
  5. * Puts a frame around an object, using the specified H margin and W/H margins ratio
  7. * This code is modeled after inkscape/extensions/dimension.py, developed in
  8. 2007 by Peter Lewerin, peter.lewerin@tele2.se
  10. * It uses the selection's bounding box, so if the bounding box has empty
  11. space in the x- or y-direction (such as with some stars) the results
  12. will look strange. Strokes might also overlap the edge of the
  13. bounding box.
  15. * This code, like dimension.py, contains code from existing effects in the Inkscape
  16. extensions library, and marker data from markers.svg.
  17. '''
  20. # imports:
  21. # : sys
  22. # : copy
  23. # : subprocess (Popen, PIPE)
  24. # : inkex imports:
  25. # : copy (deep copy)
  26. # : gettext (internationalization)
  27. # : optparse (deprecated since python 3.2 but still available)
  28. # : os (popen3, though still available, has a python3 replacement)
  29. # : random (random numbers)
  30. # : re (regular expressions)
  31. # : sys (runtime services)
  32. # : math * (math)
  33. # : etree (from lxml)
  34. # : locale (localization)
  35. #
  36. # : among other things, inkex provides:
  37. # : NSS (namespace URLs)
  38. # : addNS() (prefixes namespace url to tag)
  39. # : xpathSingle() (returns first occurrence of matching node)
  40. # : errormsg() (writes messages to modal box)
  42. import sys, copy
  44. sys.path.append('/usr/share/inkscape/extensions')
  46. try:
  47. from subprocess import Popen, PIPE
  48. gBSPr = True
  49. except:
  50. gBSPr = False
  52. # local library:
  54. import inkex
  55. import pathmodifier
  56. from simpletransform import *
  58. inkex.localize()
  60. import inkex, simpletransform, simplestyle
  66. # oFram (frame)
  67. # : subclasses pathmodifier.PathModifier
  68. # : PathModifier in turn subclasses inkex.Effect
  69. #
  70. class oFram( pathmodifier.PathModifier):
  72. def __init__( s):
  73. inkex.Effect.__init__( s)
  75. s.OptionParser.add_option('-p', '--Page', action='store', type='string', dest='aPage', default='', help='The selected UI-tab when OK was pressed')
  76. s.OptionParser.add_option('-n', '--NewT', action='store', type='string', dest='aNewT', default='rectangle', help='New object type')
  77. s.OptionParser.add_option('-t', '--BTyp', action='store', type='string', dest='aBTyp', default='geometric', help='Bounding box type')
  78. s.OptionParser.add_option('-m', '--Marg', action='store', type='float', dest='aMarg', default=40, help='Vertical margin')
  79. s.OptionParser.add_option('-r', '--WHRa', action='store', type='float', dest='aWHRa', default=2, help='W/H margin ratio')
  80. s.OptionParser.add_option('-c', '--CRad', action='store', type='float', dest='aCRad', default=0, help='Corner radius')
  81. s.OptionParser.add_option('-k', '--StrC', action='store', type='string', dest='aStrC', default='#000000', help='Stroke color (RGB)')
  82. s.OptionParser.add_option('-w', '--StrW', action='store', type='float', dest='aStrW', default=4, help='Stroke thickness')
  83. s.OptionParser.add_option('-f', '--Fill', action='store', type='string', dest='aFill', default='', help='Background fill')
  84. s.OptionParser.add_option('-s', '--Styl', action='store', type='string', dest='aStyl', default='', help='Other style options')
  85. s.OptionParser.add_option('-q', '--Trac', action='store', type='string', dest='aTrac', default='', help='Diagnostic information')
  87. # Values used by fMSel:
  89. s.mMATr = None # First flowPara that contains the text 'Trace:'
  90. s.mMAPa = None # Parent of s.mMATr
  91. s.mMASt = None # Style of s.mMATr
  95. # fMSel: Select message destination and write the message
  96. #
  97. # Input:
  98. # : aMess: The message to post
  99. # : mTrac: The destination, from the inx option
  100. # : none: Discard the message
  101. # : errm: Use the errormsg function; post the message to a modal window
  102. # : text:
  103. # : Find a flowPara element that contains "Trace:" and nothing else; note colon
  104. # : Append the message as a new flowPara in the "Trace:" flowRegion
  105. # : Copy attributes from the "Trace:" element to the new element
  106. #
  107. def fMSel( s, aMess):
  109. while True:
  110. if s.mTrac == 'none': break
  112. if s.mTrac == 'errm':
  113. inkex.errormsg( _('%s' % aMess))
  114. inkex.errormsg( '')
  115. break
  117. if s.mTrac == 'text':
  118. if s.mMAPa == None:
  119. tRoot = s.document.getroot()
  121. # # Test xpath call:
  123. # tElem = tElLi = tRoot.xpath( './/svg:ellipse', namespaces=inkex.NSS)
  124. # if isinstance( tElLi, list) and len( tElLi) > 0: tElem = tElLi[ 0]
  125. # inkex.errormsg( 'fMSel: 2: tElem(%s)' % tElem)
  127. # Find flowPara element that contains the text 'Trace:' and nothing else
  129. tElLi = tRoot.xpath( './/svg:flowPara', namespaces=inkex.NSS)
  130. if not isinstance( tElLi, list): tElLi = [ tElLi]
  131. tMATr = None
  132. for tElNu, tElem in enumerate( tElLi):
  133. tText = tElem.text
  134. # inkex.errormsg( 'fMSel: 3: tText(%s) tElNu(%s) tElem(%s)' % (tText, tElNu, tElem)) # Voluminous!
  135. if tText == 'Trace:':
  136. tMATr = tElem
  137. tMASt = tMATr.get( 'style')
  138. tMASt = simplestyle.parseStyle( tMASt)
  140. # inkex.errormsg( 'fMSel: 4: tMATr(%s)' % tMATr)
  141. s.mMATr = tMATr
  142. s.mMAPa = tMAPa = tMATr.getparent()
  143. s.mMASt = tMASt
  144. # inkex.errormsg( 'fMSel: 5: tMAPa(%s)' % tMAPa)
  146. if tMATr == None:
  147. s.mTrac = 'errm'
  148. inkex.errormsg( _('Trace mode switching to "errm":'))
  149. inkex.errormsg( _('No text area containing only "Trace:" was found'))
  150. continue # Back to the while True
  152. # # Append to existing text
  154. # tText = s.mMATr.text
  155. # tText += aMess
  156. # s.mMATr.text = tText
  158. # Create a new flowPara for the message
  160. tMAPa = s.mMAPa
  161. tMASt = s.mMASt
  162. tMANe = inkex.etree.SubElement( tMAPa, inkex.addNS( 'flowPara', 'svg'), tMASt )
  163. tMANe.text = aMess
  164. tMANe = inkex.etree.SubElement( tMAPa, inkex.addNS( 'flowPara', 'svg'), tMASt ) # Blank line: separator
  165. break
  167. break
  171. # effect:
  172. # : argument 1:
  173. # : Name of temporary file, that contains a copy of the file being edited
  174. # : E.g., '/tmp/ink_ext_XXXXXX.svgONVAQ0'
  175. # : This file is used when "visual" is specified as the bounding-box type:
  176. # : Inkscape, invoked with --query options as a subprocess, reads this
  177. # file and returns the actual dimensions of a text
  178. # : The dimensions of the text are not present in the file; this implies
  179. # that inkscape --query calculates the dimensions of the text; I wonder
  180. # then why it is not possible to invoke the query routines directly
  181. # : s.options, s.args:
  182. # : defined in inkex.Effect
  183. # : output from optparse.ObjectParser.parse_args( sys.argv[ 1:])
  184. # : s.options:
  185. # : ids: list of ids for selected nodes
  186. # : s.selected:
  187. # : selected nodes
  188. #
  189. def effect( s):
  191. s.mTrac = s.options.aTrac
  193. tFill = {
  194. # 'stroke' : '#000000',
  195. # 'stroke-width' : '4',
  196. 'fill' : 'none'
  197. }
  199. tBBox = None
  201. tNewT = s.options.aNewT
  202. tMarg = float( s.options.aMarg)
  203. tWHRa = float( s.options.aWHRa)
  204. tCRad = float( s.options.aCRad)
  205. tStrC = s.options.aStrC
  206. tStrW = s.options.aStrW
  207. tFill = s.options.aFill
  209. # Size deltas:
  210. # : Pos value makes frame larger than selected object
  211. # : Neg value makes frame smaller than selected object
  213. tSiDY = tMarg
  214. tSiDX = tSiDY * tWHRa
  216. tScal = s.unittouu('1px') # convert to document units
  217. tSiDY *= tScal
  218. tSiDX *= tScal
  221. # Query inkscape about selection and bounding box type
  222. # * ids: List of selected SVG elements: element id= value
  223. # * selected: Dict of selected elements: key is element id=, value is the SVG element
  224. # * options: inx options plus ids (ids for selected elements)
  226. # inkex.errormsg( 'args(%s)' % (s.args))
  227. # inkex.errormsg( 'ids(%s)' % (s.options.ids))
  228. # inkex.errormsg( 'options(%s)' % (s.options))
  229. # inkex.errormsg( 'selected(%s)' % (s.selected))
  230. s.fMSel( 'args(%s)' % (s.args))
  231. s.fMSel( 'ids(%s)' % (s.options.ids))
  232. s.fMSel( 'options(%s)' % (s.options))
  233. s.fMSel( 'selected(%s)' % (s.selected))
  235. if len( s.options.ids) == 0:
  236. inkex.errormsg( _( 'Please select an object.'))
  237. exit()
  239. tObjP = s.current_layer # Parent?
  240. tFile = s.args[ -1]
  242. # Need visual bounding box? Use --query-all to obtain list for use later
  243. #
  244. tBTyp = s.options.aBTyp
  245. if tBTyp == 'visual':
  246. if gBSPr:
  247. tProc = Popen( 'inkscape --query-all "%s"' % tFile, shell=True, stdout=PIPE, stderr=PIPE)
  248. tRetC = tProc.wait()
  249. tFStR = tProc.stdout.read() # List of all SVG objects in tFile
  250. tErrM = tProc.stderr.read()
  251. else:
  252. tFStO, tFStE = os.popen3( 'inkscape --query-all "%s"' % tFile)[ 1:] # Returns stdin, stdout, stderr
  253. tFStR = tFStO.read()
  254. tFStO.close()
  255. tFStE.close()
  256. tBBLi = tFStR.splitlines()
  257. # inkex.errormsg( 'BBLi: lBBLi(%d)' % len( tBBLi))
  258. s.fMSel( 'BBLi: lBBLi(%d)' % len( tBBLi))
  261. # Process selected items
  262. # : selected: dict, using item id as key and item as value
  263. #
  264. for tNoId, tNoCu in s.selected.iteritems():
  266. # inkex.errormsg( 'Iter: tNoId(%s) tNoCu(%s)' % ( tNoId, tNoCu)) # Diagnostic
  267. s.fMSel( 'Iter: tNoId(%s) tNoCu(%s)' % ( tNoId, tNoCu)) # Diagnostic
  269. tBTyp = s.options.aBTyp # Refresh
  272. tElem = None
  274. # duplicate: Get geometric bounding box from a duplicate of the selected object
  275. #
  276. # : This experimental feature is motivated by the need to get
  277. # a geometrical bounding box for a text object;
  278. # : Unfortunately, the size of the duplicate is taken from the text flow area, not from the text
  279. # : Support for this option is minimal
  280. #
  281. if tBTyp == 'duplicate':
  282. tStDi = { 'style': simplestyle.formatStyle( tFill) }
  283. while tElem == None:
  284. if tNewT == 'rectangle': tNoNe = inkex.etree.SubElement( tObjP, inkex.addNS( 'rect', 'svg'), tStDi ); break
  285. if tNewT == 'ellipse': tNoNe = inkex.etree.SubElement( tObjP, inkex.addNS( 'ellipse', 'svg'), tStDi ); break
  286. if tNewT == 'none': tNoNe = tNoCu; break
  287. break;
  289. tNoNe = copy.deepcopy( tNoCu) # Derive next node from curr
  290. tNoId = s.uniqueId( tNoId)
  291. tNoNe.set( 'id', tNoId)
  292. s.current_layer.append( tNoNe)
  293. tNoCu = tNoNe
  294. # inkex.errormsg( 'Dupl: tNoId(%s) tNoCu(%s)' % ( tNoId, tNoCu))
  295. s.fMSel( 'Dupl: tNoId(%s) tNoCu(%s)' % ( tNoId, tNoCu))
  296. tBTyp = 'geometric'
  298. # Select process depending on bounding box type:
  299. # : geometric: Use computeBBox() in simpletransform.py to get xmin, xmax, ymin, ymax
  300. # : visual: Use inkscape command-line --query option to obtain viewbox values
  302. tBBDi = { 'x':0, 'y':0, 'width':0, 'height':0} # Bounding box dictionary
  304. while True:
  305. if tBTyp == 'geometric':
  306. s.mBBox = tBBox = computeBBox( [ tNoCu]) # arg is a list of nodes
  307. tBBDi[ 'x'] = tBBox[ 0]
  308. tBBDi[ 'y'] = tBBox[ 2]
  309. tBBDi[ 'width'] = tBBox[ 1] - tBBox[ 0]
  310. tBBDi[ 'height'] = tBBox[ 3] - tBBox[ 2]
  311. break
  313. if tBTyp == 'visual':
  314. for tLine in tBBLi:
  315. if tLine.startswith( tNoId):
  316. tLSpl = tLine.split( ',')
  317. s.mBBox = tBBox = [ tLSpl[ 1], tLSpl[ 1] + tLSpl[ 3], tLSpl[ 2], tLSpl[ 2] + tLSpl[ 4]]
  318. tBBDi[ 'x'] = float( tLSpl[ 1])
  319. tBBDi[ 'y'] = float( tLSpl[ 2])
  320. tBBDi[ 'width'] = float( tLSpl[ 3])
  321. tBBDi[ 'height'] = float( tLSpl[ 4])
  322. break
  324. break # while
  327. # Avoid ugly failure on rects and texts.
  328. #
  329. if tBBox == None or tBBox[ 0] == None:
  330. inkex.errormsg( _( '%s-type bounding box not found for object: Try another bbox type.'))
  331. exit()
  333. # Assemble frame attributes
  334. # : Parse the style for the selected node (tStyl) into a dictionary (tStDi)
  335. # : Copy stroke and stroke-width from dictionary to frame attributes
  336. # : Parse the style specified on the inx panel and add to frame attributes (tFrDi)
  337. # : Explicitly specified stroke and stroke-width override earlier values
  339. # tFrDi = { 'fill': 'none' }
  341. tStyl = tNoCu.get( 'style')
  342. # inkex.errormsg( 'Styl: tStyl(%s)' % tStyl)
  343. s.fMSel( 'Styl: tStyl(%s)' % tStyl)
  344. tStDi = simplestyle.parseStyle( tStyl)
  346. tFrDi = {}
  347. if tStDi.has_key( 'stroke'): tFrDi[ 'stroke'] = str( tStDi[ 'stroke'])
  348. if tStDi.has_key( 'stroke-width'): tFrDi[ 'stroke-width'] = str( tStDi[ 'stroke-width'])
  350. tStyl = s.options.aStyl # style from inx
  351. tStDi = simplestyle.parseStyle( tStyl)
  353. for tStDK, tStDV in tStDi.items():
  354. tFrDi[ tStDK] = tStDV
  356. if tStrC != '': tFrDi[ 'stroke'] = str( tStrC)
  357. if tStrW > 0: tFrDi[ 'stroke-width'] = str( tStrW)
  358. if tFill != '': tFrDi[ 'fill'] = str( tFill)
  360. if not tFrDi.has_key( 'fill'): tFrDi[ 'fill'] = 'none'
  363. while tElem == None:
  364. if tNewT == 'rectangle': tElem = inkex.etree.SubElement( tObjP, inkex.addNS( 'rect', 'svg'), tFrDi ); break
  365. if tNewT == 'ellipse': tElem = inkex.etree.SubElement( tObjP, inkex.addNS( 'ellipse', 'svg'), tFrDi ); break
  366. # if tNewT == 'rectangle': tElem = inkex.etree.SubElement( tElPa, inkex.addNS( 'rect', 'svg'), tFrDi ); break
  367. # if tNewT == 'ellipse': tElem = inkex.etree.SubElement( tElPa, inkex.addNS( 'ellipse', 'svg'), tFrDi ); break
  368. if tNewT == 'none': tElem = tNoCu; break
  369. break;
  371. # If new node is filled, move it behind the selected node
  373. if tFrDi[ 'fill'] != 'none' and tSiDY > 0:
  374. tElPa = tNoCu.getparent()
  375. tElPI = tElPa.index( tNoCu)
  376. tElPa.insert( tElPI, tElem)
  377. # inkex.errormsg( 'Down: tElPI(%s) tElPa( %s)' % (tElPI, tElPa))
  378. s.fMSel( 'Down: tElPI(%s) tElPa( %s)' % (tElPI, tElPa))
  380. # Set the shape and size of the new node
  381. # : rect: simple case, margins constant, no adjustment needed
  382. # : ellipse: margin varies with the curve
  383. # : equation: (x/a)**2 + (y/b)**2 = 1
  384. # : let the size of the selected object be 2s wide and 2t high
  385. # then vertical and horizontal margins (mv and mh) decrease as the curve
  386. # approaches the corner of the selected object
  387. # : at x = 0: y = b and mv = y - t = b - t
  388. # : at y = 0: x = a and mh = x - s = a - s
  389. # : at x = s: y = b * sqrt( ( 1 - (s/a)**2) ) = t + Mv
  390. # : at y = t: x = a * sqrt( ( 1 - (t/b)**2) ) = s + Mh
  391. # : (t + Mv)**2 / b**2 = 1 - (s/a)**2
  392. # : (s + Mh)**2 / a**2 = 1 - (t/b)**2
  393. # : s**2 + (a*t + a*Mv)**2 = (a*b)**2
  394. # : t**2 + (b*s + b*Mh)**2 = (a*b)**2
  395. # : s**2 - t**2 = b**2 * (s+Mh)**2 - a**2 * (t+Mv)**2
  396. # : To solve, we need to assume that a nd b are proportional to s and t
  397. #
  398. while True:
  400. if tElem.tag == inkex.addNS( 'rect', 'svg'):
  401. tFrDi = {}
  402. tFrDi[ 'sy'] = tBBDi[ 'height'] + 2 * tSiDY
  403. tFrDi[ 'sx'] = tBBDi[ 'width'] + 2 * tSiDX
  404. tFrDi[ 'py'] = tBBDi[ 'y'] - tSiDY
  405. tFrDi[ 'px'] = tBBDi[ 'x'] - tSiDX
  407. tElem.set( 'height', str( tFrDi[ 'sy']))
  408. tElem.set( 'width', str( tFrDi[ 'sx']))
  409. tElem.set( 'y', str( tFrDi[ 'py']))
  410. tElem.set( 'x', str( tFrDi[ 'px']))
  411. tElem.set( 'ry', str( tCRad))
  412. tElem.set( 'rx', str( tCRad))
  413. break
  415. if tElem.tag == inkex.addNS( 'ellipse', 'svg'):
  416. tFrDi = {}
  417. tFrDi[ 'ry'] = tBBDi[ 'height'] / 2 + tSiDY
  418. tFrDi[ 'rx'] = tBBDi[ 'width'] / 2 + tSiDX
  419. tFrDi[ 'cy'] = tBBDi[ 'y'] + tBBDi[ 'height'] / 2
  420. tFrDi[ 'cx'] = tBBDi[ 'x'] + tBBDi[ 'width'] / 2
  422. tElem.set( 'ry', str( tFrDi[ 'ry']))
  423. tElem.set( 'rx', str( tFrDi[ 'rx']))
  424. tElem.set( 'cy', str( tFrDi[ 'cy']))
  425. tElem.set( 'cx', str( tFrDi[ 'cx']))
  426. break
  428. break
  431. # if tStrC != '': tElem.set( 'stroke', str( tStrC))
  432. # if tStrW > 0: tElem.set( 'stroke-width', str( tStrW))
  435. if __name__ == '__main__':
  436. tFram = oFram()
  437. tFram.affect()
  1. More ...
 
 

742

Frame

par RW E2

.91 extension: frame.py: Frames, circles or enlarges selected items

Inkscape Extensions

Lignes
437
Mots
2211
Taille
16,3 Kio
Créé le
Type
text/x-python
Public Domain (PD)
Connectez-vous pour ajouter un commentaire !

Inkscape est un logiciel libre et open source sous licence GPL.