/
PathStock.py
420 lines (352 loc) · 17.2 KB
/
PathStock.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
# -*- coding: utf-8 -*-
# ***************************************************************************
# * *
# * Copyright (c) 2015 Dan Falck <ddfalck@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 *
# * *
# ***************************************************************************
'''used to create material stock around a machined part- for visualization '''
import FreeCAD
import Part
import PathScripts.PathIconViewProvider as PathIconViewProvider
import PathScripts.PathLog as PathLog
import math
from PySide import QtCore
PathLog.setLevel(PathLog.Level.INFO, PathLog.thisModule())
#PathLog.trackModule(PathLog.thisModule())
# Qt translation handling
def translate(context, text, disambig=None):
return QtCore.QCoreApplication.translate(context, text, disambig)
class StockType:
# pylint: disable=no-init
NoStock = 'None'
FromBase = 'FromBase'
CreateBox = 'CreateBox'
CreateCylinder = 'CreateCylinder'
Unknown = 'Unknown'
@classmethod
def FromStock(cls, stock):
'''FromStock(stock) ... Answer a string representing the type of stock.'''
if not stock:
return cls.NoStock
if hasattr(stock, 'StockType'):
return stock.StockType
# fallback in case somebody messed with internals
if hasattr(stock, 'ExtXneg') and hasattr(stock, 'ExtZpos'):
return cls.FromBase
if hasattr(stock, 'Length') and hasattr(stock, 'Width'):
return cls.CreateBox
if hasattr(stock, 'Radius') and hasattr(stock, 'Height'):
return cls.CreateCylinder
return cls.Unknown
def shapeBoundBox(obj):
PathLog.track(type(obj))
if list == type(obj) and obj:
bb = FreeCAD.BoundBox()
for o in obj:
bb.add(shapeBoundBox(o))
return bb
if hasattr(obj, 'Shape'):
return obj.Shape.BoundBox
if obj and 'App::Part' == obj.TypeId:
bounds = [shapeBoundBox(o) for o in obj.Group]
if bounds:
bb = bounds[0]
for b in bounds[1:]:
bb = bb.united(b)
return bb
if obj:
PathLog.error(translate('PathStock', "Invalid base object %s - no shape found") % obj.Name)
return None
class Stock(object):
def onDocumentRestored(self, obj):
if hasattr(obj, 'StockType'):
obj.setEditorMode('StockType', 2) # hide
class StockFromBase(Stock):
def __init__(self, obj, base):
"Make stock"
obj.addProperty("App::PropertyLink", "Base", "Base", QtCore.QT_TRANSLATE_NOOP("PathStock", "The base object this stock is derived from"))
obj.addProperty("App::PropertyDistance", "ExtXneg", "Stock", QtCore.QT_TRANSLATE_NOOP("PathStock", "Extra allowance from part bound box in negative X direction"))
obj.addProperty("App::PropertyDistance", "ExtXpos", "Stock", QtCore.QT_TRANSLATE_NOOP("PathStock", "Extra allowance from part bound box in positive X direction"))
obj.addProperty("App::PropertyDistance", "ExtYneg", "Stock", QtCore.QT_TRANSLATE_NOOP("PathStock", "Extra allowance from part bound box in negative Y direction"))
obj.addProperty("App::PropertyDistance", "ExtYpos", "Stock", QtCore.QT_TRANSLATE_NOOP("PathStock", "Extra allowance from part bound box in positive Y direction"))
obj.addProperty("App::PropertyDistance", "ExtZneg", "Stock", QtCore.QT_TRANSLATE_NOOP("PathStock", "Extra allowance from part bound box in negative Z direction"))
obj.addProperty("App::PropertyDistance", "ExtZpos", "Stock", QtCore.QT_TRANSLATE_NOOP("PathStock", "Extra allowance from part bound box in positive Z direction"))
obj.Base = base
obj.ExtXneg= 1.0
obj.ExtXpos= 1.0
obj.ExtYneg= 1.0
obj.ExtYpos= 1.0
obj.ExtZneg= 1.0
obj.ExtZpos= 1.0
# placement is only tracked on creation
bb = shapeBoundBox(base.Group) if base else None
if bb:
obj.Placement = FreeCAD.Placement(FreeCAD.Vector(bb.XMin, bb.YMin, bb.ZMin), FreeCAD.Rotation())
else:
PathLog.track(obj.Label, base.Label)
obj.Proxy = self
# debugging aids
self.origin = None
self.length = None
self.width = None
self.height = None
def __getstate__(self):
return None
def __setstate__(self, state):
return None
def execute(self, obj):
bb = shapeBoundBox(obj.Base.Group) if obj.Base and hasattr(obj.Base, 'Group') else None
PathLog.track(obj.Label, bb)
# Sometimes, when the Base changes it's temporarily not assigned when
# Stock.execute is triggered - it'll be set correctly the next time around.
if bb:
self.origin = FreeCAD.Vector(-obj.ExtXneg.Value, -obj.ExtYneg.Value, -obj.ExtZneg.Value)
self.length = bb.XLength + obj.ExtXneg.Value + obj.ExtXpos.Value
self.width = bb.YLength + obj.ExtYneg.Value + obj.ExtYpos.Value
self.height = bb.ZLength + obj.ExtZneg.Value + obj.ExtZpos.Value
shape = Part.makeBox(self.length, self.width, self.height, self.origin)
shape.Placement = obj.Placement
obj.Shape = shape
def onChanged(self, obj, prop):
if prop in ['ExtXneg', 'ExtXpos', 'ExtYneg', 'ExtYpos', 'ExtZneg', 'ExtZpos'] and not 'Restore' in obj.State:
self.execute(obj)
class StockCreateBox(Stock):
MinExtent = 0.001
def __init__(self, obj):
obj.addProperty('App::PropertyLength', 'Length', 'Stock', QtCore.QT_TRANSLATE_NOOP("PathStock", "Length of this stock box"))
obj.addProperty('App::PropertyLength', 'Width', 'Stock', QtCore.QT_TRANSLATE_NOOP("PathStock", "Width of this stock box"))
obj.addProperty('App::PropertyLength', 'Height', 'Stock', QtCore.QT_TRANSLATE_NOOP("PathStock", "Height of this stock box"))
obj.Length = 10
obj.Width = 10
obj.Height = 10
obj.Proxy = self
def __getstate__(self):
return None
def __setstate__(self, state):
return None
def execute(self, obj):
if obj.Length < self.MinExtent:
obj.Length = self.MinExtent
if obj.Width < self.MinExtent:
obj.Width = self.MinExtent
if obj.Height < self.MinExtent:
obj.Height = self.MinExtent
shape = Part.makeBox(obj.Length, obj.Width, obj.Height)
shape.Placement = obj.Placement
obj.Shape = shape
def onChanged(self, obj, prop):
if prop in ['Length', 'Width', 'Height'] and not 'Restore' in obj.State:
self.execute(obj)
class StockCreateCylinder(Stock):
MinExtent = 0.001
def __init__(self, obj):
obj.addProperty('App::PropertyLength', 'Radius', 'Stock', QtCore.QT_TRANSLATE_NOOP("PathStock", "Radius of this stock cylinder"))
obj.addProperty('App::PropertyLength', 'Height', 'Stock', QtCore.QT_TRANSLATE_NOOP("PathStock", "Height of this stock cylinder"))
obj.Radius = 2
obj.Height = 10
obj.Proxy = self
def __getstate__(self):
return None
def __setstate__(self, state):
return None
def execute(self, obj):
if obj.Radius < self.MinExtent:
obj.Radius = self.MinExtent
if obj.Height < self.MinExtent:
obj.Height = self.MinExtent
shape = Part.makeCylinder(obj.Radius, obj.Height)
shape.Placement = obj.Placement
obj.Shape = shape
def onChanged(self, obj, prop):
if prop in ['Radius', 'Height'] and not 'Restore' in obj.State:
self.execute(obj)
def SetupStockObject(obj, stockType):
PathLog.track(obj.Label, stockType)
if FreeCAD.GuiUp and obj.ViewObject:
obj.addProperty('App::PropertyString', 'StockType', 'Stock', QtCore.QT_TRANSLATE_NOOP("PathStock", "Internal representation of stock type"))
obj.StockType = stockType
obj.setEditorMode('StockType', 2) # hide
PathIconViewProvider.ViewProvider(obj.ViewObject, 'Stock')
obj.ViewObject.Transparency = 90
obj.ViewObject.DisplayMode = 'Wireframe'
class FakeJob(object):
def __init__(self, base):
self.Group = [base]
def _getBase(job):
if job and hasattr(job, 'Model'):
return job.Model
if job:
import PathScripts.PathUtils as PathUtils
job = PathUtils.findParentJob(job)
return job.Model if job else None
return None
def CreateFromBase(job, neg=None, pos=None, placement=None):
PathLog.track(job.Label, neg, pos, placement)
base = _getBase(job)
obj = FreeCAD.ActiveDocument.addObject('Part::FeaturePython', 'Stock')
obj.Proxy = StockFromBase(obj, base)
if neg:
obj.ExtXneg = neg.x
obj.ExtYneg = neg.y
obj.ExtZneg = neg.z
if pos:
obj.ExtXpos = pos.x
obj.ExtYpos = pos.y
obj.ExtZpos = pos.z
if placement:
obj.Placement = placement
SetupStockObject(obj, StockType.FromBase)
obj.Proxy.execute(obj)
obj.purgeTouched()
return obj
def CreateBox(job, extent=None, placement=None):
base = _getBase(job)
obj = FreeCAD.ActiveDocument.addObject('Part::FeaturePython', 'Stock')
obj.Proxy = StockCreateBox(obj)
if extent:
obj.Length = extent.x
obj.Width = extent.y
obj.Height = extent.z
elif base:
bb = shapeBoundBox(base.Group)
obj.Length = max(bb.XLength, 1)
obj.Width = max(bb.YLength, 1)
obj.Height = max(bb.ZLength, 1)
if placement:
obj.Placement = placement
elif base:
bb = shapeBoundBox(base.Group)
origin = FreeCAD.Vector(bb.XMin, bb.YMin, bb.ZMin)
obj.Placement = FreeCAD.Placement(origin, FreeCAD.Vector(), 0)
SetupStockObject(obj, StockType.CreateBox)
return obj
def CreateCylinder(job, radius=None, height=None, placement=None):
base = _getBase(job)
obj = FreeCAD.ActiveDocument.addObject('Part::FeaturePython', 'Stock')
obj.Proxy = StockCreateCylinder(obj)
if radius:
obj.Radius = radius
if height:
obj.Height = height
elif base:
bb = shapeBoundBox(base.Group)
obj.Radius = math.sqrt(bb.XLength ** 2 + bb.YLength ** 2) / 2.0
obj.Height = max(bb.ZLength, 1)
if placement:
obj.Placement = placement
elif base:
bb = shapeBoundBox(base.Group)
origin = FreeCAD.Vector((bb.XMin + bb.XMax)/2, (bb.YMin + bb.YMax)/2, bb.ZMin)
obj.Placement = FreeCAD.Placement(origin, FreeCAD.Vector(), 0)
SetupStockObject(obj, StockType.CreateCylinder)
return obj
def TemplateAttributes(stock, includeExtent=True, includePlacement=True):
attrs = {}
if stock:
attrs['version'] = 1
stockType = StockType.FromStock(stock)
attrs['create'] = stockType
if includeExtent:
if stockType == StockType.FromBase:
attrs['xneg'] = ("%s" % stock.ExtXneg)
attrs['xpos'] = ("%s" % stock.ExtXpos)
attrs['yneg'] = ("%s" % stock.ExtYneg)
attrs['ypos'] = ("%s" % stock.ExtYpos)
attrs['zneg'] = ("%s" % stock.ExtZneg)
attrs['zpos'] = ("%s" % stock.ExtZpos)
if stockType == StockType.CreateBox:
attrs['length'] = ("%s" % stock.Length)
attrs['width'] = ("%s" % stock.Width)
attrs['height'] = ("%s" % stock.Height)
if stockType == StockType.CreateCylinder:
attrs['radius'] = ("%s" % stock.Radius)
attrs['height'] = ("%s" % stock.Height)
if includePlacement:
pos = stock.Placement.Base
attrs['posX'] = pos.x
attrs['posY'] = pos.y
attrs['posZ'] = pos.z
rot = stock.Placement.Rotation
attrs['rotX'] = rot.Q[0]
attrs['rotY'] = rot.Q[1]
attrs['rotZ'] = rot.Q[2]
attrs['rotW'] = rot.Q[3]
return attrs
def CreateFromTemplate(job, template):
if template.get('version') and 1 == int(template['version']):
stockType = template.get('create')
if stockType:
placement = None
posX = template.get('posX')
posY = template.get('posY')
posZ = template.get('posZ')
rotX = template.get('rotX')
rotY = template.get('rotY')
rotZ = template.get('rotZ')
rotW = template.get('rotW')
if posX is not None and posY is not None and posZ is not None and rotX is not None and rotY is not None and rotZ is not None and rotW is not None:
pos = FreeCAD.Vector(float(posX), float(posY), float(posZ))
rot = FreeCAD.Rotation(float(rotX), float(rotY), float(rotZ), float(rotW))
placement = FreeCAD.Placement(pos, rot)
elif posX is not None or posY is not None or posZ is not None or rotX is not None or rotY is not None or rotZ is not None or rotW is not None:
PathLog.warning(translate('PathStock', 'Corrupted or incomplete placement information in template - ignoring'))
if stockType == StockType.FromBase:
xneg = template.get('xneg')
xpos = template.get('xpos')
yneg = template.get('yneg')
ypos = template.get('ypos')
zneg = template.get('zneg')
zpos = template.get('zpos')
neg = None
pos = None
if xneg is not None and xpos is not None and yneg is not None and ypos is not None and zneg is not None and zpos is not None:
neg = FreeCAD.Vector(FreeCAD.Units.Quantity(xneg).Value, FreeCAD.Units.Quantity(yneg).Value, FreeCAD.Units.Quantity(zneg).Value)
pos = FreeCAD.Vector(FreeCAD.Units.Quantity(xpos).Value, FreeCAD.Units.Quantity(ypos).Value, FreeCAD.Units.Quantity(zpos).Value)
elif xneg is not None or xpos is not None or yneg is not None or ypos is not None or zneg is not None or zpos is not None:
PathLog.error(translate('PathStock', 'Corrupted or incomplete specification for creating stock from base - ignoring extent'))
return CreateFromBase(job, neg, pos, placement)
if stockType == StockType.CreateBox:
PathLog.track(' create box')
length = template.get('length')
width = template.get('width')
height = template.get('height')
extent = None
if length is not None and width is not None and height is not None:
PathLog.track(' have extent')
extent = FreeCAD.Vector(FreeCAD.Units.Quantity(length).Value, FreeCAD.Units.Quantity(width).Value, FreeCAD.Units.Quantity(height).Value)
elif length is not None or width is not None or height is not None:
PathLog.error(translate('PathStock', 'Corrupted or incomplete size for creating a stock box - ignoring size'))
else:
PathLog.track(" take placement (%s) and extent (%s) from model" % (placement, extent))
return CreateBox(job, extent, placement)
if stockType == StockType.CreateCylinder:
radius = template.get('radius')
height = template.get('height')
if radius is not None and height is not None:
pass
elif radius is not None or height is not None:
radius = None
height = None
PathLog.error(translate('PathStock', 'Corrupted or incomplete size for creating a stock cylinder - ignoring size'))
return CreateCylinder(job, radius, height, placement)
PathLog.error(translate('PathStock', 'Unsupported stock type named {}').format(stockType))
else:
PathLog.error(translate('PathStock', 'Unsupported PathStock template version {}').format(template.get('version')))
return None
FreeCAD.Console.PrintLog("Loading PathStock... done\n")