Control.ControlPanel Class Reference

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

Inheritance diagram for Control.ControlPanel:

Public Member Functions
def	__init__ (self, control_proxy, form)
	Initialization method for ControlPanel. More...
def	playClicked (self)
	Feedback method called when play button was clicked. More...
def	pauseClicked (self)
	Feedback method called when pause button was clicked. More...
def	rewindClicked (self)
	Feedback method called when rewind button was clicked. More...
def	recordClicked (self)
	Feedback method called when record button was clicked. More...
def	exportClicked (self)
	Feedback method called when export button was clicked. More...
def	sliderChanged (self)
	Feedback method called when slider position is changed. More...
def	setInvalidButtons (self)
	Method to enable/disable buttons according to a last clicked button. More...
def	reject (self)
	Feedback method called when Control panel is closing. 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...
def	play (self, t)
	Method to show an animation frame at an animation time t during playing. More...
def	rewind (self, t)
	Method to show an animation frame at an animation time t during rewind. More...
def	record (self, t)
	Method to show and save an animation frame at an animation time t. More...
def	distributeTime (self, t)
	Method to distribute a time t to children Trajectories. More...
def	updateCollisions (self)
	Method to update collisions from CollisionDetector children. More...
def	resetCollisions (self)
	Method to reset collisions from CollisionDetector children. More...
def	showChanges (self)
	Method to show changes made to objects, collisions. More...
def	saveImage (self)
	Method to save current view as a PNG image. More...
def	findSequences (self, files)
	Method to find sequences between files. More...
def	showSequences (self, sequences)
	Method to show sequences to export on a dialog panel. More...
def	exportConfirmed (self)
	Feedback method called when confirm button was clicked. More...
def	exportAborted (self)
	Feedback method called when abort button was clicked. More...
def	closeExportSubform (self)
	Method used to close the part of the dialog panel used for video exporting. More...
def	installPyPNGNotice (self)
	Method telling user that pyPNG library ought to be installed into FreeCAD. More...
def	writeFramerateChunk (self, framerate, image_path)
	Method to write a framerate into a PNG image as one of its chunks. More...
def	readFramerateChunk (self, image_path)
	Method to read a framerate inserted as one of a PNG image's chunks. More...

Public Attributes
	control_proxy
	A proxy to an associated Control class. More...
	form
	A QDialog instance show in the TaskView. More...
	timer
	A QTimer for timing animations. More...
	last_clicked
	A str showing which button was pressed last. More...
	record_prefix
	A str prefix for an image file name. More...
	image_number
	An int number of a next recorded image. More...
	trv_sequences
	A QTreeView showing list of recorded sequences. More...
	lyt_export
	A QHBoxLayout with a confirm and abort buttons. More...
	btn_confirm
	A QPushButton to confirm sequence to export. More...
	btn_abort
	A QPushButton to abort exporting a sequence. More...

Detailed Description

Class providing funcionality to a Control panel inside the TaskView.

This class enables user to play, pause, rewind, record, export and seek through an animation.

To create an instance of this class do:

form = FreeCADGui.PySideUic.loadUi(
    path.join(PATH_TO_UI, "AnimationControl.ui"))
form.setWindowTitle(title)
panel = ControlPanel(fp, form)

Definition at line 83 of file Control.py.

Constructor & Destructor Documentation

__init__()

def Control.ControlPanel.__init__	(		self,
			control_proxy,
			form
	)

Initialization method for ControlPanel.

A class instance is created. A proxy for an associated Control is added and the control properties are set to read-only as not to change when control panel is opened. A form and timer are assigned. Pause button is disabled as no animation is playing.

Parameters

control_proxy	A proxy to a Control so properties can be set read-only.
form	A Qt dialog loaded from a file.

Definition at line 127 of file Control.py.

    def __init__(self, control_proxy, form):
        super(ControlPanel, self).__init__()
        self.control_proxy = control_proxy

        # Disable editing of Control properties
        for prop in self.control_proxy.PropertiesList:
            self.control_proxy.setEditorMode(prop, 1)

        # Add QDialog to be displayed in freeCAD
        self.form = form

        # Connect callback functions
        self.form.btn_play.clicked.connect(self.playClicked)
        self.form.btn_pause.clicked.connect(self.pauseClicked)
        self.form.btn_rewind.clicked.connect(self.rewindClicked)
        self.form.btn_record.clicked.connect(self.recordClicked)
        self.form.btn_export.clicked.connect(self.exportClicked)
        self.form.sld_seek.valueChanged.connect(self.sliderChanged)

        # Create timer for the animations
        self.timer = QTimer(self)

        # Disable pause button as animation is not running when the panel is
        # opened
        self.last_clicked = "pause"
        self.setInvalidButtons()

Member Function Documentation

closeExportSubform()

def Control.ControlPanel.closeExportSubform

