TechDraw API/fr: Difference between revisions
(Updating to match new version of source page) |
(Created page with "Vous trouverez de bons exemples de scripts TechDraw de base dans le site [https://github.com/FreeCAD/FreeCAD/tree/master/src/Mod/TechDraw/TDTest unit test scripts].") |
||
Line 3: | Line 3: | ||
Ces fonctions font partie de l'[[TechDraw Workbench/fr|Atelier TechDraw]] et peuvent être utilisées dans [[macros/fr|macros]] et à partir de la console [[Python/fr|Python]] une fois que le module {{incode|TechDraw}} a été importé. |
Ces fonctions font partie de l'[[TechDraw Workbench/fr|Atelier TechDraw]] et peuvent être utilisées dans [[macros/fr|macros]] et à partir de la console [[Python/fr|Python]] une fois que le module {{incode|TechDraw}} a été importé. |
||
Vous trouverez de bons exemples de scripts TechDraw de base dans le site [https://github.com/FreeCAD/FreeCAD/tree/master/src/Mod/TechDraw/TDTest unit test scripts]. |
|||
See the [[TechDrawGui API|TechDrawGui API]] for more functions. |
See the [[TechDrawGui API|TechDrawGui API]] for more functions. |
Revision as of 20:22, 2 August 2022
Ces fonctions font partie de l'Atelier TechDraw et peuvent être utilisées dans macros et à partir de la console Python une fois que le module TechDraw
a été importé.
Vous trouverez de bons exemples de scripts TechDraw de base dans le site unit test scripts.
See the TechDrawGui API for more functions.
Example:
import FreeCAD
import TechDraw
page = FreeCAD.ActiveDocument.addObject('TechDraw::DrawPage', 'Page')
FreeCAD.ActiveDocument.addObject('TechDraw::DrawSVGTemplate', 'Template')
FreeCAD.ActiveDocument.Template.Template = templateFileSpec
FreeCAD.ActiveDocument.Page.Template = FreeCAD.ActiveDocument.Template
page.ViewObject.show()
view = FreeCAD.ActiveDocument.addObject('TechDraw::DrawViewPart', 'View')
rc = page.addView(view)
Description: Creates wires from edges in input by planar graph traversal. Optionally exclude the OuterWire by setting optional parameter to false.
Returns: List of wires sorted by size (descending)
Description: Finds the OuterWire (largest) of a list of edges (that form a planar graph).
Returns: Outer wire
Description: Project shape in direction and find outer wire of result.
Returns: Outline wire
Description: Return the edges of a DrawViewPart in Dxf format.
Returns: String
Example:
fileSpecDxf = "fcOut.dxf"
v = App.ActiveDocument.View
s = TechDraw.viewPartAsDxf(v)
dxfEnd = "0\nEOF\n"
dxfFile = open(fileSpecDxf, "w")
dxfFile.write(s)
dxfFile.write(dxfEnd)
dxfFile.close()
Description: Return the edges of a DrawViewPart in Svg format.
Returns: String
Example:
fileSpecSvg = "fcOut.svg"
v = App.ActiveDocument.View
s = TechDraw.viewPartAsSvg(v)
head = '<svg\n' + \
' xmlns="http://www.w3.org/2000/svg" version="1.1" \n' + \
' xmlns:freecad="http://www.freecadweb.org/wiki/index.php?title=Svg_Namespace">\n'
tail = '\n</svg>'
svgFile = open(fileSpecSvg, "w")
svgFile.write(head)
svgFile.write(s)
svgFile.write(tail)
svgFile.close()
Example:
import TechDraw
TechDraw.writeDXFView(myPart,myFileName)
Example:
import TechDraw
TechDraw.writeDXFPage(myPage,myFileName)
DrawViewPart Cosmetics
CosmeticVertex (CV) routines accessible from Python
dvp = App.ActiveDocument.View #CV's belong to views
add a CosmeticVertex at p1 (View coordinates). Returns unique tag.
tag = dvp.makeCosmeticVertex(vector p1)
add a CosmeticVertex at p1 (3d model coordinates). Returns unique tag.
tag = dvp.makeCosmeticVertex3d(vector p1)
returns CosmeticVertex with unique id.
cv = dvp.getCosmeticVertex(string id)
returns CosmeticVertex with name (Vertex6). Used in selections.
cv = dvp.getCosmeticVertexBySelection(string name)
remove CosmeticVertex from View. Returns None.
dvp.removeCosmeticVertex(object cv)
remove all CosmeticVertices from the View. Returns None.
dvp.clearCosmeticVertices()
CosmeticView attributes
Tag: unique identifier. String.
Point: location within view. Vector.
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Py CosmeticVertex demo
import FreeCAD
import TechDraw
v = App.ActiveDocument.View
p = App.Vector(-3.0, -3.0, 0.0)
#make CV
tag = v.makeCosmeticVertex(p)
print("t: {}".format(tag))
#retrieve CV
cv = v.getCosmeticVertex(tag)
print("cv: {}".format(cv))
print("Tag: {}".format(cv.Tag))
cv2 = v.getCosmeticVertexBySelection("Vertex4")
print("New Point: {}".format(cv2.Point))
#make CV from 3d
p3d = App.Vector(2.0, 2.0, 2.0)
print("3d point in: {}".format(p3d))
tag3d = v.makeCosmeticVertex3d(p3d)
cv3 = v.getCosmeticVertex(tag3d)
print("3d point out: {}".format(cv3.Point))
CosmeticEdge (CE) routines accessible from Python
dvp = App.ActiveDocument.View #CE's belong to views
Make a CosmeticEdge from p1 to p2(View coordinates). Returns unique tag.
tag = dvp.makeCosmeticLine(p1, p2)
Make a CosmeticEdge at center with radius radius(View coordinates). Returns unique tag.
tag = dvp.makeCosmeticCircle(center, radius)
Make a CosmeticEdge at center with radius radius(View coordinates) from start angle to end angle. Returns unique tag.
tag = dvp.makeCosmeticCircleArc(center, radius, start, end)
returns CosmeticEdge with unique id.
ce = dvp.getCosmeticEdge(id)
returns CosmeticEdge by name (Edge25). Used in selections.
ce = dvp.getCosmeticEdgeBySelection(name)
remove CosmeticEdge ce from View. Returns None.
dvp.removeCosmeticEdge(ce)
remove all CosmeticLines from the View. Returns None.
dvp.clearCosmeticEdges()
CosmeticEdge attributes
Tag: unique identifier. String.
Format: appearance attributes (style, color, weight, visible). Tuple.
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Py CosmeticEdge demo
import FreeCAD
import TechDraw
#points
org = App.Vector(0.0, 0.0, 0.0)
midTop = FreeCAD.Vector (1.0, 5.0, 0.0) # middle, top
midBot = FreeCAD.Vector(2.0, -5.0, 0.0) # middle, bottom
stdZ = FreeCAD.Vector(0.0, 0.0, 1.0)
center = FreeCAD.Vector(0.0, 0.0, 0.0)
arcCenter = FreeCAD.Vector(3.0, 3.0, 0.0)
vPt = FreeCAD.Vector(-3.0, 3.0, 0.0)
topRight = FreeCAD.Vector(5.0, 5.0, 0.0)
bottomLeft = FreeCAD.Vector(-5.0, -5.0, 0.0)
#angles
arcStart = -45
arcEnd = 45
#styles
solid = 1
dashed = 2
dotted = 3
#weights
weight15 = 0.15
weight75 = 0.75
#colors
pyRed = (1.0, 0.0, 0.0, 0.0)
pyBlue = (0.0, 1.0, 0.0, 0.0)
pyGreen = (0.0, 0.0, 1.0, 0.0)
pyBlack = (0.0, 0.0, 0.0, 0.0)
shadow = (0.1, 0.1, 0.1, 0.0)
radius = 5.0
style = dashed
weight = weight75
dvp = App.ActiveDocument.View
print(dvp)
print("making line")
tag = dvp.makeCosmeticLine(midTop,midBot,style, weight, pyBlue)
ce = dvp.getCosmeticEdge(tag)
print("line tag: {}".format(tag))
print("making diagonal")
dvp.makeCosmeticLine(bottomLeft,topRight,solid, weight, pyGreen)
print("making circle")
tag2 = dvp.makeCosmeticCircle(center, radius, style, weight, pyRed)
ce2 = dvp.getCosmeticEdge(tag2)
print("making circleArc")
dvp.makeCosmeticCircleArc(arcCenter, radius, arcStart, arcEnd, style, weight, shadow)
#replace
print("making new format")
oldFormat = ce.Format
newFormat = (dotted,oldFormat[1], pyRed, True)
ce.Format = newFormat
print("removing CE with tag: {}".format(tag2))
dvp.removeCosmeticEdge(tag2)
print("finished")
CenterLine (CL) routines accessible from Python
make a new CenterLine
tag = dvp.makeCenterLine(subObjs, mode)
retrieve CenterLine with unique tag.
cl = dvp.getCenterLine(tag)
retrieve CenterLine by subobject name. Used in selection.
cl = dvp.getCenterLine("Edge5")
remove CenterLine cl from View. Returns None.
dvp.removeCenterLine(cl)
CenterLine Attributes
Tag: unique identifier. String. ReadOnly.
Type: 0 - face, 1 - 2 line, 2 - 2 point. Integer. ReadOnly.
Mode: 0 - vert, 1 - horiz, 2 - aligned. Integer.
Format: appearance attributes (style, color, weight, visible). Tuple.
HorizShift: left/right offset. Float.
VertShift: up/down offset. Float.
Rotation: rotation in degrees. Float.
Extension: additional length to be added. Float.
Flip: reverse the order of points for 2 point CenterLine. Boolean.
Edges: names of source edges. List of string.
Faces: names of source faces. List of string.
Points: names of source points (Vertices). List of string.
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Py CenterLine demo
import FreeCAD
import Part
import TechDraw
start = FreeCAD.Vector (1.0, 5.0, 0.0) # middle, top
end = FreeCAD.Vector(1.0, -5.0, 0.0) # middle, bottom
faceNames = ["Face0"]
edgeNames = ["Edge2", "Edge3"]
vertNames = ["Vertex1", "Vertex2"]
vMode = 0 #vertical
hMode = 1 #horizontal
aMode = 2 #aligned
#styles
solid = 1
dashed = 2
dotted = 3
#weights
weight15 = 0.15
weight75 = 0.75
#colors
pyRed = (1.0, 0.0, 0.0, 0.0)
pyBlue = (0.0, 1.0, 0.0, 0.0)
pyBlack = (0.0, 0.0, 0.0, 0.0)
#adjustments
hShift = 1.0
vShift = 1.0
extend = 4.0
rotate = 30.0
flip = False;
dvp = App.ActiveDocument.View
print("making face CenterLine")
tag = dvp.makeCenterLine(faceNames,vMode)
cline = dvp.getCenterLine(tag)
print("cline tag: {}".format(tag))
#replace
print("making new format")
oldFormat = cline.Format
newFormat = (dotted,oldFormat[1], pyRed, True)
cline.Format = newFormat
cline.Extension = 10.0
print("making edgeCenterLine")
cline2 = dvp.makeCenterLine(edgeNames,hMode)
print("making vertexCenterLine")
cline3 = dvp.makeCenterLine(vertNames,aMode)
print("finished")
DrawViewPart Geometry
[topoShapeEdge] = dvp.getVisibleEdges()
[topoShapeEdge] = dvp.getHiddenEdges()
topoShapeEdge = dvp.getEdgeByIndex(i)
topoShapeEdge = dvp.getEdgeBySelection("Edge1")
topoShapeVertex = dvp.getVertexByIndex(i)
topoShapeVertex = dvp.getVertexBySelection("Vertex1")
dvp.requestPaint() Redraw the graphic for this View.
- Pages : Page par défaut, Page à partir d'un modèle, Redessiner une page, Tout imprimer
- Vues : Vue, Vue active, Groupe de projections, Vue en coupe, Vue en coupe complexe, Vue détaillée, Vue d'un objet Draft, Vue d'un objet Arch, Vue d'un objet Spreadsheet, Déplacer une vue, Copier une vue, Projection de forme
- Empilement : Empiler en haut, Empiler en bas, Empiler vers le haut, Empiler vers le bas
- Rognages : Fenêtre de rognage, Ajout vue dans une fenêtre de rognage, Suppression vue d'une fenêtre de rognage
- Décorations : Hachures par motif, Hachures géométriques, Symbole, Image, Bascule des cadres
- Cotes : Cote de longueur, Cote horizontale, Cote verticale, Cote de rayon, Cote de diamètre, Cote angulaire, Cote angulaire par 3 points, Cote étendue horizontale, Cote étendue verticale, Lier une cote, Infobulle, Cote axonométrique, Cote à partir des points du repère, Réparation des cotes
- Annotations : Annotation, Ligne de référence, Annotation texte enrichi, Point cosmétique, Points médians, Sommets quadrants, Ligne centrale à une face, Ligne centrale entre 2 lignes, Ligne centrale entre 2 points, Ligne cosmétique par 2 points, Cercle cosmétique, Gomme, Apparence des lignes, Montrer tout, Soudure, Symbole d'état de surface, Tolérance de trou/d'arbre
- Extensions :
- Attributs et modifications : Sélection des attributs, Modification des attributs, Prolonger, Raccourcir, Verrouiller/déverrouiller, Position d'une vue en coupe, Aligner horizontalement, Aligner verticalement, Aligner obliquemement, Cascade horizontale, Cascade verticale, Cascade oblique, Calculer l'aire des faces sélectionnées, Calculer la longueur d'arc d'arêtes sélectionnées, Personnaliser le format d'infobulle
- Lignes centrales, filetage et taraudage : Axes de centrage, Axes de centrage de trous/vis, Corps de taraudage, Taraudage, Corps de filetage, Filetage, Intersection de lignes, Ajouter un sommet décalé, Cercle, Arc, Cercle par 3 points, Ligne parallèle, Ligne perpendiculaire
- Cotes : Cotes horizontales, Cotes verticales, Cotes obliques, Cotes parallèles horizontales, Cotes parallèles verticales, Cotes parallèles obliques, Cote horizontale chanfrein, Cote verticale chanfrein, Longueur d'arc, Diamètre '⌀', Section tube '〼', Supprimer les symboles, Plus de décimales, Moins de décimales
- Exportation : Exporter au format SVG, Exporter au format DXF
- Fonctions supplémentaires : Groupe de lignes, Modèles, Hachures, Dimensionnement géométrique et tolérance, Préférences
- Démarrer avec FreeCAD
- Installation : Téléchargements, Windows, Linux, Mac, Logiciels supplémentaires, Docker, AppImage, Ubuntu Snap
- Bases : À propos de FreeCAD, Interface, Navigation par la souris, Méthodes de sélection, Objet name, Préférences, Ateliers, Structure du document, Propriétés, Contribuer à FreeCAD, Faire un don
- Aide : Tutoriels, Tutoriels vidéo
- Ateliers : Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test, Web