Draft Wire: Difference between revisions

From FreeCAD Documentation
(Link to Python which describes the conventions)
(Updated default shortcuts.)
 
(219 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:20-->
{{Docnav
|[[Draft_Line|Line]]
|[[Draft_Fillet|Fillet]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Line.svg
|IconR=Draft_Fillet.svg
|IconC=Workbench_Draft.svg
}}

<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand|Name=Draft Wire|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]|Shortcut=W I|MenuLocation=Draft → Wire|SeeAlso=[[Draft Line|Draft Line]], [[Draft BSpline|Draft BSpline]]}}
|Name=Draft Wire
|MenuLocation=Drafting → Polyline
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Shortcut={{KEY|P}} {{KEY|L}}
|Version=0.7
|SeeAlso=[[Draft_Line|Draft Line]], [[Draft_BSpline|Draft BSpline]]
}}


==Description== <!--T:2-->
==Description== <!--T:23-->
The Wire tool creates a polyline (sequence of lines made of several segments) in the current [[Draft SelectPlane|work plane]]. It takes the [[Draft Linestyle|linewidth and color]] previously set on the Tasks tab. The Wire tool behaves like the [[Draft Line]] tool, except that it doesn't stop after two points.


<!--T:3-->
<!--T:2-->
The [[Image:Draft_Wire.svg|24px]] '''Draft Wire''' command [[#Create|creates]] a polyline, a sequence of several connected line segments. The command can also be used to [[#Join|join]] [[Draft_Line|Draft Lines]] and Draft Wires.

<!--T:45-->
The corners of a Draft Wire can be filleted (rounded) or chamfered by changing its {{PropertyData|Fillet Radius}} or {{PropertyData|Chamfer Size}} respectively. It is also possible to subdivide the edges of a Draft Wire by changing its {{PropertyData|Subdivisions}} property.

</translate>
[[Image:Draft_Polyline_example.jpg|400px]]
[[Image:Draft_Polyline_example.jpg|400px]]
<translate>
<!--T:3-->
{{Caption|Wire defined by multiple points}}


==How to use== <!--T:4-->
==Create== <!--T:31-->
# Press the {{KEY|[[Image:Draft Wire.png|16px]] [[Draft Wire]]}} button, or press {{KEY|W}} then {{KEY|I}} keys
# Click a first point on the 3D view, or type a [[Draft_Coordinates|coordinate]]
# Click additional point on the 3D view, or type a [[Draft_Coordinates|coordinate]]
# Press {{KEY|F}} or {{KEY|C}}, or double-click the last point, or click on the first point to finish or close the wire. If the wire is closed, it will also be a face, even if it appears as wireframe.


==Options== <!--T:5-->
===Usage=== <!--T:24-->
* If several connected [[Draft Line|Draft Lines]] are selected when pressing the '''Draft Wire''' Button, they will be turned into a wire and the command will exit. {{Version|0.17}}
* Press {{KEY|F}} or the {{KEY|[[Image:Draft FinishLine.png|12px]] '''[[Draft_FinishLine|Finish]]'''}} button to finish the wire, leaving it open
* Press {{KEY|C}} or the {{KEY|[[Image:Draft CloseLine.png|12px]] '''[[Draft_CloseLine|Close]]'''}} button or click on the first point to finish the wire, but making it closed by adding a last segment between the last point and the first one.
* Press {{KEY|X}}, {{KEY|Y}} or {{KEY|Z}} after a point to constrain the next point on the given axis.
* To enter coordinates manually, simply enter the numbers, then press {{KEY|ENTER}} between each X, Y and Z component.
* Press {{KEY|R}} or click the checkbox to check/uncheck the {{KEY|'''Relative'''}} button. If relative mode is on, the coordinates of the next point are relative to the last one. If not, they are absolute, taken from the (0,0,0) origin point.
* Press {{KEY|T}} or click the checkbox to check/uncheck the {{KEY|'''Continue'''}} button. If continue mode is on, the Wire tool will restart after you finish or close it, allowing you to draw another one without pressing the Wire button again.
* Press {{KEY|CTRL}} while drawing to force [[Draft_Snap|snapping]] your point to the nearest snap location, independently of the distance.
* Press {{KEY|SHIFT}} while drawing to [[Draft_Constrain|constrain]] your next point horizontally or vertically in relation to the last one.
* Press {{KEY|W}} or press the {{KEY|[[Image:Draft Wipe.png|12px]] '''Wipe'''}} button to remove the existing segments and start the wire from the last point.
* Press {{KEY|CTRL}}+{{KEY|Z}} or press the {{KEY|[[Image:Draft UndoLine.png|12px]] '''[[Draft_UndoLine|Undo]]'''}} button to undo the last point.
* Press {{KEY|I}} or the {{KEY|'''Filled'''}} button to have the wire filled with a face if it is closed.
* Press {{KEY|ESC}} or the {{KEY|'''Cancel'''}} button to abort the current Line command.
* Closed wires, when in "Flat Lines" display mode, can display a hatch pattern, by setting their "Pattern" property below.


==Properties== <!--T:6-->
<!--T:32-->
See also: [[Draft_Tray|Draft Tray]], [[Draft_Snap|Draft Snap]] and [[Draft_Constrain|Draft Constrain]].
* {{PropertyData|Closed}}: Specifies if the wire is closed or not
* {{PropertyData|Chamfer Size}}: Specifies the size of chamfered corners
* {{PropertyData|Fillet Radius}}: Specifies a curvature radius to give to the nodes of the wire
* {{PropertyData|Subdivisions}}: Divides the segments of the wire with the given number of subdivisions {{version|0.16}}
* {{PropertyData|Make Face}}: Fills the wire with a face if it is closed
* {{PropertyView|End Arrow}}: Shows an arrow symbol at the last point of the wire, so it can be used as an annotation leader line
* {{PropertyView|Pattern}}: Specifies a hatch pattern to fill the wire with (Closed Wire)
* {{PropertyView|Pattern Size}}: Specifies the size of the hatch pattern


<!--T:10-->
<!--T:4-->
# There are several ways to invoke the command:
See also [[Draft Pattern|Draft Pattern]] page.
#* Press the {{Button|[[Image:Draft_Wire.svg|16px]] [[Draft_Wire|Polyline]]}} button.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_Wire.svg|16px]] Polyline}} option from the menu.
#* Use the keyboard shortcut: {{KEY|P}} then {{KEY|L}}.
# The {{MenuCommand|Polyline}} task panel opens. See [[#Options|Options]] for more information.
# Pick the first point in the [[3D_view|3D view]], or type coordinates and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button.
# Pick additional points in the [[3D_view|3D view]], or type coordinates and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button.
# Press {{KEY|Esc}} or the {{Button|Close}} button to finish the command.

===Options=== <!--T:25-->

<!--T:33-->
The single character keyboard shortcuts available in the task panel can be changed. See [[Draft_Preferences|Draft Preferences]]. The shortcuts mentioned here are the default shortcuts (for version 0.22).

<!--T:5-->
* To manually enter coordinates enter the X, Y and Z component, and press {{KEY|Enter}} after each. Or you can press the {{Button|[[Image:Draft_AddPoint.svg|16px]] Enter point}} button when you have the desired values. It is advisable to move the pointer out of the [[3D_view|3D view]] before entering coordinates.
* Press {{KEY|R}} or click the {{MenuCommand|Relative}} checkbox to toggle relative mode. If relative mode is on, coordinates are relative to the last point, if available, else they are relative to the coordinate system origin.
* Press {{KEY|G}} or click the {{MenuCommand|Global}} checkbox to toggle global mode. If global mode is on, coordinates are relative to the global coordinate system, else they are relative to the [[Draft_SelectPlane|working plane]] coordinate system. {{Version|0.20}}
* Press {{KEY|F}} or click the {{MenuCommand|Filled}} checkbox to toggle filled mode. If filled mode is on, the created wire will have {{PropertyData|Make Face}} set to {{TRUE}} and will have a filled face, provided it is closed and does not self-intersect. Note that a self-intersecting wire with a face will not display properly, for such a wire {{PropertyData|Make Face}} must be set to {{FALSE}}.
* Press {{KEY|N}} or click the {{MenuCommand|Continue}} checkbox to toggle continue mode. If continue mode is on, the command will restart after using {{Button|[[Image:Draft_FinishLine.svg|16px]] Finish}} or {{Button|[[Image:Draft_CloseLine.svg|16px]] Close}}, or after creating a closed wire by snapping to the first point of the wire, allowing you to continue creating wires.
* Press {{KEY|/}} or the {{Button|[[Image:Draft_UndoLine.svg|16px]] Undo}} button to undo the last point.
* Press {{KEY|A}} or the {{Button|[[Image:Draft_FinishLine.svg|16px]] Finish}} button to finish the command and leave the wire open.
* Press {{KEY|O}} or the {{Button|[[Image:Draft_CloseLine.svg|16px]] Close}} button to finish the command and close the wire. A closed wire can also be created by snapping to the first point of the wire.
* Press {{KEY|W}} or the {{Button|[[Image:Draft Wipe.svg|16px]] Wipe}} button to delete the segments already placed, but keep working from the last point.
* Press {{KEY|U}} or the {{Button|[[Image:Draft SelectPlane.svg|16px]] [[Draft_SelectPlane|Set WP]]}} button to adjust the current working plane in the orientation of the last segment.
* Press {{KEY|S}} to switch [[Draft_Snap|Draft snapping]] on or off.
* Press {{KEY|Esc}} or the {{Button|Close}} button to finish the command.

==Join== <!--T:34-->

===Usage=== <!--T:35-->

<!--T:36-->
# The end points of the [[Draft_Line|Draft Lines]] and/or Draft Wires to be joined must be exactly coincident. If required first adjust points to ensure that this is the case.
# Select two or more [[Draft_Line|Draft Lines]] and/or Draft Wires.
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Draft_Wire.svg|16px]] [[Draft_Wire|Draft Wire]]}} button.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_Wire.svg|16px]] Polyline}} option from the menu.
#* Use the keyboard shortcut: {{KEY|P}} then {{KEY|L}}.

