Draft CircularArray: Difference between revisions

From FreeCAD Documentation
(Improve usage notes)
(Removed Preferences paragraph.)
 
(33 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:1-->
<!--T:1-->
{{Docnav
{{Docnav
|[[Draft_PolarArray|PolarArray]]
|[[Draft_Draft2Sketch|Draft to Sketch]]
|[[Draft_PathArray|PathArray]]
|[[Draft_LinkArray|Link Array]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Draft2Sketch.svg
|IconL=Draft_PolarArray.svg
|IconR=Draft_PathArray.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
|IconR=Draft_LinkArray.svg
}}
}}


Line 14: Line 15:
{{GuiCommand
{{GuiCommand
|Name=Draft CircularArray
|Name=Draft CircularArray
|MenuLocation=Draft → Circular array
|MenuLocation=Modification → Array tools → Circular array
|Workbenches=[[Draft Module|Draft]]
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Version=0.19
|Version=0.19
|SeeAlso=[[Draft_OrthoArray|OrthoArray]], [[Draft_PolarArray|PolarArray]], [[Draft_PathArray|PathArray]], [[Draft_PathLinkArray|PathLinkArray]], [[Draft_PointArray|PointArray]], [[Draft_Clone|Clone]]
|SeeAlso=[[Draft_OrthoArray|Draft OrthoArray]], [[Draft_PolarArray|Draft PolarArray]], [[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_CircularArray.svg|16px]] [[Draft_CircularArray|Draft CircularArray]]}} tool creates an array from a selected object placing the copies along concentric circumferences. This is similar to using {{Button|[[Image:Draft_PolarArray.svg|16px]] [[Draft_PolarArray|PolarArray]]}} with a polar angle of 360 degrees, and creating several concentric arrays.
The [[Image:Draft_CircularArray.svg|24px]] '''Draft CircularArray''' command creates an array from a selected object by placing copies along concentric circumferences. 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 polar arrays, use the corresponding {{Button|[[File:Draft_OrthoArray.svg|16px]] [[Draft_OrthoArray|OrthoArray]]}} and {{Button|[[File:Draft_PolarArray.svg|16px]] [[Draft_PolarArray|PolarArray]]}} 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_CircularArray_example.png|400px]]
[[Image:Draft_CircularArray_example.png|400px]]
<translate>
<translate>

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


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

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


<!--T:9-->
<!--T:9-->
# Optionally select one object.
# Select the object from which you wish to array.
# There are several ways to invoke the command:
# Press the {{Button|[[File:Draft_CircularArray.svg|16px]] [[Draft_CircularArray|Circular array]]}} button. If no object is selected, you will be invited to select one before proceeding.
#* Press the {{Button|[[Image:Draft_CircularArray.svg|16px]] [[Draft_CircularArray|Circular array]]}} button.
# The [[task_panel|task panel]] is launched where you can select the radial distance, the tangential distance, the number of circular layers, the symmetry parameter, and the center of the axis of rotation.
#* Select the {{MenuCommand|Modification → Array tools → [[Image:Draft_CircularArray.svg|16px]] Circular 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|Circular array}} task panel opens. See [[#Options|Options]] for more information.

# If you have not yet selected an object: select one object.
===Notes===
# Enter the required parameters in the task panel.

# To finish the command do one of the following:
<!--T:10-->
#* Pick a point in the [[3D_view|3D view]] for the {{MenuCommand|Center of rotation}}.
* 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.
#* Press {{KEY|Enter}}.
* 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 the {{Button|OK}} button.
* 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_PolarArray.svg|16px]] [[Draft_PolarArray|PolarArray]]}} tools. Therefore, the array can be converted to orthogonal, polar, or circular by changing its {{PropertyData|Array Type}} property.


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


