Trajectory.TrajectoryCommand Class Reference

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

Inheritance diagram for Trajectory.TrajectoryCommand:

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 Trajectory 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 1552 of file Trajectory.py.

Member Function Documentation

Activated()

def Trajectory.TrajectoryCommand.Activated

(

self

)

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

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

Definition at line 1575 of file Trajectory.py.

    def Activated(self):
        doc = FreeCAD.ActiveDocument
        a = doc.addObject("App::DocumentObjectGroupPython", "Trajectory")
        TrajectoryProxy(a)
        if FreeCAD.GuiUp:
            ViewProviderTrajectoryProxy(a.ViewObject)
        doc.recompute()
        return

GetResources()

def Trajectory.TrajectoryCommand.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 1562 of file Trajectory.py.

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

IsActive()

def Trajectory.TrajectoryCommand.IsActive

(

self

)

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

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

Returns

True if buttons shall be enabled and False otherwise.

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