Draft PointArray: Difference between revisions

From FreeCAD Documentation
(To position copies along a path use PathArray or PathLinkArray)
No edit summary
 
(51 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:21-->
<!--T:21-->
{{Docnav
{{Docnav
|[[Draft_PathLinkArray|PathLinkArray]]
|[[Draft_PathArray|Path Array]]
|[[Draft_PointLinkArray|PointLinkArray]]
|[[Draft_Clone|Clone]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_PathArray.svg
|IconL=Draft_PathLinkArray.svg
|IconR=Draft_PointLinkArray.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
|IconR=Draft_Clone.svg
}}
}}


Line 14: Line 15:
{{GuiCommand
{{GuiCommand
|Name=Draft PointArray
|Name=Draft PointArray
|MenuLocation=Modification → Array tools → Point array
|Icon=Draft_PointArray.svg
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|MenuLocation=Draft → PointArray
|Version=0.18
|Version=0.18
|SeeAlso=[[Draft_OrthoArray|OrthoArray]], [[Draft_PolarArray|PolarArray]], [[Draft_CircularArray|CircularArray]], [[Draft_PathArray|PathArray]]
|SeeAlso=[[Draft_OrthoArray|Draft OrthoArray]], [[Draft_PolarArray|Draft PolarArray]], [[Draft_CircularArray|Draft CircularArray]], [[Draft_PathArray|Draft PathArray]], [[Draft_PathLinkArray|Draft PathLinkArray]], [[Draft_PointLinkArray|Draft PointLinkArray]]
}}
}}


Line 24: Line 24:


<!--T:3-->
<!--T:3-->
The [[Image:Draft_PointArray.svg|24px]] '''Draft PointArray''' command creates a regular array from a selected base object by placing copies at the points from a point object. Use the [[Draft_PointLinkArray|Draft PointLinkArray]] 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_PointLinkArray|Draft PointLinkArray]] command is identical to this command.
The {{Button|[[Image:Draft_PointArray.svg|16px]] [[Draft PointArray|Draft PointArray]]}} tool places copies of a selected shape along various selected points.


<!--T:15-->
<!--T:15-->
The PointArray 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]].
The base object can be a 2D object created with the [[Draft_Workbench|Draft Workbench]] or [[Sketcher_Workbench|Sketcher Workbench]], but also a 3D object such as those created with the [[Part_Workbench|Part Workbench]], [[PartDesign_Workbench|PartDesign Workbench]] or [[Arch_Workbench|Arch Workbench]].