<!--T:12-->
<!--T:12-->
* Press {{Button|Reset point}} to set the center of the circular patterns to the origin {{Value|(0, 0, 0)}}.
* Enter the {{MenuCommand|Radial distance}} to specify the distance between the circular layers, and between the center and the first circular layer.
* If the {{MenuCommand|Fuse}} checkbox is ticked, the resulting objects in the array will be fused into a single shape, if they touch or intersect each other.
* Enter the {{MenuCommand|Tangential distance}} to specify the distance between the elements on the same circular layer. Must be larger than zero.
* Enter the {{MenuCommand|Number of circular layers}}. The element at the center counts as one layer. 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 Circles}} property of the array.
* If the {{MenuCommand|Use Links}} checkbox is ticked, the resulting objects in the array will be [[App_Link|App Links]] instead of simple copies. This improves the memory usage of the array, as the App Link re-uses the [[Shape|shape]] of the original object, and does not create new shapes. If this option is used, the {{MenuCommand|Fuse}} checkbox has no effect.
* Enter the {{MenuCommand|Symmetry}} value. This number determines how the elements are distributed. A value of {{Value|3}}, for example, results in a pattern with three equal 120° pie segments. Larger values for the {{MenuCommand|Symmetry}} and the {{MenuCommand|Tangential distance}} result in fewer or even no elements on the inner layers.
* Press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the current command.
* 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.
* Press the {{MenuCommand|Reset point}} button to reset the {{MenuCommand|Center of rotation}} to the origin.
* If the {{MenuCommand|Fuse}} checkbox is checked overlapping elements in the array are fused. This does not work for Link arrays.
* 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 command.


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


<!--T:14-->
<!--T:10-->
* The default rotation axis for the array is the positive Z axis. This can be changed by editing its {{PropertyData|Axis}} property.
An [[Draft_PolarArray|Array]] object is based on [[Part_Feature|Part Feature]] ({{incode|Part::Feature}} class), and thus shares all properties of the latter. In addition to the properties listed in [[Part_Feature|Part Feature]], the Array object has additional properties.
* A Draft CircularArray can be turned into a [[Draft_OrthoArray|Draft OrthoArray]] or a [[Draft_PolarArray|Draft PolarArray]] 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-->


<!--T:15-->
<!--T:15-->
See [[Draft_OrthoArray#Properties|Draft OrthoArray]].
See the {{Button|[[Image:Draft_Array.svg|16px]] [[Draft_OrthoArray|OrthoArray]]}} tool for the complete information.


== 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]].


<!--T:18-->
<!--T:18-->
To create a circular 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_PolarArray|Draft PolarArrays]] and Draft CircularArrays. For each array type one or more wrappers are available.
The Array tool can be used in [[macros|macros]] and from the [[Python_console|Python console]] by using the following function.

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


</translate>
</translate>
{{Code|code=
{{Code|code=
array = make_array(base_object, arg1, arg2, arg3, arg4=None, arg5=None, arg6=None, use_link=True)
array_list = make_circular_array(obj, r_distance, tan_distance,
}}
axis, center, number, symmetry,
<translate>
use_link)

<!--T:34-->
The wrapper for circular arrays is:

</translate>
{{Code|code=
array = make_circular_array(base_object,
r_distance=100, tan_distance=50,
number=3, symmetry=1,
axis=App.Vector(0, 0, 1), center=App.Vector(0, 0, 0),
use_link=True)
}}
}}
<translate>
<translate>


