[GSoC] Samir55 / 3MF file format

[alranel]

This issue is dedicated to the GSoC student @Samir55 who proposed to implement support for the 3MF file format in Slic3r: https://summerofcode.withgoogle.com/projects/#6343944127381504

This topic was discussed in this original issue:

2811

@Samir55 already contributed to the Slic3r codebase by adding zoom commands (pull request #3864, merged).

@Samir55, welcome to Slic3r! Would you please introduce yourself to the Slic3r community? Please mention any experience with 3D printing or similar technologies, and include your time zone and operating system.

[Samir55]

List of what to be tested in 3MF (Read/ Write):

• Model metadata and their Slic3r custom configs.
• Model materials and their Slic3r custom configs.
• Model Object, meshes, and their Slic3r configs.
• Model Instances and the transformation matrices.

I will read a 3mf file and write it, then compare the output with the expected one.

[Samir55]

Dev Log(30 - July):

• Add a simple read/write test for 3mf.

[Samir55]

Dev Log(31 - July):

• Add another test for TMF::read().

[lordofhyphens]

@Samir55 I left my comments on the pull request (which is probably the easiest way, I find, to leave a code review on github).

[Samir55]

Dev Log(2 - August):

• Revert change in slic3r.pl file and removed .DS_store files.
• Use initialize list in TMFEditor constructor.
• Add partnumber to ModelObject::swap() function called by assignment operator.
• Deleted xs/t/3mf/.DS_Store. Add a new line in the end of slic3r.cpp.

Dev Log(4 - August):

• Removed applying 3mf translation in the z_axis to the model instances.
• Add X&Y rotations, z_translation in 3D, 3D previews, and layers platers. To be applied when duplicating objects, etc.
• Add the parent object part number to the split objects.

[Samir55]

Dev Log(5 - August):

• Initialize Model metadata - add 2 STL test files - add all 3d model test files in xs/models folder.
• Add 3mf test (convert from/to STL) - add partnumber in Model.xsp
• Changed material groups enum to scoped enums - fix a typo in 23_3mf.t

[Samir55]

@alexrj @lordofhyphens Why those 2 STL models give segmentation fault when adding I try to read them in Slic3r GUI.

• STL Files.zip

This is the message :

ahmedsamir@ahmedsamir:~/Slic3r$ perl slic3r.pl
Parentheses missing around "my" list at /home/ahmedsamir/Slic3r/lib/Slic3r/GUI/Plater.pm line 1874.

(slic3r.pl:24443): Gtk-CRITICAL **: IA__gtk_window_resize: assertion 'width > 0' failed
Segmentation fault (core dumped)

If I converted them using CLI into OBJ it worked. However if they are converted to 3mf, Slic3r gives segmentation fault.

ahmedsamir@ahmedsamir:~/Slic3r/build$ ./slic3r Spider_ascii.stl --export-obj
File exported to Spider_ascii.stl.obj
ahmedsamir@ahmedsamir:~/Slic3r/build$ ./slic3r Spider_binary.stl --export-obj
File exported to Spider_binary.stl.obj
ahmedsamir@ahmedsamir:~/Slic3r/build$ ./slic3r Spider_binary.stl --export-3mf
Segmentation fault (core dumped)
ahmedsamir@ahmedsamir:~/Slic3r/build$ ./slic3r Spider_ascii.stl --export-3mf
Segmentation fault (core dumped)

I tried to trace where this segmentation fault occurs, It is in TriangleMesh::repair() function.

What's wrong with those 2 files?

[lordofhyphens]

Offhand, I'd say it's because STL is a terrible format ;) See if it still segfaults when exporting to AMF.

[Samir55]

Dev Log(7 - August):

• Include X&Y rotation angles, scaling vector in the transformation matrix in item tag.

  Dev Log(9 - August):

• Add 3MF file extension to GUI.

@alexrj @lordofhyphens Sorry, I have not been working full time this week, I have been busy (changing our home wall paint). I will finish what is left very soon, Also these issues I want to afterwards work on them (May be extended after GSoC period):

• Improve auto-arrange algorithm with SVGNest. ( I know it would take some time :) )
• Undo to: rotate, flip, split, cut.

[lordofhyphens]

You're welcome to have at those issues ;)

[Samir55]

Dev Log (11 -> 15 August):

3MF read/ write:

---

• Added some enhancements and a test.

  Undo to rotate, flip, split, cut, etc

  ---

  Still working on it. Discussed in issue #3265
  Bracnh : gsoc-undo_redo

• Add Basic UndoableOperation class in Plater.pm.

• Add Undo/ Redo shortcuts.

• Add Undo/Redo to rotation.

[Samir55]

@alexrj @lordofhyphens I have implemented my own zip wrapper. I will push those commits soon :), I am also working on adding undo/redo. Regarding the final evaluation and submitting my work, I will submit the link of the 3mf pull request. Does that seem fine?

[lordofhyphens]

That should be fine (submitting the PR).

It's been pretty good work I've seen so far. If you have the time, making a final pass over your code with -Weffc++ switch on (I mentioned it on IRC) may be helpful to you.

[alranel]

The Pull Request was merged. Success! Congrats to @Samir55 for the great job :)