src/Mod/Draft/draftmake/make_orthoarray.py

# SPDX-License-Identifier: LGPL-2.1-or-later

# ***************************************************************************
# *   (c) 2020 Eliud Cabrera Castillo <e.cabrera-castillo@tum.de>           *
# *                                                                         *
# *   This file is part of the FreeCAD CAx development system.              *
# *                                                                         *
# *   This program is free software; you can redistribute it and/or modify  *
# *   it under the terms of the GNU Lesser General Public License (LGPL)    *
# *   as published by the Free Software Foundation; either version 2 of     *
# *   the License, or (at your option) any later version.                   *
# *   for detail see the LICENCE text file.                                 *
# *                                                                         *
# *   FreeCAD is distributed in the hope that it will be useful,            *
# *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
# *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
# *   GNU Library General Public License for more details.                  *
# *                                                                         *
# *   You should have received a copy of the GNU Library General Public     *
# *   License along with FreeCAD; if not, write to the Free Software        *
# *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
# *   USA                                                                   *
# *                                                                         *
# ***************************************************************************
"""Provides functions to create orthogonal 2D and 3D Array objects."""
## @package make_orthoarray
# \ingroup draftmake
# \brief Provides functions to create orthogonal 2D and 3D Arrays.

## \addtogroup draftmake
# @{
import FreeCAD as App
import draftutils.utils as utils
import draftmake.make_array as make_array

from draftutils.messages import _wrn, _err
from draftutils.translate import translate


def _make_ortho_array(
    base_object,
    v_x=App.Vector(10, 0, 0),
    v_y=App.Vector(0, 10, 0),
    v_z=App.Vector(0, 0, 10),
    n_x=2,
    n_y=2,
    n_z=1,
    use_link=True,
):
    """Create an orthogonal array from the given object.

    This is a simple wrapper of the `draftmake.make_array.make_array`
    function to be used by the different orthogonal arrays.

    - `make_ortho_array`
    - `make_ortho_array2d`, no Z direction
    - `make_rect_array`, strictly rectangular
    - `make_rect_array2d`, strictly rectangular, no Z direction

    This function has no error checking, nor does it display messages.
    This should be handled by the subfunctions that use this one.
    """
    _name = "_make_ortho_array"

    new_obj = make_array.make_array(
        base_object, arg1=v_x, arg2=v_y, arg3=v_z, arg4=n_x, arg5=n_y, arg6=n_z, use_link=use_link
    )
    return new_obj


def _are_vectors(v_x, v_y, v_z=None, name="Unknown"):
    """Check that the vectors are numbers."""
    try:
        if v_z:
            utils.type_check(
                [
                    (v_x, (int, float, App.Vector)),
                    (v_y, (int, float, App.Vector)),
                    (v_z, (int, float, App.Vector)),
                ],
                name=name,
            )
        else:
            utils.type_check(
                [(v_x, (int, float, App.Vector)), (v_y, (int, float, App.Vector))], name=name
            )
    except TypeError:
        _err(translate("draft", "Wrong input: must be a number or vector."))
        return False, v_x, v_y, v_z

    if not isinstance(v_x, App.Vector):
        v_x = App.Vector(v_x, 0, 0)
        _wrn(translate("draft", "Input: single value expanded to vector."))
    if not isinstance(v_y, App.Vector):
        v_y = App.Vector(0, v_y, 0)
        _wrn(translate("draft", "Input: single value expanded to vector."))
    if v_z and not isinstance(v_z, App.Vector):
        v_z = App.Vector(0, 0, v_z)
        _wrn(translate("draft", "Input: single value expanded to vector."))

    return True, v_x, v_y, v_z


def _are_integers(n_x, n_y, n_z=None, name="Unknown"):
    """Check that the numbers are integers, with minimum value of 1."""
    try:
        if n_z:
            utils.type_check([(n_x, int), (n_y, int), (n_z, int)], name=name)
        else:
            utils.type_check([(n_x, int), (n_y, int)], name=name)
    except TypeError:
        _err(translate("draft", "Wrong input: must be an integer number."))
        return False, n_x, n_y, n_z

    if n_x < 1:
        _wrn(translate("draft", "Input: number of elements must be at least 1. It is set to 1."))
        n_x = 1
    if n_y < 1:
        _wrn(translate("draft", "Input: number of elements must be at least 1. It is set to 1."))
        n_y = 1
    if n_z and n_z < 1:
        _wrn(translate("draft", "Input: number of elements must be at least 1. It is set to 1."))
        n_z = 1

    return True, n_x, n_y, n_z