(

self

)

Method used to close the part of the dialog panel used for video exporting.

The QTreeView with sequence names and their numbers of frames are closed. Then ‘'Confirm’and'Abort'` buttons are removed and the rest of buttons is returned to the default state (the same as if pause button was pressed).

Definition at line 912 of file Control.py.

    def closeExportSubform(self):
        # Close all parts of export subform and remove them from the panel
        self.trv_sequences.close()
        self.form.lyt_main.removeWidget(self.trv_sequences)
        self.btn_abort.close()
        self.lyt_export.removeWidget(self.btn_abort)
        self.btn_confirm.close()
        self.lyt_export.removeWidget(self.btn_confirm)
        self.form.lyt_main.removeItem(self.lyt_export)
        self.last_clicked = "pause"
        self.setInvalidButtons()

distributeTime()

def Control.ControlPanel.distributeTime	(		self,
			t
	)

Method to distribute a time t to children Trajectories.

List of children is loaded. If a child is Trajectory, the time is set to it and its children are added to the list.

Parameters

t	A time to distribute to all child Trajectories.

Definition at line 575 of file Control.py.

    def distributeTime(self, t):
        # Load list of objects inside Control group
        objects = self.control_proxy.Group

        # Go through them, their children and update time,
        # if they are Trajectories
        while len(objects) > 0:
            obj = objects.pop(0)
            if obj.Proxy.__class__.__name__ == "TrajectoryProxy" or \
               obj.Proxy.__class__.__name__ == "RobRotationProxy" or \
               obj.Proxy.__class__.__name__ == "RobTranslationProxy":
                obj.Time = t
                objects += obj.Group
            elif obj.Proxy.__class__.__name__ == "RobWorldProxy":
                objects += obj.Group

exportAborted()

def Control.ControlPanel.exportAborted

(

self

)

Feedback method called when abort button was clicked.

The part of the dialog panel used for video exporting is closed.

Definition at line 901 of file Control.py.

    def exportAborted(self):
        # Close the export subform
        self.closeExportSubform()

exportClicked()

def Control.ControlPanel.exportClicked

(

self

)

Feedback method called when export button was clicked.

Invalid buttons are disabled. An Export Path is checked for files. The files are checked for sequences. Sequences are shown with buttons to confirm or cancel the selection.

Definition at line 277 of file Control.py.

    def exportClicked(self):
        # Check that Export Path is valid
        if not os.access(self.control_proxy.ExportPath, os.W_OK | os.R_OK):
            # Show error if not
            QMessageBox.warning(None, 'Invalid Export Path',
                                "You don't have access to read and write\n"
                                + "in folder specified by Export Path.\n"
                                + "Change it to be able to record images.")
            self.pauseClicked()
            return

        # Disable everything
        self.last_clicked = "export"
        self.setInvalidButtons()

        # Try to load file names from an export folder
        try:
            files = os.listdir(self.control_proxy.ExportPath)
        except FileNotFoundError as e:
            QMessageBox.warning(None, 'Export Path error', str(e))
            return

        # Find all recorded sequences between the files
        sequences = self.findSequences(files)
        if sequences != {}:
            # Show them in an export menu
            self.showSequences(sequences)
        else:
            # Show error if none found
            QMessageBox.warning(None, 'Export error',
                                "No sequences to export.")
            self.last_clicked = "pause"
            self.setInvalidButtons()

exportConfirmed()

def Control.ControlPanel.exportConfirmed

(

self

)

Feedback method called when confirm button was clicked.

Buttons are disabled, framerate is loaded from the first image chunks, selected sequence name is used to create an image name template and a video name which can be used in a FFMPEG command. Such a command is executed to convert the video, if FFMPEG is installed. Otherwise warnings are shown.

