CollisionObject.ViewProviderCollisionProxy Class Reference

Proxy class for a Gui.ViewProviderDocumentObject Collision.ViewObject. More...

Inheritance diagram for CollisionObject.ViewProviderCollisionProxy:

Public Member Functions
def	__init__ (self, vp, color=None)
	Initialization method for ViewProviderCollisionProxy. More...
def	doubleClicked (self, vp)
	Method called when CollisionDetector is double-clicked in the Tree View. More...
def	setupContextMenu (self, vp, menu)
	Method editing a context menu for right click on a Collision. More...
def	getIcon (self)
	Method used to get a path to an icon which will appear in the tree view. More...
def	setProperties (self, vp)
	Method to hide unused properties. More...

Detailed Description

Proxy class for a Gui.ViewProviderDocumentObject Collision.ViewObject.

A ViewProviderServerProxy instance changes a FeaturePython Collision's icon. It prevents user from transforming a Collision object after double-clicking it in the Tree View. It also removes options to Transform and Set colors... from a context menu.

To connect this Proxy object to a Gui.ViewProviderDocumentObject Collision.ViewObject do:

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

Definition at line 140 of file CollisionObject.py.

Constructor & Destructor Documentation

__init__()

def CollisionObject.ViewProviderCollisionProxy.__init__	(		self,
			vp,
			color = None
	)

Initialization method for ViewProviderCollisionProxy.

A class instance is created and made a Proxy for a generic Gui.ViewProviderDocumentObject Collision.ViewObject. This method changes LineColor, PointColor, ShapeColor,LineWidthandPointSize` properties of a Collision instance and hides unnecessary unused View properties.

Parameters

vp	A barebone Gui.ViewProviderDocumentObject Collision.ViewObject.
color	A tuple of floats specifying Point, Line and Shape RGB color.

Definition at line 154 of file CollisionObject.py.

    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

Member Function Documentation

doubleClicked()

def CollisionObject.ViewProviderCollisionProxy.doubleClicked	(		self,
			vp
	)

Method called when CollisionDetector is double-clicked in the Tree View.

It just prevents user from accessing transformation panel and transforming a Collision object. It's enough to just implement it and return True for this purpose.

Parameters

vp	A double-clicked Collision.ViewObject.

Returns

True to specify that it was implemented and executed.

Definition at line 176 of file CollisionObject.py.

    def doubleClicked(self, vp):
        return True

getIcon()

def CollisionObject.ViewProviderCollisionProxy.getIcon

(

self

)

Method used to get a path to an icon which will appear in the tree view.

Returns

A path to the icon.

Definition at line 199 of file CollisionObject.py.

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

setProperties()

def CollisionObject.ViewProviderCollisionProxy.setProperties	(		self,
			vp
	)

Method to hide unused properties.

All unused unnecessary FeaturePythons properties are hidden except for Transparency and Visibility.

Parameters

vp	A Gui.ViewProviderDocumentObject Collision.ViewObject.

Definition at line 211 of file CollisionObject.py.

    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)

setupContextMenu()

def CollisionObject.ViewProviderCollisionProxy.setupContextMenu	(		self,
			vp,
			menu
	)

Method editing a context menu for right click on a Collision.

The Transform and Set colors... items are removed from the context menu shown upon right click on the Collision in the Tree View. This is done to prevent user from transforming the Collision object or changing its color.

Parameters

vp	A right-clicked Collision.ViewObject.
menu	A Qt's QMenu to be edited.

Definition at line 190 of file CollisionObject.py.

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

---

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

• Doxypypy outputs/CollisionObject.py