Draft PathArray

Description
The tool places copies of a selected shape along a selected path, which can be a Draft Wire, a Draft BSpline, and similar edges.

The PathArray tool can be used on any object that has a Part TopoShape, meaning 2D shapes created with the Draft Workbench, but also 3D solids created with other workbenches, for example, Part, PartDesign, or Arch.


 * To create orthogonal, polar or circular arrays, use the corresponding, , or tools.
 * To position App Link copies along a path use.
 * To position copies at specified points use or.
 * To create copies and manually place them use or.
 * To create exact copies and manually place or scale them, use or.



Usage

 * 1) Select the object that you wish to distribute.
 * 2) Select the path object or edges along which the object will be distributed.
 * 3) Press the  button.
 * 4) The Array object is immediately created. You must change the properties of the array to change the number and direction of copies created.

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.

if the object doesn't seem to be positioned correctly in the path, check that its  is in the origin. Certain objects can be placed anywhere in the 3D space when used with the tool, but others must be at the origin, particularly those created by using  with a 2D profile like a.

Options
There are no options for this tool. Either it works with the selected objects or not.

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
The properties in this group are only available for Link arrays. See Std LinkMake for more information.




 * : if it is the copies will be aligned to the path; otherwise they are left in their default orientation.
 * : three modes,, ,.
 * : additional displacement vector 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.
 * : if it is, the value of will be used as the local Z direction, when  is  or.
 * : it defaults to ; alignment unit vector that will be used when is.
 * : it defaults to ; unit vector of the local Z direction that will be used when is.


 * : specifies the object to duplicate in the path.
 * : specifies the number of copies to create in the path.
 * : (only available for Link arrays) specifies whether to expand the array in the Tree view to enable the selection of its individual elements.
 * : specifies the object along which the copies will be distributed. It must contain in its Part TopoShape.
 * : specifies the sub-elements (edges) of the 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.

View
The properties in this group, with the exception of the inherited property, are only available for Link arrays. See Std LinkMake for more information.


 * : this is an inherited property that appears in the Selection group for other arrays
 * : this is an inherited property that appears in the Selection group for other arrays
 * : this is an inherited property that appears in the Selection group for other arrays
 * : this is an inherited property that appears in the Selection group for other arrays
 * : this is an inherited property that appears in the Selection group for other arrays

The properties in this group, with the exception of the inherited property, are only available for Link arrays. See Std LinkMake for more information.


 * : this is an inherited property.
 * : this is an inherited property.
 * : this is an inherited property.
 * : this is an inherited property.
 * : this is an inherited property.

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


 * : this property is not inherited by Link arrays.
 * : for Link arrays it can be or . For other arrays it can be:, ,  or


 * : not used.
 * : not used.

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 method  of the Draft module. This method replaces the deprecated method.


 * is the object to be arrayed. It can also be the (string) of an object in the current document.
 * is the path object. It can also be the (string) of an object in the current document.
 * is the number of elements in the array.
 * is a vector that displaces each element.
 * is a list of edges of, for example . If supplied only these edges are used for the path.
 * If is  the elements are aligned along the path depending on the value of, which can be ,  or.
 * is a unit vector that defines the local tangent direction of the elements along the path. It is used when is.
 * If is   is used for the local Z direction of the elements along the path. It is used when  is  or.
 * If is  the created elements are App Links instead of regular copies.
 * is returned with the created array object.

Example:

Technical explanation for the Align property
When is, the placement of the copied shapes is easy to understand; they are just moved to a different position in their original orientation.



When is, the positioning of the shapes becomes a bit more complex:
 * 1) First, Frenet coordinate systems are built on the path: X is tangent, Z is normal, Y is binormal.
 * 2) 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.



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

Path on XY Plane:



Path on XZ Plane:



Path on 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.

thank you to 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

Railway cross ties (sleepers) - Tangent mode + ForceVertical

Frenet Mode