File size: 7,823 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 | # SPDX-License-Identifier: LGPL-2.1-or-later
# ***************************************************************************
# * Copyright (c) 2020 Eliud Cabrera Castillo <e.cabrera-castillo@tum.de> *
# * *
# * This file is part of the FreeCAD CAx development system. *
# * *
# * 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 *
# * *
# ***************************************************************************
"""Provides the object code for the PathTwistedArray object.
The copies will be placed along a path like a polyline, spline, or bezier
curve, and the copies are twisted around the path by a given rotation
parameter.
This array was developed in order to build a `twisted bridge` object.
See https://forum.freecad.org/viewtopic.php?f=23&t=49617
A `twisted bridge` would consist of three parts:
1. The ribcage composed of a twisted array generated from a frame
and a path.
2. The `tunnel` object produced by lofting or sweeping the internal twisted
profiles of the ribcage along the path.
3. The `walkway` object on which the person can stand; it is generated
from the path, and the internal width of the ribcage profile.
This module builds only the first element, the twisted ribcage.
The tunnel and walkway are built with the `twisted bridge`
object in the Arch Workbench.
"""
## @package pathtwistedarray
# \ingroup draftobjects
# \brief Provides the object code for the TwistedArray object.
import draftgeoutils.geo_arrays as geo
from draftutils.messages import _log
def QT_TRANSLATE_NOOP(ctx, txt):
return txt
from draftobjects.draftlink import DraftLink
## \addtogroup draftobjects
# @{
class PathTwistedArray(DraftLink):
"""The PathTwistedArray object.
This array distributes copies of an object along a path like a polyline,
spline, or bezier curve, and the copies are twisted around the path
by a given rotation parameter.
"""
def __init__(self, obj):
super().__init__(obj, "PathTwistedArray")
def attach(self, obj):
"""Set up the properties when the object is attached."""
self.set_properties(obj)
super().attach(obj)
def set_properties(self, obj):
"""Set properties only if they don't exist."""
if hasattr(obj, "PropertiesList"):
properties = obj.PropertiesList
else:
properties = []
if "Base" not in properties:
obj.addProperty(
"App::PropertyLink",
"Base",
"Objects",
QT_TRANSLATE_NOOP("App::Property", "The base object that will be duplicated."),
locked=True,
)
obj.Base = None
if "PathObject" not in properties:
obj.addProperty(
"App::PropertyLink",
"PathObject",
"Objects",
QT_TRANSLATE_NOOP(
"App::Property",
"The object along which the copies will be distributed. It must contain 'Edges'.",
),
locked=True,
)
obj.PathObject = None
if "Fuse" not in properties:
_tip = QT_TRANSLATE_NOOP(
"App::Property",
"Specifies if the copies "
"should be fused together "
"if they touch each other (slower)",
)
obj.addProperty("App::PropertyBool", "Fuse", "Objects", _tip, locked=True)
obj.Fuse = False
if "Count" not in properties:
obj.addProperty(
"App::PropertyInteger",
"Count",
"Objects",
QT_TRANSLATE_NOOP("App::Property", "Number of copies to create."),
locked=True,
)
obj.Count = 15
if "RotationFactor" not in properties:
obj.addProperty(
"App::PropertyFloat",
"RotationFactor",
"Objects",
QT_TRANSLATE_NOOP("App::Property", "Rotation factor of the twisted array."),
locked=True,
)
obj.RotationFactor = 0.25
if self.use_link and "ExpandArray" not in properties:
obj.addProperty(
"App::PropertyBool",
"ExpandArray",
"Objects",
QT_TRANSLATE_NOOP(
"App::Property", "Show the individual array elements (only for Link arrays)"
),
locked=True,
)
obj.ExpandArray = False
obj.setPropertyStatus("Shape", "Transient")
if not self.use_link:
if "PlacementList" not in properties:
_tip = QT_TRANSLATE_NOOP("App::Property", "The placement for each array element")
obj.addProperty(
"App::PropertyPlacementList", "PlacementList", "Objects", _tip, locked=True
)
obj.PlacementList = []
def linkSetup(self, obj):
"""Set up the object as a link object."""
super().linkSetup(obj)
obj.configLinkProperty(ElementCount="Count")
def onDocumentRestored(self, obj):
super().onDocumentRestored(obj)
# Fuse property was added in v1.0 and PlacementList property was added
# for non-link arrays in v1.1, obj should be OK if both are present:
if hasattr(obj, "Fuse") and hasattr(obj, "PlacementList"):
return
if not hasattr(obj, "Fuse"):
_log("v1.0, " + obj.Name + ", added 'Fuse' property")
if not hasattr(obj, "PlacementList"):
_log("v1.1, " + obj.Name + ", added hidden property 'PlacementList'")
self.set_properties(obj)
self.execute(obj) # Required to update PlacementList.
def execute(self, obj):
"""Execute when the object is created or recomputed."""
if self.props_changed_placement_only(obj) or not obj.Base or not obj.PathObject:
self.props_changed_clear()
return
# placement of entire PathArray object
array_placement = obj.Placement
path = obj.PathObject
count = obj.Count
rot_factor = obj.RotationFactor
copy_placements, _ = geo.get_twisted_placements(path, count=count, rot_factor=rot_factor)
self.buildShape(obj, array_placement, copy_placements)
self.props_changed_clear()
return not self.use_link
## @}
|