File size: 18,779 Bytes
985c397 | 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 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 | # SPDX-License-Identifier: LGPL-2.1-or-later
# ***************************************************************************
# * Copyright (c) 2015 Yorik van Havre <yorik@uncreated.net> *
# * *
# * 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 *
# * *
# ***************************************************************************
import FreeCAD
import FreeCADGui
import Path
import Path.Op.Base as PathOp
import PathScripts.PathUtils as PathUtils
import Path.Base.Util as PathUtil
from Path.Dressup.Utils import toolController
from PySide import QtCore
import random
from PySide.QtCore import QT_TRANSLATE_NOOP
__doc__ = """CAM Array object and FreeCAD command"""
translate = FreeCAD.Qt.translate
class ObjectArray:
def __init__(self, obj):
obj.addProperty(
"App::PropertyLinkList",
"Base",
"Path",
QT_TRANSLATE_NOOP("App::Property", "The toolpaths to array"),
)
obj.addProperty(
"App::PropertyEnumeration",
"Type",
"Path",
QT_TRANSLATE_NOOP("App::Property", "Pattern method"),
)
obj.addProperty(
"App::PropertyVectorDistance",
"Offset",
"Path",
QT_TRANSLATE_NOOP(
"App::Property",
"The spacing between the array copies in linear pattern",
),
)
obj.addProperty(
"App::PropertyInteger",
"CopiesX",
"Path",
QT_TRANSLATE_NOOP(
"App::Property", "The number of copies in X-direction in linear pattern"
),
)
obj.addProperty(
"App::PropertyInteger",
"CopiesY",
"Path",
QT_TRANSLATE_NOOP(
"App::Property", "The number of copies in Y-direction in linear pattern"
),
)
obj.addProperty(
"App::PropertyAngle",
"Angle",
"Path",
QT_TRANSLATE_NOOP("App::Property", "Total angle in polar pattern"),
)
obj.addProperty(
"App::PropertyInteger",
"Copies",
"Path",
QT_TRANSLATE_NOOP(
"App::Property", "The number of copies in linear 1D and polar pattern"
),
)
obj.addProperty(
"App::PropertyVector",
"Centre",
"Path",
QT_TRANSLATE_NOOP("App::Property", "The centre of rotation in polar pattern"),
)
obj.addProperty(
"App::PropertyBool",
"SwapDirection",
"Path",
QT_TRANSLATE_NOOP(
"App::Property",
"Make copies in X direction before Y in Linear 2D pattern",
),
)
obj.addProperty(
"App::PropertyInteger",
"JitterPercent",
"Path",
QT_TRANSLATE_NOOP("App::Property", "Percent of copies to randomly offset"),
)
obj.addProperty(
"App::PropertyVectorDistance",
"JitterMagnitude",
"Path",
QT_TRANSLATE_NOOP("App::Property", "Maximum random offset of copies"),
)
obj.addProperty(
"App::PropertyInteger",
"JitterSeed",
"Path",
QT_TRANSLATE_NOOP("App::Property", "Seed value for jitter randomness"),
)
obj.addProperty(
"App::PropertyLink",
"ToolController",
"Path",
QT_TRANSLATE_NOOP(
"App::Property",
"The tool controller that will be used to calculate the toolpath",
),
)
obj.addProperty(
"App::PropertyBool",
"Active",
"Path",
QT_TRANSLATE_NOOP("PathOp", "Make False, to prevent operation from generating code"),
)
obj.addProperty(
"App::PropertyString",
"CycleTime",
"Path",
QT_TRANSLATE_NOOP("App::Property", "Operations cycle time estimation"),
)
obj.setEditorMode("CycleTime", 1) # read-only
obj.Active = True
obj.Type = ["Linear1D", "Linear2D", "Polar"]
self.setEditorModes(obj)
obj.Proxy = self
def dumps(self):
return None
def loads(self, state):
return None
def setEditorModes(self, obj):
if obj.Type == "Linear1D":
angleMode = centreMode = copiesXMode = copiesYMode = swapDirectionMode = 2
copiesMode = offsetMode = 0
elif obj.Type == "Linear2D":
angleMode = copiesMode = centreMode = 2
copiesXMode = copiesYMode = offsetMode = swapDirectionMode = 0
elif obj.Type == "Polar":
angleMode = copiesMode = centreMode = 0
copiesXMode = copiesYMode = offsetMode = swapDirectionMode = 2
obj.setEditorMode("Angle", angleMode)
obj.setEditorMode("Copies", copiesMode)
obj.setEditorMode("Centre", centreMode)
obj.setEditorMode("CopiesX", copiesXMode)
obj.setEditorMode("CopiesY", copiesYMode)
obj.setEditorMode("Offset", offsetMode)
obj.setEditorMode("SwapDirection", swapDirectionMode)
obj.setEditorMode("JitterPercent", 0)
obj.setEditorMode("JitterMagnitude", 0)
obj.setEditorMode("JitterSeed", 0)
obj.setEditorMode("ToolController", 2)
def onChanged(self, obj, prop):
if prop == "Type":
self.setEditorModes(obj)
if prop == "Active" and obj.ViewObject:
obj.ViewObject.signalChangeIcon()
def onDocumentRestored(self, obj):
"""onDocumentRestored(obj) ... Called automatically when document is restored."""
if not hasattr(obj, "Active"):
obj.addProperty(
"App::PropertyBool",
"Active",
"Path",
QT_TRANSLATE_NOOP(
"PathOp", "Make False, to prevent operation from generating code"
),
)
obj.Active = True
if not hasattr(obj, "JitterSeed"):
obj.addProperty(
"App::PropertyInteger",
"JitterSeed",
"Path",
QtCore.QT_TRANSLATE_NOOP("App::Property", "Seed value for jitter randomness"),
)
obj.JitterSeed = 0
if not hasattr(obj, "CycleTime"):
obj.addProperty(
"App::PropertyString",
"CycleTime",
"Path",
QT_TRANSLATE_NOOP("App::Property", "Operations cycle time estimation"),
)
obj.CycleTime = self.getCycleTimeEstimate(obj)
self.setEditorModes(obj)
def execute(self, obj):
# backwards compatibility for PathArrays created before support for multiple bases
if isinstance(obj.Base, list):
base = obj.Base
else:
base = [obj.Base]
# Do not generate paths and clear current Path data
# if operation not Active or no base operations or operations not compatible
if not obj.Active or len(base) == 0 or not self.isBaseCompatible(obj):
obj.Path = Path.Path()
return
obj.ToolController = toolController(base[0])
# use seed if specified, otherwise default to object name for consistency during recomputes
seed = obj.JitterSeed or obj.Name
pa = PathArray(
obj.Base,
obj.Type,
obj.Copies,
obj.Offset,
obj.CopiesX,
obj.CopiesY,
obj.Angle,
obj.Centre,
obj.SwapDirection,
obj.JitterMagnitude,
obj.JitterPercent,
seed,
)
obj.Path = pa.getPath()
obj.CycleTime = PathOp.getCycleTimeEstimate(obj)
def isBaseCompatible(self, obj):
if not obj.Base:
return False
tcs = []
cms = []
for sel in obj.Base:
if not sel.isDerivedFrom("Path::Feature"):
return False
tcs.append(toolController(sel))
cms.append(PathUtil.coolantModeForOp(sel))
if tcs == {None} or len(set(tcs)) > 1:
Path.Log.warning(
translate(
"PathArray",
"Arrays of toolpaths having different tool controllers or tool controller not selected.",
)
)
return False
if set(cms) != {"None"}:
Path.Log.warning(
translate(
"PathArray",
"Arrays not compatible with coolant modes.",
)
)
return False
return True
class PathArray:
"""class PathArray ...
This class receives one or more base operations and repeats those operations
at set intervals based upon array type requested and the related settings for that type."""
def __init__(
self,
base,
arrayType,
copies,
offsetVector,
copiesX,
copiesY,
angle,
centre,
swapDirection,
jitterMagnitude,
jitterPercent,
seed,
):
self.base = base
self.arrayType = arrayType # ['Linear1D', 'Linear2D', 'Polar']
self.copies = copies
self.offsetVector = offsetVector
self.copiesX = copiesX
self.copiesY = copiesY
self.polarAngle = angle
self.polarCentre = centre
self.swapDirection = swapDirection
self.jitterMagnitude = jitterMagnitude
self.jitterPercent = jitterPercent
self.seed = seed
def getPath(self):
"""getPath() ... Call this method on an instance of the class to generate and return
path data for the requested path array."""
commands = []
random.seed(self.seed)
if self.arrayType == "Polar":
self.getPolarArray(commands)
elif self.arrayType == "Linear2D":
if self.swapDirection:
self.getLinear2DXYArray(commands)
else:
self.getLinear2DYXArray(commands)
else:
self.getLinear1DArray(commands)
return Path.Path(commands)
def calculateJitter(self, pos):
"""Returns the position argument with a random vector shift applied."""
if self.jitterPercent == 0:
pass
elif random.randint(0, 100) < self.jitterPercent:
pos.x = pos.x + random.uniform(-self.jitterMagnitude.x, self.jitterMagnitude.x)
pos.y = pos.y + random.uniform(-self.jitterMagnitude.y, self.jitterMagnitude.y)
pos.z = pos.z + random.uniform(-self.jitterMagnitude.z, self.jitterMagnitude.z)
return pos
def getLinear1DArray(self, commands):
"""Array type Linear1D"""
for i in range(self.copies):
pos = FreeCAD.Vector(
self.offsetVector.x * (i + 1),
self.offsetVector.y * (i + 1),
self.offsetVector.z * (i + 1),
)
pos = self.calculateJitter(pos)
for b in self.base:
pl = FreeCAD.Placement()
pl.move(pos)
path = PathUtils.getPathWithPlacement(b)
path = PathUtils.applyPlacementToPath(pl, path)
commands.extend(path.Commands)
def getLinear2DXYArray(self, commands):
"""Array type Linear2D with initial X direction"""
for i in range(self.copiesY + 1):
for j in range(self.copiesX + 1):
if (i % 2) == 0:
pos = FreeCAD.Vector(
self.offsetVector.x * j,
self.offsetVector.y * i,
self.offsetVector.z * i,
)
else:
pos = FreeCAD.Vector(
self.offsetVector.x * (self.copiesX - j),
self.offsetVector.y * i,
self.offsetVector.z * i,
)
pos = self.calculateJitter(pos)
for b in self.base:
pl = FreeCAD.Placement()
# index 0,0 will be processed by the base Paths themselves
if i != 0 or j != 0:
pl.move(pos)
path = PathUtils.getPathWithPlacement(b)
path = PathUtils.applyPlacementToPath(pl, path)
commands.extend(path.Commands)
def getLinear2DYXArray(self, commands):
"""Array type Linear2D with initial Y direction"""
for i in range(self.copiesX + 1):
for j in range(self.copiesY + 1):
if (i % 2) == 0:
pos = FreeCAD.Vector(
self.offsetVector.x * i,
self.offsetVector.y * j,
self.offsetVector.z * i,
)
else:
pos = FreeCAD.Vector(
self.offsetVector.x * i,
self.offsetVector.y * (self.copiesY - j),
self.offsetVector.z * i,
)
pos = self.calculateJitter(pos)
for b in self.base:
pl = FreeCAD.Placement()
# index 0,0 will be processed by the base Paths themselves
if i != 0 or j != 0:
pl.move(pos)
path = PathUtils.getPathWithPlacement(b)
path = PathUtils.applyPlacementToPath(pl, path)
commands.extend(path.Commands)
def getPolarArray(self, commands):
"""Array type Polar"""
for i in range(self.copies):
ang = 360
if self.copies > 0:
ang = self.polarAngle / self.copies * (1 + i)
# prepare placement for polar pattern
pl = FreeCAD.Placement()
pl.rotate(self.polarCentre, FreeCAD.Vector(0, 0, 1), ang)
for b in self.base:
path = PathUtils.getPathWithPlacement(b)
path = PathUtils.applyPlacementToPath(pl, path)
commands.extend(path.Commands)
class ViewProviderArray:
def __init__(self, vobj):
self.attach(vobj)
vobj.Proxy = self
def attach(self, vobj):
self.vobj = vobj
self.obj = vobj.Object
def dumps(self):
return None
def loads(self, state):
return None
def onChanged(self, vobj, prop):
return None
def claimChildren(self):
return []
def onDelete(self, vobj, args):
return None
def getIcon(self):
if self.obj.Active:
return ":/icons/CAM_Array.svg"
else:
return ":/icons/CAM_OpActive.svg"
class CommandPathArray:
def GetResources(self):
return {
"Pixmap": "CAM_Array",
"MenuText": QT_TRANSLATE_NOOP("CAM_Array", "Array"),
"ToolTip": QT_TRANSLATE_NOOP("CAM_Array", "Creates an array from selected toolpaths"),
}
def IsActive(self):
selection = FreeCADGui.Selection.getSelection()
if not selection:
return False
tcs = []
for sel in selection:
if not sel.isDerivedFrom("Path::Feature"):
return False
tc = toolController(sel)
if tc:
# Active only for operations with identical tool controller
tcs.append(tc)
if len(set(tcs)) != 1:
return False
else:
return False
if PathUtil.coolantModeForOp(sel) != "None":
# Active only for operations without cooling
return False
return True
def Activated(self):
# check that the selection contains exactly what we want
selection = FreeCADGui.Selection.getSelection()
for sel in selection:
if not (sel.isDerivedFrom("Path::Feature")):
FreeCAD.Console.PrintError(
translate("CAM_Array", "Arrays can be created only from toolpath operations.")
+ "\n"
)
return
# if everything is ok, execute and register the transaction in the
# undo/redo stack
FreeCAD.ActiveDocument.openTransaction("Create Array")
FreeCADGui.addModule("Path.Op.Gui.Array")
FreeCADGui.addModule("PathScripts.PathUtils")
FreeCADGui.doCommand(
'obj = FreeCAD.ActiveDocument.addObject("Path::FeaturePython","Array")'
)
FreeCADGui.doCommand("Path.Op.Gui.Array.ObjectArray(obj)")
baseString = "[%s]" % ",".join(
["FreeCAD.ActiveDocument.%s" % sel.Name for sel in selection]
)
FreeCADGui.doCommand("obj.Base = %s" % baseString)
FreeCADGui.doCommand(
"obj.ViewObject.Proxy = Path.Op.Gui.Array.ViewProviderArray(obj.ViewObject)"
)
FreeCADGui.doCommand("PathScripts.PathUtils.addToJob(obj)")
FreeCAD.ActiveDocument.commitTransaction()
FreeCAD.ActiveDocument.recompute()
if FreeCAD.GuiUp:
# register the FreeCAD command
FreeCADGui.addCommand("CAM_Array", CommandPathArray())
|