Definition at line 841 of file Control.py.

    def exportConfirmed(self):
        # Disable export and confirm buttons
        self.btn_confirm.setEnabled(False)
        self.btn_abort.setEnabled(False)

        # Prepare arguments for ffmpeg conversion
        selected_seq = \
            self.trv_sequences.selectionModel().selectedRows()[0].data()
        # Load framerate
        image_name = selected_seq + "-" + (NAME_NUMBER_FORMAT % 0) + ".png"
        image_path = path.join(self.control_proxy.ExportPath, image_name)
        # load fps from the first image
        fps = self.readFramerateChunk(image_path)
        if fps == -1.0:
            fps = 1 / self.control_proxy.StepTime
            QMessageBox.warning(
                            None, 'Loading framerate failed',
                            "Framerate was not loaded, this recorded image\n"
                            + "sequence will be exported using current\n"
                            + "Step Time: FPS = 1/(Step Time) = "
                            + str(fps) + ".")

        image_name = '"' + path.normpath(
                path.join(self.control_proxy.ExportPath, selected_seq + "-"
                          + NAME_NUMBER_FORMAT + ".png")) + '"'
        video_name = '"' + path.normpath(
                path.join(self.control_proxy.ExportPath,
                          selected_seq + ".mp4")) + '"'

        # Prepare an ffmpeg command
        export_command = 'ffmpeg -r ' + str(fps) + ' -i ' + image_name \
            + ' -c:v libx264 -pix_fmt yuv420p ' + video_name

        # Try to run the command
        try:
            return_val = subprocess.call(export_command)
        except OSError as e:
            if e.errno == os.errno.ENOENT:
                QMessageBox.warning(None, 'FFMPEG not available',
                                    "FFMPEG is necessary to export video.\n"
                                    + "Please install it")
            else:
                QMessageBox.warning(None, 'Something failed', str(e))
        if return_val == 0:
            QMessageBox.information(None, 'Export successful!',
                                    "FFMPEG successfully converted image "
                                    + "sequence into a video.")
        else:
            QMessageBox.warning(None, 'FFMPEG unsuccessfull',
                                "FFMPEG failed to convert sequence into "
                                + "a video")

        # Close the export subform
        self.closeExportSubform()

findSequences()

def Control.ControlPanel.findSequences	(		self,
			files
	)

Method to find sequences between files.

Files are scanned for sequences, the valid sequences are recognized and number of frames is counted.

Parameters

files

A list of string file names.

Returns

A dict with sequence names and numbers of frames.

Definition at line 677 of file Control.py.

    def findSequences(self, files):
        # Check there are any files
        if len(files) == 0:
            return {}

        # Go through the files
        sequences = {}
        for f in files:

            # Check they fit the name pattern
            img_name = re.search(r"(seq\d+)-(\d+)(?=\.png)", f)
            if img_name is not None:

                # Add new sequences
                if img_name.group(1) not in list(sequences.keys()):

                    # Add sequence if it's starting with 0
                    if int(img_name.group(2)) == 0:
                        sequences[img_name.group(1)] = 1
                        last_frame = int(img_name.group(2))

                # Compute number of successive frames
                elif int(img_name.group(2)) == (last_frame + 1):
                    sequences[img_name.group(1)] += 1
                    last_frame += 1

                # Remove sequence if a frame is missing
                else:
                    sequences.pop(img_name.group(1))

        # Leave sequences longer than 1 frame
        sequences = {key: val for key, val in sequences.items() if val > 1}
        return sequences

getStandardButtons()

def Control.ControlPanel.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 381 of file Control.py.

    def getStandardButtons(self, *args):
        return QDialogButtonBox.Close

installPyPNGNotice()

def Control.ControlPanel.installPyPNGNotice

(

self

)

Method telling user that pyPNG library ought to be installed into FreeCAD.

The pyPNG library is not part of FreeCAD and so we need to add it using pip. This method tells user to do so.

Definition at line 930 of file Control.py.

    def installPyPNGNotice(self):
        QMessageBox.information(
                None, "Install PyPNG", "PyPNG is missing from your FreeCAD\n"
                + "Please follow these instructions to install it:\n\n"
                + "Windows:\n"
                + "   1) Open a command line window with admin privileges\n"
                + '        Press "Win + X" and "A"\n\n'
                + "   2) Go to the bin folder in your FreeCAD installation\n"
                + '        Type "CD ' + FreeCAD.getHomePath() + 'bin"\n\n'
                + "   3) Install PyPNG\n"
                + '        Type "python.exe -m pip install pyPNG"\n\n\n'
                + "Ubuntu (installed using PPA):\n"
                + "   1) Open a terminal window\n\n"
                + "   2) Install PyPNG\n"
                + '        Type "sudo python.exe -m pip install pyPNG"\n')

#        Alternative way to install it directly from FreeCAD
#        import pip
#        if hasattr(pip, "main"):
#            FreeCAD.Console.PrintLog("Installing pyPNG.\n")
#            if pip.main(["install", "pyPNG"]) != 0:
#                FreeCAD.Console.PrintError("pyPNG installation failed.\n")
#            FreeCAD.Console.PrintLog("Installation successful.\n")
#        else:
#            import pip._internal
#            if hasattr(pip._internal, "main"):
#                if pip._internal.main(["install", "pyPNG"]) != 0:
#                    FreeCAD.Console.PrintError("pyPNG installation failed.\n")
#                FreeCAD.Console.PrintLog("Installation successful.\n")
#            else:
#                FreeCAD.Console.PrintLog(
#                        "Unable to import and install pyPNG.\n")

isAllowedAlterDocument()

def Control.ControlPanel.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 408 of file Control.py.

    def isAllowedAlterDocument(self):
        return True

isAllowedAlterSelection()

def Control.ControlPanel.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 390 of file Control.py.

    def isAllowedAlterSelection(self):
        return False