==Notes== <!--T:37-->

<!--T:14-->
* A Draft Wire can be edited with the [[Draft_Edit|Draft Edit]] command.
* A Draft Wire can be converted to a [[Draft_BSpline|Draft BSpline]] with the [[Draft_WireToBSpline|Draft WireToBSpline]] command.
* [[Draft_Line|Draft Lines]] and Draft Wires can also be joined with the [[Draft_Join|Draft Join]] command or the [[Draft_Upgrade|Draft Upgrade]] command.

==Properties== <!--T:28-->

<!--T:38-->
See also: [[Property_editor|Property editor]].

<!--T:39-->
A Draft Wire object is derived from a [[Part_Part2DObject|Part Part2DObject]] and inherits all its properties. It also has the following additional properties:

===Data=== <!--T:29-->

<!--T:40-->
{{TitleProperty|Draft}}

<!--T:17-->
* {{PropertyData|Area|Area}}: (read-only) specifies the area of the face of the wire. The value will be {{value|0.0}} if {{PropertyData|Make Face}} is {{FALSE}} or the face cannot be created.
* {{PropertyData|Base|Link}}
* {{PropertyData|Chamfer Size|Length}}: specifies the length of the chamfers at the corners of the wire.
* {{PropertyData|Closed|Bool}}: specifies if the wire is closed or not. If the wire is initially open this value is {{FALSE}}, setting it to {{TRUE}} will draw a line segment to close the wire. If the wire is initially closed this value is {{TRUE}}, setting it to {{FALSE}} will remove the last line segment and make the wire open.
* {{PropertyData|End|VectorDistance}}: specifies the end point of the wire.
* {{PropertyData|Fillet Radius|Length}}: specifies the radius of the fillets at the corners of the wire.
* {{PropertyData|Length|Length}}: (read-only) specifies the total length of the wire.
* {{PropertyData|Make Face|Bool}}: specifies if the wire makes a face or not. If it is {{TRUE}} a face is created, otherwise only the edges are considered part of the object. This property only works if {{PropertyData|Closed}} is {{TRUE}} and if the wire does not self-intersect.
* {{PropertyData|Points|VectorList}}: specifies the points of the wire in its local coordinate system.
* {{PropertyData|Start|VectorDistance}}: specifies the start point of the wire.
* {{PropertyData|Subdivisions|Integer}}: specifies the number of subdivisions for each edge of the wire. If it is {{value|1}} each edge will be divided into {{value|2}} equal segments. Subdivisions are applied before chamfers and fillets.
* {{PropertyData|Tool|Link}}

