Skip to content

Latest commit

 

History

History
209 lines (102 loc) · 7.58 KB

Draft_PointArray.md

File metadata and controls

209 lines (102 loc) · 7.58 KB
Raw

Draft PointArray

Description

The Draft PointArray command creates a regular array from a selected object by placing copies at the points from a point compound. 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.

Both commands 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 PointArray*

Usage

  1. Select the object you wish to array.
  2. Add the point compound object to the selection.
  3. There are several ways to invoke the command:
    • Press the Draft PointArray 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 compound

A point compound is an object that contains one or more points. These are the supported point compounds 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

{{TitleProperty|Link}}

The properties in this group are only available for Link arrays. See Std LinkMake for more information.

  • Scale|Float

  • Scale Vector|Vector|Hidden

  • Scale List|VectorList

  • Visibility List|BoolList|Hidden

  • Placement List|PlacementList|Hidden

  • Element List|LinkList|Hidden

  • _ Link Touched|Bool|Hidden

  • _ Child Cache|LinkList|Hidden

  • Colored Elements|LinkSubHidden|Hidden

  • Link Transform|Bool

{{TitleProperty|Objects}}

  • Base|Link: specifies the object to duplicate in the array.

  • Count|Integer: (read-only) specifies the number of elements in the array. This number is determined by the number of points in the Point Object.

  • Expand 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.

  • Extra Placement|Placement: : specifies an additional placement, translation and rotation, for each element in the array. (v0.19)

  • Point Object|Link: specifies the compound object whose points are used to position the elements in the array. The object must have a Links, Components or Geometry property, and contain at least one element with X, Y, and Z properties.

View

{{TitleProperty|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.

  • Draw Style|Enumeration

  • Line Width|FloatConstraint

  • Override Material|Bool

  • Point Size|FloatConstraint

  • Selectable|Bool: this is an inherited property that appears in the Selection group for other arrays

  • Shape Material|Material

{{TitleProperty|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.

  • Child View Provider|PersistentObject|Hidden

  • Material List|MaterialList|Hidden

  • Override Color List|ColorList|Hidden

  • Override Material List|BoolList|Hidden

  • Proxy|PythonObject|Hidden: this is an inherited property.

{{TitleProperty|Display Options}}

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

  • Bounding Box|Bool: this property is not inherited by Link arrays.

  • 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}}

  • Show In Tree|Bool

  • Visibility|Bool

{{TitleProperty|Draft}}

  • Pattern|Enumeration: not used.

  • Pattern Size|Float: not used.

{{TitleProperty|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 ((v0.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_objectis the object to be arrayed. It can also be the Label (string) of an object in the current document.

  • point_objectis 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.

  • extrais 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()

documentation index > Draft > Draft PointArray