<!--T:19-->
<!--T:19-->
* Creates an array from the objects contained in {{incode|obj}}, which can be a single object or a list of objects.
* {{incode|base_object}} is the object to be arrayed. It can also be the {{incode|Label}} (string) of an object in the current document.
* The values of {{incode|r_distance}} and {{incode|tan_distance}} correspond to the radial and tangential distances of the elements in the array.
* {{incode|r_distance}} and {{incode|tan_distance}} are the radial and tangential distances between the elements.
* {{incode|number}} is the number of circular layers in the pattern, the original object counts as the first layer.
* The values of {{incode|axis}} and {{incode|center}} are vectors that describe the direction of the axis of rotation, and a point through which that axis goes.
* {{incode|symmetry}} is an integer used in some calculations that affect the way the elements are distributed around the circumferences. Usual values are from 1 to 6. Higher values are not recommended and will make the elements in the inner layers disappear.
* The value of {{incode|number}} is the number of circular layers in the circular pattern; the original object counts as the first layer.
* {{incode|axis}} and {{incode|center}} are vectors that describe the direction of the axis of rotation, and a point through which that axis passes.
* The value of {{incode|symmetry}} is an integer that participates in some calculations that affect the way the copies are distributed around the circumferences. Try different values, from 1 to 10, to get different placements of the copies.
* 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_list}} is returned with the new copies.
* {{incode|array}} is returned with the created array object.
** {{incode|array_list}} is either a single object or a list of objects, depending on the input {{incode|obj}}.


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

</translate>
</translate>
{{Code|code=
{{Code|code=
import FreeCAD as App
import FreeCAD as App
import Draft
import Draft
import draftobjects.circulararray as ca


doc = App.newDocument()
doc = App.newDocument()


tri = Draft.makePolygon(3, 600)
tri = Draft.make_polygon(3, 600)

axis = App.Vector(0, 0, 1)
array = Draft.make_circular_array(tri, 1800, 1200, 4, 1)
center = App.Vector(0, 0, 0)
doc.recompute()
arr = ca.make_circular_array(tri, 1800, 1200, axis, center, 4, 1)
App.ActiveDocument.recompute()
}}
}}
<translate>
<translate>



<!--T:21-->
<!--T:21-->
{{Docnav
{{Docnav
|[[Draft_PolarArray|PolarArray]]
|[[Draft_Draft2Sketch|Draft to Sketch]]
|[[Draft_PathArray|PathArray]]
|[[Draft_LinkArray|Link Array]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Draft2Sketch.svg
|IconL=Draft_PolarArray.svg
|IconR=Draft_PathArray.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
|IconR=Draft_LinkArray.svg
}}
}}


Line 130: Line 148:
{{Draft Tools navi{{#translation:}}}}
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 19:49, 7 December 2023

Draft CircularArray

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

Description

The Draft CircularArray command creates an array from a selected object by placing copies along concentric circumferences. 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 CircularArray

Usage

See also: Draft Snap.

  1. Optionally select one object.
  2. There are several ways to invoke the command:
    • Press the Circular array button.
    • Select the Modification → Array tools → Circular array option from the menu.
  3. The Circular 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 Radial distance to specify the distance between the circular layers, and between the center and the first circular layer.
  • Enter the Tangential distance to specify the distance between the elements on the same circular layer. Must be larger than zero.
  • Enter the Number of circular layers. The element at the center counts as one layer. 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 Circles property of the array.
  • Enter the Symmetry value. This number determines how the elements are distributed. A value of 3, for example, results in a pattern with three equal 120° pie segments. Larger values for the Symmetry and the Tangential distance result in fewer or even no elements on the inner layers.
  • 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 CircularArray can be turned into a Draft OrthoArray or a Draft PolarArray 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.

To create a circular 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 circular arrays is:

array = make_circular_array(base_object,
                            r_distance=100, tan_distance=50,
                            number=3, symmetry=1,
                            axis=App.Vector(0, 0, 1), 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.
  • r_distance and tan_distance are the radial and tangential distances between the elements.
  • number is the number of circular layers in the pattern, the original object counts as the first layer.
  • symmetry is an integer used in some calculations that affect the way the elements are distributed around the circumferences. Usual values are from 1 to 6. Higher values are not recommended and will make the elements in the inner layers disappear.
  • axis and center are vectors that describe the direction of the axis of rotation, and a point through which that axis passes.
  • 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)

array = Draft.make_circular_array(tri, 1800, 1200, 4, 1)
doc.recompute()