Draft PathArray/en: Difference between revisions
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
(18 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{Docnav|[[Draft_LinkArray|Link Array]]|[[Draft_PathLinkArray|Path LinkArray]]|[[Draft_Module|Draft]]|IconL=Draft_LinkArray.svg|IconC=Workbench_Draft.svg|IconR=Draft_PathLinkArray.svg}} |
|||
{{Docnav |
|||
|[[Draft_CircularArray|CircularArray]] |
|||
|[[Draft_PathLinkArray|PathLinkArray]] |
|||
|[[Draft_Workbench|Draft]] |
|||
|IconL=Draft_CircularArray.svg |
|||
|IconR=Draft_PathLinkArray.svg |
|||
|IconC=Workbench_Draft.svg |
|||
}} |
|||
{{GuiCommand |
{{GuiCommand |
||
|Name=Draft PathArray |
|Name=Draft PathArray |
||
|MenuLocation= |
|MenuLocation=Modification → Array tools → Path array |
||
|Workbenches=[[ |
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]] |
||
|SeeAlso=[[Draft PathLinkArray|Draft PathLinkArray]], [[Draft Array|Draft Array]], [[Draft LinkArray|Draft LinkArray]], [[Draft PointArray|Draft PointArray]] |
|||
|Version=0.14 |
|Version=0.14 |
||
|SeeAlso=[[Draft_OrthoArray|Draft OrthoArray]], [[Draft_PolarArray|Draft PolarArray]], [[Draft_CircularArray|Draft CircularArray]], [[Draft_PathLinkArray|Draft PathLinkArray]], [[Draft_PointArray|Draft PointArray]], [[Draft_PointLinkArray|Draft PointLinkArray]] |
|||
}} |
}} |
||
==Description== |
==Description== |
||
The [[Image:Draft_PathArray.svg|24px]] '''Draft PathArray''' command creates a regular array from a selected object by placing copies along a path. Use the [[Draft_PathLinkArray|Draft PathLinkArray]] command to create a more efficient [[App_Link|Link]] array instead. Except for the type of array that is created, Link array or regular array, the [[Draft_PathLinkArray|Draft PathLinkArray]] command is identical to this command. |
|||
The PathArray tool places copies of a selected shape along a selected path, which can be a [[Draft Wire|Draft Wire]], a [[Draft BSpline|Draft BSpline]], and similar edges. |
|||
Both commands can be used on 2D objects created with the [[Draft_Workbench|Draft Workbench]] or [[Sketcher_Workbench|Sketcher Workbench]], but also on many 3D objects such as those created with the [[Part_Workbench|Part Workbench]], [[PartDesign_Workbench|PartDesign Workbench]] or [[Arch_Workbench|Arch Workbench]]. |
|||
To position copies in an orthogonal array use [[Draft Array|Draft Array]]; to position copies at specified points use [[Draft PointArray|Draft PointArray]]; to create copies or clones, and manually place them use [[Draft Move|Draft Move]], [[Draft Rotate|Draft Rotate]], and [[Draft Clone|Draft Clone]]. |
|||
[[Image:Draft_PathArray_Example.png|400px]] |
[[Image:Draft_PathArray_Example.png|400px]] |
||
{{Caption| |
{{Caption|Draft PathArray}} |
||
== |
==Usage== |
||
# Select |
# Select the object you wish to array. |
||
# |
# Add the path object to the selection. It is also possible to select edges instead. The edges must belong to the same object and they must be connected. |
||
# There are several ways to invoke the command: |
|||
# Press the {{Button|[[Image:Draft_PathArray.svg|16px]] [[Draft PathArray|Draft PathArray]]}} button. |
|||
#* Press the {{Button|[[Image:Draft_PathArray.svg|16px]] [[Draft_PathArray|Draft PathArray]]}} button. |
|||
# The Array object is immediately created. You must change the properties of the array to change the number and direction of copies created. |
|||
#* Select the {{MenuCommand|Modification → Array tools → [[Image:Draft_PathArray.svg|16px]] Path array}} option from the menu. |
|||
# The array is created. |
|||
# Optionally change the [[#Properties|properties]] of the array in the [[property_editor|Property editor]]. |
|||
==Alignment== |
|||
Each element in the array is an exact clone of the original object, but the entire array is considered a single unit in terms of properties and appearance. |
|||
The alignment of the elements in a Draft PathArray depends on the properties of the array and the orientation of the source object. The position of the source object is ignored: for the purpose of the array the {{Value|x}}, {{Value|y}} and {{Value|z}} are set to {{Value|0}}. If the {{PropertyData|Align}} property of the array is set to {{FALSE}} the orientation of the array elements is identical to that of the source object. If it is set to {{TRUE}} the X axis of the local coordinate system of each element placement is tangent to the path. The Y and Z axes of the local coordinate systems depend on the {{PropertyData|Align Mode}} property of the array. Other array properties involved in the alignment include {{PropertyData|Tangent Vector}}, {{PropertyData|Force Vertical}} and {{PropertyData|Vertical Vector}}. |
|||
The base object should be centred around the origin, even if the path starts somewhere else. |
|||
[[Image:Draft_PathArray_example2.png|600px]] |
|||
==Options== |
|||
{{Caption|3 arrays based on the same non-planar path. From left to right: Align is false, Align is true with Align Mode Original and Align is true with Align Mode Frenet}}. |
|||
===Align Mode=== |
|||
There are no options for this tool. Either it works with the selected objects or not. |
|||
Three modes are available: |
|||
====Original==== |
|||
This mode comes closest to the single {{PropertyData|Align Mode}} available in version 0.18. It relies on a fixed normal vector. If the path is planar this vector is perpendicular to the plane of the path, else a default vector, the positive Z axis, is used. From this normal vector and the local tangent vector (the local X axis) a [https://en.wikipedia.org/wiki/Cross_product cross product] is calculated. This new vector is used as the local Z axis. The orientation of the local Y axis is determined from the local X and Z axes. |
|||
====Frenet==== |
|||
This mode uses the local normal vector derived from the path at each element placement. If this vector cannot be determined (for example in the case of a straight segment) a default vector, again the positive Z axis, is used instead. With this vector and the local tangent vector the local coordinate system is determined using the same procedure as in the previous paragraph. |
|||
====Tangent==== |
|||
This mode is similar to {{PropertyData|Align Mode}} {{Value|Original}} but includes the possibility to pre-rotate the source object by specifying a {{PropertyData|Tangent Vector}}. |
|||
===Force Vertical and Vertical Vector=== |
|||
These properties are only available if {{PropertyData|Align Mode}} is {{Value|Original}} or {{Value|Tangent}}. If {{PropertyData|Force Vertical}} is set to {{TRUE}} the local coordinate system is calculated in a different manner. The {{PropertyData|Vertical Vector}} is used as a fixed normal vector. From this normal vector and the local tangent vector (the local X axis) again a cross product is calculated. But now this vector is used as the local Y axis. The orientation of the local Z axis is determined from the local X and Y axes. |
|||
Using these properties can be required if one of the edged of the path is (almost) parallel to the default normal of the path. |
|||
==Properties== |
==Properties== |
||
See also: [[property_editor|Property editor]]. |
|||
* {{PropertyData|Base}}: specifies the object to duplicate in the path. |
|||
* {{PropertyData|PathObj}}: specifies the path object. |
|||
* {{PropertyData|PathSubs}}: specifies the sub-elements (edges) of the path object. This property does not yet appear in the [[property editor|property editor]]. |
|||
* {{PropertyData|Count}}: specifies the number of copies of the base object. |
|||
* {{PropertyData|Align}}: if it is {{TRUE}} the copies are aligned to the path; otherwise they are left in their default orientation. |
|||
:{{Emphasis|Note:}} in certain cases the shape will appear flat, in reality it may have moved in the 3D space, so instead of using a flat view, change the view to axonometric. |
|||
* {{PropertyData|Xlate}}: specifies a translation vector (x, y, z) to displace each copy along the path. |
|||
:{{Emphasis|Note:}} when {{PropertyData|Align}} is {{TRUE}}, the vector is relative to the local tangent, normal or binormal coordinates; otherwise the vector is relative to the global coordinates. |
|||
A Draft PathArray object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties (with the exception of some View properties that are not inherited by Link arrays). The following properties are additional unless otherwise stated: |
|||
==Scripting== |
|||
{{Emphasis|See also:}} [[Draft API|Draft API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]]. |
|||
===Data=== |
|||
The PathArray tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function: |
|||
{{Code|code= |
|||
PathArray = makePathArray(baseobject, pathobject, count, xlate=None, align=False, pathobjsubs=[]) |
|||
}} |
|||
{{TitleProperty|Link}} |
|||
* Creates a {{incode|PathArray}} object from the {{incode|baseobject}}, by placing as many as {{incode|count}} copies along {{incode|pathobject}}. |
|||
** If {{incode|pathobjsubs}} is given, it is a list of sub-objects of {{incode|pathobject}}, and the copies are created along this shorter path. |
|||
* If {{incode|xlate}} is given, it is a {{incode|FreeCAD.Vector}} that indicates an additional displacement to move the base point of the copies. |
|||
* If {{incode|align}} is {{incode|True}} the copies are aligned to the tangent, normal or binormal of the {{incode|pathobject}} at the point where the copy is placed. |
|||
The properties in this group are only available for Link arrays. See [[Std_LinkMake#Properties|Std LinkMake]] for more information. |
|||
Example: |
|||
{{Code|code= |
|||
import FreeCAD,Draft |
|||
* {{PropertyData|Scale|Float}} |
|||
p1 = FreeCAD.Vector(500, -1000, 0) |
|||
* {{PropertyData|Scale Vector|Vector|Hidden}} |
|||
p2 = FreeCAD.Vector(1500, 1000, 0) |
|||
* {{PropertyData|Scale List|VectorList}} |
|||
p3 = FreeCAD.Vector(3000, 500, 0) |
|||
* {{PropertyData|Visibility List|BoolList|Hidden}} |
|||
p4 = FreeCAD.Vector(4500, 100, 0) |
|||
* {{PropertyData|Placement List|PlacementList|Hidden}} |
|||
spline = Draft.makeBSpline([p1, p2, p3, p4]) |
|||
* {{PropertyData|Element List|LinkList|Hidden}} |
|||
object = Draft.makePolygon(3, 500) |
|||
* {{PropertyData|_ Link Touched|Bool|Hidden}} |
|||
* {{PropertyData|_ Child Cache|LinkList|Hidden}} |
|||
* {{PropertyData|Colored Elements|LinkSubHidden|Hidden}} |
|||
* {{PropertyData|Link Transform|Bool}} |
|||
{{TitleProperty|Alignment}} |
|||
PathArray = Draft.makePathArray(object, spline, 6) |
|||
}} |
|||
* {{PropertyData|Align|Bool}}: specifies if the elements in the array are aligned along the path or not. If it is {{FALSE}} all other properties in this group, except {{PropertyData|Extra Translation}}, do not apply and are hidden. |
|||
==Technical explanation for the Align property== |
|||
* {{PropertyData|Align Mode|Enumeration}}: specifies the align mode, which can be {{Value|Original}}, {{Value|Frenet}} or {{Value|Tangent}}. |
|||
When {{PropertyData|Align}} is {{FALSE}}, the placement of the copied shapes is easy to understand; they are just moved to a different position in their original orientation. |
|||
* {{PropertyData|Extra Translation|VectorDistance}}: specifies an additional displacement for each element along the path. |
|||
[[Image:patharray_NoAlign.png|600px|left|Align false]] |
|||
* {{PropertyData|Force Vertical|Bool}}: specifies whether to override the default normal direction with the value of {{PropertyData|Vertical Vector}}. Only used if {{PropertyData|Align Mode}} is {{Value|Original}} or {{Value|Tangent}}. |
|||
{{clear}} |
|||
* {{PropertyData|Tangent Vector|Vector}}: specifies the alignment vector. Only used if {{PropertyData|Align Mode}} is {{Value|Tangent}}. |
|||
{{Caption|Object arranged along a closed path in the original orientation}} |
|||
* {{PropertyData|Vertical Vector|Vector}}: specifies the override for the default normal direction. Only used if {{PropertyData|Vertical Vector}} is {{TRUE}}. |
|||
{{TitleProperty|Objects}} |
|||
When {{PropertyData|Align}} is {{TRUE}}, the positioning of the shapes becomes a bit more complex: |
|||
# First, Frenet coordinate systems are built on the path: X is tangent, Z is normal, Y is binormal. |
|||
# Then the original object is copied to every on-path coordinate system, so that the global origin is matched with the on-path coordinate system origin. |
|||
[[Image:patharray alignment annotated.png|600px|left]] |
|||
{{clear}} |
|||
{{Caption|Object arranged along a closed path; description of components and path}} |
|||
* {{PropertyData|Base|LinkGlobal}}: specifies the object to duplicate in the array. |
|||
The following images show how the array is produced, depending on which plane the path is. |
|||
* {{PropertyData|Count|Integer}}: specifies the number of elements in the array. |
|||
* {{PropertyData|Expand Array|Bool}}: specifies whether to expand the array in the [[Tree_view|Tree view]] to enable the selection of its individual elements. Only available for Link arrays. |
|||
* {{PropertyData|Path Object|LinkGlobal}}: specifies the object to be used for the path. It must contain {{Value|Edges}} in its [[Part_TopoShape|Part TopoShape]]. |
|||
* {{PropertyData|Path Subelements|LinkSubListGlobal}}: specifies a list of edges of the {{PropertyData|Path Object}}. If supplied only these edges are used for the path. |
|||
===View=== |
|||
Path on XY Plane: |
|||
[[Image:patharray_alignment.png|600px|left]] |
|||
{{clear}} |
|||
{{Caption|Object arranged along a closed path which is aligned to the XY plane}} |
|||
{{TitleProperty|Link}} |
|||
Path on XZ Plane: |
|||
[[Image:patharray_alignment-XZ.png|600px|left]] |
|||
{{clear}} |
|||
{{Caption|Object arranged along a closed path which is aligned to the XZ plane}} |
|||
The properties in this group, with the exception of the inherited property, are only available for Link arrays. See [[Std_LinkMake#Properties|Std LinkMake]] for more information. |
|||
Path on YZ Plane: |
|||
[[Image:patharray_alignment-YZ.png|600px|left]] |
|||
{{clear}} |
|||
{{Caption|Object arranged along a closed path which is aligned to the YZ plane}} |
|||
* {{PropertyView|Draw Style|Enumeration}} |
|||
As you reorient the path but not the object, the result is consistent: the object remains aligned to the path the way it was before reorienting the path. |
|||
* {{PropertyView|Line Width|FloatConstraint}} |
|||
* {{PropertyView|Override Material|Bool}} |
|||
* {{PropertyView|Point Size|FloatConstraint}} |
|||
* {{PropertyView|Selectable|Bool}}: this is an inherited property that appears in the Selection group for other arrays |
|||
* {{PropertyView|Shape Material|Material}} |
|||
{{TitleProperty|Base}} |
|||
{{Emphasis|Editor:}} thank you to user DeepSOIC for this explanation. |
|||
The properties in this group, with the exception of the inherited property, are only available for Link arrays. See [[Std_LinkMake#Properties|Std LinkMake]] for more information. |
|||
{{Docnav|[[Draft_LinkArray|Link Array]]|[[Draft_PathLinkArray|Path LinkArray]]|[[Draft_Module|Draft]]|IconL=Draft_LinkArray.svg|IconC=Workbench_Draft.svg|IconR=Draft_PathLinkArray.svg}} |
|||
* {{PropertyView|Child View Provider|PersistentObject|Hidden}} |
|||
{{Draft Tools navi}} |
|||
* {{PropertyView|Material List|MaterialList|Hidden}} |
|||
* {{PropertyView|Override Color List|ColorList|Hidden}} |
|||
* {{PropertyView|Override Material List|BoolList|Hidden}} |
|||
* {{PropertyView|Proxy|PythonObject|Hidden}}: this is an inherited property. |
|||
{{TitleProperty|Display Options}} |
|||
The properties in this group are inherited properties. See [[Part_Feature#Properties|Part Feature]] for more information. |
|||
* {{PropertyView|Bounding Box|Bool}}: this property is not inherited by Link arrays. |
|||
* {{PropertyView|Display Mode|Enumeration}}: for Link arrays it can be {{value|Link}} or {{value|ChildView}}. For other arrays it can be: {{value|Flat Lines}}, {{value|Shaded}}, {{value|Wireframe}} or {{value|Points}} |
|||
* {{PropertyView|Show In Tree|Bool}} |
|||
* {{PropertyView|Visibility|Bool}} |
|||
{{TitleProperty|Draft}} |
|||
* {{PropertyView|Pattern|Enumeration}}: not used. |
|||
* {{PropertyView|Pattern Size|Float}}: not used. |
|||
{{TitleProperty|Object style}} |
|||
The properties in this group are not inherited by Link arrays. |
|||
==Scripting== |
|||
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]]. |
|||
To create a path array use the {{incode|make_path_array}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makePathArray}} method. |
|||
{{Code|code= |
|||
path_array = make_path_array(base_object, path_object, |
|||
count=4, extra=App.Vector(0, 0, 0), subelements=None, |
|||
align=False, align_mode="Original", tan_vector=App.Vector(1, 0, 0), |
|||
force_vertical=False, vertical_vector=App.Vector(0, 0, 1), |
|||
use_link=True) |
|||
}} |
|||
* {{incode|base_object}} is the object to be arrayed. It can also be the {{incode|Label}} (string) of an object in the current document. |
|||
* {{incode|path_object}} is the path object. It can also be the {{incode|Label}} (string) of an object in the current document. |
|||
* {{incode|count}} is the number of elements in the array. |
|||
* {{incode|extra}} is a vector that displaces each element. |
|||
* {{incode|subelements}} is a list of edges of {{incode|path_object}}, for example {{incode|["Edge1", "Edge2"]}}. If supplied only these edges are used for the path. |
|||
* If {{incode|align}} is {{incode|True}} the elements are aligned along the path depending on the value of {{incode|align_mode}}, which can be {{incode|"Original"}}, {{incode|"Frenet"}} or {{incode|"Tangent"}}. |
|||
* {{incode|tan_vector}} is a unit vector that defines the local tangent direction of the elements along the path. It is used when {{incode|align_mode}} is {{incode|"Tangent"}}. |
|||
* If {{incode|force_vertical}} is {{incode|True}} {{incode|vertical_vector}} is used for the local Z direction of the elements along the path. It is used when {{incode|align_mode}} is {{incode|"Original"}} or {{incode|"Tangent"}}. |
|||
* If {{incode|use_link}} is {{incode|True}} the created elements are [[App_Link|App Links]] instead of regular copies. |
|||
* {{incode|path_array}} is returned with the created array object. |
|||
Example: |
|||
{{Code|code= |
|||
import FreeCAD as App |
|||
import Draft |
|||
doc = App.newDocument() |
|||
p1 = App.Vector(500, -1000, 0) |
|||
p2 = App.Vector(1500, 1000, 0) |
|||
p3 = App.Vector(3000, 500, 0) |
|||
p4 = App.Vector(4500, 100, 0) |
|||
spline = Draft.make_bspline([p1, p2, p3, p4]) |
|||
obj = Draft.make_polygon(3, 500) |
|||
path_array = Draft.make_path_array(obj, spline, 6) |
|||
doc.recompute() |
|||
wire = Draft.make_wire([p1, -p2, -p3, -p4]) |
|||
path_array2 = Draft.make_path_array(obj, wire, count=3, extra=App.Vector(0, -500, 0), subelements=["Edge2", "Edge3"], align=True, force_vertical=True) |
|||
doc.recompute() |
|||
}} |
|||
{{Docnav |
|||
|[[Draft_CircularArray|CircularArray]] |
|||
|[[Draft_PathLinkArray|PathLinkArray]] |
|||
|[[Draft_Workbench|Draft]] |
|||
|IconL=Draft_CircularArray.svg |
|||
|IconR=Draft_PathLinkArray.svg |
|||
|IconC=Workbench_Draft.svg |
|||
}} |
|||
{{Draft Tools navi{{#translation:}}}} |
|||
{{Userdocnavi}} |
|||
{{Userdocnavi{{#translation:}}}} |
|||
{{clear}} |
Revision as of 12:42, 9 August 2022
Draft PathArray |
Menu location |
---|
Modification → Array tools → Path array |
Workbenches |
Draft, Arch |
Default shortcut |
None |
Introduced in version |
0.14 |
See also |
Draft OrthoArray, Draft PolarArray, Draft CircularArray, Draft PathLinkArray, Draft PointArray, Draft PointLinkArray |
Description
The Draft PathArray command creates a regular array from a selected object by placing copies along a path. Use the Draft PathLinkArray command to create a more efficient Link array instead. Except for the type of array that is created, Link array or regular array, the Draft PathLinkArray command is identical to this command.
Both commands can be used on 2D objects created with the Draft Workbench or Sketcher Workbench, but also on many 3D objects such as those created with the Part Workbench, PartDesign Workbench or Arch Workbench.
Draft PathArray
Usage
- Select the object you wish to array.
- Add the path object to the selection. It is also possible to select edges instead. The edges must belong to the same object and they must be connected.
- There are several ways to invoke the command:
- Press the Draft PathArray button.
- Select the Modification → Array tools → Path array option from the menu.
- The array is created.
- Optionally change the properties of the array in the Property editor.
Alignment
The alignment of the elements in a Draft PathArray depends on the properties of the array and the orientation of the source object. The position of the source object is ignored: for the purpose of the array the x
, y
and z
are set to 0
. If the DataAlign property of the array is set to false
the orientation of the array elements is identical to that of the source object. If it is set to true
the X axis of the local coordinate system of each element placement is tangent to the path. The Y and Z axes of the local coordinate systems depend on the DataAlign Mode property of the array. Other array properties involved in the alignment include DataTangent Vector, DataForce Vertical and DataVertical Vector.
3 arrays based on the same non-planar path. From left to right: Align is false, Align is true with Align Mode Original and Align is true with Align Mode Frenet
.
Align Mode
Three modes are available:
Original
This mode comes closest to the single DataAlign Mode available in version 0.18. It relies on a fixed normal vector. If the path is planar this vector is perpendicular to the plane of the path, else a default vector, the positive Z axis, is used. From this normal vector and the local tangent vector (the local X axis) a cross product is calculated. This new vector is used as the local Z axis. The orientation of the local Y axis is determined from the local X and Z axes.
Frenet
This mode uses the local normal vector derived from the path at each element placement. If this vector cannot be determined (for example in the case of a straight segment) a default vector, again the positive Z axis, is used instead. With this vector and the local tangent vector the local coordinate system is determined using the same procedure as in the previous paragraph.
Tangent
This mode is similar to DataAlign Mode Original
but includes the possibility to pre-rotate the source object by specifying a DataTangent Vector.
Force Vertical and Vertical Vector
These properties are only available if DataAlign Mode is Original
or Tangent
. If DataForce Vertical is set to true
the local coordinate system is calculated in a different manner. The DataVertical Vector is used as a fixed normal vector. From this normal vector and the local tangent vector (the local X axis) again a cross product is calculated. But now this vector is used as the local Y axis. The orientation of the local Z axis is determined from the local X and Y axes.
Using these properties can be required if one of the edged of the path is (almost) parallel to the default normal of the path.
Properties
See also: Property editor.
A Draft PathArray object is derived from a Part Feature object and inherits all its properties (with the exception of some View properties that are not inherited by Link arrays). The following properties are additional unless otherwise stated:
Data
Link
The properties in this group are only available for Link arrays. See Std LinkMake for more information.
- DataScale (
Float
) - Data (Hidden)Scale Vector (
Vector
) - DataScale List (
VectorList
) - Data (Hidden)Visibility List (
BoolList
) - Data (Hidden)Placement List (
PlacementList
) - Data (Hidden)Element List (
LinkList
) - Data (Hidden)_ Link Touched (
Bool
) - Data (Hidden)_ Child Cache (
LinkList
) - Data (Hidden)Colored Elements (
LinkSubHidden
) - DataLink Transform (
Bool
)
Alignment
- DataAlign (
Bool
): specifies if the elements in the array are aligned along the path or not. If it isfalse
all other properties in this group, except DataExtra Translation, do not apply and are hidden. - DataAlign Mode (
Enumeration
): specifies the align mode, which can beOriginal
,Frenet
orTangent
. - DataExtra Translation (
VectorDistance
): specifies an additional displacement for each element along the path. - DataForce Vertical (
Bool
): specifies whether to override the default normal direction with the value of DataVertical Vector. Only used if DataAlign Mode isOriginal
orTangent
. - DataTangent Vector (
Vector
): specifies the alignment vector. Only used if DataAlign Mode isTangent
. - DataVertical Vector (
Vector
): specifies the override for the default normal direction. Only used if DataVertical Vector istrue
.
Objects
- DataBase (
LinkGlobal
): specifies the object to duplicate in the array. - DataCount (
Integer
): specifies the number of elements in the array. - DataExpand Array (
Bool
): specifies whether to expand the array in the Tree view to enable the selection of its individual elements. Only available for Link arrays. - DataPath Object (
LinkGlobal
): specifies the object to be used for the path. It must containEdges
in its Part TopoShape. - DataPath Subelements (
LinkSubListGlobal
): specifies a list of edges of the DataPath Object. If supplied only these edges are used for the path.
View
Link
The properties in this group, with the exception of the inherited property, are only available for Link arrays. See Std LinkMake for more information.
- ViewDraw Style (
Enumeration
) - ViewLine Width (
FloatConstraint
) - ViewOverride Material (
Bool
) - ViewPoint Size (
FloatConstraint
) - ViewSelectable (
Bool
): this is an inherited property that appears in the Selection group for other arrays - ViewShape Material (
Material
)
Base
The properties in this group, with the exception of the inherited property, are only available for Link arrays. See Std LinkMake for more information.
- View (Hidden)Child View Provider (
PersistentObject
) - View (Hidden)Material List (
MaterialList
) - View (Hidden)Override Color List (
ColorList
) - View (Hidden)Override Material List (
BoolList
) - View (Hidden)Proxy (
PythonObject
): this is an inherited property.
Display Options
The properties in this group are inherited properties. See Part Feature for more information.
- ViewBounding Box (
Bool
): this property is not inherited by Link arrays. - ViewDisplay Mode (
Enumeration
): for Link arrays it can beLink
orChildView
. For other arrays it can be:Flat Lines
,Shaded
,Wireframe
orPoints
- ViewShow In Tree (
Bool
) - ViewVisibility (
Bool
)
Draft
- ViewPattern (
Enumeration
): not used. - ViewPattern Size (
Float
): not used.
Object style
The properties in this group are not inherited by Link arrays.
Scripting
See also: Autogenerated API documentation and FreeCAD Scripting Basics.
To create a path array use the make_path_array
method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makePathArray
method.
path_array = make_path_array(base_object, path_object,
count=4, extra=App.Vector(0, 0, 0), subelements=None,
align=False, align_mode="Original", tan_vector=App.Vector(1, 0, 0),
force_vertical=False, vertical_vector=App.Vector(0, 0, 1),
use_link=True)
base_object
is the object to be arrayed. It can also be theLabel
(string) of an object in the current document.path_object
is the path object. It can also be theLabel
(string) of an object in the current document.count
is the number of elements in the array.extra
is a vector that displaces each element.subelements
is a list of edges ofpath_object
, for example["Edge1", "Edge2"]
. If supplied only these edges are used for the path.- If
align
isTrue
the elements are aligned along the path depending on the value ofalign_mode
, which can be"Original"
,"Frenet"
or"Tangent"
. tan_vector
is a unit vector that defines the local tangent direction of the elements along the path. It is used whenalign_mode
is"Tangent"
.- If
force_vertical
isTrue
vertical_vector
is used for the local Z direction of the elements along the path. It is used whenalign_mode
is"Original"
or"Tangent"
. - If
use_link
isTrue
the created elements are App Links instead of regular copies. path_array
is returned with the created array object.
Example:
import FreeCAD as App
import Draft
doc = App.newDocument()
p1 = App.Vector(500, -1000, 0)
p2 = App.Vector(1500, 1000, 0)
p3 = App.Vector(3000, 500, 0)
p4 = App.Vector(4500, 100, 0)
spline = Draft.make_bspline([p1, p2, p3, p4])
obj = Draft.make_polygon(3, 500)
path_array = Draft.make_path_array(obj, spline, 6)
doc.recompute()
wire = Draft.make_wire([p1, -p2, -p3, -p4])
path_array2 = Draft.make_path_array(obj, wire, count=3, extra=App.Vector(0, -500, 0), subelements=["Edge2", "Edge3"], align=True, force_vertical=True)
doc.recompute()
- Drafting: Line, Polyline, Fillet, Arc, Arc by 3 points, Circle, Ellipse, Rectangle, Polygon, B-spline, Cubic Bézier curve, Bézier curve, Point, Facebinder, ShapeString, Hatch
- Annotation: Text, Dimension, Label, Annotation styles, Annotation scale
- Modification: Move, Rotate, Scale, Mirror, Offset, Trimex, Stretch, Clone, Array, Polar array, Circular array, Path array, Path link array, Point array, Point link array, Edit, Subelement highlight, Join, Split, Upgrade, Downgrade, Wire to B-spline, Draft to sketch, Set slope, Flip dimension, Shape 2D view
- Draft Tray: Select plane, Set style, Toggle construction mode, AutoGroup
- Snapping: Snap lock, Snap endpoint, Snap midpoint, Snap center, Snap angle, Snap intersection, Snap perpendicular, Snap extension, Snap parallel, Snap special, Snap near, Snap ortho, Snap grid, Snap working plane, Snap dimensions, Toggle grid
- Miscellaneous: Apply current style, Layer, Manage layers, Add a new named group, Move to group, Select group, Add to construction group, Toggle normal/wireframe display, Create working plane proxy, Heal, Show snap toolbar
- Additional: Constraining, Pattern, Preferences, Import Export Preferences, DXF/DWG, SVG, OCA, DAT
- Context menu:
- Layer container: Merge layer duplicates, Add new layer
- Layer: Activate this layer, Select layer contents
- Text: Open hyperlinks
- Wire: Flatten
- Working plane proxy: Write camera position, Write objects state
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub