Draft PathArray/tr: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
(12 intermediate revisions by 2 users 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
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
{{GuiCommand/tr
{{GuiCommand/tr|Name=Draft PathArray|Name/tr=Yol dizisi|Workbenches=[[Draft Module/tr|Draft]], [[Arch Module/tr|Arch]]|MenuLocation=Draft → PathArray|SeeAlso=[[Draft Array/tr|Draft Array]] }}
|Name=Draft PathArray
|Name/tr=Yol dizisi
|MenuLocation=Draft → PathArray
|Workbenches=[[Draft_Workbench/tr|Draft]], [[Arch_Workbench/tr|Arch]]
|SeeAlso=[[Draft Array/tr|Draft Array]]
}}
</div>
</div>


==Description==
==Description==


The {{Button|[[Image:Draft_PathArray.svg|16px]] [[Draft PathArray|Draft 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.
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 can be used on any object that has a [[Part_TopoShape|Part TopoShape]], meaning 2D shapes created with the [[Draft_Workbench|Draft Workbench]], but also 3D solids created with other workbenches, for example, [[Part_Workbench|Part]], [[PartDesign_Workbench|PartDesign]], or [[Arch_Workbench|Arch]].


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 create orthogonal, polar or circular arrays, use the corresponding {{Button|[[File:Draft_OrthoArray.svg|16px]] [[Draft_OrthoArray|OrthoArray]]}}, {{Button|[[File:Draft_PolarArray.svg|16px]] [[Draft_PolarArray|PolarArray]]}}, or {{Button|[[File:Draft_CircularArray.svg|16px]] [[Draft_CircularArray|CircularArray]]}} tools.
* To position [[App_Link|App Link]] copies along a path use {{Button|[[File:Draft_PathLinkArray.svg|16px]] [[Draft_PathLinkArray|PathLinkArray]]}}.
* To position copies at specified points use {{Button|[[File:Draft_PointArray.svg|16px]] [[Draft_PointArray|PointArray]]}}.
* To create copies and manually place them use {{Button|[[File:Draft_Move.svg|16px]] [[Draft_Move|Move]]}} or {{Button|[[File:Draft_Rotate.svg|16px]] [[Draft_Rotate|Rotate]]}}.
* To create exact copies and manually place or scale them, use {{Button|[[File:Draft_Clone.svg|16px]] [[Draft_Clone|Clone]]}} or {{Button|[[File:Std_LinkMake.svg|16px]] [[Std_LinkMake|Std LinkMake]]}}.


[[Image:Draft_PathArray_Example.png|400px]]
[[Image:Draft_PathArray_Example.png|400px]]
{{Caption|Object arranged along a path}}
{{Caption|Draft PathArray}}


==Usage==
==Usage==


# Select the object that you wish to distribute.
# 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. In FreeCAD version 0.19 and earlier edges must be selected in the correct order.
# Select the path object or edges along which the object will be distributed.
# There are several ways to invoke the command:
# Press the {{Button|[[Image:Draft_PathArray.svg|16px]] [[Draft_PathArray|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}}.
{{Emphasis|Note:}} if the {{PropertyData|Base}} object doesn't seem to be positioned correctly in the path, check that its {{PropertyData|Placement}} is in the origin {{Value|(0,0,0)}}. Certain objects can be placed anywhere in the 3D space when used with the {{Button|[[Image:Draft_PathArray.svg|16px]] [[Draft_PathArray|PathArray]]}} tool, but others must be at the origin, particularly those created by using {{Button|[[File:Part_Extrude.svg|16px]] [[Part_Extrude|Part Extrude]]}} with a 2D profile like a {{Button|[[File:Sketcher_NewSketch.svg|16px]] [[Sketch|Sketch]]}}.


[[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]].
A [[Draft_PathArray|PathArray]] is derived from a [[Part_Feature|Part Feature]] ({{incode|Part::Feature}} class), therefore it shares all the latter's properties. In addition to the properties described in [[Part_Feature|Part Feature]], the PathArray has the following properties in the [[property_editor|property editor]].

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:

===Data===

{{TitleProperty|Link}}

The properties in this group are only available for Link arrays. See [[Std_LinkMake#Properties|Std LinkMake]] for more information.

* {{PropertyData|Scale|Float}}
* {{PropertyData|Scale Vector|Vector|Hidden}}
* {{PropertyData|Scale List|VectorList}}
* {{PropertyData|Visibility List|BoolList|Hidden}}
* {{PropertyData|Placement List|PlacementList|Hidden}}
* {{PropertyData|Element List|LinkList|Hidden}}
* {{PropertyData|_ Link Touched|Bool|Hidden}}
* {{PropertyData|_ Child Cache|LinkList|Hidden}}
* {{PropertyData|Colored Elements|LinkSubHidden|Hidden}}
* {{PropertyData|Link Transform|Bool}}


{{TitleProperty|Alignment}}
{{TitleProperty|Alignment}}

* {{PropertyData|Align|Bool}}: if it is {{TRUE}} the copies will be aligned to the path; otherwise they are left in their default orientation.
* {{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.
:{{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|Align Mode|Enumeration}}: three modes, {{Value|Original}}, {{Value|Frenet}}, {{Value|Tangent}}.
* {{PropertyData|Align Mode|Enumeration}}: specifies the align mode, which can be {{Value|Original}}, {{Value|Frenet}} or {{Value|Tangent}}.
* {{PropertyData|Extra Translation|VectorDistance}}: additional displacement vector {{Value|(x, y, z)}} that will be applied to each copy along the path. This is useful to make small adjustments in the position of the copies, for example, when its reference point doesn't match the center point of its shape.
* {{PropertyData|Extra Translation|VectorDistance}}: specifies an additional displacement for each element along the path.
* {{PropertyData|Force Vertical|Bool}}: if it is {{TRUE}}, the value of {{PropertyData|Vertical Vector}} will be used as the local Z direction, when {{PropertyData|Align Mode}} is {{Value|Original}} or {{Value|Tangent}}. {{Version|0.19}}
* {{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}}. {{Version|0.19}}
* {{PropertyData|Tangent Vector|Vector}}: it defaults to {{Value|(1, 0, 0)}}; alignment unit vector that will be used when {{PropertyData|Align Mode}} is {{Value|Tangent}}. {{Version|0.19}}
* {{PropertyData|Tangent Vector|Vector}}: specifies the alignment vector. Only used if {{PropertyData|Align Mode}} is {{Value|Tangent}}. {{Version|0.19}}
* {{PropertyData|Vertical Vector|Vector}}: it defaults to {{Value|(0, 0, 1)}}; unit vector of the local Z direction that will be used when {{PropertyData|Vertical Vector}} is {{TRUE}}. {{Version|0.19}}
* {{PropertyData|Vertical Vector|Vector}}: specifies the override for the default normal direction. Only used if {{PropertyData|Vertical Vector}} is {{TRUE}}. {{Version|0.19}}


{{TitleProperty|Objects}}
{{TitleProperty|Objects}}

* {{PropertyData|Base|LinkGlobal}}: specifies the object to duplicate in the path.
* {{PropertyData|Count|Integer}}: specifies the number of copies to create in the path.
* {{PropertyData|Base|LinkGlobal}}: specifies the object to duplicate in the array.
* {{PropertyData|Count|Integer}}: specifies the number of elements in the array.
* {{PropertyData|Path Object|LinkGlobal}}: specifies the object along which the copies will be distributed. It must contain {{Value|'Edges'}} in its [[Part_TopoShape|Part TopoShape]]; for example, it could be a {{Button|[[File:Draft_Wire.svg|16px]] [[Draft_Wire|Wire]]}} or {{Button|[[File:Draft_BSpline.svg|16px]] [[Draft_BSpline|BSpline]]}}.
* {{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 Subelements|LinkSubListGlobal}}: specifies the sub-elements (edges) of the {{PropertyData|Path Object}} on which the copies will be created. The copies will be created only on these edges. If this property is empty, the copies will be distributed on the entire {{PropertyData|Path Object}}.
* {{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===

{{TitleProperty|Link}}

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.

* {{PropertyView|Draw Style|Enumeration}}
* {{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}}

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.

* {{PropertyView|Child View Provider|PersistentObject|Hidden}}
* {{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==
==Scripting==
{{Emphasis|See also:}} [[Draft API|Draft API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].


See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
The PathArray tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:


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.
Older call
{{Code|code=
path_array = makePathArray(base_object, path_object, count, xlate=None, align=False, pathobjsubs=[])
}}


New call
{{Code|code=
{{Code|code=
path_array = make_path_array(base_object, path_object,
path_array = make_path_array(base_object, path_object,
Line 71: Line 160:
align=False, align_mode="Original", tan_vector=App.Vector(1, 0, 0),
align=False, align_mode="Original", tan_vector=App.Vector(1, 0, 0),
force_vertical=False, vertical_vector=App.Vector(0, 0, 1),
force_vertical=False, vertical_vector=App.Vector(0, 0, 1),
use_link=True):
use_link=True)
}}
}}


* Creates a {{incode|"PathArray"}} object from the {{incode|base_object}}, by placing as many as {{incode|count}} copies along {{incode|path_object}}.
* {{incode|base_object}} is the object to be arrayed. It can also be the {{incode|Label}} (string) of an object in the current document.
** If {{incode|extra}} is given, it is a vector that displaces each of the individual copies by a small amount.
* {{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.
** If {{incode|subelements}} is given, it is a list of edges of {{incode|path_object}}, for example, {{incode|['Edge1', 'Edge2']}}; the copies will be created along this shorter path.
* {{incode|extra}} is a vector that displaces each element.
** If {{incode|align}} is {{incode|True}}, the copies are aligned along the {{incode|path_object}} depending on the value of {{incode|align_mode}}, which may be {{incode|"Original"}}, {{incode|"Frenet"}} or {{incode|"Tangent"}}.
* {{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|tan_vector}} is given, it is a unit vector that defines the local tangent direction of the copy along the path. It is used when {{incode|align_mode}} is {{incode|"Tangent"}}.
** If {{incode|force_vertical}} is {{incode|True}}, the value of {{incode|vertical_vector}} is used to determine the local Z direction of the copy along the path. It is used when {{incode|align_mode}} is {{incode|"Original"}} or {{incode|"Tangent"}}.
* 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|use_link}} is {{incode|True}}, the type of array created will be a [[Draft_PathLinkArray|PathLinkArray]], whose elements are [[App_Link|App Link]] instances instead of simple copies.
* 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:


Example:
{{Code|code=
{{Code|code=
import FreeCAD as App
import FreeCAD as App
Line 104: Line 197:
}}
}}


==Technical explanation for the Align property==
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.
[[Image:patharray_NoAlign.png|600px|left|Align false]]
{{clear}}
{{Caption|Object arranged along a closed path in the original orientation}}


{{Docnav
When {{PropertyData|Align}} is {{TRUE}}, the positioning of the shapes becomes a bit more complex:
|[[Draft_CircularArray|CircularArray]]
# First, Frenet coordinate systems are built on the path: X is tangent, Z is normal, Y is binormal.
|[[Draft_PathLinkArray|PathLinkArray]]
# 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.
|[[Draft_Workbench|Draft]]
[[Image:patharray alignment annotated.png|600px|left]]
|IconL=Draft_CircularArray.svg
{{clear}}
|IconR=Draft_PathLinkArray.svg
{{Caption|Object arranged along a closed path; description of components and path}}
|IconC=Workbench_Draft.svg

}}
The following images show how the array is produced, depending on which plane the path is.

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}}

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}}

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}}

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.

{{Emphasis|Editor:}} thank you to user DeepSOIC for this explanation.

==Additional alignment modes and options introduced in v0.19==

'''Original''' mode (the default) is the historic alignment mode as in version 0.18.
It is not really the Frenet alignment. Original mode uses the normal parameter
from Draft.getNormal (or the default) as a constant - it does not calculate
curve normal. X follows the curve tangent, Y is the normal parameter, Z is
X.Cross(Y).

'''Tangent''' mode is similar to '''Original''', but includes a rotation to align the
Base object's X to the TangentVector before placing copies. After the
rotation, Tangent behaves the same as Original. In previous versions this
rotation would be performed manually before invoking PathArray.

'''Frenet''' mode orients the copies to a coordinate system along the path. X is
tangent to curve, Y is curve normal, Z is curve binormal. If a normal can not
be computed (ex a straight line), the default is used.

The ForceVertical option applies to Original and Tangent modes. When this
option is applied, the normal parameter from Draft.getNormal is ignored. X
follows the curve tangent, Z is the VerticalVector property and Y is
X.Cross(Z).

Version 18 cycle chain - Original mode
[[Image:patharray_cycleChain.png|600px|left|Align false]]
{{clear}}

Railway cross ties (sleepers) - Tangent mode + ForceVertical
[[Image:patharray_railwayTies.png|600px|left|Align false]]
{{clear}}

Frenet Mode
[[Image:patharray_FrenetMode.png|600px|left|Align false]]
{{clear}}


{{Docnav|[[Draft_LinkArray|Link Array]]|[[Draft_PathLinkArray|Path LinkArray]]|[[Draft_Module|Draft]]|IconL=Draft_LinkArray.svg|IconC=Workbench_Draft.svg|IconR=Draft_PathLinkArray.svg}}


{{Draft Tools navi{{#translation:}}}}
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 08:48, 8 May 2022

Other languages:

Yol dizisi

Menü konumu
Draft → PathArray
Tezgahlar
Draft, Arch
Varsayılan kısayol
Hiçbiri
Versiyonda tanıtıldı
-
Ayrıca bkz
Draft Array

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

  1. Select the object you wish to array.
  2. 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. In FreeCAD version 0.19 and earlier edges must be selected in the correct order.
  3. There are several ways to invoke the command:
    • Press the Draft PathArray button.
    • Select the Modification → Array tools → Path array option from the menu.
  4. The array is created.
  5. 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 VeriAlign 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 VeriAlign Mode property of the array. Other array properties involved in the alignment include VeriTangent Vector, VeriForce Vertical and VeriVertical 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 VeriAlign 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 VeriAlign Mode Original but includes the possibility to pre-rotate the source object by specifying a VeriTangent Vector.

Force Vertical and Vertical Vector

These properties are only available if VeriAlign Mode is Original or Tangent. If VeriForce Vertical is set to true the local coordinate system is calculated in a different manner. The VeriVertical 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.

  • VeriScale (Float)
  • Veri (Hidden)Scale Vector (Vector)
  • VeriScale List (VectorList)
  • Veri (Hidden)Visibility List (BoolList)
  • Veri (Hidden)Placement List (PlacementList)
  • Veri (Hidden)Element List (LinkList)
  • Veri (Hidden)_ Link Touched (Bool)
  • Veri (Hidden)_ Child Cache (LinkList)
  • Veri (Hidden)Colored Elements (LinkSubHidden)
  • VeriLink Transform (Bool)

Alignment

  • VeriAlign (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 VeriExtra Translation, do not apply and are hidden.
  • VeriAlign Mode (Enumeration): specifies the align mode, which can be Original, Frenet or Tangent.
  • VeriExtra Translation (VectorDistance): specifies an additional displacement for each element along the path.
  • VeriForce Vertical (Bool): specifies whether to override the default normal direction with the value of VeriVertical Vector. Only used if VeriAlign Mode is Original or Tangent. introduced in version 0.19
  • VeriTangent Vector (Vector): specifies the alignment vector. Only used if VeriAlign Mode is Tangent. introduced in version 0.19
  • VeriVertical Vector (Vector): specifies the override for the default normal direction. Only used if VeriVertical Vector is true. introduced in version 0.19

Objects

  • VeriBase (LinkGlobal): specifies the object to duplicate in the array.
  • VeriCount (Integer): specifies the number of elements in the array.
  • VeriExpand 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.
  • VeriPath Object (LinkGlobal): specifies the object to be used for the path. It must contain Edges in its Part TopoShape.
  • VeriPath Subelements (LinkSubListGlobal): specifies a list of edges of the VeriPath 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.

  • GörünümDraw Style (Enumeration)
  • GörünümLine Width (FloatConstraint)
  • GörünümOverride Material (Bool)
  • GörünümPoint Size (FloatConstraint)
  • GörünümSelectable (Bool): this is an inherited property that appears in the Selection group for other arrays
  • GörünümShape 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.

  • Görünüm (Hidden)Child View Provider (PersistentObject)
  • Görünüm (Hidden)Material List (MaterialList)
  • Görünüm (Hidden)Override Color List (ColorList)
  • Görünüm (Hidden)Override Material List (BoolList)
  • Görünüm (Hidden)Proxy (PythonObject): this is an inherited property.

Display Options

The properties in this group are inherited properties. See Part Feature for more information.

  • GörünümBounding Box (Bool): this property is not inherited by Link arrays.
  • GörünümDisplay Mode (Enumeration): for Link arrays it can be Link or ChildView. For other arrays it can be: Flat Lines, Shaded, Wireframe or Points
  • GörünümShow In Tree (Bool)
  • GörünümVisibility (Bool)

Draft

  • GörünümPattern (Enumeration): not used.
  • GörünümPattern 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 the Label (string) of an object in the current document.
  • path_object is the path object. It can also be the Label (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 of path_object, for example ["Edge1", "Edge2"]. If supplied only these edges are used for the path.
  • If align is True the elements are aligned along the path depending on the value of align_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 when align_mode is "Tangent".
  • If force_vertical is True vertical_vector is used for the local Z direction of the elements along the path. It is used when align_mode is "Original" or "Tangent".
  • If use_link is True 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()


Draft
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Draft_PathArray/tr&oldid=1137556"