CollisionObject.CollisionProxy Class Reference

Proxy class for a FeaturePython Collision instance. More...

Inheritance diagram for CollisionObject.CollisionProxy:

Public Member Functions
def	__init__ (self, fp, shape=None, cause1=None, cause2=None)
	Initialization method for CollisionProxy. More...
def	onDocumentRestored (self, fp)
	Method called when document is restored to make sure everything is as it was. More...
def	setProperties (self, fp, cause1=None, cause2=None)
	Method to set properties during initialization or document restoration. More...

Detailed Description

Proxy class for a FeaturePython Collision instance.

To connect this Proxy object to a DocumentObjectGroupPython CollisionDetector do:

    a = FreeCAD.ActiveDocument.addObject("Part::FeaturePython",
                                         "Collision")
    CollisionProxy(a, shape, cause1, cause2)

Definition at line 55 of file CollisionObject.py.

Constructor & Destructor Documentation

__init__()

def CollisionObject.CollisionProxy.__init__	(		self,
			fp,
			shape = None,
			cause1 = None,
			cause2 = None
	)

Initialization method for CollisionProxy.

A class instance is created and made a Proxy for a generic FeaturePython Collision object. During initialization number of properties are specified and preset. An object shape is supplied and the object is labeled so its known which objects caused this collision.

Parameters

fp	A barebone FeaturePython Server object to be extended.
shape	A Solid object defining the shape of an intersection.
cause1	An FreeCAD object observed intersecting with the cause2.
cause2	An FreeCAD object observed intersecting with the cause1.

Definition at line 71 of file CollisionObject.py.

    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

Member Function Documentation

onDocumentRestored()

def CollisionObject.CollisionProxy.onDocumentRestored	(		self,
			fp
	)

Method called when document is restored to make sure everything is as it was.

Reinitialization it creates properties and sets them to default values, if they were not restored automatically. Properties of connected ViewObject are also recreated and reset if necessary.

Parameters

fp	A restored FeaturePython CollisionObject object.

Definition at line 89 of file CollisionObject.py.

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

setProperties()

def CollisionObject.CollisionProxy.setProperties	(		self,
			fp,
			cause1 = None,
			cause2 = None
	)

Method to set properties during initialization or document restoration.

The properties are set if they are not already present. Later they are set read only, because an user is not allowed to edit any instance of the CollisionObject.

Parameters

fp	A restored or barebone FeaturePython CollisionObject object.

Definition at line 104 of file CollisionObject.py.

    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

---

The documentation for this class was generated from the following file:

• Doxypypy outputs/CollisionObject.py