isAllowedAlterView()

def Control.ControlPanel.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 399 of file Control.py.

    def isAllowedAlterView(self):
        return True

pauseClicked()

def Control.ControlPanel.pauseClicked

(

self

)

Feedback method called when pause button was clicked.

Invalid buttons are disabled in this method and that's it.

Definition at line 189 of file Control.py.

    def pauseClicked(self):
        # Enable everything except for the pause button
        self.last_clicked = "pause"
        self.setInvalidButtons()

play()

def Control.ControlPanel.play	(		self,
			t
	)

Method to show an animation frame at an animation time t during playing.

Current clock time is loaded. If the pause button was clicked, an animation is stopped. Otherwise the animation time t is distributed to appropriate children. If the animation time t exceeded Stop Time, the animation is stopped. Lastly next frame time is computed as well as pause time (to stick with real time if computation did not exceeded Step Time). Finally the timer is set to show the next animation frame after precomputed pause.

Parameters

t	An animation time to generate an animation frame at.

Definition at line 425 of file Control.py.

    def play(self, t):
        # Load current time
        time_ = time.clock()

        # Check pause button was not pressed
        if self.last_clicked == "pause":
            return

        # Disribute the animation time to trajectories so that they change
        # positions of all animated objects
        self.distributeTime(t)
        self.updateCollisions()
        self.showChanges()

        # Display current progress on the seek slider
        self.form.sld_seek.setValue(
            numpy.round(100*(t - self.control_proxy.StartTime)
                        / (self.control_proxy.StopTime
                           - self.control_proxy.StartTime)))

        # Stop the animation if the animation time reached a range boundary
        if t >= self.control_proxy.StopTime:
            self.last_clicked = "pause"
            self.setInvalidButtons()
            return

        # Compute an animation time for the next frame
        next_t = min(t + self.control_proxy.StepTime,
                     self.control_proxy.StopTime)

        # Compute pause period so that animaiton time roughly corresponds to
        # the real time
        pause = round(1000*(self.control_proxy.StepTime + time_
                            - time.clock()))
        pause = pause*(pause > 0)

        # Setup a timer to show next frame if animaiton wasn't paused
        if self.last_clicked != "pause":
            self.timer.singleShot(pause, lambda: self.play(next_t))

playClicked()

def Control.ControlPanel.playClicked

(

self

)

Feedback method called when play button was clicked.

Invalid buttons are disabled. Active View's animation is disabled (Necessary). Slider position is checked for invalid position (at the end) and if position is plausible, all collisions are reset, current time is extrapolated from the slider and an animation is played.

Definition at line 162 of file Control.py.

    def playClicked(self):
        # Disable everything except for the pause button
        self.last_clicked = "play"
        self.setInvalidButtons()
        FreeCADGui.ActiveDocument.ActiveView.setAnimationEnabled(False)

        # Check that we are not already at the end of an animation range
        if self.form.sld_seek.value() == self.form.sld_seek.maximum():
            # Show error if we are
            QMessageBox.warning(None, 'Error while playing',
                                "The animation is at the end.")
            self.pauseClicked()
        else:
            # Reset collisions
            self.resetCollisions()
            # Load current time from the time slider and start playing
            t = self.form.sld_seek.value() \
                * (self.control_proxy.StopTime
                   - self.control_proxy.StartTime) / 100 \
                + self.control_proxy.StartTime
            self.play(t)

readFramerateChunk()

def Control.ControlPanel.readFramerateChunk	(		self,
			image_path
	)

Method to read a framerate inserted as one of a PNG image's chunks.

This method tries to import pyPNG first. Then it tries to install it and import again. If either import is successful, all chunks currently in the PNG image at an image_path are extracted. The framerate chunk ought to be stored as the second chunk, right behind IHDR. If the chunk's code type matches, its value is returned.

Parameters

image_path

A str containing a path to an image with the framerate chunk.

Returns

A float signifying framerate, or -1.0 if something failed.

Definition at line 1014 of file Control.py.

    def readFramerateChunk(self, image_path):
        # import or install pyPNG
        try:
            import png
        except ModuleNotFoundError:
            self.installPyPNGNotice()
            return -1.0
        # Read chunks already present in a PNG image
        reader = png.Reader(filename=image_path)
        chunks = list(reader.chunks())
        if chunks[1][0] == FPS_CHUNK_CODE:
            return struct.unpack("f", chunks[1][1])[0]
        else:
            FreeCAD.Console.PrintError("Unable to unpack a framerate.\n")
            return -1.0

record()

def Control.ControlPanel.record	(		self,
			t
	)

Method to show and save an animation frame at an animation time t.

Current clock time is loaded. If the pause button was clicked, an animation is stopped. Otherwise the animation time t is distributed to appropriate children. If the animation time t exceeded Stop Time, the animation is stopped. Lastly next frame time is computed. Finally the timer is set to show the next animation frame after precomputed pause.

