#***************************************************************************
#* *
#* Copyright (c) 2016 - 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 *
#* *
#***************************************************************************
__title__= "Lattice SubLink feature for FreeCAD"
__author__ = "DeepSOIC"
__doc__ = "Lattice SubLink is like Draft Facebinder, but for edges and vertices too."
from lattice2Common import *
from lattice2BaseFeature import isObjectLattice, assureProperty #assureProperty(self, selfobj, proptype, propname, defvalue, group, tooltip)
import lattice2Markers as markers
import FreeCAD as App
import lattice2ShapeCopy as ShapeCopy
import lattice2Subsequencer as LSS
from lattice2Utils import sublinkFromApart, syncSublinkApart
# -------------------------- feature --------------------------------------------------
def makeSubLink(name):
'''makeSubLink(name): makes a SubLink object.'''
obj = App.ActiveDocument.addObject("Part::FeaturePython",name)
LatticeSubLink(obj)
ViewProviderSubLink(obj.ViewObject)
return obj
class LatticeSubLink:
"The Lattice SubLink object"
def __init__(self,obj):
self.Type = "SubLink"
obj.addProperty("App::PropertyLink","Object","Lattice SubLink","Object to extract an element from")
obj.addProperty("App::PropertyStringList","SubNames","Lattice SubLink", "List of elements to extract. Example: Edge5,Edge8")
obj.Proxy = self
self.assureProperties(obj)
def assureProperties(self, selfobj):
assureProperty(selfobj, "App::PropertyEnumeration","Looping", ["Single"] + LSS.LOOP_MODES, "Lattice SubLink", "Sets wether to collect just the element, or all similar from array.")
assureProperty(selfobj, "App::PropertyEnumeration","CompoundTraversal", LSS.TRAVERSAL_MODES, "Lattice SubLink", "Sets how to unpack compounds if Looping is not 'Single'.")
assureProperty(selfobj, "App::PropertyLinkSub", "SubLink", sublinkFromApart(selfobj.Object, selfobj.SubNames), "Lattice SubLink", "Mirror of Object+SubNames properties")
def execute(self,selfobj):
self.assureProperties(selfobj)
#validity check
if isObjectLattice(selfobj.Object):
import lattice2Executer
lattice2Executer.warning(selfobj,"A generic shape is expected, but a placement/array was supplied. It will be treated as a generic shape.")
lnkobj = selfobj.Object
sh = lnkobj.Shape
# subsequencing
full_link = (lnkobj, selfobj.SubNames)
if selfobj.Looping == 'Single':
lnkseq = [full_link]
else:
lnkseq = LSS.Subsequence_auto(full_link, selfobj.CompoundTraversal, selfobj.Looping )
# main code
seq_packs = [] #pack = single item of subsequence. Pack contains list of elements that were selected.
shape_count = 0
for lnk in lnkseq: # loop over subsequence (if Looping == 'Single', this loop will only loop once)
# extract the pack
assert(lnk[0] is lnkobj) # all links should point to elements of one object anyway
subnames = lnk[1]
pack = [] #acculumator, to eventually become a compound of shapes for this subsequence item
for subname in subnames:
subname = subname.strip()
if len(subname)==0:
raise ValueError("Empty subname! Not allowed.")
if 'Face' in subname: # manual handling of standard cases, because support for negative indexing is needed
index = int(subname.replace('Face',''))-1
pack.append(sh.Faces[index])
elif 'Edge' in subname:
index = int(subname.replace('Edge',''))-1
pack.append(sh.Edges[index])
elif 'Vertex' in subname:
index = int(subname.replace('Vertex',''))-1
pack.append(sh.Vertexes[index])
else: #fail-safe. non-standard sublink.
lattice2Executer.warning(selfobj,"Unexpected subelement name: "+subname+". Trying to extract it with .Shape.getElement()...")
pack.append(sh.getElement(subname))
shape_count += len(pack)
# convert list into compound
if len(pack) == 1:
pack = ShapeCopy.transformCopy(pack[0])
else:
pack = Part.makeCompound(pack)
# accumulate
seq_packs.append(pack)
# convert list into compound
if len(seq_packs) == 1:
seq_packs = seq_packs[0]
else:
seq_packs = Part.makeCompound(seq_packs)
if shape_count == 0:
# no shapes collected, FAIL!
scale = 1.0
try:
if selfobj.Object:
scale = selfobj.Object[0].Shape.BoundBox.DiagonalLength/math.sqrt(3)
except Exception as err:
App.Console.PrintError(selfobj.Name+": Failed to estimate size of marker shape")
if scale < DistConfusion * 100:
scale = 1.0
selfobj.Shape = markers.getNullShapeShape(scale)
raise ValueError('Nothing is linked, apparently!') #Feeding empty compounds to FreeCAD seems to cause rendering issues, otherwise it would have been a good idea to output nothing.
# done!
selfobj.Shape = seq_packs
def onChanged(self, selfobj, prop): #prop is a string - name of the property
# synchronize SubLink and Object+SubNames properties
syncSublinkApart(selfobj, prop, 'SubLink', 'Object', 'SubNames')
def __getstate__(self):
return None
def __setstate__(self,state):
return None
class ViewProviderSubLink:
"A View Provider for the SubLink object"
def __init__(self,vobj):
vobj.Proxy = self
def getIcon(self):
ret = ""
if len(self.Object.SubNames) == 1:
subname = self.Object.SubNames[0]
if 'Face' in subname:
ret = getIconPath("Lattice2_SubLink_Face.svg")
elif 'Edge' in subname:
ret = getIconPath("Lattice2_SubLink_Edge.svg")
elif 'Vertex' in subname:
ret = getIconPath("Lattice2_SubLink_Vertex.svg")
if len(ret) == 0:
ret = getIconPath("Lattice2_SubLink.svg")
if hasattr(self.Object,'Looping') and self.Object.Looping != 'Single':
ret = ret.replace("SubLink","SubLinkSubsequence")
return ret
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 claimChildren(self):
return []
def CreateSubLink(object, subnames, looping):
#stabilize links
subnames = list(subnames) #'tuple' object does not support item assignment; SubElementNames of SelectionObject is a tuple
try:
cnt_faces = 0
cnt_edges = 0
cnt_vertexes = 0
cnt_somethingelse = 0
n_faces = None #vars to receive counts of respective subelements in the shape of object. Not prefilling them, for speed - filled only as needed
n_edges = None
n_vertexes = None
for i in range(len(subnames)):
subname = subnames[i].strip()
if 'Face' in subname:
index = int(subname.replace('Face',''))
if n_faces is None:
n_faces = len(object.Shape.Faces)
if (index-1)*2 > n_faces:
index = index - n_faces
subname = "Face"+str(index)
cnt_faces += 1
elif 'Edge' in subname:
index = int(subname.replace('Edge',''))
if n_edges is None:
n_edges = len(object.Shape.Edges)
if (index-1)*2 > n_edges:
index = index - n_edges
subname = "Edge"+str(index)
cnt_edges += 1
elif 'Vertex' in subname:
index = int(subname.replace('Vertex',''))
if n_vertexes is None:
n_vertexes = len(object.Shape.Vertexes)
if (index-1)*2 > n_vertexes:
index = index - n_vertexes
subname = "Vertex"+str(index)
cnt_vertexes += 1
else:
cnt_somethingelse += 1
pass #something unexpected, pass through unchanged
subnames[i] = subname
except Exception:
pass
FreeCADGui.addModule("lattice2SubLink")
FreeCADGui.addModule("lattice2Executer")
name = object.Name+"_"+subnames[0] if len(subnames)==1 else "SubLink"
if looping != 'Single':
name = object.Name+"_"+"Elements"
FreeCADGui.doCommand("f = lattice2SubLink.makeSubLink(name = "+repr(name)+")")
label = unicode(subnames[0] if len(subnames)==1 else "subelements") + u" of " + object.Label
FreeCADGui.doCommand("f.Label = "+repr(label))
FreeCADGui.doCommand("f.Object = App.ActiveDocument."+object.Name)
FreeCADGui.doCommand("f.SubNames = "+repr(subnames))
FreeCADGui.doCommand("f.Looping = "+repr(looping))
FreeCADGui.doCommand("lattice2Executer.executeFeature(f)")
if cnt_vertexes > 0 and cnt_faces+cnt_edges+cnt_somethingelse == 0: #only vertices selected - make them bigger to make them visible
FreeCADGui.doCommand("f.ViewObject.PointSize = 10")
FreeCADGui.doCommand("f.Object.ViewObject.hide()")
FreeCADGui.doCommand("Gui.Selection.addSelection(f)")
FreeCADGui.doCommand("f = None")
return App.ActiveDocument.ActiveObject
def cmdSubLink(looping = 'Single'):
sel = FreeCADGui.Selection.getSelectionEx()
if len(sel) == 0:
raise SelectionError("Bad selection", "Please select some subelements from one object, first.")
if len(sel) > 1:
raise SelectionError("Bad selection", "You have selected subelements from more than one object. Not allowed. You can only select subelements of one object.")
if len(sel[0].SubElementNames)==0:
raise SelectionError("Bad selection", "Please select some subelements, not the whole object.")
App.ActiveDocument.openTransaction("Create SubLink")
CreateSubLink(sel[0].Object,sel[0].SubElementNames, looping)
deselect(sel)
App.ActiveDocument.commitTransaction()
# -------------------------- /common stuff --------------------------------------------------
# -------------------------- Gui command --------------------------------------------------
class CommandSubLink:
"Command to create SubLink feature"
def GetResources(self):
return {'Pixmap' : getIconPath("Lattice2_SubLink.svg"),
'MenuText': QtCore.QT_TRANSLATE_NOOP("Lattice2_SubLink","SubLink"),
'Accel': "",
'ToolTip': QtCore.QT_TRANSLATE_NOOP("Lattice2_SubLink","SubLink: extract individual vertices, edges and faces from shapes")}
def Activated(self):
try:
if len(FreeCADGui.Selection.getSelection())==0:
infoMessage("SubLink",
"'SubLink' command. Extracts selected faces, edges or vertices from the object.\n\n"+
"Please select subelements of one object, then invoke the command.")
return
cmdSubLink()
except Exception as err:
msgError(err)
def IsActive(self):
if App.ActiveDocument:
return True
else:
return False
class CommandSublinkSubsequence:
"Command to create SubLink Subsequence feature"
def GetResources(self):
return {'Pixmap' : getIconPath("Lattice2_SubLinkSubsequence.svg"),
'MenuText': QtCore.QT_TRANSLATE_NOOP("Lattice2_SubLink","Subsequence"),
'Accel': "",
'ToolTip': QtCore.QT_TRANSLATE_NOOP("Lattice2_SubLink","Subsequence: extract individual vertices, edges and faces from shapes, from each instance in an array.")}
def Activated(self):
try:
if len(FreeCADGui.Selection.getSelection())==0:
infoMessage("SubLink",
"'Subsequence' command. Extracts all faces/edges/vertexes similar to those selected, from an array of shapes.\n\n"+
"Please select one or more subelements of one array (compound), then invoke the command.")
return
cmdSubLink(looping= 'All around')
except Exception as err:
msgError(err)
def IsActive(self):
if App.ActiveDocument:
return True
else:
return False
FreeCADGui.addCommand('Lattice2_SubLink', CommandSubLink())
FreeCADGui.addCommand('Lattice2_SublinkSubsequence', CommandSublinkSubsequence())
class CommandSublinkGroup:
def GetCommands(self):
return ("Lattice2_SubLink","Lattice2_SublinkSubsequence")
def GetDefaultCommand(self): # return the index of the tuple of the default command.
return 0
def GetResources(self):
return { 'MenuText': 'Sublink:',
'ToolTip': 'Sublink (group): extract elements from shapes.'}
def IsActive(self): # optional
return App.ActiveDocument is not None
FreeCADGui.addCommand('Lattice2_Sublink_GroupCommand',CommandSublinkGroup())
exportedCommands = ['Lattice2_Sublink_GroupCommand']
# -------------------------- /Gui command --------------------------------------------------