Class that keeps Animate workbench objects in recommended structures. More...

Inheritance diagram for AnimateDocumentObserver.AnimateDocumentObserver:

Public Member Functions
def	__new__ (cls, args, *kwargs)
	Method creating an `AnimateDocumentObserver` singleton instance. More...

def	slotBeforeChangeObject (self, obj, prop)
	Qt slot method called when an object in a surveyed document is about to change. More...

def	slotChangedObject (self, obj, prop)
	Qt slot method called when an object in an observed document was changed. More...

def	isAnimateGroup (self, obj)
	Method to check whether a group object comes from the `Animate` workbench. More...

def	isAnimateObject (self, obj)
	Method to check whether an object comes from the `Animate` workbench. More...

def	foreignObjectInAnimateGroup (self, obj, group)
	Method testing whether a forbidden object is in an `Animate` group object. More...

def	animateObjectInForeignGroup (self, obj, group)
	Method testing whether an `Animate` object is in a foreign group object. More...

def	slotDeletedDocument (self, doc)
	Qt slot method called if a document is about to be closed. More...

def	addServerToNotify (self, server_proxy, document_name)
	Method to add a server which needs to be notified when its document is closing. More...

Public Attributes
	group_before
	A list of objects inside a group object about to change. More...

Static Public Attributes
dictionary	server_proxies = {}
	A dict of document names and `ServerProxies` in them. More...

Detailed Description

Class that keeps Animate workbench objects in recommended structures.

Definition at line 63 of file AnimateDocumentObserver.py.

Member Function Documentation

◆ new()

def AnimateDocumentObserver.AnimateDocumentObserver.__new__	(		cls,
		*	args,
		**	kwargs
	)

Method creating an AnimateDocumentObserver singleton instance.

Returns: An AnimateDocumentObserver singleton instance.

Definition at line 86 of file AnimateDocumentObserver.py.

     def __new__(cls, *args, **kwargs):
         # Make AnimateDocumentObserver a singleton
         if cls.__instance is None:
             cls.__instance = super(AnimateDocumentObserver,
                                    cls).__new__(cls, *args, **kwargs)
         return cls.__instance
 

◆ addServerToNotify()

def AnimateDocumentObserver.AnimateDocumentObserver.addServerToNotify	(	self,
		server_proxy,
		document_name
	)

Method to add a server which needs to be notified when its document is closing.

An active server must close a socket, it is using, when a document it's on is closing, so that a socket won't be blocked when it is needed again.

Parameters

server_proxy	A `ServerProxy` which takes care of a `Server` instance.
document_name	Name of a document with the `Server` instance.

Definition at line 308 of file AnimateDocumentObserver.py.

     def addServerToNotify(self, server_proxy, document_name):
         # Add a server proxy to the dictionary under a document name it's on
         if document_name in self.server_proxies:
             if server_proxy not in self.server_proxies[document_name]:
                 self.server_proxies[document_name].append(server_proxy)
 
         # Add a new document name to the dictionary and assign it a list
         # with a server proxy
         else:
             self.server_proxies[document_name] = [server_proxy]
 
 

◆ animateObjectInForeignGroup()

def AnimateDocumentObserver.AnimateDocumentObserver.animateObjectInForeignGroup	(	self,
		obj,
		group
	)

Method testing whether an Animate object is in a foreign group object.

Parameters

obj	A suspected `Animate` object.
group	A group object which is possibly not from the `Animate` workbench.

Returns: True if an Animate object is not in a Animate group and false otherwise.

Definition at line 279 of file AnimateDocumentObserver.py.

     def animateObjectInForeignGroup(self, obj, group):
         return not self.isAnimateGroup(group) and self.isAnimateObject(obj)
 

◆ foreignObjectInAnimateGroup()

def AnimateDocumentObserver.AnimateDocumentObserver.foreignObjectInAnimateGroup	(	self,
		obj,
		group
	)

Method testing whether a forbidden object is in an Animate group object.

Trajectory group objects are allowed to be stacked. Control objects can contain any other Animate object. CollisionDetector objects can accommodate only Collision objects.

Parameters

obj	A suspected foreign object in an `Animate` group object.
group	The `Animate` group object possibly harboring an illegal object.