Parameters

t	An animation time to generate an animation frame at.

Definition at line 532 of file Control.py.

    def record(self, t):
        # Check pause button was not pressed
        if self.last_clicked == "pause":
            return

        # Disribute the animation time to trajectories so that they change
        # positions of all animated objects, save the image
        self.distributeTime(t)
        self.updateCollisions()

        # Show changes and save view
        self.showChanges()
        self.saveImage()

        # Display current progress on the seek slider
        self.form.sld_seek.setValue(
                numpy.round(100*(t - self.control_proxy.StartTime)
                            / (self.control_proxy.StopTime
                               - self.control_proxy.StartTime)))

        # Stop the animation if the animation time reached a range boundary
        if t >= self.control_proxy.StopTime:
            self.last_clicked = "pause"
            self.setInvalidButtons()
            return

        # Compute an animation time for the next frame
        next_t = min(t + self.control_proxy.StepTime,
                     self.control_proxy.StopTime)

        # Setup a timer to show next frame if animaiton wasn't paused
        if self.last_clicked != "pause":
            self.timer.singleShot(0, lambda: self.record(next_t))

recordClicked()

def Control.ControlPanel.recordClicked

(

self

)

Feedback method called when record button was clicked.

Invalid buttons are disabled. A record prefix is generated. An Image number is set to 0. Active View's animation is disabled (Necessary). Slider position is checked for invalid position (at the end) and if position is plausible, all collisions are reset, current time is extrapolated from the slider and an animation is played/recorded.

Definition at line 233 of file Control.py.

    def recordClicked(self):
        # Disable everything except for the pause button
        self.last_clicked = "record"
        self.setInvalidButtons()

        # Create an unique prefix for the image files which will be made
        self.record_prefix = "seq" + time.strftime("%Y%m%d%H%M%S") + "-"
        # Reset image number for new image sequence
        self.image_number = 0
        FreeCADGui.ActiveDocument.ActiveView.setAnimationEnabled(False)

        # Check that we are not already at the end of an animation range
        if self.form.sld_seek.value() == self.form.sld_seek.maximum():
            # Show error if we are
            QMessageBox.warning(None, 'Error while playing',
                                "The animation is at the end.")
            self.pauseClicked()

        # Check that Export Path is valid
        elif not os.access(self.control_proxy.ExportPath, os.W_OK | os.R_OK):
            # Show error if not
            QMessageBox.warning(None, 'Invalid Export Path',
                                "You don't have access to read and write\n"
                                + "in folder specified by Export Path.\n"
                                + "Change it to be able to record images.")
            self.pauseClicked()

        else:
            # Reset collisions
            self.resetCollisions()
            # Load current time from the time slider and start recording
            t = self.form.sld_seek.value() \
                * (self.control_proxy.StopTime
                   - self.control_proxy.StartTime) / 100 \
                + self.control_proxy.StartTime
            self.record(t)

reject()

def Control.ControlPanel.reject

(

self

)

Feedback method called when Control panel is closing.

Animation is stopped. Controls properties are set to be editable. Dialog is closed.

Definition at line 360 of file Control.py.

    def reject(self):
        # Stop animaiton, if it's running by clicking pause button
        self.pauseClicked()

        # Allow editing of Control properties again
        for prop in self.control_proxy.PropertiesList:
            self.control_proxy.setEditorMode(prop, 0)

        # Delete reference to this panel from the view provider as the panel
        # will no longer exist
        self.control_proxy.ViewObject.Proxy.panel = None

        # Close the dialog
        FreeCADGui.Control.closeDialog()

resetCollisions()

def Control.ControlPanel.resetCollisions

(

self

)

Method to reset collisions from CollisionDetector children.

List of children is loaded. If a child is CollisionDetector, it's reset.

Definition at line 612 of file Control.py.

    def resetCollisions(self):
        # Load list of objects inside Control group
        objects = self.control_proxy.Group

        # if they are CollisionDetectors, then check for collisions
        while len(objects) > 0:
            obj = objects.pop(0)
            if obj.Proxy.__class__.__name__ == "CollisionDetectorProxy":
                obj.Proxy.reset()

rewind()

def Control.ControlPanel.rewind	(		self,
			t
	)

Method to show an animation frame at an animation time t during rewind.

Current clock time is loaded. If the pause button was clicked, an animation is stopped. Otherwise the animation time t is distributed to appropriate children. If the animation time t exceeded Stop Time, the animation is stopped. Lastly next frame time is computed as well as pause time (to stick with real time if computation did not exceeded Step Time). Finally the timer is set to show the next animation frame after precomputed pause.

Parameters

t	An animation time to generate an animation frame at.