===View=== <!--T:30-->

<!--T:41-->
{{TitleProperty|Draft}}

<!--T:18-->
* {{PropertyView|Arrow Size|Length}}: specifies the size of the symbol displayed at the end of the wire.
* {{PropertyView|Arrow Type|Enumeration}}: specifies the type of symbol displayed at the end of the wire, which can be {{value|Dot}}, {{value|Circle}}, {{value|Arrow}}, {{value|Tick}} or {{value|Tick-2}}.
* {{PropertyView|End Arrow|Bool}}: specifies whether to show a symbol at the end of the wire, so it can be used as an annotation line.
* {{PropertyView|Pattern|Enumeration}}: specifies the [[Draft_Pattern|Draft Pattern]] with which to fill the face of the closed wire. This property only works if {{PropertyData|Make Face}} is {{TRUE}} and if {{PropertyView|Display Mode}} is {{value|Flat Lines}}.
* {{PropertyView|Pattern Size|Float}}: specifies the size of the [[Draft_Pattern|Draft Pattern]].


==Scripting== <!--T:7-->
==Scripting== <!--T:7-->

The Wire tool can be used in [[macros]] and from the [[Python]] console by using the following function:
<!--T:11-->
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].

<!--T:12-->
To create a Draft Wire use the {{incode|make_wire}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makeWire}} method.

