Draft PolarArray: Difference between revisions

From FreeCAD Documentation
(Better code example)
(Removed Preferences paragraph.)
 
(41 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:1-->
<!--T:1-->
{{Docnav
{{Docnav
|[[Draft_OrthoArray|OrthoArray]]
|[[Draft_Draft2Sketch|Draft to Sketch]]
|[[Draft_CircularArray|CircularArray]]
|[[Draft_LinkArray|Link Array]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Draft2Sketch.svg
|IconL=Draft_OrthoArray.svg
|IconR=Draft_CircularArray.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
|IconR=Draft_LinkArray.svg
}}
}}


Line 14: Line 15:
{{GuiCommand
{{GuiCommand
|Name=Draft PolarArray
|Name=Draft PolarArray
|MenuLocation=Draft → Polar array
|MenuLocation=Modification → Array tools → Polar array
|Workbenches=[[Draft Module|Draft]]
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Version=0.19
|Version=0.19
|SeeAlso=[[Draft_OrthoArray|OrthoArray]], [[Draft_CircularArray|CircularArray]], [[Draft_PathArray|PathArray]], [[Draft_PathLinkArray|PathLinkArray]], [[Draft_PointArray|PointArray]], [[Draft_Clone|Clone]]
|SeeAlso=[[Draft_OrthoArray|Draft OrthoArray]], [[Draft_CircularArray|Draft CircularArray]], [[Draft_PathArray|Draft PathArray]], [[Draft_PathLinkArray|Draft PathLinkArray]], [[Draft_PointArray|Draft PointArray]], [[Draft_PointLinkArray|Draft PointLinkArray]]
}}
}}


Line 23: Line 24:


<!--T:4-->
<!--T:4-->
The {{Button|[[File:Draft_PolarArray.svg|16px]] [[Draft_PolarArray|Draft PolarArray]]}} tool creates an array from a selected object placing the copies along a circumference.
The [[Image:Draft_PolarArray.svg|24px]] '''Draft PolarArray''' command creates an array from a selected object by placing copies along a circumference. The command can optionally create a [[App_Link|Link]] array, which is more efficient than a regular array.


<!--T:5-->
<!--T:5-->
This 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]]. It can also create [[App_Link|App Links]] instead of simple copies.
The command 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]].

<!--T:6-->
* To create orthogonal or circular arrays, use the corresponding {{Button|[[File:Draft_OrthoArray.svg|16px]] [[Draft_OrthoArray|OrthoArray]]}} and {{Button|[[File:Draft_CircularArray.svg|16px]] [[Draft_CircularArray|CircularArray]]}} tools.
* To position copies along a path use {{Button|[[File:Draft_PathArray.svg|16px]] [[Draft_PathArray|PathArray]]}} or {{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]]}}.


</translate>
</translate>
[[Image:Draft_PolarArray_example.png|400px]]
[[Image:Draft_PolarArray_example.png|400px]]
<translate>
<translate>

<!--T:7-->
<!--T:7-->
{{Caption|A polar array of an object.}}
{{Caption|Draft PolarArray}}


== Usage == <!--T:8-->
== Usage == <!--T:8-->

<!--T:35-->
See also: [[Draft_Snap|Draft Snap]].


<!--T:9-->
<!--T:9-->
# Select the object that you wish to array.
# Optionally select one object.
# There are several ways to invoke the command:
# Press the {{Button|[[File:Draft_PolarArray.svg|16px]] [[Draft_PolarArray|Polar array]]}} button. If no object is selected, you will be invited to select one before proceeding.
#* Press the {{Button|[[Image:Draft_PolarArray.svg|16px]] [[Draft_PolarArray|Polar array]]}} button.
# The [[task_panel|task panel]] is launched where you can select the polar angle, the number of elements, and the center of the axis of rotation.
#* Select the {{MenuCommand|Modification → Array tools → [[Image:Draft_PolarArray.svg|16px]] Polar array}} option from the menu.
# You can click on the [[3D_view|3D view]] to simultaneously set the position of the center of rotation, and complete the command. Otherwise, just press {{KEY|Enter}} or the {{Button|OK}} button to complete the operation.
# The {{MenuCommand|Polar array}} task panel opens. See [[#Options|Options]] for more information.

