Documentation

[tomasiser]

BOLD means DONE.

Structure:

I. Introduction

• Introduction - copy pasted from Spec
• Related work - copy pasted from Spec, expanded by Jindra's comments

II. Developer Documentation

• Architecture

in the following, elaborate on classes, what they do, how they are connected, what is ours/what is a library thing

• Geometry
  • Geometry
  • Model Importer
  • Model Exporter
  • Font Rasterizer
  • Color Manager
• Commands - check this @Fro-Z pls
• Tools
• User interface
• Testing
  • Unit tests
  • Manual tests - corrupted files, non polyhedron files, different files (jpg), each tool test all properties, export a cube and test the insides, test error logs.
    • missing: Brush and Text Tool
    • done: everything else
  • Continuou Integration
• Building the project
  • Required libraries (CGAL, Assimp, Freetype, Cereal)
  • Cmake

III. Progress of implementation

• Progress of implementation
• Comparison to minimal requirements - straight forward, we met all, and almost all from advanced
• Results - with photos of real 3D prints
  • needs updating with new export
• Chosen techniques critique - choosing CGAL/cereal/cinder, some other that didnt fit in their own chapter
• Future work on the project - all that doesn't work and could, e.g. different more sophisticated export
• Conclusion

IV. User Documentation

• System requirements and Installation - one page, easy
• First run (incl. color palette?)
• Tools:
  • TriPainter
  • BucketPainter
  • Brush
  • Text
  • AutoSeg
  • ManuSeg
• Import, export, .p3d format (incl. slicer support, photos of real examples??)
  • Import
  • Export
  • .p3d
• Aditional options and settings

[tomasiser]

Architecture:

• add threadpool library https://github.com/progschj/ThreadPool
• remove spirit-po library
• use new diagram
  newdiagram.zip
• explain that MainApplication is basically also a container, a single source of truth, that holds data that can be fetched from other components
• explain a simple data flow, use a similar example as from specification 3.3, but explain it in greater details, do not forget to mention that, e.g., side pane calls a draw method on the tools and they render "themselves"

[tomasiser]

Add "how to build" and do not forget to mention how to setup FREETYPE!

[tomasiser]

• 11.2.2 "the user can rotate the camera around the model, and the projection will be orthonormal from the camera angle" - this is wrong, we paint the text from the normal vectors of where the user clicks
• change Part IV to Appendix according to Tobias
• Part III name is same as Chapter 10
• chapter 13: Summary of our work, 3rd party libs, future work