</translate>
</translate>
{{Code|code=
{{Code|code=
Wire = makeWire(pointslist, closed=False, placement=None, face=None, support=None)
wire = make_wire(pointslist, closed=False, placement=None, face=None, support=None)
Wire = makeWire(Part.Wire, closed=False, placement=None, face=None, support=None)
wire = make_wire(Part.Wire, closed=False, placement=None, face=None, support=None)

}}
}}
<translate>
<translate>

<!--T:8-->
<!--T:8-->
* Creates a <code>Wire</code> object with the given list of points, <code>pointslist</code>
* Creates a {{incode|Wire}} object with the given list of points, {{incode|pointslist}}.
* Each point in the list is defined by its <code>FreeCAD.Vector</code>
** Each point in the list is defined by its {{incode|FreeCAD.Vector}}, with units in millimeters.
** Alternatively, the input can be a <code>Part.Wire</code>, from which points are extracted
** Alternatively, the input can be a {{incode|Part.Wire}}, from which points are extracted.
* If <code>closed</code> is <code>True</code>, or if the first and last points are identical, the wire is closed
* If {{incode|closed}} is {{incode|True}}, or if the first and last points are identical, the wire is closed.
* If {{incode|placement}} is {{incode|None}} the shape is created at the origin.
* If <code>face</code> is <code>True</code>, and the wire is closed, the wire will make a face, that is, it will appear filled
* If {{incode|face}} is {{incode|True}}, and the wire is closed, the wire will make a face, that is, it will appear filled.
* It uses the current [[Draft Linestyle]]


