ObjectsAplan.py

# ***************************************************************************
# *                                                                         *
# *   Copyright (c) 2016 Bernd Hahnebach <bernd@bimstatik.org>              *
# *   Copyright (c) 2021 Martijn Cramer <martijn.cramer@outlook.com>        *
# *                                                                         *
# *   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.                                 *
# *                                                                         *
# *   This program 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 this program; if not, write to the Free Software   *
# *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
# *   USA                                                                   *
# *                                                                         *
# ***************************************************************************

__title__ = "Objects APLAN"
__author__ = "Martijn Cramer, Bernd Hahnebach"
__url__ = "https://www.freecadweb.org"

# \addtogroup APLAN
#  @{

import FreeCAD
from aplansolvers.aplan_obstruction_detectors import base_obstruction_detector as base
try:
    import typing
except ImportError as ie:
    print("Missing dependency! Please install the following Python module: {}".format(str(ie.name or "")))


# ********* analysis objects ************************************************
def makeAnalysis(doc, name="Analysis"):
    """makeAnalysis(document, [name]):
    makes an APLAN analysis object"""
    obj = doc.addObject("Aplan::AplanAnalysis", name)
    return obj


# ********* constraint objects **********************************************
def makeCompound(analysis, components: typing.List, name="Compound"):
    """makeCompound(analysis, components, [name]):
    makes an APLAN Compound object"""
    import aplanobjects.compound
    obj = aplanobjects.compound.create(FreeCAD.ActiveDocument, analysis, components, name)
    return obj


def makeCompoundGroup(doc, name="Compounds"):
    """makeCompoundGroup(document, [name]):
    makes an APLAN compound group object"""
    obj = doc.addObject("Aplan::AplanCompoundGroup", name)
    return obj


def makeConstraintGroup(doc, name="Constraints"):
    """makeConstraintGroup(document, [name]):
    makes an APLAN constraint group object"""
    obj = doc.addObject("Aplan::AplanConstraintGroup", name)
    return obj


def makePartFilter(doc, name="PartFilter"):
    """makePartFilter(document, [name]):
    makes an APLAN PartFilter object"""
    import aplanobjects.part_filter
    obj = aplanobjects.part_filter.create(doc, name)
    return obj


# ********* Connection detection objects **********************************************
def makeConnectionDetectorSwellOCCT(doc, name="ConnectDetector"):
    """makeConnectionDetectorSwellOCCT(document, [name]):
    makes an APLAN SwellOCCT ConnectionDetector object"""
    from aplansolvers.aplan_connection_detectors import swell_occt
    obj = swell_occt.create(doc, name)
    return obj


def makeTopoConstraints(analysis, constraints: typing.Set[typing.Tuple[str, str]] = set(), name="TopoConstraints"):
    """makeTopoConstraints(analysis, [constraints], [name]):
    makes an APLAN TopoConstraints object"""
    import aplanobjects.topo_constraints
    obj = aplanobjects.topo_constraints.create(
        FreeCAD.ActiveDocument, analysis, constraints, name)
    return obj


# ********* Obstruction detection objects **********************************************
def makeObstructionDetectorOCCT(doc, name="ObstructDetector"):
    """makeObstructionDetectorOCCT(document, [name]):
    ..."""
    from aplansolvers.aplan_obstruction_detectors import occt
    obj = occt.create(doc, name)
    return obj


def makeGeomConstraints(analysis, motionDirection: base.IMotionDirection = base.UndefMotionDirection.UNDEF, 
                        constraints: typing.Set[typing.Tuple[str, str]] = set(), name = None):
    """makeGeomConstraints(analysis, [motionDirection], [constraints], [name]):
    makes an APLAN GeomConstraints object"""
    import aplanobjects.geom_constraints
    obj = aplanobjects.geom_constraints.create(
        FreeCAD.ActiveDocument, analysis, motionDirection, constraints, 
        name or "GeomConstraints_{}".format(motionDirection.name))
    return obj