importDatumCmd.py

#!/usr/bin/env python3
# coding: utf-8
#
# LGPL
# Copyright HUBERT Zoltán
#
# importDatumCmd.py


import os

from PySide import QtGui, QtCore
import FreeCADGui as Gui
import FreeCAD as App
from FreeCAD import Console as FCC

import Asm4_libs as Asm4




"""
    +-----------------------------------------------+
    |                  The command                  |
    +-----------------------------------------------+
"""
class importDatumCmd():
    def __init__(self):
        super(importDatumCmd,self).__init__()

    def GetResources(self):
        tooltip  = "Imports the selected Datum object(s) from a sub-part into the root assembly.\n"
        tooltip += "This creates a new datum of the same type, and with the same global placement\n\n"
        tooltip += "This command can also be used to override the placement of an existing datum :\n"
        tooltip += "select a second datum in the same root container as the first selected datum"
        iconFile = os.path.join( Asm4.iconPath , 'Import_Datum.svg')
        return {"MenuText": "Import Datum object",
                "ToolTip" : tooltip,
                "Pixmap"  : iconFile }

    def IsActive(self):
        if App.ActiveDocument and self.getSelectedDatums():
            return True
        else:
            return False

    def getSelectedDatums(self):
        selection = Gui.Selection.getSelection()

        # Need to have all the selected objects to be one of the datum types
        for selObj in selection:
            if selObj.TypeId not in Asm4.datumTypes:
                return None

        return selection

    """
    +-----------------------------------------------+
    |                 the real stuff                |
    +-----------------------------------------------+
    """
    def Activated(self):
        ( selDatum, selTree ) = Asm4.getSelectionTree()
        if selTree:
            # the root parent container is the first in the selection tree
            rootContainer = App.ActiveDocument.getObject(selTree[0])
            selection = self.getSelectedDatums()
            
            # special case where 2 objects are selected in order to update the placement of the second one
            if len(selection)==2 and selection[0].getParentGeoFeatureGroup() == rootContainer:
                confirm = False
                selDatum = selection[0]
                ( targetDatum, selTree ) = Asm4.getSelectionTree(1)
                # target datum is free
                if selDatum.MapMode == 'Deactivated':
                    message = 'This will superimpose '+Asm4.labelName(selDatum)+' in '+Asm4.labelName(rootContainer)+' on:\n\n'
                    for objName in selTree[1:-1]:
                        message += '> '+objName+'\n'
                    message += '> '+Asm4.labelName(selDatum)
                    Asm4.warningBox(message)
                    confirm = True
                # selected datum is attached
                else:
                    message = Asm4.labelName(selDatum)+' in '+Asm4.labelName(rootContainer)+' is already attached to some geometry. '
                    message += 'This will superimpose its Placement on:\n\n'
                    for objName in selTree[1:-1]:
                        message += '> '+objName+'\n'
                    message += '> '+Asm4.labelName(selDatum)
                    confirm = Asm4.confirmBox(message)
                if confirm:
                    self.setupTargetDatum(selDatum, self.getDatumExpression(selTree))
                    # hide initial datum
                    targetDatum.Visibility = False
                    # select the newly created datum
                    Gui.Selection.clearSelection()
                    Gui.Selection.addSelection( App.ActiveDocument.Name, rootContainer.Name, selDatum.Name+'.' )
                    # recompute assembly
                    rootContainer.recompute(True)
                # Done with the special case, no need to continue with the normal process
                return

            # the selected datum is not deep enough
            if len(selTree)<3:
                message = selDatum.Name + ' is already at the top-level and cannot be imported'
                Asm4.warningBox(message)
                return

        # Single or Multiple selection(s) for regular case
        # Notify user that default names will be used and import all the objects
        proposedName = selTree[-2]+'_'+selDatum.Label

        if len(selection) == 1:
            message = 'Create a new '+selDatum.TypeId+' in '+Asm4.labelName(rootContainer)+' \nsuperimposed on:\n\n'
            for objName in selTree[1:]:
                message += '> '+objName+'\n'
            message += '\nEnter name for this datum :'+' '*40
            userSpecifiedName,confirm = QtGui.QInputDialog.getText(None,'Import Datum',
                    message, text = proposedName)
        else:
            message = str(len(selection)) + " selected datum objects will be imported into the root assembly\n"
            message += "with their default names such as:\n"
            message += proposedName
            confirm = Asm4.confirmBox(message)

        if confirm:
            for index in range(len(selection)):
                ( selDatum, selTree ) = Asm4.getSelectionTree(index)
                # create a new datum object
                if len(selection) == 1:
                    proposedName = userSpecifiedName
                else:
                    proposedName = selTree[-2]+'_'+selDatum.Label

                targetDatum = rootContainer.newObject(selDatum.TypeId, proposedName)
                targetDatum.Label = proposedName
                # apply existing view properties if applicable
                if hasattr(selDatum,'ResizeMode') and selDatum.ResizeMode == 'Manual':
                    targetDatum.ResizeMode = 'Manual'
                    if hasattr(selDatum,'Length'):
                        targetDatum.Length = selDatum.Length
                    if hasattr(selDatum,'Width'):
                        targetDatum.Width = selDatum.Width
                targetDatum.ViewObject.ShapeColor   = selDatum.ViewObject.ShapeColor
                targetDatum.ViewObject.Transparency = selDatum.ViewObject.Transparency

                self.setupTargetDatum(targetDatum, self.getDatumExpression(selTree))

                # hide initial datum
                selDatum.Visibility = False

            # select the last created datum
            Gui.Selection.clearSelection()
            Gui.Selection.addSelection( App.ActiveDocument.Name, rootContainer.Name, targetDatum.Name+'.' )

        # recompute assembly
        rootContainer.recompute(True)


    def setupTargetDatum(self, targetDatum, expression):
        # unset Attachment
        targetDatum.MapMode = 'Deactivated'
        targetDatum.Support = None
        # Set Asm4 properties
        Asm4.makeAsmProperties( targetDatum, reset=True )
        targetDatum.AttachedBy = 'Origin'
        targetDatum.SolverId   = 'Asm4EE'
        # set the Placement's ExpressionEngine
        targetDatum.setExpression( 'Placement', expression )
        targetDatum.Visibility = True

        # recompute the object to apply the placement:
        targetDatum.recompute()

    def getDatumExpression(self, selTree):
        # build the Placement expression
        # the first [0] object is at the document root and its Placement is ignored
        # the second [1] object gets a special treatment, it is always in the current document
        # but Groups don't have Placement properties, so we iterate until finding something.
        # Some idiot will certainly make 15 levels of Groups
        first = 1
        firstObj = App.ActiveDocument.getObject(selTree[first])
        while not hasattr(firstObj,'Placement'):
            first += 1
            firstObj = App.ActiveDocument.getObject(selTree[first])
        expression = selTree[first]+'.Placement'
        # the document where an object is
        if firstObj.isDerivedFrom('App::Link') and firstObj.LinkedObject.Document != App.ActiveDocument:
            doc = firstObj.LinkedObject.Document
        else:
            doc = App.ActiveDocument
        # parse the rest of the tree
        for objName in selTree[first+1:]:
            obj = doc.getObject(objName)
            # Groups don't have Placement properties, ignore
            if hasattr(obj,'Placement'):
                # the *previous* object was a link to doc
                if doc == App.ActiveDocument:
                    expression += ' * '+objName+'.Placement'
                else:
                    expression += ' * '+doc.Name+'#'+objName+'.Placement'
            # check whether *this* object is a link to an *external* doc
            if obj.isDerivedFrom('App::Link') and obj.LinkedObject.Document != App.ActiveDocument:
                doc = obj.LinkedObject.Document
            # else, keep the same document
            else:
                pass
        # FCC.PrintMessage('expression = '+expression+'\n')
        return expression



"""
    +-----------------------------------------------+
    |       add the command to the workbench        |
    +-----------------------------------------------+
"""
Gui.addCommand( 'Asm4_importDatum', importDatumCmd() )