# If you have not yet selected an object: select one object.
<!--T:10-->
# Enter the required parameters in the task panel.
Notes:
# To finish the command do one of the following:
* By default, the axis of rotation is the positive Z axis {{Value|(0, 0, 1)}}. This can be changed in the [[property_editor|property editor]] after the object is created.
#* Pick a point in the [[3D_view|3D view]] for the {{MenuCommand|Center of rotation}}.
* 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.
#* Press {{KEY|Enter}}.
* This command creates the same parametric "Array" object as the one created with the {{Button|[[File:Draft_OrthoArray.svg|16px]] [[Draft_OrthoArray|OrthoArray]]}} and {{Button|[[File:Draft_CircularArray.svg|16px]] [[Draft_CircularArray|CircularArray]]}} tools. Therefore, the array can be converted to orthogonal, polar, or circular by changing its {{PropertyData|Array Type}} property.
#* Press the {{Button|OK}} button.


== Options == <!--T:11-->
== Options == <!--T:11-->

These are the options displayed in the [[task_panel|task panel]].


<!--T:12-->
<!--T:12-->
* {{MenuCommand|Polar angle}}: the angle which determines where the last element of the array will be placed in the polar arrangement. The angle is positive in the counter-clockwise direction, and negative in the clockwise direction.
* Enter the {{MenuCommand|Polar angle}} to specify the total angle of the array. The angle is positive in the counter-clockwise direction.
* {{MenuCommand|Number of elements}}: the number of elements in the array. Minimum of 2, maximum of 99.
* Enter the {{MenuCommand|Number of elements}}. Must be at least {{Value|2}}. The maximum that can be entered in the task panel is {{Value|99}}, but higher values are possible by changing the {{PropertyData|Number Polar}} property of the array.
* Pick a point in the [[3D_view|3D view]], note that this will also finish the command, or type coordinates for the {{MenuCommand|Center of rotation}}. The rotation axis of the array will pass through this point. It is advisable to move the pointer out of the [[3D_view|3D view]] before entering coordinates.
* {{MenuCommand|Center of rotation}}: the coordinates through which the axis of rotation goes through.
* {{MenuCommand|Reset point}}: it resets the center of rotation to the origin {{Value|(0, 0, 0)}}.
* Press the {{MenuCommand|Reset point}} button to reset the {{MenuCommand|Center of rotation}} to the origin.
* {{MenuCommand|Fuse}}: if it is checked, the resulting objects in the array will fuse together if they touch each other. This only works if {{MenuCommand|Link array}} is unchecked.
* If the {{MenuCommand|Fuse}} checkbox is checked overlapping elements in the array are fused. This does not work for Link arrays.
* {{MenuCommand|Link array}}: if it is checked, the resulting array will be a "Link array". This array internally uses [[App_Link|App Link]] objects, so it is more efficient when handling many copies of complex shapes. However, in this case, the objects cannot be fused together.
* If the {{MenuCommand|Link array}} checkbox is checked a Link array instead of a regular array is created. A Link array is more efficient because its elements are [[App_Link|App Link]] objects.
* Press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the current command.
* Press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the command.


==Notes== <!--T:36-->
{{Emphasis|Note:}} if a Link array is created, this object cannot be converted to a regular array. And similarly, a regular array cannot be converted to a Link array. Therefore, you must choose the type of array that you want at creation time.

<!--T:10-->
* The default rotation axis for the array is the positive Z axis. This can be changed by editing its {{PropertyData|Axis}} property.
* A Draft PolarArray can be turned into a [[Draft_OrthoArray|Draft OrthoArray]] or a [[Draft_CircularArray|Draft CircularArray]] by changing its {{PropertyData|Array Type}} property.
* A Link array cannot be turned into a regular array or vice versa. The type of array must be decided at creation time.


== Properties == <!--T:13-->
== Properties == <!--T:13-->

<!--T:14-->
A [[Draft_PolarArray|PolarArray]] object internally is the same object produced with the {{Button|[[Image:Draft_OrthoArray.svg|16px]] [[Draft_OrthoArray|OrthoArray]]}} tool. It is based on [[Part_Feature|Part Feature]] ({{incode|Part::Feature}} class), and thus shares all properties of the latter.


