CollisionDetector.CollisionDetectorCommand Class Reference

Class specifying Animate workbench's CollisionDetector button/command. More...

Inheritance diagram for CollisionDetector.CollisionDetectorCommand:

Public Member Functions
def	GetResources (self)
	Method used by FreeCAD to retrieve resources to use for this command. More...
def	Activated (self)
	Method used as a callback when the toolbar button or the menu item is clicked. More...
def	IsActive (self)
	Method to specify when the toolbar button and the menu item are enabled. More...

Detailed Description

Class specifying Animate workbench's CollisionDetector button/command.

This class provides resources for a toolbar button and a menu button. It controls their behaivor(Active/Inactive) and responds to callbacks after either of them was clicked(Activated).

Definition at line 944 of file CollisionDetector.py.

Member Function Documentation

Activated()

def CollisionDetector.CollisionDetectorCommand.Activated

(

self

)

Method used as a callback when the toolbar button or the menu item is clicked.

This method creates a CollisionDetector instance in currently active document. Afterwards it adds a CollisionDetectorProxy as a Proxy to this instance as well as ViewProviderCollisionDetectorProxy to its ViewObject.Proxy, if FreeCAD runs in the Graphic mode.

Definition at line 967 of file CollisionDetector.py.

    def Activated(self):
        doc = FreeCAD.ActiveDocument
        a = doc.addObject("App::DocumentObjectGroupPython",
                          "CollisionDetector")
        CollisionDetectorProxy(a)
        if FreeCAD.GuiUp:
            ViewProviderCollisionDetectorProxy(a.ViewObject)
        doc.recompute()
        return

GetResources()

def CollisionDetector.CollisionDetectorCommand.GetResources

(

self

)

Method used by FreeCAD to retrieve resources to use for this command.

Returns

A dict with items PixMap, MenuText and ToolTip which contain a path to a command icon, a text to be shown in a menu and a tooltip message.

Definition at line 954 of file CollisionDetector.py.

    def GetResources(self):
        return {'Pixmap': path.join(PATH_TO_ICONS, "CollisionDetectorCmd.png"),
                'MenuText': "CollisionDetector",
                'ToolTip': "Create CollisionDetector instance."}

IsActive()

def CollisionDetector.CollisionDetectorCommand.IsActive

(

self

)

Method to specify when the toolbar button and the menu item are enabled.

The toolbar button CollisionDetector and menu item CollisionDetector are set to be active only when there is an active document in which a CollisionDetector instance can be created.

Returns

True if buttons shall be enabled and False otherwise.

Definition at line 987 of file CollisionDetector.py.

    def IsActive(self):
        if FreeCAD.ActiveDocument is None:
            return False
        else:
            return True

---

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

• Doxypypy outputs/CollisionDetector.py