API de l'atelier Draft
Draft_API/fr
Cette page n'est pas totalement traduite (getRealName, makeDimension, makeWire, select,) et attends un traducteur (voir la page originale en anglais).
(Une fois la page traduite, vous pouvez supprimer le bandeau)
Ces fonctions font partie du Draft module et une fois que le Draft module a été importé,elles peuvent être utilisées dans les scripts et les macros, ou dans l'interpréteur Python.
Exemple:
import FreeCAD from Draft import * myrect = makeRectangle(4,3) mydistance = FreeCAD.Vector(2,2,0) move(myrect,mydistance)
cut(FreeCAD.Object, FreeCAD.Object)Description: Renvoie un objet construit à partir de la différence de la coupe des 2 objets sélectionnés. Les objets originaux obtenu sont cachés.
Returns: Un nouvel objet est créé
extrude(FreeCAD.Object, Vector)Description: Extrude l'objet sélectionné dans la direction donnée par le vecteur. L'objet d'origine est caché.
Returns: Un nouvel objet est créé
formatObject(FreeCAD.Object, [FreeCAD.Object])Description: Cette fonction s'applique à l'objet cible, compte tenu des propriétés actuelles fixées sur la barre d'outils Draft (couleur et largeur de la ligne), ou, le cas échéant copie les propriétés d'un deuxième objet. Il met également l'objet dans le groupe de construction si le bouton de construction est pressé.
Returns: Aucun
fuse(FreeCAD.Object, FreeCAD.Object)Description: Retourne un objet fabriqué à partir de la fusion des 2 objets sélectionnés. Si les objets sont coplanaires, un Draft Wire spécial est utilisé, sinon l'objet final est une fusion standard (standard Part fuse).
Returns: Un nouvel objet est créé
getDraftPath([string])Description: Retourne le chemin d'accès utilisateur ou système, à partir duquel, le Draft module est exécuté. Si un sous-dossier ou un nom de fichier est fourni, le chemin complet vers le sous-dossier de l'intérieur du Draft module est renvoyé.
Returns: Le chemin du fichier
getGroupContents(list)Description: Scanne récursivement la liste de données pour les groupes. Si les groupes sont trouvés, leur contenu est ajouté à la liste.
Returns: Une liste d'Objets FreeCAD
getRealName(string)Description: Strips the trailing numbers from an object name.
Returns: The stripped object name
getSelection( )Description: Retourne la sélection actuelle FreeCAD.
Returns: Retourne la sélection actuelle FreeCAD.
makeCircle(radius, [placement], [facemode], [startangle], [endangle])Description: Crée un objet cercle de rayon donné. Si une coordonnée est fournie, elle est utilisée. Si facemode est False, le cercle est représenté comme un fil de fer, sinon comme une face. Si startAngle et endAngle (en degrés) sont donnés, ils sont utilisés et l'objet apparaîtra comme un arc.
Returns: Un nouvel objet est créé.
makeDimension(Vector, Vector, [Vector] or FreeCAD.Object, int, int, [Vector])Description: Creates a Dimension object measuring distance between first and second vectors, with the dimension line passign through the third vector if provided. The current line width and color from the Draft toolbar will be used. Instead of 2 vectors, you can also pass a FreeCAD object, and two integers (and optionally a vector where the dimension line must pass). In that case, the dimension will be associated with the object, and measure two of its vertices, indicated by the two given indice numbers.
Returns: The newly created object.
makeLine(Vector, Vector)Description: Crée une ligne entre les deux vecteurs données. La largeur de ligne et la couleur courante sélectionnés dans la barre d'outils Draft seront utilisés.
Returns: Un nouvel objet est créé.
makeRectangle(length, width, [placement], [facemode])Description: Crée un objet Rectangle avec une longueur dans la direction X et la hauteur dans la direction Y. Si une position est donnée, elle est utilisée. Si facemode est False, le rectangle est représenté comme un fil de fer, sinon comme une face. La largeur de ligne et la couleur courante sélectionnés dans la barre d'outils Draft seront utilisés.
Returns: Un nouvel objet est créé.
makeText(string or list, [Vector], [screenmode]))Description: Crée un objet Texte, au point donné, si un vecteur est fourni, contenant la chaîne ou les chaînes figurant dans la liste, une chaîne par ligne. La couleur actuelle de la barre d'outils Projet la hauteur du texte et la police spécifiée dans les préférences sont utilisés. Si screenmode est sur True, le texte fait toujours face à la direction de vue, sinon il se trouve sur le plan X, Y.
Returns: Un nouvel objet est créé.
makeWire(list or Part.Wire, [closed], [placement], [facemode])Description: Creates a Wire object from the given list of vectors or from the given Wire. If closed is True or if first and last points are identical, the wire is closed. If facemode is True (and wire is closed), the wire will appear filled. The current line width and color from the Draft toolbar will be used.
Returns: The newly created object.
move(FreeCAD.Object or list, Vector, [copymode]))Description: Déplace l'objet ou les objets sélectionnés contenus dans la liste donnée ,dans la direction et la distance indiquée par le vecteur. Si CopyMode est sur True les objets réels ne sont pas déplacés, mais copiés à sa (leur) place.
Returns: L'objet ou les objets (ou leurs copies, si CopyMode était sur True).
precision( )Description: Retourne la valeur de précision définie dans les paramètres utilisateur.
Returns: Un integer.
rotate(FreeCAD.Object or list, angle, [center], [axis] ,[copymode])Description: Tourne l'objet donné ou les objets sélectionnés à l'angle donné et autour du centre donnée s'ils sont fourni, en utilisant l'axe comme un axe de rotation. Si l'axe est omis, la rotation se fera autour de l'axe vertical Z. Si CopyMode est sur True, les objets réels ne sont pas déplacés, mais les copies sont créées à leur place.
Returns: Les objets (ou leurs copies).
scale(FreeCAD.Object or list, vector, [center], [copymode])Description: Redimensionne l'objet donné ou les objets sélectionnés au facteur d'échelle définis par le vecteur de donnés (X, Y et Z) autour du centre donnée si elle est fournie. Si CopyMode est sur True les objets réels ne sont pas déplacés, mais les copies sont créées à la place.
Returns: Les objets (ou leurs copies).
select(FreeCAD.Object)Description: Deselects everything and selects only the passed object
Returns: Nothing.
shapify(FreeCAD.Object)Description: Transforme un objet de forme paramétrique en objet non-paramétrique.
Returns: Un nouvel objet est créé.
draftify(FreeCAD.Object or list)Description: Met l'objet ou chaque objet sélectionné(s) en fils paramétriques Projet.
Returns: Rien.
getSVG(FreeCAD.Object, [linemodifier], [textmodifier], [(u,v)])Description: Crée une représentation SVG de l'objet donné. L'attribut linemodifier est le facteur d'échelle (en pourcent) pour la largeur de la ligne, et textmodifier pour la taille du texte. Vous pouvez également éventuellement fournir un tuple de vecteurs pour définir un plan de projection, sinon la forme géométrique sera projetée sur le plan X, Y.
Returns: Une chaîne contenant la représentation SVG de l'objet sélectionné.