def _are_numbers(d_x, d_y, d_z=None, name="Unknown"):
    """Check that the numbers are numbers."""
    try:
        if d_z:
            utils.type_check(
                [(d_x, (int, float)), (d_y, (int, float)), (d_z, (int, float))], name=name
            )
        else:
            utils.type_check([(d_x, (int, float)), (d_y, (int, float))], name=name)
    except TypeError:
        _err(translate("draft", "Wrong input: must be a number."))
        return False, d_x, d_y, d_z

    return True, d_x, d_y, d_z


def _find_object_in_doc(base_object, doc=None):
    """Check that a document is available and the object exists."""
    found, base_object = utils.find_object(base_object, doc=doc)
    if not found:
        _err(translate("draft", "Wrong input: base_object not in document."))

    return found, base_object


def make_ortho_array(
    base_object,
    v_x=App.Vector(10, 0, 0),
    v_y=App.Vector(0, 10, 0),
    v_z=App.Vector(0, 0, 10),
    n_x=2,
    n_y=2,
    n_z=1,
    use_link=True,
):
    """Create an orthogonal array from the given 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.

    v_x, v_y, v_z: Base::Vector3, optional
        The vector indicating the vector displacement between two elements
        in the specified orthogonal direction X, Y, Z.

        By default:
        ::
            v_x = App.Vector(10, 0, 0)
            v_y = App.Vector(0, 10, 0)
            v_z = App.Vector(0, 0, 10)

        Given that this is a vectorial displacement
        the next object can appear displaced in one, two or three axes
        at the same time.

        For example
        ::
            v_x = App.Vector(10, 5, 0)

        means that the next element in the X direction will be displaced
        10 mm in X, 5 mm in Y, and 0 mm in Z.

        A traditional "rectangular" array is obtained when
        the displacement vector only has its corresponding component,
        like in the default case.

        If these values are entered as single numbers instead
        of vectors, the single value is expanded into a vector
        of the corresponding direction, and the other components are assumed
        to be zero.

        For example
        ::
            v_x = 15
            v_y = 10
            v_z = 1
        becomes
        ::
            v_x = App.Vector(15, 0, 0)
            v_y = App.Vector(0, 10, 0)
            v_z = App.Vector(0, 0, 1)

    n_x, n_y, n_z: int, optional
        The number of copies in the specified orthogonal direction X, Y, Z.
        This number includes the original object, therefore, it must be
        at least 1.

        The values of `n_x` and `n_y` default to 2,
        while `n_z` defaults to 1.
        This means the array is a planar array by default.

    use_link: bool, optional
        It defaults to `True`.
        If it is `True` the produced copies are not `Part::TopoShape` copies,
        but rather `App::Link` objects.
        The Links repeat the shape of the original `base_object` exactly,
        and therefore the resulting array is more memory efficient.

        Also, when `use_link` is `True`, the `Fuse` property
        of the resulting array does not work; the array doesn't
        contain separate shapes, it only has the original shape repeated
        many times, so there is nothing to fuse together.

        If `use_link` is `False` the original shape is copied many times.
        In this case the `Fuse` property is able to fuse
        all copies into a single object, if they touch each other.

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

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

    See Also
    --------
    make_ortho_array2d, make_rect_array, make_rect_array2d, make_polar_array,
    make_circular_array, make_path_array, make_point_array
    """
    _name = "make_ortho_array"

    found, base_object = _find_object_in_doc(base_object, doc=App.activeDocument())
    if not found:
        return None

    ok, v_x, v_y, v_z = _are_vectors(v_x, v_y, v_z, name=_name)
    if not ok:
        return None

    ok, n_x, n_y, n_z = _are_integers(n_x, n_y, n_z, name=_name)
    if not ok:
        return None

    use_link = bool(use_link)

    new_obj = _make_ortho_array(
        base_object, v_x=v_x, v_y=v_y, v_z=v_z, n_x=n_x, n_y=n_y, n_z=n_z, use_link=use_link
    )
    return new_obj


