RobTranslation.RobTranslationCommand Class Reference

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

Inheritance diagram for RobTranslation.RobTranslationCommand:

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 RobTranslation 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 1121 of file RobTranslation.py.

Member Function Documentation

Activated()

def RobTranslation.RobTranslationCommand.Activated

(

self

)

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

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

Definition at line 1144 of file RobTranslation.py.

    def Activated(self):
        doc = FreeCAD.ActiveDocument
        a = doc.addObject("App::DocumentObjectGroupPython", "RobTranslation")
        RobTranslationProxy(a)
        if FreeCAD.GuiUp:
            ViewProviderRobTranslationProxy(a.ViewObject)
        doc.recompute()
        return

GetResources()

def RobTranslation.RobTranslationCommand.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 1131 of file RobTranslation.py.

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

IsActive()

def RobTranslation.RobTranslationCommand.IsActive

(

self

)

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

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

Returns

True if buttons shall be enabled and False otherwise.

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