Drawing Documentation/fr

Cette page documente le module de dessin de jcc242. Il inclut des fichiers et des fonctionnalités sur lesquels il travaille actuellement et qui peuvent ne pas encore être dans la branche principale. La source de ces fichiers est sur son Github mais faites attention car il est pour le moment très instable!

gdtsvg.py
Script Python qui génère des extraits svg pour des éléments tels que les symboles gd & t, des symboles de dimension et des éléments de base svg tels que des lignes, des cercles et des chemins.

Il a plusieurs fichiers qui ne font pas vraiment beaucoup de choses. Exécutez DrawingTest.py pour créer un groupe d’icônes svg dans le répertoire icon qui affiche différentes icônes dans le fichier gdtsvg.py. settingslist.py, dimesettings et convert.py sont tous déconseillés pour les méthodes de paramétrage plus anciennes et doivent probablement être supprimés à mesure que la branche de dessin se fusionne en maître.

DrawingAlgos.py
Crée des lignes svg à partir d'une liste de sommets, prend en charge les bords cachés et visibles. Devrait probablement être fusionné avec gdtsvg.py à l’échéance du fichier.

createSVG
Accepte la pièce en tant qu'argument, projette la pièce dans des lignes à partir de l'objet Drawing.project, puis dessine et crée le svg pour chaque ligne.

App
Contient le côté arrière du module de dessin.

AppDrawing.cpp
Initialise les différents espaces de noms, modules et éléments utilisés dans le module de dessin. Lance une erreur s'il ne peut pas charger le module Part.

DrawingExport.cpp
Deux classes: SVGOutput et DXFOutput. Ils contiennent tous deux des méthodes pour afficher le code dans leur langue respective. Nécessite généralement un objet de la typedef appropriée, et parfois des informations d'identifiant supplémentaires.

FeatureClip.cpp
Callback (?) méthodes pour l'interface de coupure de fonctionnalité, semble-t-il. Appelé seul, il créera le chemin du clip. Si ShowFrame.getValue est défini sur TRUE, il affiche également la bordure de l'image.

FeaturePage.cpp
Gère les vues.

onChanged for doing stuff when properties get changed.

execute for recalculating a feature view, or so it claims. It seems to have stuff for checking for editable texts and saving drawings. Need to investigate further.

getEditableTextsFromTemplate for retrieving text that can be edited by FreeCAD from an SVG file.

FeatureProjection.cpp
Flattens object to a 2D image?

FeatureView.cpp
Defines the properties for views.

FeatureViewAnnotation.cpp
Defines properties for annotations (right now just text), has an execute method to update the text if changed/moved.

FeatureViewPart.cpp
Constructor to add properties. Gets appearance stuff for projected parts.

PageGroup.cpp
Just adds a property for a list of pages, does not much else.

Precompiled.cppp
Just #include "PreCompiled.h"

ProjectionAlgos.cpp
The constructor just runs the execute method to update it's stuff

invertY: since SVG does its y-axis backwards to every other coordinate system in the world, we must invert it when converting from a FreeCAD part to an SVG projection for the Drawing view.

getSVG: fetches the SVG code from the DrawingExport stuff. Formats depending on type of line (hidden or not and some other stuff I need to figure out).

getDXF: same as getSVG except for DXF format.

AppDrawingGui.cpp
Initializes the drawing gui.

AppDrawingGuiPy.cpp
Provides opening, importing, and exporting interfaces? Looks like it is python accessible.

Command.cpp
Handles commands (from the toolbar?) such as creating new drawings and stuff. It looks like this handles QT calls from clicking the button to whatever command it needs to go to e.g. clicking the CmdDrawingOrthoViews button will show the Ortho views gui in the task dialog spot.

DrawingView.cpp
Does a bunch of qt gui stuff, need to read more on it.

TaskDialog.cpp
Creates the task dialog thing on the side and probably switches to it from the tree view, as appropriate.

TaskOrthoViews.cpp
Creates the task dialog for placing the orthographic views!

Does a lot of the calculations for where to position stuff (automatic calculations as well, it seems).

Takes the input from the TaskOrthoViews gui and does stuff with it. Uses the single inheritance method talked about on the qt website.

ViewProviderPage.cpp
Constructor adds some properties for the view stuff. Destructor does nothing. Attaches something (attaches what? attaches the view to the page?) sets and gets display modes (what are display modes? what do they do and what are possible options?) Does something about updating some kind of data has a context menu that says "Show drawing", figure out what this means Has a thing for double clicking to select the view (I think?)

showDrawingView seems to do some work on settings things up: gets the current document, sets the window icon and title, adds it to the main window (of FreeCAD?)

ViewProviderView.cpp
Doesn't seem to do much, though I am sure it is important.

Workbench.cpp
Adds the icons to the toolbars and stuff.

= Workflow =

Program Flow
CanvasView is the actual QGraphicsScene object and DrawingView processes a list of FeatureView that are linked by reference in /App/FeatureViewPage. DrawingView then chooses the appropriate QGraphicsItem class (QGraphicsItemViewPart or QGraphicsItemViewDimension) and then calls a function in CanvasView to create this and add it to the scene.

Adding commands to the Drawing Workbench
4 simple steps:
 * 1) Add a class to Command.cpp. Follow the others for an example of the formatting.
 * 2) Add a title, icon, tooltip, etc., again, follow the existing classes in command.cpp
 * 3) Add your class to the bottom of Command.cpp
 * 4) Add your information to Workbench.cpp, this will tell FreeCAD/Drawing module where to place the icons defined in command.cpp  in the actual freecad interface (the toolbars, dropdowns, etc.)