<!--T:16-->
<!--T:53-->
The point object can be any object with a shape and vertices (including a [[Std_Part|Std Part]] containing one or more of such objects), as well as a [[Mesh_Workbench|mesh]] and a [[Points_Workbench|point cloud]]. Duplicate points in the point object are filtered out. {{Version|0.21}}
* 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 copies along a path use {{Button|[[File:Draft_PathArray.svg|16px]] [[Draft_PathArray|PathArray]]}} or {{Button|[[File:Draft_PathLinkArray.svg|16px]] [[Draft_PathLinkArray|PathLinkArray]]}}.
<!--T:54-->
* 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]]}}.
In {{VersionMinus|0.20}} only three point object types are supported see [[#Point_object_version_0.20_and_below|Point object version 0.20 and below]].
* 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>
Line 39: Line 39:
<translate>
<translate>
<!--T:17-->
<!--T:17-->
{{Caption|Object arranged at specific points}}
{{Caption|Draft PointArray}}


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


<!--T:5-->
<!--T:5-->
# Select the object that you wish to distribute.
# Select the object you wish to array.
# Select a point compound.
# Add the point object to the selection.
# There are several ways to invoke the command:
# Press the {{Button|[[Image:Draft_PointArray.svg|16px]] [[Draft_PointArray|PointArray]]}} button.
#* Press the {{Button|[[Image:Draft_PointArray.svg|16px]] [[Draft_PointArray|Point array]]}} button.
#* Select the {{MenuCommand|Modification → Array tools → [[Image:Draft_PointArray.svg|16px]] Point array}} option from the menu.
# The array is created.
# Optionally change the [[#Properties|properties]] of the array in the [[property_editor|Property editor]].


== Point object version 0.20 and below == <!--T:55-->
<!--T:19-->
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.

=== Point compound === <!--T:24-->


<!--T:18-->
<!--T:18-->
These are the supported point objects in {{VersionMinus|0.20}} and how they can be created:
The point compound object can be created in different ways.
* Create various {{Button|[[File:Draft_Point.svg|16px]] [[Draft_Point|Draft Points]]}} or {{Button|[[File:Part_Point.svg|16px]] [[Part_Point|Part Points]]}}, and then press {{Button|[[File:Part_Compound.svg|16px]] [[Part_Compound|Part Compound]]}} to create the compound.
* [[Part_Compound|Part Compound]]: Create one or more [[Draft_Point|Draft Points]] or [[Part_Point|Part Points]], select them and invoke the [[Part_Compound|Part Compound]] command.
* Repeat the previous method but instead of a compound use {{Button|[[Image:Draft_Upgrade.svg|16px]] [[Draft_Upgrade|Draft Upgrade]]}} to create a "Block".
* Draft Block: Create one or more [[Draft_Point|Draft Points]] or [[Part_Point|Part Points]], select them and invoke the [[Draft_Upgrade|Draft Upgrade]] command.
* Create a {{Button|[[File:Sketcher_NewSketch.svg|16px]] [[Sketch|Sketch]]}}, and inside add various {{Button|[[File:Sketcher_CreatePoint.svg|16px]] [[Sketcher_CreatePoint|Sketcher Points]]}}.
* [[Sketcher_NewSketch|Sketcher Sketch]]: Create a [[Sketcher_NewSketch|Sketch]] and add one or more [[Sketcher_CreatePoint|Sketcher Points]] to the sketch.


<!--T:25-->
==Properties== <!--T:8-->
In essence, the object to be used as the compound must have one of three properties, {{PropertyData|Components}}, {{PropertyData|Links}}, or {{PropertyData|Geometry}}, and inside that compound, there must be at least one point with {{PropertyData|X}}, {{PropertyData|Y}}, and {{PropertyData|Z}} properties.


<!--T:26-->
<!--T:34-->
See also: [[property_editor|Property editor]].
{{Emphasis|Note:}} in the case of {{Button|[[File:Draft_Point.svg|16px]] [[Draft_Point|Draft Point]]}} and {{Button|[[File:Part_Point.svg|16px]] [[Part_Point|Part Point]]}} the array will try to position the copies using the {{PropertyData|Placement}} of the point. In the case of a {{Button|[[File:Sketcher_CreatePoint.svg|16px]] [[Sketcher_CreatePoint|Sketcher Point]]}}, the position will be taken from its internal {{incode|X}}, {{incode|Y}}, and {{incode|Z}} attributes.


<!--T:27-->
<!--T:28-->
A Draft PointArray 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:
{{Emphasis|Note 2:}} for {{Button|[[File:Draft_Point.svg|16px]] [[Draft_Point|Draft Point]]}} its {{PropertyData|Placement}} always follows the values of {{PropertyData|X}}, {{PropertyData|Y}}, {{PropertyData|Z}}, so modifying these values is enough to produce the desired displacement. However, for {{Button|[[File:Part_Point.svg|16px]] [[Part_Point|Part Point]]}}, the net displacement is given by the sum of {{PropertyData|Placement}} with the vector with components {{PropertyData|X}}, {{PropertyData|Y}}, and {{PropertyData|Z}}.


==Options== <!--T:6-->
===Data=== <!--T:35-->


<!--T:7-->
<!--T:36-->
{{TitleProperty|Link}}
There are no options for this tool. Either it works with the selected objects or not.


==Properties== <!--T:8-->
<!--T:37-->
The properties in this group are only available for Link arrays. See [[Std_LinkMake#Properties|Std LinkMake]] for more information.


<!--T:28-->
<!--T:38-->
* {{PropertyData|Scale|Float}}
A [[Draft_PointArray|PointArray]] 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 PointArray has the following properties in the [[property editor|property editor]].
* {{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}}


<!--T:9-->
<!--T:31-->
{{TitleProperty|Objects}}
{{TitleProperty|Objects}}
* {{PropertyData|Base|Link}}: the object to duplicate; it must have a [[Part_TopoShape|Part TopoShape]].
* {{PropertyData|Count|Integer}}: (read-only) specifies the number of copies in the array. This property is read-only because the number of copies is determined by the number of points inside of {{PropertyData|Point Object}}.
* {{PropertyData|Extra Placement|Placement}}: specifies an additional [[Placement|placement]], translation and rotation, that will be applied to each copy in the array. Each copy normally appears with the same rotation as the {{PropertyData|Base}} object; with this property it is possible to provide additional rotation, or counter the original rotation, and make small adjustments to the position of the copies. {{Version|0.19}}
* {{PropertyData|Point Object|Link}}: specifies a compound object with points that indicate where the copies of the {{PropertyData|Base}} object will appear. The compound object needs to have one of {{PropertyData|Links}}, {{PropertyData|Components}}, or {{PropertyData|Geometry}} properties, and contain at least one element with {{PropertyData|X}}, {{PropertyData|Y}}, and {{PropertyData|Z}} attributes.


==Scripting== <!--T:10-->
<!--T:9-->
* {{PropertyData|Base|Link}}: specifies the object to duplicate in the array.
{{Emphasis|See also:}} [[Draft API|Draft API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
* {{PropertyData|Count|Integer}}: (read-only) specifies the number of elements in the array. This number is determined by the number of points in the {{PropertyData|Point Object}}.
* {{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|Extra Placement|Placement}}: : specifies an additional [[Placement|placement]], translation and rotation, for each element in the array.
* {{PropertyData|Fuse|Bool}}: specifies if overlapping elements in the array are fused or not. Not used for Link arrays. {{Version|0.22}}
* {{PropertyData|Point Object|Link}}: specifies the object whose points are used to position the elements in the array.

===View=== <!--T:39-->

<!--T:40-->
{{TitleProperty|Link}}

<!--T:41-->
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.

<!--T:42-->
* {{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}}

<!--T:43-->
{{TitleProperty|Base}}

<!--T:44-->
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.

<!--T:45-->
* {{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.

<!--T:46-->
{{TitleProperty|Display Options}}

<!--T:47-->
The properties in this group are inherited properties. See [[Part_Feature#Properties|Part Feature]] for more information.

<!--T:48-->
* {{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}}

<!--T:49-->
{{TitleProperty|Draft}}

<!--T:50-->
* {{PropertyView|Pattern|Enumeration}}: not used.
* {{PropertyView|Pattern Size|Float}}: not used.

<!--T:51-->
{{TitleProperty|Object style}}

<!--T:52-->
The properties in this group are not inherited by Link arrays.

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

<!--T:10-->
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].


<!--T:11-->
<!--T:11-->
To create a point array use the {{incode|make_point_array}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makePointArray}} method.
The PointArray tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:


<!--T:29-->
Older call
</translate>
</translate>
{{Code|code=
{{Code|code=
point_array = makePointArray(base_object, point_object)
point_array = make_point_array(base_object, point_object, extra=None, use_link=True)
}}
<translate>

<!--T:30-->
New call
</translate>
{{Code|code=
point_array = make_point_array(base_object, point_object, extra=None):
}}
}}
<translate>
<translate>


<!--T:12-->
<!--T:12-->
* Creates a {{incode|"PointArray"}} object from the {{incode|base_object}}, by placing the copies in the points contained within {{incode|point_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|point_object}} should have one of {{incode|Geometry}}, {{incode|Links}}, or {{incode|Components}} attributes containing points.
* {{incode|point_object}} is the object containing the points. It can also be the {{incode|Label}} (string) of an object in the current document. It should have a {{incode|Geometry}}, {{incode|Links}}, or {{incode|Components}} property containing points.
** Instead of a reference to an object, {{incode|base_object}} and {{incode|point_object}} can also be {{incode|Labels}} (strings) of objects existing in the current document.
* {{incode|extra}} is an {{incode|App.Placement}}, an {{incode|App.Vector}} or an {{incode|App.Rotation}} that displaces each element.
** {{incode|extra}} can be a full {{incode|App.Placement}}, or just an {{incode|App.Vector}} or {{incode|App.Rotation}}.
* If {{incode|use_link}} is {{incode|True}} the created elements are [[App_Link|App Links]] instead of regular copies.


<!--T:13-->
<!--T:13-->
Example:
Example:

</translate>
</translate>
{{Code|code=
{{Code|code=
Line 135: Line 196:
}}
}}
<translate>
<translate>



<!--T:20-->
<!--T:20-->
{{Docnav
{{Docnav
|[[Draft_PathLinkArray|PathLinkArray]]
|[[Draft_PathArray|Path Array]]
|[[Draft_PointLinkArray|PointLinkArray]]
|[[Draft_Clone|Clone]]
|[[Draft_Module|Draft]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_PathArray.svg
|IconL=Draft_PathLinkArray.svg
|IconR=Draft_PointLinkArray.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
|IconR=Draft_Clone.svg
}}
}}


Line 149: Line 211:
{{Draft Tools navi{{#translation:}}}}
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 09:05, 28 March 2024

Draft PointArray

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

Description

The Draft PointArray command creates a regular array from a selected base object by placing copies at the points from a point object. Use the Draft PointLinkArray 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 PointLinkArray command is identical to this command.

The base object can be a 2D object created with the Draft Workbench or Sketcher Workbench, but also a 3D object such as those created with the Part Workbench, PartDesign Workbench or Arch Workbench.

The point object can be any object with a shape and vertices (including a Std Part containing one or more of such objects), as well as a mesh and a point cloud. Duplicate points in the point object are filtered out. introduced in version 0.21

In version 0.20 and below only three point object types are supported see Point object version 0.20 and below.

Draft PointArray

Usage

  1. Select the object you wish to array.
  2. Add the point object to the selection.
  3. There are several ways to invoke the command:
    • Press the Point array button.
    • Select the Modification → Array tools → Point array option from the menu.
  4. The array is created.
  5. Optionally change the properties of the array in the Property editor.

Point object version 0.20 and below

These are the supported point objects in version 0.20 and below and how they can be created:

Properties

See also: Property editor.

A Draft PointArray 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.

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

Objects

  • DataBase (Link): specifies the object to duplicate in the array.
  • DataCount (Integer): (read-only) specifies the number of elements in the array. This number is determined by the number of points in the DataPoint Object.
  • DataExpand 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.
  • DataExtra Placement (Placement): : specifies an additional placement, translation and rotation, for each element in the array.
  • DataFuse (Bool): specifies if overlapping elements in the array are fused or not. Not used for Link arrays. introduced in version 0.22
  • DataPoint Object (Link): specifies the object whose points are used to position the elements in the array.

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.

  • ViewDraw Style (Enumeration)
  • ViewLine Width (FloatConstraint)
  • ViewOverride Material (Bool)
  • ViewPoint Size (FloatConstraint)
  • ViewSelectable (Bool): this is an inherited property that appears in the Selection group for other arrays
  • ViewShape 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.

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

Display Options

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

  • ViewBounding Box (Bool): this property is not inherited by Link arrays.
  • ViewDisplay Mode (Enumeration): for Link arrays it can be Link or ChildView. For other arrays it can be: Flat Lines, Shaded, Wireframe or Points
  • ViewShow In Tree (Bool)
  • ViewVisibility (Bool)

Draft

  • ViewPattern (Enumeration): not used.
  • ViewPattern 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 point array use the make_point_array method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makePointArray method.

point_array = make_point_array(base_object, point_object, extra=None, 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.
  • point_object is the object containing the points. It can also be the Label (string) of an object in the current document. It should have a Geometry, Links, or Components property containing points.
  • extra is an App.Placement, an App.Vector or an App.Rotation that displaces each element.
  • If use_link is True the created elements are App Links instead of regular copies.

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

polygon = Draft.make_polygon(3, radius=500.0)

p1 = Draft.make_point(App.Vector(1500, 0, 0))
p2 = Draft.make_point(App.Vector(2500, 0, 0))
p3 = Draft.make_point(App.Vector(2000, 1000, 0))

compound = doc.addObject("Part::Compound", "Compound")
compound.Links = [p1, p2, p3]

point_array = Draft.make_point_array(polygon, compound)
doc.recompute()