Returns: True if a forbidden object is in a Animate group obj. and false otherwise.

Definition at line 234 of file AnimateDocumentObserver.py.

     def foreignObjectInAnimateGroup(self, obj, group):
         # If an obj proxy is NoneType extrapolate it from object name
         if not hasattr(obj, "Proxy"):
             return False
         else:
             if obj.Proxy.__class__.__name__ == "NoneType":
                 obj_type = obj.Name.rstrip('0123456789') + "Proxy"
             else:
                 obj_type = obj.Proxy.__class__.__name__
 
         # If an obj proxy is NoneType extrapolate it from object name
         if group.Proxy.__class__.__name__ == "NoneType":
             group_type = group.Name.rstrip('0123456789') + "Proxy"
         else:
             group_type = group.Proxy.__class__.__name__
 
         # Only a Trajectory can be in a Trajectory group
         if group_type == "TrajectoryProxy" and obj_type == "TrajectoryProxy":
             return False
 
         # Only some objects can be in a Control group
         elif group_type == "ControlProxy" and obj_type in ALLOWED_IN_CONTROL:
             return False
 
         elif group_type == "CollisionDetectorProxy" and \
                 obj.Name.find("Collision") != -1:
             return False
         # Only RobRotation and RobTranslation can be in RobWorld, RobRotation
         # and RobTRanslation groups
         elif (group_type in ["RobWorldProxy", "RobRotationProxy",
                              "RobTranslationProxy"]) and \
                 (obj_type in ["RobRotationProxy", "RobTranslationProxy"]):
             return False
         return True
 

◆ isAnimateGroup()

def AnimateDocumentObserver.AnimateDocumentObserver.isAnimateGroup	(	self,
		obj
	)

Method to check whether a group object comes from the Animate workbench.

As all Animate objects have a Proxy attached, its reasonable to firstly check for it and then decide according to the Proxy object's name if it is an Animate group.

Returns: True if the group object is from Animate workbench and false otherwise.

Definition at line 178 of file AnimateDocumentObserver.py.

     def isAnimateGroup(self, obj):
         # If a proxy is NoneType extrapolate it from object name
         if not hasattr(obj, "Proxy"):
             return False
         else:
             if obj.Proxy.__class__.__name__ == "NoneType":
                 obj_type = obj.Name.rstrip('0123456789') + "Proxy"
             else:
                 obj_type = obj.Proxy.__class__.__name__
 
         # Check if proxy is an Animate group class
         if obj_type not in ANIMATE_OBJECT_GROUP_CLASSES:
             return False
         else:
             return True
 

◆ isAnimateObject()

def AnimateDocumentObserver.AnimateDocumentObserver.isAnimateObject	(	self,
		obj
	)

Method to check whether an object comes from the Animate workbench.

As all Animate objects have a Proxy attached, its reasonable to firstly check for it and then decide according to the Proxy object's name if it is from the Animate workbench.

Returns: True if the object is from Animate workbench and false otherwise.

Definition at line 204 of file AnimateDocumentObserver.py.

     def isAnimateObject(self, obj):
         # If a proxy is NoneType extrapolate it from object name
         if not hasattr(obj, "Proxy"):
             return False
         else:
             if obj.Proxy.__class__.__name__ == "NoneType":
                 obj_type = obj.Name.rstrip('0123456789') + "Proxy"
             else:
                 obj_type = obj.Proxy.__class__.__name__
 
         # Check if proxy is an Animate object class
         if obj_type not in ANIMATE_CLASSES:
             return False
         else:
             return True
 

◆ slotBeforeChangeObject()

def AnimateDocumentObserver.AnimateDocumentObserver.slotBeforeChangeObject	(	self,
		obj,
		prop
	)

Qt slot method called when an object in a surveyed document is about to change.

If the object which is going to change has a Group property, then a transaction is begun and a current state of the Group property is recorded.

Parameters

obj	An object in the observed document about to change.
prop	A str of a property about to change.

Definition at line 103 of file AnimateDocumentObserver.py.

     def slotBeforeChangeObject(self, obj, prop):
         # If any group is about to be changed, start a transaction
         if prop == "Group":
             FreeCAD.ActiveDocument.openTransaction()
             self.group_before = obj.Group
 

