CollisionObject.py

# -*- coding: utf-8 -*-

# ***************************************************************************
# *                                                                         *
# *   Animate workbench - FreeCAD Workbench for lightweight animation       *
# *   Copyright (c) 2019 Jiří Valášek jirka362@gmail.com                    *
# *                                                                         *
# *   This file is part of the Animate workbench.                           *
# *                                                                         *
# *   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.                                 *
# *                                                                         *
# *   Animate workbench 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 Lesser General Public License for more details.                   *
# *                                                                         *
# *   You should have received a copy of the GNU Library General Public     *
# *   License along with Animate workbench; if not, write to the Free       *
# *   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,        *
# *   MA  02111-1307 USA                                                    *
# *                                                                         *
# ***************************************************************************/



import FreeCAD

from os import path


PATH_TO_ICONS = path.join(FreeCAD.getHomePath(), "Mod", "Animate", "Resources",
                          "Icons")




class CollisionProxy(object):

    

    def __init__(self, fp, shape=None, cause1=None, cause2=None):
        if shape is not None:
            fp.Shape = shape
        if cause1 is not None and cause2 is not None:
            fp.Label = cause1.Label + " x " + cause2.Label
        self.setProperties(fp, cause1=cause1, cause2=cause2)
        fp.Proxy = self

    

    def onDocumentRestored(self, fp):
        self.setProperties(fp)
        fp.ViewObject.Proxy.setProperties(
            fp.ViewObject)

    

    def setProperties(self, fp, cause1=None, cause2=None):
        if not hasattr(fp, "CausedBy"):
            fp.addProperty(
                "App::PropertyLinkList", "CausedBy", "Collision",
                "Objects that made this collision").CausedBy = [cause1, cause2]
        if not hasattr(fp, "Volume"):
            fp.addProperty(
                    "App::PropertyVolume", "Volume", "Collision",
                    "Overlapping volume of interfering objects."
                    ).Volume = fp.Shape.Volume

        fp.setEditorMode("Placement", 1)
        fp.setEditorMode("CausedBy", 1)
        fp.setEditorMode("Volume", 1)
        fp.setEditorMode("Label", 1)

        # Add ViewObject to __dict__ so that it can be accessed using
        # __getattribute__
        fp.__dict__["ViewObject"] = fp.ViewObject




class ViewProviderCollisionProxy(object):

    

    def __init__(self, vp, color=None):
        if color is None:
            color = (1.0, 0.0, 0.0)
        vp.LineColor = vp.PointColor = vp.ShapeColor = color
        vp.LineWidth = 10.0
        vp.PointSize = 10.0
        self.setProperties(vp)
        vp.Proxy = self

    

    def doubleClicked(self, vp):
        return True

    

    def setupContextMenu(self, vp, menu):
        menu.clear()

    

    def getIcon(self):
        return path.join(PATH_TO_ICONS, "Collision.png")

    

    def setProperties(self, vp):
        vp.setEditorMode("AngularDeflection", 2)
        vp.setEditorMode("BoundingBox", 2)
        vp.setEditorMode("Deviation", 2)
        vp.setEditorMode("DisplayMode", 2)
        vp.setEditorMode("DrawStyle", 2)
        vp.setEditorMode("Lighting", 2)
        vp.setEditorMode("LineColor", 2)
        vp.setEditorMode("LineWidth", 2)
        vp.setEditorMode("PointColor", 2)
        vp.setEditorMode("PointSize", 2)
        vp.setEditorMode("Selectable", 2)
        vp.setEditorMode("SelectionStyle", 2)
        vp.setEditorMode("ShapeColor", 2)