Proxy class for Gui.ViewProviderDocumentObject Control.ViewObject. More...

Public Member Functions
def	__init__ (self, vp)
	Initialization method for ViewProviderControlProxy. More...

def	attach (self, vp)
	Method called by FreeCAD after initialization. More...

def	claimChildren (self)
	Method called by FreeCAD to retrieve assigned children. More...

def	canDropObject (self, obj)
	Method called by FreeCAD to ask if an object `obj` can be dropped into a Group. More...

def	getIcon (self)
	Method called by FreeCAD to supply an icon for the Tree View. More...

def	setProperties (self, vp)
	Method to hide unused properties. More...

def	doubleClicked (self, vp)
	Method called by FreeCAD when Control is double-clicked in the Tree View. More...

def	setupContextMenu (self, vp, menu)
	Method called by the FreeCAD to customize a context menu for a Control. More...

def	__getstate__ (self)
	Necessary method to avoid errors when trying to save unserializable objects. More...

def	__setstate__ (self, state)
	Necessary method to avoid errors when trying to restore unserializable objects. More...

Static Public Attributes
	panel = None
	A ControlPanel if one is active or None. More...

	fp = None
	A Control object. More...

Detailed Description

Proxy class for Gui.ViewProviderDocumentObject Control.ViewObject.

A ViewProviderControlProxy instance provides a Control's icon, double-click response and context menu with "Show control panel".

To connect this Proxy object to a Gui.ViewProviderDocumentObject Control.ViewObject do:

a = FreeCAD.ActiveDocument.addObject("App::DocumentObjectGroupPython",
                                     "Control")
ViewProviderControlProxy(a.ViewObject)

Definition at line 1238 of file Control.py.

Constructor & Destructor Documentation

◆ init()

def Control.ViewProviderControlProxy.__init__	(	self,
		vp
	)

Initialization method for ViewProviderControlProxy.

A class instance is created and made a Proxy for a generic Gui.ViewProviderDocumentObject Control.ViewObject. During initialization number of properties are specified and preset.

Parameters

vp	A barebone `Gui.ViewProviderDocumentObject` Control.ViewObject.

Definition at line 1258 of file Control.py.

     def __init__(self, vp):
         self.setProperties(vp)
         vp.Proxy = self
 

Member Function Documentation

◆ getstate()

def Control.ViewProviderControlProxy.__getstate__ ( self )

Necessary method to avoid errors when trying to save unserializable objects.

This method is used by JSON to serialize unserializable objects during autosave. Without this an Error would rise when JSON would try to do that itself.

We need this for unserializable fp attribute, but we don't serialize it, because it's enough to reset it when object is restored.

Returns: None, because we don't serialize anything.

Definition at line 1401 of file Control.py.

     def __getstate__(self):
         return None
 

◆ setstate()

def Control.ViewProviderControlProxy.__setstate__	(	self,
		state
	)

Necessary method to avoid errors when trying to restore unserializable objects.

This method is used during a document restoration. We need this for unserializable fp attribute, but we do not restore it, because it's enough to reset it.

Definition at line 1411 of file Control.py.

     def __setstate__(self, state):
         pass

◆ attach()

def Control.ViewProviderControlProxy.attach	(	self,
		vp
	)

Method called by FreeCAD after initialization.

This method adds Control as the fp attribute.

Parameters

vp	A Control.ViewObject after initialization.

Definition at line 1270 of file Control.py.

     def attach(self, vp):
         # Add feature python as it's necessary to claimChildren
         self.fp = vp.Object
 

◆ canDropObject()

def Control.ViewProviderControlProxy.canDropObject	(	self,
		obj
	)

Method called by FreeCAD to ask if an object obj can be dropped into a Group.

FreeCAD objects of a Server, Trajectory and CollisionDetector type are allowed to drop inside a Control group.

Parameters

obj	A FreeCAD object hovering above a Control item in the Tree View.

Definition at line 1298 of file Control.py.

     def canDropObject(self, obj):
         # Allow only some objects to be dropped into the Control group
         if hasattr(obj, "Proxy") and \
            (obj.Proxy.__class__.__name__ == "ServerProxy" or
            obj.Proxy.__class__.__name__ == "TrajectoryProxy" or
            obj.Proxy.__class__.__name__ == "CollisionDetectorProxy" or
            obj.Proxy.__class__.__name__ == "RobWorldProxy" or
            obj.Proxy.__class__.__name__ == "RobRotationProxy" or
            obj.Proxy.__class__.__name__ == "RobTranslationProxy"):
             return True
         return False
 