◆ slotChangedObject()

def AnimateDocumentObserver.AnimateDocumentObserver.slotChangedObject	(	self,
		obj,
		prop
	)

Qt slot method called when an object in an observed document was changed.

This method is used to enforce a recommended structure of Animate objects in Tree View. It checks that only allowed objects are inside Animate group objects. It also checks that no Animate object is inside a group object that does not belong to the Animate workbench. Lastly, it obstructs user from deleting Collision objects from a CollisionDetector group object.

Parameters

obj	An object in the observed document about to change.
prop	A str of a property about to change.

Definition at line 122 of file AnimateDocumentObserver.py.

     def slotChangedObject(self, obj, prop):
         # If objects are added to a group
         if prop == "Group" and len(obj.Group) > len(self.group_before):
             # If a new object is added to a group object from Animate workbench
             new_obj = obj.Group[-1]
             if self.isAnimateGroup(obj):
                 # An object not from Animate workbench was added to it
                 if self.foreignObjectInAnimateGroup(new_obj, obj):
                     QMessageBox.warning(
                             None, 'Forbidden action detected',
                             "Group objects from Animate workbench can group\n"
                             + "only selected objects from Animate workbench.\n"
                             + "Check the user guide for more info.")
                     FreeCAD.ActiveDocument.undo()
                 else:
                     FreeCAD.ActiveDocument.commitTransaction()
 
             # An object is added to a group not from Animate workbench
             else:
                 # The added object was from Animate workbench
                 if self.animateObjectInForeignGroup(new_obj, obj):
                     QMessageBox.warning(
                             None, 'Forbidden action detected',
                             "Objects from Animate workbench can be grouped\n"
                             + "only by selected objects from Animate "
                             + "workbench.\nCheck the user guide "
                             + "for more info.")
                     FreeCAD.ActiveDocument.undo()
                 else:
                     FreeCAD.ActiveDocument.commitTransaction()
 
         # If objects are removed from a group
         elif prop == "Group" and len(obj.Group) < len(self.group_before):
             # If a Collision is removed from
             removed = set(self.group_before).difference(set(obj.Group)).pop()
             if removed.Proxy.__class__.__name__ == "CollisionProxy" and \
                     hasattr(obj, "Proxy") and not obj.Proxy.resetting and \
                     not obj.Proxy.checking:
                 QMessageBox.warning(
                         None, 'Forbidden action detected',
                         "Collision objects cannot be removed from\n"
                         + "a CollisionDetector group.")
                 FreeCAD.ActiveDocument.undo()
             else:
                 FreeCAD.ActiveDocument.commitTransaction()
 

◆ slotDeletedDocument()

def AnimateDocumentObserver.AnimateDocumentObserver.slotDeletedDocument	(	self,
		doc
	)

Qt slot method called if a document is about to be closed.

This method is used to notify all ServerProxies that the document they are in is going to be closed.

Parameters

doc	A FreeCAD's `App.Document` document about to be closed.

Definition at line 291 of file AnimateDocumentObserver.py.

     def slotDeletedDocument(self, doc):
         # Check at least one server is in the document about to be closed
         if doc.Name in self.server_proxies:
             # Notify all servers in the document
             for server_proxy in self.server_proxies[doc.Name]:
                 server_proxy.onDocumentClosed()
 

Member Data Documentation

◆ group_before

AnimateDocumentObserver.AnimateDocumentObserver.group_before

A list of objects inside a group object about to change.

Definition at line 107 of file AnimateDocumentObserver.py.

◆ server_proxies

AnimateDocumentObserver.AnimateDocumentObserver.server_proxies = {}

static

A dict of document names and ServerProxies in them.

Definition at line 78 of file AnimateDocumentObserver.py.

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

Doxypypy outputs/AnimateDocumentObserver.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ __new__()

◆ addServerToNotify()

◆ animateObjectInForeignGroup()

◆ foreignObjectInAnimateGroup()

◆ isAnimateGroup()

◆ isAnimateObject()

◆ slotBeforeChangeObject()

◆ slotChangedObject()

◆ slotDeletedDocument()

Member Data Documentation

◆ group_before

◆ server_proxies

◆ new()