Skip to content
design-notes.rst 5.85 KiB
Newer Older
Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. _design-note-page:
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
==============
 Design Notes
==============
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Patro is a python implementation of the `Valentina <http://valentina-project.org/>`_ Pattern
Fabrice Salvaire's avatar
Fabrice Salvaire committed
Making software, which only focus to implement the core engine and not the graphical user interface.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

A pattern in flat pattern design is build from geometrical operations which can be turned to a
computer program and is thus a field of applications of Computer Aided Design.  It corresponds more
precisely to parametric modelling with dedicated features to fashion modelling and manufacturing.

What is the requirements of a pattern drafting software ?
---------------------------------------------------------

The core functionality of a CAD system for pattern drafting consists of these two software components :

Fabrice Salvaire's avatar
Fabrice Salvaire committed
* an **open** file format to store and exchange the pattern,
Fabrice Salvaire's avatar
Fabrice Salvaire committed
* a geometrical engine to compute the pattern, e.g. to generate the layout of each fabric's piece of a clothe.

The XML language is a natural candidate to define an open file format to store and exchange the
pattern. Valentina uses XML to sore measurements in *.vit* files and patterns in *.val* files.

Another solution to define and store a pattern is to use a programming language, it can be a
dedicated language or any programming language associated to a dedicated API.  Many graphical
languages was invented for specific usages, e.g. PostScript for printer, Metafont and MetaPost for
publishing, G-code for machining etc.

Usually the geometrical operations of a pattern are simple in comparison to the requirements of a
mechanical or electronic CAD software.  In first hand it is only 2D and the number of operations
should be handled smoothly by a computer of these days, whereas it is still challenging for other
Fabrice Salvaire's avatar
Fabrice Salvaire committed
domains.

.. A pattern drafting software only need a good geometrical engine to be designed efficiently.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Finally, a pattern drafting software requires an efficient graphical user interface so as to be used
Fabrice Salvaire's avatar
Fabrice Salvaire committed
by fashion designers and not only by hackers.  This software component is more challenging in therms
of software engineering, i.e. in therms of design and cost.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Why Python is a good language for this library ?
------------------------------------------------

The Python language has a large audience in engineering, due to its canonical syntax and richness of
its ecosystem (scientific libraries).

Python is a high level language and thus more productive.

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Python is used as scripting language to extend many softwares, in particular the famous open source
Fabrice Salvaire's avatar
Fabrice Salvaire committed
3D creation suite `Blender <https://www.blender.org>`_, the parametric 3D modeller `FreeCad
<http://freecadweb.org>`_ as well as the SVG editor `Inkscape <https://inkscape.org/>`_.  Moreover
the 3D human model generator `MakeHuman <http://www.makehuman.org>`_ is written in Python.

Python can be easily extended by C libraries using `CFFI <http://cffi.readthedocs.io/en/latest>`_
and C++ libraries using `SWIG <http://www.swig.org>`_.

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Python as other dynamic languages is able to evaluate code on the fly which provide an expression
evaluator for free.  And this feature is even more pertinent in our case because of the canonical
nature of the syntax of Python which is natural to somebody initiated to a basic mathematical
language level.

Fabrice Salvaire's avatar
Fabrice Salvaire committed
What is the purpose of this library ?
-------------------------------------

This library could serve several purposes :

* help to experiment core features for pattern drafting,
* plug Valentina to software featuring a Python plugin mechanism like Blender, FreeCad etc.

Could we implement a full software using Python ?
-------------------------------------------------

Fabrice Salvaire's avatar
Fabrice Salvaire committed
The answer is *yes we can!* since `Qt <https://www.qt.io>`_ has as a nice binding so called
`PyQt <https://riverbankcomputing.com/software/pyqt/intro>`_.

..  (if we consider Qt is superior to GTK and WxWidgets)
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
But up to now Python has of course some drawbacks!
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Its main drawback is due to the fact the standard interpreter cannot execute more than one *Python
Fabrice Salvaire's avatar
Fabrice Salvaire committed
bytecode* thread at once, this limitation so called Global Interpreter Lock is required for
implementation simplicity.

..  in true parallelism (multi-core)
.. Consequently we can do multi-threading, even on multi-core in some cases, but less easily than in Java or Cxx11.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Despite a GUI implemented in PyQt is almost of the time more faster than the human perception on a
Fabrice Salvaire's avatar
Fabrice Salvaire committed
computer of these days.  It can be sometime difficult to overcome latency arising from the software
stack.  Thus yes we can do it, but it could requires some tricks to achieve the performance of a C++
application.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

How to generate drawings in standard format like PDF or SVG ?
-------------------------------------------------------------

SVG is not difficult to generate from Python since it is based on XML.  However the PDF format is
more challenging, for efficiency reason PDF is a binary format and is thus much more complicated
Fabrice Salvaire's avatar
Fabrice Salvaire committed
than PostScript which is a true programming language.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

There is several possibilities to generate PDF.

The most disturbing one is to use the `LaTeX <https://en.wikipedia.org/wiki/LaTeX>`_ publishing
system in combination with the `PGF <http://www.texample.net/tikz/examples>`_ package which provide
Fabrice Salvaire's avatar
Fabrice Salvaire committed
an amazing graphical language on top of LaTeX.  This solution could terrify many peoples, but it do
the job very well for text and graphics.  However user must install a LaTeX environment from their
Linux distribution or using the `TexLive <https://www.tug.org/texlive>`_ distribution.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
A more conventional solution requires a library that can generate PDF from standard graphical
operations.  Some libraries featuring that are :
Fabrice Salvaire's avatar
Fabrice Salvaire committed

* Qt using QPainter API, Valentina solution, see https://wiki.qt.io/Handling_PDF
* `Cairo <https://www.cairographics.org/manual/cairo-PDF-Surfaces.html>`_
* `ReportLab <http://www.reportlab.com/opensource>`_  open-source PDF Toolkit (more commercial and less known)
* `Matplotlib <http://matplotlib.org>`_ (but more oriented to plot)
* and ???