Definition at line 479 of file Control.py.

    def rewind(self, t):
        # Load current time
        time_ = time.clock()

        # Check pause button was not pressed
        if self.last_clicked == "pause":
            return

        # Disribute the animation time to trajectories so that they change
        # positions of all animated objects
        self.distributeTime(t)
        self.updateCollisions()
        self.showChanges()

        # Display current progress on the seek slider
        self.form.sld_seek.setValue(
                numpy.round(100*(t - self.control_proxy.StartTime)
                            / (self.control_proxy.StopTime
                               - self.control_proxy.StartTime)))

        # Stop the animation if the animation time reached a range boundary
        if t <= self.control_proxy.StartTime:
            self.last_clicked = "pause"
            self.setInvalidButtons()
            return

        # Compute an animation time for the next frame
        next_t = max(t - self.control_proxy.StepTime,
                     self.control_proxy.StartTime)

        # Compute pause period so that animaiton time roughly corresponds to
        # the real time
        pause = round(1000*(self.control_proxy.StepTime + time_
                            - time.clock()))
        pause = pause*(pause > 0)

        # Setup a timer to show next frame if animaiton wasn't paused
        if self.last_clicked != "pause":
            self.timer.singleShot(pause, lambda: self.rewind(next_t))

rewindClicked()

def Control.ControlPanel.rewindClicked

(

self

)

Feedback method called when rewind button was clicked.

Invalid buttons are disabled. Active View's animation is disabled (Necessary). Slider position is checked for invalid position (at the end) and if position is plausible, all collisions are reset, current time is extrapolated from the slider and an animation is played.

Definition at line 202 of file Control.py.

    def rewindClicked(self):
        # Disable everything except for the pause button
        self.last_clicked = "rewind"
        self.setInvalidButtons()
        FreeCADGui.ActiveDocument.ActiveView.setAnimationEnabled(False)

        # Check that we are not already at the start of an animation range
        if self.form.sld_seek.value() == self.form.sld_seek.minimum():
            # Show error if we are
            QMessageBox.warning(None, 'Error while rewinding',
                                "The animation is at the beginning.")
            self.pauseClicked()
        else:
            # Reset collisions
            self.resetCollisions()
            # Load current time from the time slider and start rewinding
            t = self.form.sld_seek.value() \
                * (self.control_proxy.StopTime
                   - self.control_proxy.StartTime) / 100 \
                + self.control_proxy.StartTime
            self.rewind(t)

saveImage()

def Control.ControlPanel.saveImage

(

self

)

Method to save current view as a PNG image.

An image name is pieced together from record prefix and image number. Then an image path is constructed. Animation is disabled(obligatory) and current view is saved as an image. Afterwards, if saving the first image(image number 0), a chunk with a framerate corresponding to a step size is added. Finally the image number is incremented.

Definition at line 641 of file Control.py.

    def saveImage(self):
        # Prepare complete path to an image
        name = self.record_prefix + (NAME_NUMBER_FORMAT % self.image_number) \
            + ".png"
        image_path = path.join(self.control_proxy.ExportPath, name)

        # Export image and increase image number
        FreeCADGui.ActiveDocument.ActiveView.setAnimationEnabled(False)
        FreeCADGui.ActiveDocument.ActiveView.saveImage(
                image_path,
                self.control_proxy.VideoWidth, self.control_proxy.VideoHeight)

        # Write a framerate chunk into the first image
        if self.image_number == 0:
            if not self.writeFramerateChunk(1 / self.control_proxy.StepTime,
                                            image_path):
                QMessageBox.warning(
                            None, 'Saving framerate failed',
                            "Framerate was not saved, this recorded image\n"
                            + "sequence will have to be exported using\n"
                            + "current Step Time to compute framerate.\n"
                            + "Check Report View for more info.")
        self.image_number += 1

setInvalidButtons()

def Control.ControlPanel.setInvalidButtons

(

self

)

Method to enable/disable buttons according to a last clicked button.

If pause button was pressed, all others buttons are disabled. If any other button was pressed, only pause button is left enabled.

Definition at line 337 of file Control.py.

    def setInvalidButtons(self):
        # Disable invalid buttons with respect to the last clicked button
        self.form.btn_play.setEnabled(self.last_clicked == "pause" and
                                      self.last_clicked != "export")
        self.form.btn_pause.setEnabled(self.last_clicked != "pause" and
                                       self.last_clicked != "export")
        self.form.btn_rewind.setEnabled(self.last_clicked == "pause" and
                                        self.last_clicked != "export")
        self.form.btn_record.setEnabled(self.last_clicked == "pause" and
                                        self.last_clicked != "export")
        self.form.btn_export.setEnabled(self.last_clicked == "pause" and
                                        self.last_clicked != "export")
        self.form.lbl_seek.setEnabled(self.last_clicked == "pause" and
                                      self.last_clicked != "export")
        self.form.sld_seek.setEnabled(self.last_clicked == "pause" and
                                      self.last_clicked != "export")

