Code source de FreeCAD

From FreeCAD Documentation
Revision as of 10:34, 18 March 2021 by FuzzyBot (talk | contribs) (Updating to match new version of source page)

Le FreeCAD source code est géré avec git et est public, ouvert et disponible sous la licence LGPL. Il peut être copié, téléchargé, lu, analysé, redistribué et modifié par n'importe qui. Si vous prévoyez d'apporter des modifications que vous souhaitez voir incluses dans le code officiel lui-même, n'oubliez pas que vos modifications devront être approuvées par les développeurs de FreeCAD, il est donc sage de discuter d'abord de vos intentions et de vos idées sur le forum, pour éviter le risque de voir vos modifications rejetées pour une raison que vous n'aviez pas prévue.

Vous trouverez ci-dessous quelques indices et informations utiles pour vous mettre sur les rails si vous souhaitez explorer le code FreeCAD.

  • Le code FreeCAD est principalement programmé en C++ mais repose fortement sur Python. Une très grande partie de ses fonctionnalités fournit des liaisons Python associées, et cela fait partie de la philosophie de base du développement FreeCAD de toujours offrir un accès python à toute nouvelle fonctionnalité implémentée en C++. Pour obtenir cela, CPython (les outils d'interfaçage C fournis par Python lui-même) et spécialement PyCXX sont largement utilisés dans FreeCAD. De nombreux modèles et outils personnalisés sont également fournis dans le code FreeCAD lui-même pour faciliter la création de liaisons python associées. Certaines parties de plus haut niveau du code FreeCAD sont entièrement codées en Python.
  • Le code source de FreeCAD est entièrement multi-plateforme et un grand soin est pris pour permettre d'utiliser l'application sur un plus grand nombre possible de plates-formes et de configurations, et de ne pas mettre les utilisateurs existants dans des situations difficiles. Par conséquent, autant que possible, les nouvelles versions des composants nécessaires sont évitées alors qu'elles ne sont pas largement et facilement disponibles sur toutes les plates-formes, et la rétrocompatibilité (la possibilité d'ouvrir un fichier produit avec une ancienne version de FreeCAD sur une version plus récente) est un priorité importante.
  • Presque toutes les fonctionnalités de FreeCAD sont séparées en deux parties différentes, nommées App et Gui. Cette séparation se reflète partout dans la structure des fichiers du code source. L'application contient toutes les fonctionnalités nécessaires pour fonctionner en mode console pure (pas d'interface graphique). Comme FreeCAD peut être compilé et exécuté sans son interface utilisateur graphique, le code de l'application est indépendant de toute bibliothèque liée à l'interface graphique. L'interface graphique contient tout le code nécessaire pour s'exécuter en mode GUI et est construite autour de la fonctionnalité de l'application.
  • La plupart des fonctionnalités de FreeCAD sont implémentées dans Modules. FreeCAD sans son module est une simple fenêtre de conteneur qui peut simplement ouvrir et enregistrer un fichier. Tous les outils de géométrie et les ateliers sont implémentés dans des modules. Les modules peuvent être écrits en C++, en Python ou en combinant le meilleur des deux mondes. Il peut s'agir de modules hybrides C++/Python, où les fonctionnalités de base solides sont programmées en C++ et les outils de l'utilisateur final sont écrits en Python, ce qui les rend plus faciles à étendre et à adapter par les utilisateurs de FreeCAD. Chaque module définit et crée généralement un Atelier dans l'interface FreeCAD, lorsqu'il est utilisé en mode GUI, généralement avec le même nom, mais il n'est pas obligatoire pour les modules de contenir un workbench.
  • Les modules FreeCAD dépendent souvent d'autres modules. La plupart des modules qui utilisent la géométrie solide dépendent du module Part, qui est le module le plus fondamental de FreeCAD, et implémente la plupart de l'interfaçage avec OpenCascade. Bien que d'autres modules puissent utiliser directement la fonctionnalité OpenCascade, ils s'appuient souvent sur des fonctions de niveau supérieur fournies par Part.
  • Les modules sont toujours initialisés depuis Python. Même s'ils sont entièrement écrits en C++, ils contiennent toujours une structure Python/CPython minimale.
  • FreeCAD est un utilisateur avide d'autres bibliothèques open-source. Outre Python et Qt, utilisés par le noyau et presque tous les modules, les deux bibliothèques lourdes utilisées dans la plupart des modules sont Open CASCADE Technology (OCCT) et Coin3D Open Cascade est utilisé pour créer et gérer toute la géométrie solide de FreeCAD, tandis que coin3D est utilisé pour gérer la vue 3D. OpenCascade est principalement utilisé dans le monde des applications et coin3D exclusivement dans le monde de l'interface graphique. Une compréhension de base d'Open Cascade est fondamentale pour effectuer tout travail lié à la géométrie avec FreeCAD. Des modules plus spécifiques utilisent des bibliothèques plus spécifiques, et comme il n'y a généralement aucune restriction sur ce point en dehors de ces bibliothèques pour être facilement disponibles sur toutes les plates-formes, la liste des dépendances d'une installation complète de FreeCAD avec tous ses modules peut être assez longue.
  • Les objets de document de FreeCAD, qui sont tous les objets contenus dans un document FreeCAD, sont ce qui apparaît dans l'arborescence de l'interface graphique et dans FreeCAD.ActiveDocument.Objects() en Python. Ils peuvent ou non avoir des données géométriques, et peuvent ou non afficher quoi que ce soit dans la vue 3D. Ils sont toujours séparés dans les parties App et Gui. La partie Gui n'est pas chargée lors de l'exécution en mode console. Les objets géométriques standard, tels que ceux trouvés dans Part ou PartDesign, ont leur géométrie basée sur OpenCascade définie dans leur homologue App, tandis que l'homologue Gui (également généralement appelé "View Provider") est responsable de la création d'une représentation coin3D de cette géométrie, qui sera inséré dans le graphique principal de la scène coin3D de la vue 3D.
  • La structure de répertoire de base du code source est organisée comme ceci:
    • App: contient l'application en mode console FreeCAD, définit les structures de base et les classes de base pour les objets de document, qui sont utilisées par les modules pour créer leurs propres
    • Base: contient les fonctionnalités de base couramment utilisées partout dans FreeCAD: vecteurs 3D, unités, matrices, placements, etc.
    • Gui: contient l'application en mode GUI de FreeCAD, définit la vue 3D, contient de nombreux outils et fonctions à utiliser par les établis pour interagir avec l'interface et avec la vue 3D, définit les classes de base pour les fournisseurs de vues .
    • Doc: contient principalement un fichier d'aide Qt tout-en-un généré à partir de ce wiki.
    • Mod: contient tous les modules, eux-mêmes séparés en App et Gui (à l'exception des modules python, qui ne suivent pas toujours cette règle aussi clairement).

En relation