# *************************************************************************** # * Copyright (c) 2016 Victor Titov (DeepSOIC) * # * * # * 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__ = "CompoundTools.CompoundFilter" __author__ = "DeepSOIC, Bernd Hahnebach" __url__ = "http://www.freecad.org" __doc__ = "Compound Filter: remove some children from a compound (features)." import FreeCAD import Part import math import sys def makeCompoundFilter(name, into_group = None): '''makeCompoundFilter(name): makes a CompoundFilter object.''' if into_group is None: into_group = FreeCAD.ActiveDocument if into_group.isDerivedFrom('App::Document'): obj = into_group.addObject("Part::FeaturePython", name) else: obj = into_group.newObject("Part::FeaturePython", name) _CompoundFilter(obj) if obj.ViewObject: _ViewProviderCompoundFilter(obj.ViewObject) return obj class _CompoundFilter: """The CompoundFilter object.""" def __init__(self, obj): obj.addProperty("App::PropertyLink", "Base", "CompoundFilter", "Compound to be filtered") obj.addProperty("App::PropertyEnumeration", "FilterType", "CompoundFilter", "Type of filter method to use; some of these methods " "require, or are affected by, a 'Stencil' object.") obj.FilterType = ['bypass', 'specific items', 'collision-pass', 'window-volume', 'window-area', 'window-length', 'window-distance'] obj.FilterType = 'bypass' # properties controlling "specific items" mode obj.addProperty("App::PropertyString", "items", "CompoundFilter", "Indices of the pieces to be returned.\n" "These are numbers separated by a semicolon, '1;3;5'.\n" "A range can also be provided using a colon, '1;4;8:10'.") obj.addProperty("App::PropertyLink", "Stencil", "CompoundFilter", "Object that defines filtering") obj.addProperty("App::PropertyFloat", "WindowFrom", "CompoundFilter", "Value of threshold, expressed as a percentage of maximum value.") obj.WindowFrom = 80.0 obj.addProperty("App::PropertyFloat", "WindowTo", "CompoundFilter", "Value of threshold, expressed as a percentage of maximum value.") obj.WindowTo = 100.0 obj.addProperty("App::PropertyFloat", "OverrideMaxVal", "CompoundFilter", "Volume threshold, expressed as percentage of the volume of largest child") obj.OverrideMaxVal = 0 obj.addProperty("App::PropertyBool", "Invert", "CompoundFilter", "Output shapes that are rejected by the filter, instead") obj.Invert = False self.Type = "CompoundFilter" obj.Proxy = self def execute(self, obj): # When operating on the object, it is to be treated as a lattice object. # If False, treat as a regular shape. if hasattr(obj, "isLattice"): if 'On' in obj.isLattice: print(obj.Name + " A generic shape is expected, but an array of placements was supplied. " "It will be treated as a generic shape.\n") rst = [] # variable to receive the final list of shapes shps = obj.Base.Shape.childShapes() if obj.FilterType == 'bypass': rst = shps elif obj.FilterType == 'specific items': rst = [] flags = [False] * len(shps) if not obj.items: raise ValueError("The 'items' property must have a number to use this filter: '{}'".format(obj.FilterType)) ranges = obj.items.split(';') for r in ranges: r_v = r.split(':') if len(r_v) == 1: try: i = int(r_v[0]) except ValueError: raise ValueError("Make sure the 'item' does not have spaces; " "a semicolon (;) can only appear between two numbers; " "filter: '{}'".format(obj.FilterType)) try: rst.append(shps[i]) except IndexError: raise ValueError("Item index '{}' is out of range for this filter: '{}'".format(i, obj.FilterType)) flags[i] = True elif len(r_v) == 2 or len(r_v) == 3: if len(r_v) == 2: # fix issue #1: instead of checking length # here and there, simply add the missing field =) (DeepSOIC) r_v.append("") ifrom = None if len(r_v[0].strip()) == 0 else int(r_v[0]) ito = None if len(r_v[1].strip()) == 0 else int(r_v[1]) istep = None if len(r_v[2].strip()) == 0 else int(r_v[2]) rst = rst + shps[ifrom:ito:istep] for b in flags[ifrom:ito:istep]: b = True else: raise ValueError("index range cannot be parsed: '{}'".format(r)) if obj.Invert: rst = [] for i in range(len(shps)): if not flags[i]: rst.append(shps[i]) elif obj.FilterType == 'collision-pass': if not obj.Stencil: raise ValueError("A 'Stencil' object must be set to use this filter: '{}'".format(obj.FilterType)) stencil = obj.Stencil.Shape for s in shps: d = s.distToShape(stencil) if bool(d[0] < Part.Precision.confusion()) ^ bool(obj.Invert): rst.append(s) elif obj.FilterType in ('window-volume', 'window-area', 'window-length', 'window-distance'): vals = [0.0] * len(shps) for i in range(len(shps)): if obj.FilterType == 'window-volume': vals[i] = shps[i].Volume elif obj.FilterType == 'window-area': vals[i] = shps[i].Area elif obj.FilterType == 'window-length': vals[i] = shps[i].Length elif obj.FilterType == 'window-distance': if not obj.Stencil: raise ValueError("A 'Stencil' object must be set to use this filter: '{}'".format(obj.FilterType)) vals[i] = shps[i].distToShape(obj.Stencil.Shape)[0] maxval = max(vals) if obj.Stencil: if obj.FilterType == 'window-volume': maxval = obj.Stencil.Shape.Volume elif obj.FilterType == 'window-area': maxval = obj.Stencil.Shape.Area elif obj.FilterType == 'window-length': maxval = obj.Stencil.Shape.Length if obj.OverrideMaxVal: maxval = obj.OverrideMaxVal valFrom = obj.WindowFrom / 100.0 * maxval valTo = obj.WindowTo / 100.0 * maxval for i in range(len(shps)): if bool(vals[i] >= valFrom and vals[i] <= valTo) ^ obj.Invert: rst.append(shps[i]) else: raise ValueError("Filter mode not implemented: '{}'".format(obj.FilterType)) if len(rst) == 0: scale = 1.0 if not obj.Base.Shape.isNull(): scale = obj.Base.Shape.BoundBox.DiagonalLength / math.sqrt(3) / math.sqrt(len(shps)) if scale < Part.Precision.confusion() * 100: scale = 1.0 print(scale) obj.Shape = getNullShapeShape(scale) # Feeding empty compounds to FreeCAD seems to cause rendering issues, # otherwise it would have been a good idea to output nothing. raise ValueError('Nothing passes through the filter') if len(rst) > 1: obj.Shape = Part.makeCompound(rst) else: # don't make compound of one shape, output it directly sh = rst[0] sh.transformShape(sh.Placement.toMatrix(), True) # True = make copy sh.Placement = FreeCAD.Placement() obj.Shape = sh return class _ViewProviderCompoundFilter: """A View Provider for the CompoundFilter object.""" def __init__(self, vobj): vobj.Proxy = self vobj.addProperty("App::PropertyBool", "DontUnhideOnDelete", "CompoundFilter", "When this object is deleted, Base and Stencil are unhidden. " "This flag stops it from happening.") vobj.setEditorMode("DontUnhideOnDelete", 2) # set hidden def getIcon(self): return "Part_CompoundFilter" def attach(self, vobj): self.ViewObject = vobj self.Object = vobj.Object def dumps(self): return None def loads(self, state): return None def claimChildren(self): children = [self.Object.Base] if self.Object.Stencil: children.append(self.Object.Stencil) return children def onDelete(self, feature, subelements): """subelements is a tuple of strings.""" if not self.ViewObject.DontUnhideOnDelete: try: if self.Object.Base: # the base object might be deleted be the user # https://forum.freecad.org/viewtopic.php?f=3&t=42242 self.Object.Base.ViewObject.show() if self.Object.Stencil: self.Object.Stencil.ViewObject.show() except Exception as err: if hasattr(err, "message"): error_string = err.message else: error_string = err FreeCAD.Console.PrintError("Error in onDelete: {}\n".format(error_string)) return True def getNullShapeShape(scale=1.0): """Obtains a shape intended as a placeholder in case null shape was produced by an operation""" # read shape from file, if not done this before global _nullShapeShape try: # TODO: check this, and possibly remove this code # vocx: this doesn't work at all. # What is `empty-shape.brep`? An empty shape that is imported # from a BREP file? Why do we need it? What does it contain? # It does not even exist. # The simplest way to return a `Null` shape is with `Part.Shape`. if not _nullShapeShape: _nullShapeShape = Part.Shape() import os shapePath = os.path.join(os.path.dirname(__file__), "shapes", "empty-shape.brep") f = open(shapePath) _nullShapeShape.importBrep(f) f.close() except NameError: _nullShapeShape = Part.Shape() # scale the shape ret = _nullShapeShape if scale != 1.0: ret = _nullShapeShape.copy() # In the past the software would crash trying to scale a Null shape ret.scale(scale) return ret