<!--T:9-->
<!--T:9-->
Example:
Example:

</translate>
</translate>
{{Code|code=
{{Code|code=
import FreeCAD, Draft
import FreeCAD as App
import Draft
p1 = FreeCAD.Vector(0, 0, 0)

p2 = FreeCAD.Vector(1, 1, 0)
doc = App.newDocument()
p3 = FreeCAD.Vector(2, 0, 0)

Wire = Draft.makeWire([p1, p2, p3], closed=True)
p1 = App.Vector(0, 0, 0)
p2 = App.Vector(1000, 1000, 0)
p3 = App.Vector(2000, 0, 0)

wire1 = Draft.make_wire([p1, p2, p3], closed=True)
wire2 = Draft.make_wire([p1, 2*p3, 1.3*p2], closed=True)
wire3 = Draft.make_wire([1.3*p3, p1, -1.7*p2], closed=True)

doc.recompute()
}}
}}
<translate>
{{clear}}


<!--T:19-->
{{Docnav
|[[Draft_Line|Line]]
|[[Draft_Fillet|Fillet]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Line.svg
|IconR=Draft_Fillet.svg
|IconC=Workbench_Draft.svg
}}

</translate>
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 18:20, 6 January 2024

Draft Wire

Menu location
Drafting → Polyline
Workbenches
Draft, Arch
Default shortcut
P L
Introduced in version
0.7
See also
Draft Line, Draft BSpline

Description

The Draft Wire command creates a polyline, a sequence of several connected line segments. The command can also be used to join Draft Lines and Draft Wires.

The corners of a Draft Wire can be filleted (rounded) or chamfered by changing its DataFillet Radius or DataChamfer Size respectively. It is also possible to subdivide the edges of a Draft Wire by changing its DataSubdivisions property.

Wire defined by multiple points

Create

Usage

See also: Draft Tray, Draft Snap and Draft Constrain.

  1. There are several ways to invoke the command:
    • Press the Polyline button.
    • Select the Drafting → Polyline option from the menu.
    • Use the keyboard shortcut: P then L.
  2. The Polyline task panel opens. See Options for more information.
  3. Pick the first point in the 3D view, or type coordinates and press the Enter point button.
  4. Pick additional points in the 3D view, or type coordinates and press the Enter point button.
  5. Press Esc or the Close button to finish the command.

Options

The single character keyboard shortcuts available in the task panel can be changed. See Draft Preferences. The shortcuts mentioned here are the default shortcuts (for version 0.22).

  • To manually enter coordinates enter the X, Y and Z component, and press Enter after each. Or you can press the Enter point button when you have the desired values. It is advisable to move the pointer out of the 3D view before entering coordinates.
  • Press R or click the Relative checkbox to toggle relative mode. If relative mode is on, coordinates are relative to the last point, if available, else they are relative to the coordinate system origin.
  • Press G or click the Global checkbox to toggle global mode. If global mode is on, coordinates are relative to the global coordinate system, else they are relative to the working plane coordinate system. introduced in version 0.20
  • Press F or click the Filled checkbox to toggle filled mode. If filled mode is on, the created wire will have DataMake Face set to true and will have a filled face, provided it is closed and does not self-intersect. Note that a self-intersecting wire with a face will not display properly, for such a wire DataMake Face must be set to false.
  • Press N or click the Continue checkbox to toggle continue mode. If continue mode is on, the command will restart after using Finish or Close, or after creating a closed wire by snapping to the first point of the wire, allowing you to continue creating wires.
  • Press / or the Undo button to undo the last point.
  • Press A or the Finish button to finish the command and leave the wire open.
  • Press O or the Close button to finish the command and close the wire. A closed wire can also be created by snapping to the first point of the wire.
  • Press W or the Wipe button to delete the segments already placed, but keep working from the last point.
  • Press U or the Set WP button to adjust the current working plane in the orientation of the last segment.
  • Press S to switch Draft snapping on or off.
  • Press Esc or the Close button to finish the command.

Join

Usage

  1. The end points of the Draft Lines and/or Draft Wires to be joined must be exactly coincident. If required first adjust points to ensure that this is the case.
  2. Select two or more Draft Lines and/or Draft Wires.
  3. There are several ways to invoke the command:
    • Press the Draft Wire button.
    • Select the Drafting → Polyline option from the menu.
    • Use the keyboard shortcut: P then L.

Notes

Properties

See also: Property editor.

A Draft Wire object is derived from a Part Part2DObject and inherits all its properties. It also has the following additional properties:

Data

Draft

  • DataArea (Area): (read-only) specifies the area of the face of the wire. The value will be 0.0 if DataMake Face is false or the face cannot be created.
  • DataBase (Link)
  • DataChamfer Size (Length): specifies the length of the chamfers at the corners of the wire.
  • DataClosed (Bool): specifies if the wire is closed or not. If the wire is initially open this value is false, setting it to true will draw a line segment to close the wire. If the wire is initially closed this value is true, setting it to false will remove the last line segment and make the wire open.
  • DataEnd (VectorDistance): specifies the end point of the wire.
  • DataFillet Radius (Length): specifies the radius of the fillets at the corners of the wire.
  • DataLength (Length): (read-only) specifies the total length of the wire.
  • DataMake Face (Bool): specifies if the wire makes a face or not. If it is true a face is created, otherwise only the edges are considered part of the object. This property only works if DataClosed is true and if the wire does not self-intersect.
  • DataPoints (VectorList): specifies the points of the wire in its local coordinate system.
  • DataStart (VectorDistance): specifies the start point of the wire.
  • DataSubdivisions (Integer): specifies the number of subdivisions for each edge of the wire. If it is 1 each edge will be divided into 2 equal segments. Subdivisions are applied before chamfers and fillets.
  • DataTool (Link)

View

Draft

  • ViewArrow Size (Length): specifies the size of the symbol displayed at the end of the wire.
  • ViewArrow Type (Enumeration): specifies the type of symbol displayed at the end of the wire, which can be Dot, Circle, Arrow, Tick or Tick-2.
  • ViewEnd Arrow (Bool): specifies whether to show a symbol at the end of the wire, so it can be used as an annotation line.
  • ViewPattern (Enumeration): specifies the Draft Pattern with which to fill the face of the closed wire. This property only works if DataMake Face is true and if ViewDisplay Mode is Flat Lines.
  • ViewPattern Size (Float): specifies the size of the Draft Pattern.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

To create a Draft Wire use the make_wire method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makeWire method.

wire = make_wire(pointslist, closed=False, placement=None, face=None, support=None)
wire = make_wire(Part.Wire, closed=False, placement=None, face=None, support=None)
  • Creates a Wire object with the given list of points, pointslist.
    • Each point in the list is defined by its FreeCAD.Vector, with units in millimeters.
    • Alternatively, the input can be a Part.Wire, from which points are extracted.
  • If closed is True, or if the first and last points are identical, the wire is closed.
  • If placement is None the shape is created at the origin.
  • If face is True, and the wire is closed, the wire will make a face, that is, it will appear filled.

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

p1 = App.Vector(0, 0, 0)
p2 = App.Vector(1000, 1000, 0)
p3 = App.Vector(2000, 0, 0)

wire1 = Draft.make_wire([p1, p2, p3], closed=True)
wire2 = Draft.make_wire([p1, 2*p3, 1.3*p2], closed=True)
wire3 = Draft.make_wire([1.3*p3, p1, -1.7*p2], closed=True)

doc.recompute()