showChanges()

def Control.ControlPanel.showChanges

(

self

)

Method to show changes made to objects, collisions.

This method is necessary to call after distributeTime, updateCollisions and resetCollisions.

Definition at line 628 of file Control.py.

    def showChanges(self):
        FreeCAD.ActiveDocument.recompute()
        FreeCADGui.updateGui()

showSequences()

def Control.ControlPanel.showSequences	(		self,
			sequences
	)

Method to show sequences to export on a dialog panel.

Sequences and frame numbers are shown in a QTreeView, and buttons ‘'Confirm’ and'Abort'` are attached under it. All of this is put under the Export button on the dialog panel.

Parameters

sequences

A dict with sequence names and numbers of frames.

Definition at line 721 of file Control.py.

    def showSequences(self, sequences):
        # Add names to columns
        NAME, N_FRAMES = range(2)

        # Create a tree view  and set it up
        self.trv_sequences = QTreeView()
        self.trv_sequences.setRootIsDecorated(False)
        self.trv_sequences.setAlternatingRowColors(True)
        self.trv_sequences.setToolTip("Select a sequence to export.")
        self.trv_sequences.setSizeAdjustPolicy(
                self.trv_sequences.AdjustToContents)
        self.trv_sequences.setSizePolicy(
                self.trv_sequences.sizePolicy().Ignored,
                self.trv_sequences.sizePolicy().Minimum)
        self.trv_sequences.header().setResizeMode(
                self.trv_sequences.header().Fixed)
        self.trv_sequences.header().setDefaultSectionSize(120)
        self.trv_sequences.setSelectionMode(self.trv_sequences.SingleSelection)

        # Prepare a table
        model = QStandardItemModel(0, 2, self.trv_sequences)

        # Prepare a header
        hdr_name = QStandardItem("Sequence Name")
        model.setHorizontalHeaderItem(NAME, hdr_name)
        hdr_frames = QStandardItem("# of frames")
        hdr_frames.setTextAlignment(Qt.AlignmentFlag.AlignRight)
        model.setHorizontalHeaderItem(N_FRAMES, hdr_frames)

        # Add data to the table
        for name, frames in sequences.items():
            itm_name = QStandardItem(name)
            itm_name.setSelectable(True)
            itm_name.setEditable(False)
            itm_frames = QStandardItem(str(frames))
            itm_frames.setSelectable(True)
            itm_frames.setEditable(False)
            itm_frames.setTextAlignment(Qt.AlignmentFlag.AlignRight)
            model.appendRow((itm_name, itm_frames))

        # Add the table to the tree view
        self.trv_sequences.setModel(model)

        # Add the tree view to the panel under the EXPORT button
        self.form.lyt_main.insertWidget(5, self.trv_sequences)

        # Make column with the numbers of frames smaller
        self.trv_sequences.setColumnWidth(1, 80)
        # Select the first item
        self.trv_sequences.setCurrentIndex(model.index(0, 0))

        # Add horizontal layout under the tree view
        self.lyt_export = QHBoxLayout()
        self.form.lyt_main.insertLayout(6, self.lyt_export)

        # Add buttons for confirmation of a selected sequence and
        # export abortion
        self.btn_confirm = QPushButton("Confirm")
        self.btn_confirm.setStyleSheet(
            """
            QPushButton {
                background-color: qlineargradient(x1: 0, y1: 0, x2: 0, y2: 1,
                                            stop: 0 #0B0, stop: 1.0 #0D0);
                font-weight: bold;
            }
            QPushButton:hover {border-color: #0D0;}
            QPushButton:focus {
                background-color: qlineargradient(x1: 0, y1: 0, x2: 0, y2: 1,
                                            stop: 0 #0C0, stop: 1.0 #0F0);
                border-color: #0E0; color: #FFF;
            }
            QPushButton:pressed {
                background-color: qlineargradient(x1: 0, y1: 0, x2: 0, y2: 1,
                                            stop: 0 #0F0, stop: 1.0 #0C0);
            }""")
        self.btn_confirm.clicked.connect(self.exportConfirmed)
        self.btn_abort = QPushButton("Abort")
        self.btn_abort.setStyleSheet(
            """
            QPushButton {
                background-color: qlineargradient(x1: 0, y1: 0, x2: 0, y2: 1,
                                            stop: 0 #B00, stop: 1.0 #D00);
                font-weight: bold;
            }
            QPushButton:hover {border-color: #D00;}
            QPushButton:focus {
                background-color: qlineargradient(x1: 0, y1: 0, x2: 0, y2: 1,
                                            stop: 0 #C00, stop: 1.0 #F00);
                border-color: #E00; color: #FFF;
            }
            QPushButton:pressed {
                background-color: qlineargradient(x1: 0, y1: 0, x2: 0, y2: 1,
                                            stop: 0 #F00, stop: 1.0 #C00);
            }""")
        self.btn_abort.clicked.connect(self.exportAborted)
        self.lyt_export.addWidget(self.btn_confirm)
        self.lyt_export.addWidget(self.btn_abort)

        # Create a function to disable deselection
        def mySelectionChanged(selected, deselected):
            if selected.isEmpty() and not deselected.isEmpty():
                self.trv_sequences.selectionModel().select(
                        deselected.first().indexes()[0],
                        self.trv_sequences.selectionModel().Select
                        | self.trv_sequences.selectionModel().Rows)

        # Connect the function as a slot for signal emitted when selection is
        # changed
        self.trv_sequences.selectionModel().selectionChanged.connect(
                mySelectionChanged)

