Cell.py

Go to the documentation of this file.

#***************************************************************************
#*                                                                         *
#*   Copyright (c) 2011                                                    *  
#*   Yorik van Havre <yorik@uncreated.net>                                 *  
#*                                                                         *
#*   This program is free software; you can redistribute it and/or modify  *
#*   it under the terms of the GNU General Public License (GPL)            *
#*   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                                                                   *
#*                                                                         *
#***************************************************************************

import FreeCAD,FreeCADGui,Part,Draft
from FreeCAD import Vector
from PyQt4 import QtCore

__title__="FreeCAD Cell"
__author__ = "Yorik van Havre"
__url__ = "http://free-cad.sourceforge.net"

def makeCell(objectslist,join=True,name="Cell"):
    '''makeCell(objectslist,[joinmode]): creates a cell including the
    objects from the given list. If joinmode is False, contents will
    not be joined.'''
    obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython",name)
    Cell(obj)
    ViewProviderCell(obj.ViewObject)
    obj.Components = objectslist
    for comp in obj.Components:
        comp.ViewObject.hide()
    obj.JoinMode = join
    return obj

class CommandCell:
    "the Arch Cell command definition"
    def GetResources(self):
        return {'Pixmap'  : 'Arch_Cell',
                'MenuText': QtCore.QT_TRANSLATE_NOOP("Arch_Cell","Cell"),
                'Accel': "C, E",
                'ToolTip': QtCore.QT_TRANSLATE_NOOP("Arch_Cell","Creates a cell object including selected objects")}
        
    def Activated(self):
        FreeCAD.ActiveDocument.openTransaction("Cell")
        makeCell(FreeCADGui.Selection.getSelection())
        FreeCAD.ActiveDocument.commitTransaction()

class Cell:
    "The Cell object"
    def __init__(self,obj):
        obj.addProperty("App::PropertyLinkList","Components","Base",
                        "The objects that make part of this cell")
        obj.addProperty("App::PropertyBool","JoinMode","Base",
                        "If True, underlying geometry will be joined")
        obj.Proxy = self
        self.Type = "Cell"
        
    def execute(self,obj):
        self.createGeometry(obj)
        
    def onChanged(self,obj,prop):
        if prop in ["Components","JoinMode"]:
            self.createGeometry(obj)

    def createGeometry(self,obj):
        pl = obj.Placement
        if obj.Components:
            if obj.JoinMode:
                components = obj.Components[:]
                f = components.pop(0)
                baseShape = f.Shape
                for comp in components:
                    if Draft.getType(comp) in ["Wall","Cell","Shape"]:
                        baseShape = baseShape.oldFuse(comp.Shape)
            else:
                compshapes = []
                for o in obj.Components:
                    compshapes.append(o.Shape)
                baseShape = Part.makeCompound(compshapes)
            obj.Shape = baseShape
            obj.Placement = pl

class ViewProviderCell:
    "A View Provider for the Cell object"
    def __init__(self,vobj):
        vobj.Proxy = self
        self.Object = vobj.Object

    def getIcon(self):
        return """
                /* XPM */
                static char * Arch_Cell_xpm[] = {
                "16 16 9 1",
                "       c None",
                ".      c #0C0A04",
                "+      c #413F37",
                "@      c #636057",
                "#      c #7E7D75",
                "$      c #9C9B95",
                "%      c #B7B8B3",
                "&      c #D2D4D1",
                "*      c #FCFEFB",
                "        +++     ",
                "    ++#++@$+    ",
                " +@$%**@%#@++++ ",
                " #&**%*@%%%$@+##",
                " #&%@@*@%$@+@&*%",
                " #&% @*@$@@%***%",
                " #&% @*@+@#****%",
                " #&%.@*@+@#****%",
                " #&%$&*@+@#****%",
                ".@&****@+@#****%",
                " @&***&@+@#****%",
                " @&**$  .@#****%",
                " @&%#    @#****#",
                " +@      @#**&  ",
                "         @#*$   ",
                "         @@#    "};
                """
       
    def updateData(self,obj,prop):
        return

    def onChanged(self,vobj,prop):
        return

    def claimChildren(self):
        return self.Object.Components

    def attach(self,vobj):
        self.Object = vobj.Object
        return

    def getDisplayModes(self,obj):
        modes=[]
        return modes

    def setDisplayMode(self,mode):
        return mode

    def __getstate__(self):
        return None

    def __setstate__(self,state):
        return None

FreeCADGui.addCommand('Arch_Cell',CommandCell())