IPSDK 4.1.0.2
IPSDK : Image Processing Software Development Kit
IPSDK Interface documentation

Movie maker

Overview

The moviemaker module allows the user to create his own 3D animations, in a way similar to video editing softwares, and then export them as videos or gifs.

Creating movies or animations facilitates the understanding and readability of 3D results, thus avoiding the use of 2D screenshots, which are usually harder to interpret. This module is an embedded solution in IPSDK Explorer for sharing results via publications or during presentations.

The module launches by accessing the 3D viewer module first, by clicking on the 3D button, then by clicking on the clapperboard button.


Interface


Once the movie maker module is opened, additional buttons and a timeline will appear beneath the 3D viewer. It is on this timeline that the frames forming the animations will be added. Below is an illustration depicting the 3D viewer in moviemaker mode, with several frames within the timeline.


Buttons

The buttons allow various actions in the moviemaker, from adding frames, to playing the movie or saving an animation.

Here is a detailed list of each button and the action associated with it in the module.

Icon Description
Add.png
Adds a new frame to the movie.
Trash.png
Deletes the selected frame.
Lecture.png
Plays the movie at the movie slider position.
Pause.png
Pauses the movie.
Save_Movie.png
Exports the movie with a video format to a chosen folder.
Delete.png
Deletes all the frames of the movie.
Save.png
Saves all the settings changed and the camera positions as a scenario.
Save_Folder.png
Saves all the volumes/meshes in the list as well as the scenario in a project.
Folder.png
Imports an existing scenario or project.
Settings.png
Opens the settings window.


Video track

Like in most video editing software, the moviemaker module also has a video track. This track will not contain videos, but instead a list of frames that will form the final video.

The video track consists of a timeline, a timeline slider, and a queue of frames. It allows to add new frames and organizing them to create the desired animation.

Adding new frames creates new thumbnails to the video track. There are many ways to interact with the frames.

All possible interactions with the video track and frames are summarized in the table below.

Interactions Description
mouseDoubleClick.png
Selects a frame and load its state in the viewer.
mouseDrag.png
Moves a frame inside the video track when interacting with a frame, or changes the frame displayed when interacting with the time slider.
ctrlDrag.png
Moves a frame and all the frames behind it inside the video track.
leftArrow.png
Moves a selected frame to the left in the video track.
rightArrow.png
Moves a selected frame to the right in the video track.
mouseRightClick.png
Opens the contextual menu for a frame.
suppr.png
Deletes a selected frame.


Frames menu


It is possible to modify a frame by right-clicking on its thumbnail. A context menu will open allowing to update, delete, duplicate a frame, or edit the camera parameters of a frame.

Adding Frames

To create a movie, the user must add frames by first changing the volume 3D settings or interacting with the camera, and clicking on the
button.



Every frame created is added to the video track timeline as a thumbnail that is editable.

Frame update

The module allows the user to update a frame. To do so, follow the steps below.

1) Click on the frame to edit and change the 3d settings or the camera position,
2) Right click on the snapshot of the frame and select "Update frame" in the contextual menu,
3) Double click on the first frame and click on play to preview the changes.

Here is an example of what an update of a frame looks like.


Frame removal

The module allows the user to remove a frame from the movie. To do so, follow the instructions below.

1) Right click on the frame to delete,
2) In the contextual menu, select the remove frame option.

It is also possible to select a frame by double clicking on it and click on the
button, or to press DELETE on the keyboard to delete it faster.


Here is an example of what the removal of a frame looks like.


It is also possible to remove all the frames from the video track by clicking the
button.


Frame duplication

The module allows the user to duplicate a frame in the video track. To do so, follow the few steps below.

1) Right click on the frame to duplicate,
2) In the contextual menu, select the duplicate frame option,
3) Move the duplicated frame at the right place in the movie if necessary.

Here is an example of the duplication of a frame.


Frame edition

The module allows the user to edit the camera settings of a frame. To do so, follow the few steps below.

1) Right click on the frame to edit,
2) In the frame editor window, change the settings that needs to be changed,
3) Click on the check mark button on the bottom right when finished to apply changes.

There are different camera settings in the frame editor window, like the zoom, the camera center, the camera angle, and the field of view.

Here is an example of the edition of a frame.


Saving a scenario

Each created animation consists of a scenario that records every parameter modified throughout the film. These scenarios can be saved and re-imported later into the module for further modifications.

Scenario saving is done via the
icon, while project saving, including the scenario and imported images, is done via
icon.


Importing a scenario

After saving a project or a scenario, it is possible to import it into the moviemaker by clicking the
button and choosing either a scenario to apply to a volume or a project to import.

Importing a project will load the saved volumes into the 3D viewer along with the frames composing the scenario.

Exporting a movie

After completing the animation, the module allows to export the movie by clicking on the button
. In the ensuing window, simply give a name to the video and select the desired output format.

Numerous formats are available, such as .avi, .mp4, .gif, .mov, or .mkv.