RobWorld.RobWorldCommand Class Reference

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

Inheritance diagram for RobWorld.RobWorldCommand:

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 RobWorld 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 747 of file RobWorld.py.

Member Function Documentation

Activated()

def RobWorld.RobWorldCommand.Activated

(

self

)

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

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

Definition at line 770 of file RobWorld.py.

    def Activated(self):
        doc = FreeCAD.ActiveDocument
        a = doc.addObject("App::DocumentObjectGroupPython", "RobWorld")
        RobWorldProxy(a)
        if FreeCAD.GuiUp:
            ViewProviderRobWorldProxy(a.ViewObject)
        doc.recompute()
        return

GetResources()

def RobWorld.RobWorldCommand.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 757 of file RobWorld.py.

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

IsActive()

def RobWorld.RobWorldCommand.IsActive

(

self

)

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

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

Returns

True if buttons shall be enabled and False otherwise.

Definition at line 789 of file RobWorld.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/RobWorld.py