Difference between revisions of "Draft CircularArray"

From FreeCAD Documentation
Jump to: navigation, search
(How to use)
(Remove {{UnfinishedDocu}})
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{UnfinishedDocu}}
 
 
<languages/>
 
<languages/>
 
<translate>
 
<translate>
Line 37: Line 36:
 
# Select an object from which you wish to make the circular array.
 
# Select an object from which you wish to make the circular array.
 
# Press the {{Button|[[File:Draft_CircularArray.svg|16px]] [[Draft_CircularArray|Circular array]]}} button. If no object is selected, the [[task_panel|task panel]] will open, but you still need to select an object to proceed.
 
# Press the {{Button|[[File:Draft_CircularArray.svg|16px]] [[Draft_CircularArray|Circular array]]}} button. If no object is selected, the [[task_panel|task panel]] will open, but you still need to select an object to proceed.
# Choose the radial distance, which determines the distance from the center of the array to the next circular layer, and between each subsequent circular layers.
+
# Choose the radial distance, which determines the distance from the center of the array to the next circular layer, and between subsequent circular layers.
# Choose the tangential distance, which determines the distance from one element in the array to the next element in the same circular layer. This distance determines how many elements will be created; if the number is small, there will be many tightly packed objects; if the number is large, there will only be a few elements. This distance cannot be zero.
+
# Choose the tangential distance, which determines the distance from one element in the array to the next element in the same circular layer. This distance determines how many elements will be in the array; if the number is small, there will be many tightly packed copies; if the number is large, there will only be a few copies. This distance cannot be zero.
 
# Choose the number of circular layers. The original object is considered one layer by itself. Minimum of 2, maximum of 99.
 
# Choose the number of circular layers. The original object is considered one layer by itself. Minimum of 2, maximum of 99.
# Choose the symmetry, which determines how the objects will be distributed in the array.
+
# Choose the symmetry number, which determines how the objects will be distributed in the array. Choose a number between 1 and 10.
 
# Choose the center of the axis of rotation. You can click on the [[3D_view|3D view]], to simultaneously set the position of the center of rotation, and complete the command.
 
# Choose the center of the axis of rotation. You can click on the [[3D_view|3D view]], to simultaneously set the position of the center of rotation, and complete the command.
 
# Optionally, check the fuse or link options.
 
# Optionally, check the fuse or link options.
Line 49: Line 48:
 
* 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.  
 
* 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.  
 
* This command creates the same object as the one created with the [[Draft_Array|Array]] and [[Draft_PolarArray|PolarArray]] tools. Therefore, the array can be converted to orthogonal, polar, or circular just by changing its properties.
 
* This command creates the same object as the one created with the [[Draft_Array|Array]] and [[Draft_PolarArray|PolarArray]] tools. Therefore, the array can be converted to orthogonal, polar, or circular just by changing its properties.
 +
 +
== Options ==
 +
 +
* Press {{Button|Reset point}} to set the center of the circular patterns to the origin {{Value|(0, 0, 0)}}.
 +
* 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.
 +
* 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.
 +
* Press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the current command.
 +
 +
== Properties ==
 +
 +
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.
 +
 +
See the [[Draft_Array|Array]] tool for the complete information.
 +
 +
