RobRotation.RobRotationCommand Class Reference

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

Inheritance diagram for RobRotation.RobRotationCommand:

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 RobRotation 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 1131 of file RobRotation.py.

Member Function Documentation

Activated()

def RobRotation.RobRotationCommand.Activated

(

self

)

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

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

Definition at line 1154 of file RobRotation.py.

    def Activated(self):
        doc = FreeCAD.ActiveDocument
        a = doc.addObject("App::DocumentObjectGroupPython", "RobRotation")
        RobRotationProxy(a)
        if FreeCAD.GuiUp:
            ViewProviderRobRotationProxy(a.ViewObject)
        doc.recompute()
        return

GetResources()

def RobRotation.RobRotationCommand.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 1141 of file RobRotation.py.

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

IsActive()

def RobRotation.RobRotationCommand.IsActive

(

self

)

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

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

Returns

True if buttons shall be enabled and False otherwise.

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