◆ claimChildren()

def Control.ViewProviderControlProxy.claimChildren ( self )

Method called by FreeCAD to retrieve assigned children.

When a property of a Control is touched the Control and the FreeCAD ActiveDocument are notified. The FreeCAD ActiveDocument then emits a signal to inform all its observers e.g. the FreeCADGui ActiveDocument. The FreeCADGui document then emits a new signal to inform e.g. the tree view. The tree view then invokes claimChildren().

Definition at line 1283 of file Control.py.

     def claimChildren(self):
         if hasattr(self, "fp"):
             if self.fp:
                 return self.fp.Group
         return []
 

◆ doubleClicked()

def Control.ViewProviderControlProxy.doubleClicked	(	self,
		vp
	)

Method called by FreeCAD when Control is double-clicked in the Tree View.

If no dialog is opened in the Task View, a new ControlPanel is opened. If a ControlPanel is already opened, the Model tab on the Combo View is swapped for the Tasks tab so that the panel becomes visible. If another dialog is opened a warning is shown.

Parameters

vp	A `Gui.ViewProviderDocumentObject` Control.ViewObject.

Definition at line 1345 of file Control.py.

     def doubleClicked(self, vp):
         # Switch to the Task View if a Control panel is already opened
         if self.panel:
             FreeCADGui.Control.showTaskView()
 
         # Try to open new Control panel
         else:
             # Load the QDialog from a file and name it after this object
             form = FreeCADGui.PySideUic.loadUi(
                     path.join(PATH_TO_UI, "AnimationControl.ui"))
             form.setWindowTitle(vp.Object.Label)
 
             # Create a control panel and try to show it
             self.panel = ControlPanel(vp.Object, form)
             try:
                 FreeCADGui.Control.showDialog(self.panel)
             except RuntimeError as e:
                 self.panel = None
                 if str(e) == "Active task dialog found":
                     QMessageBox.warning(None,
                                         'Error while opening control panel',
                                         "A panel is already active on "
                                         + "the Tasks tab of the Combo View.")
                     FreeCADGui.Control.showTaskView()
         return True
 

◆ getIcon()

def Control.ViewProviderControlProxy.getIcon ( self )

Method called by FreeCAD to supply an icon for the Tree View.

A full path to an icon is supplied for the FreeCADGui.

Returns: A str path to an icon.

Definition at line 1318 of file Control.py.

     def getIcon(self):
         return path.join(PATH_TO_ICONS, "Control.png")
 

◆ setProperties()

def Control.ViewProviderControlProxy.setProperties	(	self,
		vp
	)

Method to hide unused properties.

Properties Display Mode, Visibility are set to be invisible as they are unused.

Parameters

vp	A `Gui.ViewProviderDocumentObject` Control.ViewObject.

Definition at line 1329 of file Control.py.

     def setProperties(self, vp):
         # Hide unnecessary view properties
         vp.setEditorMode("DisplayMode", 2)
         vp.setEditorMode("Visibility", 2)
 

◆ setupContextMenu()

def Control.ViewProviderControlProxy.setupContextMenu	(	self,
		vp,
		menu
	)

Method called by the FreeCAD to customize a context menu for a Control.

The Transform and Set colors... items are removed from the context menu shown upon right click on DocumentObjectGroupPython Control in the Tree View. The option to Show control panel is added instead.

Parameters

vp	A right-clicked `Gui.ViewProviderDocumentObject` Control.ViewObject.
menu	A Qt's QMenu to be edited.

Definition at line 1382 of file Control.py.

     def setupContextMenu(self, vp, menu):
         # Add an option to open the Control panel
         menu.clear()
         action = menu.addAction("Show control panel")
         action.triggered.connect(lambda f=self.doubleClicked, arg=vp: f(arg))
 

Member Data Documentation

◆ fp

Control.ViewProviderControlProxy.fp = None

static

A Control object.

Definition at line 1246 of file Control.py.

◆ panel

Control.ViewProviderControlProxy.panel = None

static

A ControlPanel if one is active or None.

Definition at line 1245 of file Control.py.

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

Doxypypy outputs/Control.py

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __getstate__()

◆ __setstate__()

◆ attach()

◆ canDropObject()

◆ claimChildren()

◆ doubleClicked()

◆ getIcon()

◆ setProperties()

◆ setupContextMenu()

Member Data Documentation

◆ fp

◆ panel

◆ init()

◆ getstate()

◆ setstate()