== Scripting ==
 +
 +
{{Emphasis|See also:}} [[Draft API|Draft API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
 +
 +
The Array tool can be used in [[macros|macros]] and from the [[Python_console|Python console]] by using the following function.
 +
 +
</translate>
 +
{{Code|code=
 +
array_list = make_circular_array(obj, r_distance, tan_distance,
 +
                                axis, center, number, symmetry,
 +
                                use_link)
 +
}}
 +
<translate>
 +
 +
* Creates an array from the objects contained in {{incode|obj}}, which can be a single object or a list of objects.
 +
* The values of {{incode|r_distance}} and {{incode|tan_distance}} correspond to the radial and tangential distances of the elements in the array.
 +
* 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.
 +
* The value of {{incode|number}} is the number of circular layers in the circular pattern; the original object counts as the first layer.
 +
* 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.
 +
* {{incode|array_list}} is returned with the new copies.
 +
** {{incode|array_list}} is either a single object or a list of objects, depending on the input {{incode|obj}}.
 +
 +
Example:
 +
</translate>
 +
{{Code|code=
 +
import FreeCAD as App
 +
import Draft
 +
import draftobjects.circulararray as ca
 +
 +
doc = App.newDocument()
 +
 +
tri = Draft.makePolygon(3, 600)
 +
axis = App.Vector(0, 0, 1)
 +
center = App.Vector(0, 0, 0)
 +
arr = ca.make_circular_array(tri, 1800, 1200, axis, center, 4, 1)
 +
App.ActiveDocument.recompute()
 +
}}
 +
<translate>
  
 
{{Draft Tools navi}}
 
{{Draft Tools navi}}
 
{{Userdocnavi}}
 
{{Userdocnavi}}
 
</translate>
 
</translate>

Revision as of 05:21, 17 January 2020

Other languages:
English • ‎français
Arrow-left.svg Previous: Draft Draft2Sketch.svg Draft to Sketch
Next: Link Array Draft LinkArray.svg Arrow-right.svg

Draft CircularArray.svg Draft CircularArray

Menu location
Draft → Circular array
Workbenches
Draft
Default shortcut
None
Introduced in version
0.19
See also
Array, PolarArray, PathArray, PointArray, Clone


Description

The Draft CircularArray tool creates an array from a selected object placing the copies along concentric circumferences. This is like using PolarArray with a polar angle of 360 degrees, and creating several such concentric arrays.

This tool can be used on 2D shapes created with the Draft Workbench but can also be used on many types of 3D objects such as those created with the Part Workbench or PartDesign Workbench.

To position copies in a rectangular grid use Array; to position in a polar pattern use PolarArray; to position copies along a path use PathArray; to position copies at specified points use PointArray; to create copies or clones, and manually place them use Move, Rotate, and Clone.

Draft CircularArray example.png

A circular array of an object.


How to use

  1. Select an object from which you wish to make the circular array.
  2. Press the Draft CircularArray.svg Circular array button. If no object is selected, the task panel will open, but you still need to select an object to proceed.
  3. Choose the radial distance, which determines the distance from the center of the array to the next circular layer, and between subsequent circular layers.
  4. Choose the tangential distance, which determines the distance from one element in the array to the next element in the same circular layer. This distance determines how many elements will be in the array; if the number is small, there will be many tightly packed copies; if the number is large, there will only be a few copies. This distance cannot be zero.
  5. Choose the number of circular layers. The original object is considered one layer by itself. Minimum of 2, maximum of 99.
  6. Choose the symmetry number, which determines how the objects will be distributed in the array. Choose a number between 1 and 10.
  7. Choose the center of the axis of rotation. You can click on the 3D view, to simultaneously set the position of the center of rotation, and complete the command.
  8. Optionally, check the fuse or link options.
  9. Press OK to complete the command.

Notes:

  • By default, the axis of rotation is the positive Z axis (0, 0, 1). This can be changed in the property editor after the object is 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.
  • This command creates the same object as the one created with the Array and PolarArray tools. Therefore, the array can be converted to orthogonal, polar, or circular just by changing its properties.

Options

  • Press Reset point to set the center of the circular patterns to the origin (0, 0, 0).
  • If the Fuse checkbox is ticked, the resulting objects in the array will be fused into a single shape, if they touch or intersect each other.
  • If the Use Links checkbox is ticked, the resulting objects in the array will be App Links instead of simple copies. This improves the memory usage of the array, as the App Link re-uses the shape of the original object, and does not create new shapes. If this option is used, the Fuse checkbox has no effect.
  • Press Esc or the Cancel button to abort the current command.

Properties

An Array object is based on Part Feature (Part::Feature class), and thus shares all properties of the latter. In addition to the properties listed in Part Feature, the Array object has additional properties.

See the Array tool for the complete information.

Scripting

See also: Draft API and FreeCAD Scripting Basics.

The Array tool can be used in macros and from the Python console by using the following function.

array_list = make_circular_array(obj, r_distance, tan_distance,
                                 axis, center, number, symmetry,
                                 use_link)
  • Creates an array from the objects contained in obj, which can be a single object or a list of objects.
  • The values of r_distance and tan_distance correspond to the radial and tangential distances of the elements in the array.
  • The values of axis and center are vectors that describe the direction of the axis of rotation, and a point through which that axis goes.
  • The value of number is the number of circular layers in the circular pattern; the original object counts as the first layer.
  • The value of 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 use_link is True the created copies will be App Links and not regular copies.
  • array_list is returned with the new copies.
    • array_list is either a single object or a list of objects, depending on the input obj.

Example:

import FreeCAD as App
import Draft
import draftobjects.circulararray as ca

doc = App.newDocument()

tri = Draft.makePolygon(3, 600)
axis = App.Vector(0, 0, 1)
center = App.Vector(0, 0, 0)
arr = ca.make_circular_array(tri, 1800, 1200, axis, center, 4, 1)
App.ActiveDocument.recompute()