New tool: Lattice ShapeString
Powered by Draft ShapeString, it is a convenient way to make arrays of strings
This commit is contained in:
DeepSOIC
parent
5a6f7db1b1
commit
22ad960bd4
|
|
@ -69,6 +69,8 @@ class LatticeWorkbench (Workbench):
|
|||
cmdsCompoundTools = cmdsCompoundTools + latticeInspect.exportedCommands
|
||||
import latticeBoundBox
|
||||
cmdsMiscTools = cmdsMiscTools + latticeBoundBox.exportedCommands
|
||||
import latticeShapeString
|
||||
cmdsMiscTools = cmdsMiscTools + latticeShapeString.exportedCommands
|
||||
|
||||
self.appendToolbar('LatticeArrayTools', cmdsArrayTools)
|
||||
self.appendToolbar('LatticeCompoundTools', cmdsCompoundTools)
|
||||
|
|
|
|||
275
latticeShapeString.py
Normal file
275
latticeShapeString.py
Normal file
|
|
@ -0,0 +1,275 @@
|
|||
#***************************************************************************
|
||||
#* *
|
||||
#* Copyright (c) 2015 - Victor Titov (DeepSOIC) *
|
||||
#* <vv.titov@gmail.com> *
|
||||
#* *
|
||||
#* This program is free software; you can redistribute it and/or modify *
|
||||
#* it under the terms of the GNU Lesser General Public License (LGPL) *
|
||||
#* as published by the Free Software Foundation; either version 2 of *
|
||||
#* the License, or (at your option) any later version. *
|
||||
#* for detail see the LICENCE text file. *
|
||||
#* *
|
||||
#* This program is distributed in the hope that it will be useful, *
|
||||
#* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
||||
#* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
||||
#* GNU Library General Public License for more details. *
|
||||
#* *
|
||||
#* You should have received a copy of the GNU Library General Public *
|
||||
#* License along with this program; if not, write to the Free Software *
|
||||
#* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
|
||||
#* USA *
|
||||
#* *
|
||||
#***************************************************************************
|
||||
|
||||
|
||||
from latticeCommon import *
|
||||
import latticeBaseFeature
|
||||
import latticeExecuter
|
||||
import latticeCompoundExplorer as LCE
|
||||
from latticeBoundBox import getPrecisionBoundBox #needed for alignment
|
||||
|
||||
import FreeCAD as App
|
||||
import Part
|
||||
from Draft import _ShapeString
|
||||
|
||||
|
||||
__title__="BoundingBox module for FreeCAD"
|
||||
__author__ = "DeepSOIC"
|
||||
__url__ = ""
|
||||
|
||||
|
||||
def findFont(font_file_name):
|
||||
'''checks for existance of the file in a few locations and returns the full path of the first one found'''
|
||||
|
||||
import os
|
||||
|
||||
if os.path.isabs(font_file_name):
|
||||
if not os.path.exists(font_file_name):
|
||||
raise ValueError("Font file not found: " + font_file_name )
|
||||
return font_file_name
|
||||
|
||||
|
||||
dirlist = [] #list of directories to probe
|
||||
|
||||
import latticeDummy
|
||||
lattice_path = os.path.dirname(latticeDummy.__file__)
|
||||
dirlist.append(lattice_path + "/fonts")
|
||||
|
||||
if len(App.ActiveDocument.FileName) > 0:
|
||||
dirlist.append(os.path.dirname(App.ActiveDocument.FileName)+"/fonts")
|
||||
|
||||
dirlist.append(os.path.abspath(os.curdir))
|
||||
|
||||
#todo: figure out the path to system fonts, and add it here
|
||||
|
||||
#do the probing
|
||||
for _dir in dirlist:
|
||||
if os.path.exists(_dir + "/" + font_file_name):
|
||||
return _dir + "/" + font_file_name
|
||||
raise ValueError("Font file not found: "+font_file_name +". Locations probed: \n"+'\n'.join(dirlist))
|
||||
|
||||
|
||||
# -------------------------- document object --------------------------------------------------
|
||||
|
||||
def makeLatticeShapeString(name):
|
||||
'''makeBoundBox(name): makes a BoundBox object.'''
|
||||
obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython",name)
|
||||
LatticeShapeString(obj)
|
||||
ViewProviderLatticeShapeString(obj.ViewObject)
|
||||
return obj
|
||||
|
||||
class FoolFeatureDocumentObject:
|
||||
'''A class that is to be fed to Draft ShapeString object instead of a real one, to obtain shapes it generates'''
|
||||
def __init__(self):
|
||||
self.Placement = App.Placement()
|
||||
self.Shape = Part.Shape()
|
||||
self.properties = []
|
||||
self.Proxy = None
|
||||
|
||||
def addProperty(self, proptype, propname, group = None, hint = None):
|
||||
setattr(self,propname,None)
|
||||
self.properties.append((proptype, propname, group, hint))
|
||||
|
||||
|
||||
class LatticeShapeString:
|
||||
"The LatticeShapeString object"
|
||||
def __init__(self,obj):
|
||||
self.Type = "LatticeShapeString"
|
||||
|
||||
|
||||
#initialize accompanying Draft ShapeString
|
||||
foolObj = FoolFeatureDocumentObject()
|
||||
self.draft_shape_string = _ShapeString(foolObj)
|
||||
self.foolObj = foolObj
|
||||
|
||||
#add Draft ShapeString's properties to document object in posession of our LatticeShapeString
|
||||
for (proptype, propname, group, hint) in foolObj.properties:
|
||||
if propname != "String": #we'll define our own string property
|
||||
obj.addProperty(proptype,propname,"Lattice ShapeString",hint)
|
||||
|
||||
|
||||
obj.addProperty("App::PropertyLink","ArrayLink","Lattice ShapeString","array to use for the shapestring")
|
||||
|
||||
obj.addProperty("App::PropertyStringList","Strings","Lattice ShapeString","Strings to put at each placement.")
|
||||
|
||||
obj.addProperty("App::PropertyEnumeration","XAlign","Lattice ShapeString","Horizontal alignment of individual strings")
|
||||
obj.XAlign = ['None','Left','Right','Middle']
|
||||
|
||||
obj.addProperty("App::PropertyEnumeration","YAlign","Lattice ShapeString","Vertical alignment of individual strings")
|
||||
obj.YAlign = ['None','Top','Bottom','Middle']
|
||||
|
||||
obj.addProperty("App::PropertyFile","FullPathToFont","Lattice ShapeString","Full path of font file that is actually being used.")
|
||||
obj.setEditorMode("FullPathToFont", 1) # set read-only
|
||||
|
||||
obj.Proxy = self
|
||||
|
||||
self.setDefaults(obj)
|
||||
|
||||
def setDefaults(self, obj):
|
||||
'''initializes the properties, so that LatticeShapeString can be used with no initial fiddling'''
|
||||
obj.FontFile = "FreeUniversal-Regular.ttf"
|
||||
obj.Size = 10
|
||||
obj.Tracking = 0
|
||||
obj.Strings = ['string1','string2']
|
||||
|
||||
def execute(self,obj):
|
||||
nOfStrings = len(obj.Strings)
|
||||
lattice = obj.ArrayLink
|
||||
if lattice is None:
|
||||
plms = [App.Placement() for i in range(0,nOfStrings)]
|
||||
else:
|
||||
if not latticeBaseFeature.isObjectLattice(lattice):
|
||||
latticeExecuter.warning(obj,"ShapeString's link to array must point to a lattice. It points to a generic shape. Results may be unexpected.")
|
||||
leaves = LCE.AllLeaves(lattice.Shape)
|
||||
plms = [leaf.Placement for leaf in leaves]
|
||||
|
||||
#update foolObj's properties
|
||||
for (proptype, propname, group, hint) in self.foolObj.properties:
|
||||
if propname != "String": #ignore "String", that will be taken care of in the following loop
|
||||
setattr(self.foolObj, propname, getattr(obj, propname))
|
||||
self.foolObj.FontFile = findFont(obj.FontFile)
|
||||
obj.FullPathToFont = self.foolObj.FontFile
|
||||
|
||||
shapes = []
|
||||
for i in range( 0 , min(len(plms),len(obj.Strings)) ):
|
||||
if len(obj.Strings[i]) > 0:
|
||||
#generate shapestring using Draft
|
||||
self.foolObj.String = obj.Strings[i]
|
||||
self.foolObj.Shape = None
|
||||
self.draft_shape_string.execute(self.foolObj)
|
||||
shape = self.foolObj.Shape
|
||||
|
||||
#calculate alignment point
|
||||
if obj.XAlign == 'None' and obj.YAlign == 'None':
|
||||
pass #need not calculate boundbox
|
||||
else:
|
||||
bb = getPrecisionBoundBox(shape)
|
||||
|
||||
alignPnt = App.Vector()
|
||||
|
||||
if obj.XAlign == 'Left':
|
||||
alignPnt.x = bb.XMin
|
||||
elif obj.XAlign == 'Right':
|
||||
alignPnt.x = bb.XMax
|
||||
elif obj.XAlign == 'Middle':
|
||||
alignPnt.x = bb.Center.x
|
||||
|
||||
if obj.YAlign == 'Bottom':
|
||||
alignPnt.y = bb.YMin
|
||||
elif obj.YAlign == 'Top':
|
||||
alignPnt.y = bb.YMax
|
||||
elif obj.YAlign == 'Middle':
|
||||
alignPnt.y = bb.Center.y
|
||||
|
||||
#Apply alignment
|
||||
shape.Placement = App.Placement(alignPnt*(-1.0), App.Rotation()).multiply(shape.Placement)
|
||||
|
||||
#Apply placement from array
|
||||
shape.Placement = plms[i].multiply(shape.Placement)
|
||||
|
||||
shapes.append(shape.copy())
|
||||
|
||||
if len(shapes) == 0:
|
||||
scale = 1.0
|
||||
if lattice is not None:
|
||||
scale = lattice.Shape.BoundBox.DiagonalLength/math.sqrt(3)/math.sqrt(len(shps))
|
||||
if scale < DistConfusion * 100:
|
||||
scale = 1.0
|
||||
obj.Shape = markers.getNullShapeShape(scale)
|
||||
raise ValueError('No strings were converted into shapes') #Feeding empty compounds to FreeCAD seems to cause rendering issues, otherwise it would have been a good idea to output nothing.
|
||||
|
||||
obj.Shape = Part.makeCompound(shapes)
|
||||
|
||||
|
||||
class ViewProviderLatticeShapeString:
|
||||
"A View Provider for the LatticeShapeString object"
|
||||
|
||||
def __init__(self,vobj):
|
||||
vobj.Proxy = self
|
||||
|
||||
def getIcon(self):
|
||||
return getIconPath("Draft_ShapeString.svg")
|
||||
|
||||
def attach(self, vobj):
|
||||
self.ViewObject = vobj
|
||||
self.Object = vobj.Object
|
||||
|
||||
|
||||
def setEdit(self,vobj,mode):
|
||||
return False
|
||||
|
||||
def unsetEdit(self,vobj,mode):
|
||||
return
|
||||
|
||||
def __getstate__(self):
|
||||
return None
|
||||
|
||||
def __setstate__(self,state):
|
||||
return None
|
||||
|
||||
def CreateLatticeShapeString(name):
|
||||
sel = FreeCADGui.Selection.getSelectionEx()
|
||||
FreeCAD.ActiveDocument.openTransaction("Create LatticeShapeString")
|
||||
FreeCADGui.addModule("latticeShapeString")
|
||||
FreeCADGui.addModule("latticeExecuter")
|
||||
FreeCADGui.doCommand("f = latticeShapeString.makeLatticeShapeString(name='"+name+"')")
|
||||
if len(sel) == 1:
|
||||
FreeCADGui.doCommand("f.ArrayLink = FreeCADGui.Selection.getSelection()[0]")
|
||||
FreeCADGui.doCommand("latticeExecuter.executeFeature(f)")
|
||||
FreeCADGui.doCommand("f = None")
|
||||
FreeCAD.ActiveDocument.commitTransaction()
|
||||
|
||||
|
||||
# -------------------------- /common stuff --------------------------------------------------
|
||||
|
||||
# -------------------------- Gui command --------------------------------------------------
|
||||
|
||||
class _CommandLatticeShapeString:
|
||||
"Command to create LatticeShapeString feature"
|
||||
def GetResources(self):
|
||||
return {'Pixmap' : getIconPath("Draft_ShapeString.svg"),
|
||||
'MenuText': QtCore.QT_TRANSLATE_NOOP("Lattice_ShapeString","ShapeString for arraying"),
|
||||
'Accel': "",
|
||||
'ToolTip': QtCore.QT_TRANSLATE_NOOP("Lattice_ShapeString","Make strings at given placements")}
|
||||
|
||||
def Activated(self):
|
||||
if len(FreeCADGui.Selection.getSelection()) == 0 or len(FreeCADGui.Selection.getSelection()) == 1:
|
||||
CreateLatticeShapeString(name = "Strings")
|
||||
else:
|
||||
mb = QtGui.QMessageBox()
|
||||
mb.setIcon(mb.Icon.Warning)
|
||||
mb.setText(translate("Lattice_ShapeString", "Either select nothing, or just one lattice object! You seem to have more than one object selected.", None))
|
||||
mb.setWindowTitle(translate("Lattice_ShapeString","Bad selection", None))
|
||||
mb.exec_()
|
||||
|
||||
def IsActive(self):
|
||||
if FreeCAD.ActiveDocument:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
FreeCADGui.addCommand('Lattice_ShapeString', _CommandLatticeShapeString())
|
||||
|
||||
exportedCommands = ['Lattice_ShapeString']
|
||||
|
||||
# -------------------------- /Gui command --------------------------------------------------
|
||||
Loading…
Reference in New Issue
Block a user