def make_ortho_array2d(
    base_object, v_x=App.Vector(10, 0, 0), v_y=App.Vector(0, 10, 0), n_x=2, n_y=2, use_link=True
):
    """Create a 2D orthogonal array from the given object.

    This works the same as `make_ortho_array`.
    The Z component is ignored so it only considers vector displacements
    in X and Y directions.

    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.

    v_x, v_y: Base::Vector3, optional
        Vectorial displacement of elements
        in the corresponding X and Y directions.
        See `make_ortho_array`.

    n_x, n_y: int, optional
        Number of elements
        in the corresponding X and Y directions.
        See `make_ortho_array`.

    use_link: bool, optional
        If it is `True`, create `App::Link` array.
        See `make_ortho_array`.

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

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

    See Also
    --------
    make_ortho_array, make_rect_array, make_rect_array2d, make_polar_array,
    make_circular_array, make_path_array, make_point_array
    """
    _name = "make_ortho_array2d"

    found, base_object = _find_object_in_doc(base_object, doc=App.activeDocument())
    if not found:
        return None

    ok, v_x, v_y, __ = _are_vectors(v_x, v_y, v_z=None, name=_name)
    if not ok:
        return None

    ok, n_x, n_y, __ = _are_integers(n_x, n_y, n_z=None, name=_name)
    if not ok:
        return None

    use_link = bool(use_link)

    new_obj = _make_ortho_array(base_object, v_x=v_x, v_y=v_y, n_x=n_x, n_y=n_y, use_link=use_link)
    return new_obj


def make_rect_array(base_object, d_x=10, d_y=10, d_z=10, n_x=2, n_y=2, n_z=1, use_link=True):
    """Create a rectangular array from the given object.

    This function wraps around `make_ortho_array`
    to produce strictly rectangular arrays, in which
    the displacement vectors `v_x`, `v_y`, and `v_z`
    only have their respective components in X, Y, and Z.

    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.

    d_x, d_y, d_z: Base::Vector3, optional
        Displacement of elements in the corresponding X, Y, and Z directions.

    n_x, n_y, n_z: int, optional
        Number of elements in the corresponding X, Y, and Z directions.

    use_link: bool, optional
        If it is `True`, create `App::Link` array.
        See `make_ortho_array`.

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

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

    See Also
    --------
    make_ortho_array, make_ortho_array2d, make_rect_array2d, make_polar_array,
    make_circular_array, make_path_array, make_point_array
    """
    _name = "make_rect_array"

    found, base_object = _find_object_in_doc(base_object, doc=App.activeDocument())
    if not found:
        return None

    ok, d_x, d_y, d_z = _are_numbers(d_x, d_y, d_z, name=_name)
    if not ok:
        return None

    ok, n_x, n_y, n_z = _are_integers(n_x, n_y, n_z, _name)
    if not ok:
        return None

    use_link = bool(use_link)

    new_obj = _make_ortho_array(
        base_object,
        v_x=App.Vector(d_x, 0, 0),
        v_y=App.Vector(0, d_y, 0),
        v_z=App.Vector(0, 0, d_z),
        n_x=n_x,
        n_y=n_y,
        n_z=n_z,
        use_link=use_link,
    )
    return new_obj


def make_rect_array2d(base_object, d_x=10, d_y=10, n_x=2, n_y=2, use_link=True):
    """Create a 2D rectangular array from the given object.

    This function wraps around `make_ortho_array`,
    to produce strictly rectangular arrays, in which
    the displacement vectors `v_x` and `v_y`
    only have their respective components in X and Y.
    The Z component is ignored.

    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.

    d_x, d_y: Base::Vector3, optional
        Displacement of elements in the corresponding X and Y directions.

    n_x, n_y: int, optional
        Number of elements in the corresponding X and Y directions.

    use_link: bool, optional
        If it is `True`, create `App::Link` array.
        See `make_ortho_array`.

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

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

    See Also
    --------
    make_ortho_array, make_ortho_array2d, make_rect_array, make_polar_array,
    make_circular_array, make_path_array, make_point_array
    """
    _name = "make_rect_array2d"

    found, base_object = _find_object_in_doc(base_object, doc=App.activeDocument())
    if not found:
        return None

    ok, d_x, d_y, __ = _are_numbers(d_x, d_y, d_z=None, name=_name)
    if not ok:
        return None

    ok, n_x, n_y, __ = _are_integers(n_x, n_y, n_z=None, name=_name)
    if not ok:
        return None

    use_link = bool(use_link)

    new_obj = _make_ortho_array(
        base_object,
        v_x=App.Vector(d_x, 0, 0),
        v_y=App.Vector(0, d_y, 0),
        n_x=n_x,
        n_y=n_y,
        use_link=use_link,
    )
    return new_obj


## @}