draftmake.make_pointarray Namespace Reference

Functions

def make_point_array (base_object, point_object, extra=None)
 
def makePointArray (base, ptlst)
 

Function Documentation

◆ make_point_array()

def draftmake.make_pointarray.make_point_array (   base_object,
  point_object,
  extra = None 
)
Make a Draft PointArray object.

Distribute copies of a `base_object` in the points
defined by `point_object`.

Parameters
----------
base_object: Part::Feature or str
    Any of object that has a `Part::TopoShape` that can be duplicated.
    This means most 2D and 3D objects produced with any workbench.
    If it is a string, it must be the `Label` of that object.
    Since a label is not guaranteed to be unique in a document,
    it will use the first object found with this label.

point_object: Part::Feature or str
    An object that is a type of container for holding points.
    This object must have one of the following properties `Geometry`,
    `Links`, or `Components`, which themselves must contain objects
    with `X`, `Y`, and `Z` properties.

    This object could be:

    - A `Sketcher::SketchObject`, as it has a `Geometry` property.
      The sketch can contain different elements but it must contain
      at least one `Part::GeomPoint`.

    - A `Part::Compound`, as it has a `Links` property. The compound
      can contain different elements but it must contain at least
      one object that has `X`, `Y`, and `Z` properties,
      like a `Draft Point` or a `Part::Vertex`.

    - A `Draft Block`, as it has a `Components` property. This `Block`
      behaves essentially the same as a `Part::Compound`. It must
      contain at least a point or vertex object.

extra: Base::Placement, Base::Vector3, or Base::Rotation, optional
    It defaults to `None`.
    If it is provided, it is an additional placement that is applied
    to each copy of the array.
    The input could be a full placement, just a vector indicating
    the additional translation, or just a rotation.

Returns
-------
Part::FeaturePython
    A scripted object of type `'PointArray'`.
    Its `Shape` is a compound of the copies of the original object.

None
    If there is a problem it will return `None`.

Referenced by draftmake.make_pointarray.makePointArray().

◆ makePointArray()

def draftmake.make_pointarray.makePointArray (   base,
  ptlst 
)
Create PointArray. DEPRECATED. Use 'make_point_array'.

References draftmake.make_pointarray.make_point_array().