<!--T:15-->
<!--T:15-->
See [[Draft_OrthoArray#Properties|Draft OrthoArray]].
See the {{Button|[[Image:Draft_OrthoArray.svg|16px]] [[Draft_OrthoArray|OrthoArray]]}} tool for the complete description of the properties. All properties apply, except for those under the {{TitleProperty|Orthogonal array}} and {{TitleProperty|Circular array}} groups.


== Scripting == <!--T:16-->
== Scripting == <!--T:16-->


<!--T:17-->
<!--T:17-->
{{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]].

===Parametric array=== <!--T:40-->


<!--T:18-->
<!--T:18-->
To create a parametric polar array use the {{incode|make_array}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makeArray}} method. The {{incode|make_array}} method can create [[Draft_OrthoArray|Draft OrthoArrays]], Draft PolarArrays and [[Draft_CircularArray|Draft CircularArrays]]. For each array type one or more wrappers are available.
The PolarArray tool can be used in [[macros|macros]] and from the [[Python_console|Python console]] by using the following function.

<!--T:41-->
The main method:


Older call:
</translate>
</translate>
{{Code|code=
{{Code|code=
array = makeArray(baseobject, center, totalangle, totalnum, use_link=False)
array = make_array(base_object, arg1, arg2, arg3, arg4=None, arg5=None, arg6=None, use_link=True)
}}
}}
<translate>
<translate>


<!--T:42-->
New call:
The wrapper for polar arrays is:

</translate>
</translate>
{{Code|code=
{{Code|code=
Line 104: Line 107:


<!--T:19-->
<!--T:19-->
* Creates an {{incode|"Array"}} object from the {{incode|base_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.
** {{incode|number}} is the number of copies in the polar pattern, including the original object.
* {{incode|number}} is the number of elements in the pattern, including the original object.
** {{incode|angle}} is the angle of the polar arc in degrees.
* {{incode|angle}} is the angle of the polar arc in degrees.
** {{incode|center}} is a vector that defines the center of the array pattern.
* {{incode|center}} is the vector that defines the center of the pattern.
** If {{incode|use_link}} is {{TRUE}} the created copies will be [[App_Link|App Links]] and not regular copies.
* If {{incode|use_link}} is {{incode|True}} the created elements are [[App_Link|App Links]] instead of regular copies.
* {{incode|array}} is returned with the created array object.


<!--T:20-->
<!--T:20-->
Example:
Example:

</translate>
</translate>
{{Code|code=
{{Code|code=
Line 127: Line 132:
<translate>
<translate>


== Scripting, non-parametric array ==
===Non-parametric array=== <!--T:43-->


<!--T:29-->
When using the {{Button|[[Image:Draft_PolarArray.svg|16px]] [[Draft_PolarArray|PolarArray]]}} tool, a parametric {{incode|"Array"}} object is created. This can be scripted as described in the previous section.
To create a non-parametric polar array use the {{incode|array}} method of the Draft module. This method returns {{incode|None}}.


However, to obtain standalone copies of the base object, the simple {{incode|Draft.array}} function can be used. This will create simple copies, not a new parametric object.

To create a polar array, use it like this:
</translate>
</translate>
{{Code|code=
{{Code|code=
array_list = array(objectslist, center, angle, number)
array(objectslist, center, angle, number)
}}
}}
<translate>
<translate>


<!--T:33-->
* Creates an array from the objects contained in {{incode|objectslist}}, which can be a single object or a list of objects.
** In case of a polar array, {{incode|center}} defines the center of the array circle, {{incode|angle}} is the angle of the arc in degrees to cover with copies, and {{incode|number}} is the number of copies to arrange on the circular arc, including the original object.
** {{incode|array_list}} is returned with the new copies. It is either a single object or a list of objects, depending on the input {{incode|objectslist}}.

This function internally uses {{incode|Draft.move()}} and {{incode|Draft.rotate()}} with <code>copy=True</code>.

Example:
Example:


Line 158: Line 156:
center = App.Vector(-1600, 0, 0)
center = App.Vector(-1600, 0, 0)


array = Draft.array(tri, center, 270, 6)
Draft.array(tri, center, 270, 8)
doc.recompute()
doc.recompute()
}}
}}
<translate>
<translate>



<!--T:21-->
<!--T:21-->
{{Docnav
{{Docnav
|[[Draft_OrthoArray|OrthoArray]]
|[[Draft_Draft2Sketch|Draft to Sketch]]
|[[Draft_CircularArray|CircularArray]]
|[[Draft_LinkArray|Link Array]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Draft2Sketch.svg
|IconL=Draft_OrthoArray.svg
|IconR=Draft_CircularArray.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
|IconR=Draft_LinkArray.svg
}}
}}


Line 176: Line 175:
{{Draft Tools navi{{#translation:}}}}
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 19:48, 7 December 2023

Draft PolarArray

Menu location
Modification → Array tools → Polar array
Workbenches
Draft, Arch
Default shortcut
None
Introduced in version
0.19
See also
Draft OrthoArray, Draft CircularArray, Draft PathArray, Draft PathLinkArray, Draft PointArray, Draft PointLinkArray

Description

The Draft PolarArray command creates an array from a selected object by placing copies along a circumference. The command can optionally create a Link array, which is more efficient than a regular array.

The command 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 PolarArray

Usage

See also: Draft Snap.

  1. Optionally select one object.
  2. There are several ways to invoke the command:
    • Press the Polar array button.
    • Select the Modification → Array tools → Polar array option from the menu.
  3. The Polar array task panel opens. See Options for more information.
  4. If you have not yet selected an object: select one object.
  5. Enter the required parameters in the task panel.
  6. To finish the command do one of the following:
    • Pick a point in the 3D view for the Center of rotation.
    • Press Enter.
    • Press the OK button.

Options

  • Enter the Polar angle to specify the total angle of the array. The angle is positive in the counter-clockwise direction.
  • Enter the Number of elements. Must be at least 2. The maximum that can be entered in the task panel is 99, but higher values are possible by changing the DataNumber Polar property of the array.
  • Pick a point in the 3D view, note that this will also finish the command, or type coordinates for the Center of rotation. The rotation axis of the array will pass through this point. It is advisable to move the pointer out of the 3D view before entering coordinates.
  • Press the Reset point button to reset the Center of rotation to the origin.
  • If the Fuse checkbox is checked overlapping elements in the array are fused. This does not work for Link arrays.
  • If the Link array checkbox is checked a Link array instead of a regular array is created. A Link array is more efficient because its elements are App Link objects.
  • Press Esc or the Cancel button to abort the command.

Notes

  • The default rotation axis for the array is the positive Z axis. This can be changed by editing its DataAxis property.
  • A Draft PolarArray can be turned into a Draft OrthoArray or a Draft CircularArray by changing its DataArray Type property.
  • A Link array cannot be turned into a regular array or vice versa. The type of array must be decided at creation time.

Properties

See Draft OrthoArray.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

Parametric array

To create a parametric polar array use the make_array method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makeArray method. The make_array method can create Draft OrthoArrays, Draft PolarArrays and Draft CircularArrays. For each array type one or more wrappers are available.

The main method:

array = make_array(base_object, arg1, arg2, arg3, arg4=None, arg5=None, arg6=None, use_link=True)

The wrapper for polar arrays is:

array = make_polar_array(base_object,
                         number=5, angle=360, center=App.Vector(0, 0, 0),
                         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.
  • number is the number of elements in the pattern, including the original object.
  • angle is the angle of the polar arc in degrees.
  • center is the vector that defines the center of the pattern.
  • If use_link is True the created elements are App Links instead of regular copies.
  • array is returned with the created array object.

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

tri = Draft.make_polygon(3, 600)
center = App.Vector(-1600, 0, 0)

array = Draft.make_polar_array(tri, 8, 270, center)
doc.recompute()

Non-parametric array

To create a non-parametric polar array use the array method of the Draft module. This method returns None.

array(objectslist, center, angle, number)

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

tri = Draft.make_polygon(3, 600)
center = App.Vector(-1600, 0, 0)

Draft.array(tri, center, 270, 8)
doc.recompute()