Class providing funcionality to a Trajectory panel inside the TaskView. More...

Inheritance diagram for Trajectory.TrajectoryPanel:

Public Member Functions
def	__init__ (self, trajectories, forms)
	Initialization method for TrajectoryPanel. More...

def	sliderChanged (self, value, form, trajectory)
	Feedback method called when any slider position is changed. More...

def	close (self)
	Method used to close `TrajectoryPanel`. More...

def	reject (self)
	Feedback method called when 'Cancel' button was pressed to close the panel. More...

def	accept (self)
	Feedback method called when 'OK' button was pressed to close the panel. More...

def	getStandardButtons (self, *args)
	Method to set just one button (close) to close the dialog. More...

def	isAllowedAlterSelection (self)
	Method to tell FreeCAD if dialog is allowed to alter a selection. More...

def	isAllowedAlterView (self)
	Method to tell FreeCAD if dialog is allowed to alter a view. More...

def	isAllowedAlterDocument (self)
	Method to tell FreeCAD if dialog is allowed to alter a document. More...

Public Attributes
	trajectories
	A list of `DocumentObjectGroupPython` Trajectory instances. More...

	previous_times
	A list of trajectory times before opening a panel. More...

	form
	A list of QDialog instances to show in the TaskView. More...

Detailed Description

Class providing funcionality to a Trajectory panel inside the TaskView.

This class enables user to see a manipulator in different configurations. It provides a dialogs to be shown in the TaskView. These dialogs have sliders which allow user to go through a trajectory.

Definition at line 63 of file Trajectory.py.

Constructor & Destructor Documentation

◆ init()

def Trajectory.TrajectoryPanel.__init__	(	self,
		trajectories,
		forms
	)

Initialization method for TrajectoryPanel.

A class instance is created. A list of proxies for associated Trajectory instances are loaded as well as corresponding QDialog forms. Previously visible properties are set to be read-only as not to change when a TrajectoryPanel is open. Finally all sliders on dialogs are moved to a position corresponding to a Trajectory time.

Parameters

trajectories	A list of `DocumentObjectGroupPython` Trajectory instances.
forms	A list of QDialog instances to show in the TaskView.

Definition at line 87 of file Trajectory.py.

     def __init__(self, trajectories, forms):
         super(TrajectoryPanel, self).__init__()
         self.trajectories = trajectories
 
         # Disable editing of Trajectory properties and store previous
         # times from trajectories
         self.previous_times = []
         for trajectory in trajectories:
             self.previous_times.append(trajectory.Time)
             for prop in trajectory.PropertiesList:
                 trajectory.setEditorMode(prop, 1)
             # Leave some properties hidden
             trajectory.setEditorMode("Placement", 2)
             trajectory.setEditorMode("ValidTrajectory", 2)
 
         # Add QDialogs to be displayed in freeCAD
         self.form = forms
 
         # Add callbacks to sliders on all forms and muve sliders to a position
         # corresponding with time values
         for i in range(len(forms)):
             forms[i].sld_time.valueChanged.connect(
                 lambda value, form=forms[i],
                 trajectory=trajectories[i]:
                     self.sliderChanged(value, form, trajectory))
             val = (100 * (trajectories[i].Time
                           - trajectories[i].Timestamps[0])) / \
                   (trajectory.Timestamps[-1]
                    - trajectory.Timestamps[0])
             forms[i].sld_time.setValue(val)
 

Member Function Documentation

◆ accept()

def Trajectory.TrajectoryPanel.accept ( self )

Feedback method called when 'OK' button was pressed to close the panel.

Trajectory Times are saved. TrajectoryPanel is closed. FreeCAD and FreeCADGui documents are updated.

Definition at line 187 of file Trajectory.py.

     def accept(self):
         # Close the panel
         self.close()
 

◆ close()

def Trajectory.TrajectoryPanel.close ( self )

Method used to close TrajectoryPanel.

Trajectory properties are return to be editable/read-only/invisible as they were before. After that TrajectoryPanel is closed.