sliderChanged()

def Control.ControlPanel.sliderChanged

(

self

)

Feedback method called when slider position is changed.

If slider is enabled (not used to show animation time) and slider position is changed, time is extrapolated from slider position and animation in that time is shown.

Definition at line 318 of file Control.py.

    def sliderChanged(self):
        # Check if the slider is enabled i.e. the change is an user input,
        # not a visualization of animation progress
        if self.form.sld_seek.isEnabled():
            # Load current time from the time slider and show it.
            t = self.form.sld_seek.value() \
                * (self.control_proxy.StopTime
                   - self.control_proxy.StartTime) / 100 \
                + self.control_proxy.StartTime
            self.distributeTime(t)
            self.updateCollisions()
            self.showChanges()

updateCollisions()

def Control.ControlPanel.updateCollisions

(

self

)

Method to update collisions from CollisionDetector children.

List of children is loaded. If a child is CollisionDetector, it's touched so that it's recomputed.

Definition at line 597 of file Control.py.

    def updateCollisions(self):
        # Load list of objects inside Control group
        objects = self.control_proxy.Group

        # if they are CollisionDetectors, then check for collisions
        while len(objects) > 0:
            obj = objects.pop(0)
            if obj.Proxy.__class__.__name__ == "CollisionDetectorProxy":
                obj.touch()

writeFramerateChunk()

def Control.ControlPanel.writeFramerateChunk	(		self,
			framerate,
			image_path
	)

Method to write a framerate into a PNG image as one of its chunks.

This method tries to import pyPNG first. Then it tries to install it and import again. If either import is successful, all chunks currently in the PNG image at an image_path are extracted. The framerate chunk is added as the second chunk, right behind IHDR. Finally the image is rewritten with new list of chunks.

Parameters

framerate	A float specifying the framerate to be written into the image.
image_path	A str containing a path to an image about to be augmented.

Definition at line 976 of file Control.py.

    def writeFramerateChunk(self, framerate, image_path):
        # import or install pyPNG
        try:
            import png
        except ModuleNotFoundError:
            self.installPyPNGNotice()
            return False
        except Exception as e:
            FreeCAD.Console.PrintError(
                "Unexpected error occurred while importing pyPNG - " + str(e))

        # Read chunks already present in a PNG image
        reader = png.Reader(filename=image_path)
        chunks = list(reader.chunks())
        # Insert custom framerate chunk
        chunks.insert(1, (FPS_CHUNK_CODE, struct.pack("f", framerate)))

        # Write it into the image
        with open(image_path, 'wb') as image_file:
            png.write_chunks(image_file, chunks)

        return True

Member Data Documentation

btn_abort

Control.ControlPanel.btn_abort

A QPushButton to abort exporting a sequence.

Definition at line 797 of file Control.py.

btn_confirm

Control.ControlPanel.btn_confirm

A QPushButton to confirm sequence to export.

Definition at line 778 of file Control.py.

control_proxy

Control.ControlPanel.control_proxy

A proxy to an associated Control class.

Definition at line 129 of file Control.py.

form

Control.ControlPanel.form

A QDialog instance show in the TaskView.

Definition at line 136 of file Control.py.

image_number

Control.ControlPanel.image_number

An int number of a next recorded image.

Definition at line 241 of file Control.py.

last_clicked

Control.ControlPanel.last_clicked

A str showing which button was pressed last.

Definition at line 151 of file Control.py.

lyt_export

Control.ControlPanel.lyt_export

A QHBoxLayout with a confirm and abort buttons.

Definition at line 773 of file Control.py.

record_prefix

Control.ControlPanel.record_prefix

A str prefix for an image file name.

Definition at line 239 of file Control.py.

timer

Control.ControlPanel.timer

A QTimer for timing animations.

Definition at line 147 of file Control.py.

trv_sequences

Control.ControlPanel.trv_sequences

A QTreeView showing list of recorded sequences.

Definition at line 726 of file Control.py.

---

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

• Doxypypy outputs/Control.py