Definition at line 149 of file Trajectory.py.

     def close(self):
         # Allow editing of Trajecotry properties again
         for trajectory in self.trajectories:
             for prop in trajectory.PropertiesList:
                 trajectory.setEditorMode(prop, 0)
             trajectory.ViewObject.Proxy.panel = None
 
             # Keep some properties read-only state if they were in it before
             trajectory.setEditorMode("ObjectPlacement", 1)
             trajectory.setEditorMode("ParentFramePlacement", 1)
 
             # Keep some properties hidden state if they were hidden before
             trajectory.setEditorMode("Placement", 2)
             trajectory.setEditorMode("ValidTrajectory", 2)
         FreeCADGui.Control.closeDialog()
 

◆ getStandardButtons()

def Trajectory.TrajectoryPanel.getStandardButtons	(		self,
		*	args
	)

Method to set just one button (close) to close the dialog.

*args: A tuple of unused arguments from Qt.

Definition at line 197 of file Trajectory.py.

     def getStandardButtons(self, *args):
         return QDialogButtonBox.Ok | QDialogButtonBox.Cancel
 

◆ isAllowedAlterDocument()

def Trajectory.TrajectoryPanel.isAllowedAlterDocument ( self )

Method to tell FreeCAD if dialog is allowed to alter a document.

Returns: True this dialog does change a document.

Definition at line 224 of file Trajectory.py.

     def isAllowedAlterDocument(self):
         return True

◆ isAllowedAlterSelection()

def Trajectory.TrajectoryPanel.isAllowedAlterSelection ( self )

Method to tell FreeCAD if dialog is allowed to alter a selection.

Returns: False this dialog does not change a selection.

Definition at line 206 of file Trajectory.py.

     def isAllowedAlterSelection(self):
         return False
 

◆ isAllowedAlterView()

def Trajectory.TrajectoryPanel.isAllowedAlterView ( self )

Method to tell FreeCAD if dialog is allowed to alter a view.

Returns: True this dialog does change a view.

Definition at line 215 of file Trajectory.py.

     def isAllowedAlterView(self):
         return True
 

◆ reject()

def Trajectory.TrajectoryPanel.reject ( self )

Feedback method called when 'Cancel' button was pressed to close the panel.

Trajectory Times are set to the original values. TrajectoryPanel is closed. FreeCAD and FreeCADGui documents are updated.

Definition at line 171 of file Trajectory.py.

     def reject(self):
         # Return Trajectory times to previous values
         for i in range(len(self.trajectories)):
             self.trajectories[i].Time = self.previous_times[i]
 
         # Close the panel and recompute the document to show changes
         self.close()
         FreeCAD.ActiveDocument.recompute()
         FreeCADGui.updateGui()
 

◆ sliderChanged()

def Trajectory.TrajectoryPanel.sliderChanged	(	self,
		value,
		form,
		trajectory
	)

Feedback method called when any slider position is changed.

A trajectory time is extrapolated from the slider position. The time is shown on the dialog and set to a trajectory. Finally, the FreeCAD document and the FreeCADGui document are updated.

Parameters

value	A slider position.
form	A Dialog panel on which slider was moved.
trajectory	A Trajectory associated with the `form`.

Definition at line 130 of file Trajectory.py.

     def sliderChanged(self, value, form, trajectory):
         # Compute a time from the slider position and timestamp range
         t = value * (trajectory.Timestamps[-1]
                      - trajectory.Timestamps[0]) / 100 \
             + trajectory.Timestamps[0]
 
         # Update the time in a trajectory and
         # recompute the document to show changes
         trajectory.Time = t
         form.lbl_time.setText("Time: " + ("%5.3f" % t))
         FreeCAD.ActiveDocument.recompute()
         FreeCADGui.updateGui()
 

Member Data Documentation

◆ form

Trajectory.TrajectoryPanel.form

A list of QDialog instances to show in the TaskView.

Definition at line 103 of file Trajectory.py.

◆ previous_times

Trajectory.TrajectoryPanel.previous_times

A list of trajectory times before opening a panel.

Definition at line 93 of file Trajectory.py.

◆ trajectories

Trajectory.TrajectoryPanel.trajectories

A list of DocumentObjectGroupPython Trajectory instances.

Definition at line 89 of file Trajectory.py.

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

Doxypypy outputs/Trajectory.py

Public Member Functions

Public Attributes